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

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

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

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

MPIcallInfo
===========

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

.. java:type:: public final class MPIcallInfo

   The collection of all info about a particular Message-Passing call, needed to analyze it and to differentiate it more easily later.

Methods
-------
argumentIsABuffer
^^^^^^^^^^^^^^^^^

.. java:method:: public boolean argumentIsABuffer(int argumentRank)
   :outertype: MPIcallInfo

argumentIsAReduceOp
^^^^^^^^^^^^^^^^^^^

.. java:method:: public boolean argumentIsAReduceOp(int argumentRank)
   :outertype: MPIcallInfo

argumentIsAType
^^^^^^^^^^^^^^^

.. java:method:: public boolean argumentIsAType(int argumentRank)
   :outertype: MPIcallInfo

argumentIsRead
^^^^^^^^^^^^^^

.. java:method:: public boolean argumentIsRead(int argumentRank)
   :outertype: MPIcallInfo

checkMessagePassingCalls
^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: protected static void checkMessagePassingCalls(CallGraph callGraph)
   :outertype: MPIcallInfo

checkNumberOfChannels
^^^^^^^^^^^^^^^^^^^^^

.. java:method:: protected static int checkNumberOfChannels(CallGraph callGraph)
   :outertype: MPIcallInfo

findMessagePassingChannel
^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public TapPair<MPIcallInfo, TapIntList> findMessagePassingChannel(CallGraph callGraph)
   :outertype: MPIcallInfo

findMessagePassingChannelZones
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public TapIntList findMessagePassingChannelZones(CallGraph callGraph)
   :outertype: MPIcallInfo

funcName
^^^^^^^^

.. java:method:: public String funcName()
   :outertype: MPIcallInfo

   The full name of this message-passing call, capitalized the way it is used.

getMessagePassingMPIcallInfo
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public static MPIcallInfo getMessagePassingMPIcallInfo(String funcName, Tree callTree, int language, Block block)
   :outertype: MPIcallInfo

   Get (or create) the Message-Passing info attached to the particular call "callTree".

   :return: null when callTree is not and MPI call or is an MPI call irrelevant to AD (e.g. mpi_init, mpi_finalize,...).

isCommCreation
^^^^^^^^^^^^^^

.. java:method:: public boolean isCommCreation()
   :outertype: MPIcallInfo

isCommFree
^^^^^^^^^^

.. java:method:: public boolean isCommFree()
   :outertype: MPIcallInfo

isMessagePassingFunction
^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public static boolean isMessagePassingFunction(String funcName, int language)
   :outertype: MPIcallInfo

   :param funcName: MPI or AMPI function name.
   :param language: current language.
   :return: true for a Message Passing call.

isNonBlocking
^^^^^^^^^^^^^

.. java:method:: public boolean isNonBlocking()
   :outertype: MPIcallInfo

isNonBlockingMPI
^^^^^^^^^^^^^^^^

.. java:method:: public static boolean isNonBlockingMPI(Tree callTree, Unit calledUnit, Block block)
   :outertype: MPIcallInfo

isOnDifferentiableType
^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public boolean isOnDifferentiableType()
   :outertype: MPIcallInfo

   When false, indicates that this message-passing call deals with values of non-differentiable type, and therefore must not be differentiated.

isPointToPoint
^^^^^^^^^^^^^^

.. java:method:: public boolean isPointToPoint()
   :outertype: MPIcallInfo

   :return: True when this is a send or recv i.e. one end of a point-to-point communication.

isReduceCall
^^^^^^^^^^^^

.. java:method:: public boolean isReduceCall()
   :outertype: MPIcallInfo

receivedExprFromChannel
^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public Tree receivedExprFromChannel()
   :outertype: MPIcallInfo

registerMessagePassingChannel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public void registerMessagePassingChannel(CallGraph callGraph)
   :outertype: MPIcallInfo

replaceMPIconstantsIfPossible
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public static Tree replaceMPIconstantsIfPossible(Tree preprocessedTree)
   :outertype: MPIcallInfo

   NOT_YET_IMPLEMENTED !!! When possible, replace a Tree which has been returned by the C preprocessor, e.g. (MPI_Comm)0x44000000, with a reference to the MPI defined name it had before, e.g. MPI_COMM_WORLD.

sentExprToChannel
^^^^^^^^^^^^^^^^^

.. java:method:: public Tree sentExprToChannel()
   :outertype: MPIcallInfo

toString
^^^^^^^^

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