.. java:import:: fr.inria.tapenade.representation ILUtils

.. java:import:: fr.inria.tapenade.representation InstructionMask

.. java:import:: fr.inria.tapenade.representation TapList

.. java:import:: fr.inria.tapenade.representation TypeSpec

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

DiffAssignmentNode
==================

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

.. java:type:: public class DiffAssignmentNode

   Object that stores an almost finished differentiated assignment, as returned by ExpressionDifferentiator.adjointDifferentiateAssignedExpression().

Fields
------
action
^^^^^^

.. java:field:: protected int action
   :outertype: DiffAssignmentNode

   Assignment action: SET_VARIABLE or INCREMENT_VARIABLE.

diffAssign
^^^^^^^^^^

.. java:field:: protected Tree diffAssign
   :outertype: DiffAssignmentNode

   Alternative to (diffRecv ; diffValue), the complete assignment Tree. It would be good to completely replace (diffRecv ; diffValue) with diffAssign.

diffR
^^^^^

.. java:field:: protected TapList<Tree> diffR
   :outertype: DiffAssignmentNode

   Lists of elementary Trees whose diff is read by the assignment.

diffRecv
^^^^^^^^

.. java:field:: protected Tree diffRecv
   :outertype: DiffAssignmentNode

   The differentiated variable that receives the assignment. May be null if this DiffAssignmentNode actually stands for an expression only.

diffValue
^^^^^^^^^

.. java:field:: protected Tree diffValue
   :outertype: DiffAssignmentNode

   The value that is set-to or added-into the receiving differentiated variable.

diffW
^^^^^

.. java:field:: protected TapList<Tree> diffW
   :outertype: DiffAssignmentNode

   Lists of elementary Trees whose diff is written by the assignment.

iReplic
^^^^^^^

.. java:field:: protected int iReplic
   :outertype: DiffAssignmentNode

   The replica number that was used to build "diffRecv" from "primRecv".

mask
^^^^

.. java:field:: protected InstructionMask mask
   :outertype: DiffAssignmentNode

   When there is a vector mask (e.g. in F90) that controls the assignment. Otherwise null.

primR
^^^^^

.. java:field:: protected TapList<Tree> primR
   :outertype: DiffAssignmentNode

   Lists of elementary Trees read by the assignment.

primRecv
^^^^^^^^

.. java:field:: protected Tree primRecv
   :outertype: DiffAssignmentNode

   The primal variable whose diff is diffRecv.

primW
^^^^^

.. java:field:: protected TapList<Tree> primW
   :outertype: DiffAssignmentNode

   Lists of elementary Trees written by the assignment.

type
^^^^

.. java:field:: protected TypeSpec type
   :outertype: DiffAssignmentNode

   The type of the (primal) assigned value

Constructors
------------
DiffAssignmentNode
^^^^^^^^^^^^^^^^^^

.. java:constructor:: protected DiffAssignmentNode(Tree diffRecv, int action, Tree diffValue, InstructionMask mask, Tree primRecv, int iReplic, TapList<Tree> primR, TapList<Tree> primW, TapList<Tree> diffR, TapList<Tree> diffW)
   :outertype: DiffAssignmentNode

   Creates a new DiffAssignmentNode that represents an assignment (or incrementation if action==INCREMENT_VARIABLE), to the diff variable described by "diffRecv", of expression "diffValue".

DiffAssignmentNode
^^^^^^^^^^^^^^^^^^

.. java:constructor:: protected DiffAssignmentNode(Tree diffAssign, int action, InstructionMask mask, Tree primRecv, int iReplic, TapList<Tree> primR, TapList<Tree> primW, TapList<Tree> diffR, TapList<Tree> diffW)
   :outertype: DiffAssignmentNode

   Alternative creation, directly with a complete assignment Tree

Methods
-------
toString
^^^^^^^^

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