.. java:import:: fr.inria.tapenade.utils ILLang

.. java:import:: fr.inria.tapenade.utils Tree

InstructionMask
===============

.. java:package:: fr.inria.tapenade.representation
   :noindex:

.. java:type:: public final class InstructionMask

   A vectorial mask, used to guard vectorial instructions.

Fields
------
controlInstruction
^^^^^^^^^^^^^^^^^^

.. java:field:: public Instruction controlInstruction
   :outertype: InstructionMask

   The control of this mask. Control must be an expression Tree of type (array of) boolean. It is placed in an Instruction to allow all controlled Instructions to share any modification of this control.

enclosingMask
^^^^^^^^^^^^^

.. java:field:: public InstructionMask enclosingMask
   :outertype: InstructionMask

   The enclosing mask level, if any.

isTrueBranch
^^^^^^^^^^^^

.. java:field:: public boolean isTrueBranch
   :outertype: InstructionMask

   When true, this mask designates the "then" where branch of its control, otherwise the "else" where branch.

Constructors
------------
InstructionMask
^^^^^^^^^^^^^^^

.. java:constructor:: public InstructionMask(Tree localControl, InstructionMask enclosingMask)
   :outertype: InstructionMask

   Create a mask level enclosed in enclosingMask, controlled by localControl.

Methods
-------
copy
^^^^

.. java:method:: protected InstructionMask copy()
   :outertype: InstructionMask

   :return: a copy of this mask, but the copy shares the controlInstruction.

createElseMask
^^^^^^^^^^^^^^

.. java:method:: public InstructionMask createElseMask()
   :outertype: InstructionMask

   :return: a copy of this mask, sharing the controlInstruction, but designating the "else" branch.

depth
^^^^^

.. java:method:: public int depth()
   :outertype: InstructionMask

   :return: the depth of the enclosing mask levels.

dump
^^^^

.. java:method:: public void dump() throws java.io.IOException
   :outertype: InstructionMask

   Prints in detail the contents of this InstructionMask, onto TapEnv.curOutputStream().

equalMasks
^^^^^^^^^^

.. java:method:: public static boolean equalMasks(InstructionMask mask1, InstructionMask mask2)
   :outertype: InstructionMask

getControlTree
^^^^^^^^^^^^^^

.. java:method:: public Tree getControlTree()
   :outertype: InstructionMask

   :return: the control Tree of this mask.

isEmpty
^^^^^^^

.. java:method:: public boolean isEmpty()
   :outertype: InstructionMask

   :return: true if this mask level is empty i.e. has no control.

rebuildTree
^^^^^^^^^^^

.. java:method:: public Tree rebuildTree()
   :outertype: InstructionMask

setControlTree
^^^^^^^^^^^^^^

.. java:method:: public void setControlTree(Tree tree)
   :outertype: InstructionMask

   Sets the control Tree of this mask.

toString
^^^^^^^^

.. java:method:: @Override public String toString()
   :outertype: InstructionMask