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

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

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

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

AtomFuncDerivative
==================

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

.. java:type:: public final class AtomFuncDerivative

   Object that manages the derivatives of a black-box routine, intrinsic or external or other. For each routine, one such object is built from a specification which is an IL Tree, as described in function incorporateNewAtomFunc(Tree, SymbolTable).

Fields
------
derivs
^^^^^^

.. java:field:: public Tree[] derivs
   :outertype: AtomFuncDerivative

derivsKeyTreeList
^^^^^^^^^^^^^^^^^

.. java:field:: public TapList<TapPair<Tree, Tree>>[] derivsKeyTreeList
   :outertype: AtomFuncDerivative

factor
^^^^^^

.. java:field:: public Tree factor
   :outertype: AtomFuncDerivative

factorKeyTreeList
^^^^^^^^^^^^^^^^^

.. java:field:: public TapList<TapPair<Tree, Tree>> factorKeyTreeList
   :outertype: AtomFuncDerivative

origKeyTreeList
^^^^^^^^^^^^^^^

.. java:field:: public TapList<TapPair<Tree, Tree>> origKeyTreeList
   :outertype: AtomFuncDerivative

origPattern
^^^^^^^^^^^

.. java:field:: public Tree origPattern
   :outertype: AtomFuncDerivative

paramVars
^^^^^^^^^

.. java:field:: public TapPair<Tree, Tree>[] paramVars
   :outertype: AtomFuncDerivative

Constructors
------------
AtomFuncDerivative
^^^^^^^^^^^^^^^^^^

.. java:constructor:: public AtomFuncDerivative(Tree origPattern, TapList<TapPair<Tree, Tree>> origKeyTreeList, Tree factor, TapList<TapPair<Tree, Tree>> factorKeyTreeList, TapPair<Tree, Tree>[] paramVars, Tree[] derivs, TapList<TapPair<Tree, Tree>>[] derivsKeyTreeList)
   :outertype: AtomFuncDerivative

Methods
-------
buildPartialDerivative
^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public Tree buildPartialDerivative(int i)
   :outertype: AtomFuncDerivative

getDiffCallNames
^^^^^^^^^^^^^^^^

.. java:method:: public TapList<Tree> getDiffCallNames()
   :outertype: AtomFuncDerivative

getMetavarsFromPattern
^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public static TapList<TapPair<Tree, Tree>> getMetavarsFromPattern(Tree tree, TapList<TapPair<Tree, Tree>> keyTreeList)
   :outertype: AtomFuncDerivative

getParamExprs
^^^^^^^^^^^^^

.. java:method:: public Tree[] getParamExprs()
   :outertype: AtomFuncDerivative

incorporateNewAtomFunc
^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public static void incorporateNewAtomFunc(Tree defTree, Unit functionUnit)
   :outertype: AtomFuncDerivative

   Incorporates the definition of derivatives of an atomic function into the properties attached to that atomic function in the "symbolTable". Assumes that defTree is an IL Tree of the shape: binary(call(none(), ident "atomicFunctionName", expressions(containing <e1>,<e2>,...)) <factor>, expressions(binary(<e1>,none(),<e'1>), binary(<e2>,none(),<e'2>), ...)) Where the <ei> are metavariables (op_metavar) that get instantiated during the pattern-match between the origPattern and the actual call, and the <e'i> are the corresponding partial derivatives wrt <ei>. Of course, each <e'i> may use some or all of the <ej>.

matches
^^^^^^^

.. java:method:: public void matches(Tree tree)
   :outertype: AtomFuncDerivative

toString
^^^^^^^^

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