DiffConstants
=============

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

.. java:type:: public final class DiffConstants

   Constants used during differentiation.

Fields
------
ADJOINT
^^^^^^^

.. java:field:: protected static final int ADJOINT
   :outertype: DiffConstants

ADJOINT_BWD
^^^^^^^^^^^

.. java:field:: protected static final int ADJOINT_BWD
   :outertype: DiffConstants

ADJOINT_FWD
^^^^^^^^^^^

.. java:field:: protected static final int ADJOINT_FWD
   :outertype: DiffConstants

ADJOINT_MODE
^^^^^^^^^^^^

.. java:field:: protected static final int ADJOINT_MODE
   :outertype: DiffConstants

ADJOINT_SPLIT_MODE
^^^^^^^^^^^^^^^^^^

.. java:field:: protected static final int ADJOINT_SPLIT_MODE
   :outertype: DiffConstants

ALT_DIFF_VAR
^^^^^^^^^^^^

.. java:field:: protected static final int ALT_DIFF_VAR
   :outertype: DiffConstants

   The index where we store an alternate diff name of a given variable. For instance for v, the std diff var may be vb, and me may need another diff var vb0 for instance for storing a previous value of vb...

BINOMIAL_LOOP
^^^^^^^^^^^^^

.. java:field:: protected static final int BINOMIAL_LOOP
   :outertype: DiffConstants

CHECKPOINT
^^^^^^^^^^

.. java:field:: protected static final int CHECKPOINT
   :outertype: DiffConstants

COPY_DIFF_VAR
^^^^^^^^^^^^^

.. java:field:: protected static final int COPY_DIFF_VAR
   :outertype: DiffConstants

DIFFERENTIATED
^^^^^^^^^^^^^^

.. java:field:: protected static final int DIFFERENTIATED
   :outertype: DiffConstants

DO_LOOP
^^^^^^^

.. java:field:: protected static final int DO_LOOP
   :outertype: DiffConstants

ENTRY_BLOCK
^^^^^^^^^^^

.. java:field:: protected static final int ENTRY_BLOCK
   :outertype: DiffConstants

FIXEDPOINT_LOOP
^^^^^^^^^^^^^^^

.. java:field:: protected static final int FIXEDPOINT_LOOP
   :outertype: DiffConstants

II_LOOP
^^^^^^^

.. java:field:: protected static final int II_LOOP
   :outertype: DiffConstants

INCALL
^^^^^^

.. java:field:: protected static final int INCALL
   :outertype: DiffConstants

INCREMENT_VARIABLE
^^^^^^^^^^^^^^^^^^

.. java:field:: protected static final int INCREMENT_VARIABLE
   :outertype: DiffConstants

   Constants for the "kind" of differentiated statement.

INEXPR
^^^^^^

.. java:field:: protected static final int INEXPR
   :outertype: DiffConstants

   The possible values for the (stacked) contexts in which variables must be differentiated. May be INEXPR (default), INCALL, INHEADER

INHEADER
^^^^^^^^

.. java:field:: protected static final int INHEADER
   :outertype: DiffConstants

LABELLED_REGION
^^^^^^^^^^^^^^^

.. java:field:: protected static final int LABELLED_REGION
   :outertype: DiffConstants

MOD
^^^

.. java:field:: protected static final int MOD
   :outertype: DiffConstants

MULTITHREAD_REGION
^^^^^^^^^^^^^^^^^^

.. java:field:: protected static final int MULTITHREAD_REGION
   :outertype: DiffConstants

NATURAL_LOOP
^^^^^^^^^^^^

.. java:field:: protected static final int NATURAL_LOOP
   :outertype: DiffConstants

NODIFF
^^^^^^

.. java:field:: protected static final int NODIFF
   :outertype: DiffConstants

ORIGCOPY
^^^^^^^^

.. java:field:: protected static final int ORIGCOPY
   :outertype: DiffConstants

PLAIN
^^^^^

.. java:field:: protected static final int PLAIN
   :outertype: DiffConstants

PLAIN_BLOCK
^^^^^^^^^^^

.. java:field:: protected static final int PLAIN_BLOCK
   :outertype: DiffConstants

   Constants for the "kind" of FlowGraphLevel.

PLAIN_GROUP
^^^^^^^^^^^

.. java:field:: protected static final int PLAIN_GROUP
   :outertype: DiffConstants

PROC
^^^^

.. java:field:: protected static final int PROC
   :outertype: DiffConstants

SET_VARIABLE
^^^^^^^^^^^^

.. java:field:: protected static final int SET_VARIABLE
   :outertype: DiffConstants

TANGENT
^^^^^^^

.. java:field:: protected static final int TANGENT
   :outertype: DiffConstants

TANGENT_MODE
^^^^^^^^^^^^

.. java:field:: protected static final int TANGENT_MODE
   :outertype: DiffConstants

   The current mode of differentiation for the current unit. - in TANGENT_MODE we generate procedure FOO_D. - in ADJOINT_SPLIT_MODE we generate the two procedures FOO_FWD and FOO_BWD. - in ADJOINT_MODE we generate procedure FOO_B. ADJOINT_MODE also includes "CONTEXT" mode, where we only build a context from which to call the differentiated code.

TIMES_LOOP
^^^^^^^^^^

.. java:field:: protected static final int TIMES_LOOP
   :outertype: DiffConstants

TOP_LEVEL
^^^^^^^^^

.. java:field:: protected static final int TOP_LEVEL
   :outertype: DiffConstants

TYPE
^^^^

.. java:field:: protected static final int TYPE
   :outertype: DiffConstants

UNDEFSORT
^^^^^^^^^

.. java:field:: protected static final int UNDEFSORT
   :outertype: DiffConstants

   The different sorts of differentiated Units or Variables that we may create. This integer is also the rank in the arrays of all such differentiated objects. Reserve -1 for UNDEFINED.

VAR
^^^

.. java:field:: protected static final int VAR
   :outertype: DiffConstants

   Ranks in suffixes array.

WHILE_LOOP
^^^^^^^^^^

.. java:field:: protected static final int WHILE_LOOP
   :outertype: DiffConstants

WILD_LOOP
^^^^^^^^^

.. java:field:: protected static final int WILD_LOOP
   :outertype: DiffConstants