MPICommcompare(3OpenMPI) MPICommcompare(3OpenMPI)

NAME
       MMPPIICCoommmmccoommppaarree  -  Compares two communicators.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPICommcompare(MPIComm comm1, MPIComm comm2, int *result)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPICOMMCOMPARE(COMM1, COMM2, RESULT, IERROR)
            INTEGER   COMM1, COMM2, RESULT, IERROR


CC++++ SSyynnttaaxx
       #include 
       static int Comm::Compare(const Comm& comm1, const Comm& comm2)


IINNPPUUTT PPAARRAAMMEETTEERRSS
       comm1     Comm1 (handle).

       comm2     Comm2 (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       result    Result of comparison (integer).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPIIDENT  results  if  and only if comm1 and comm2 are handles for the
       same object (identical groups and same contexts). MPICONGRUENT results
       if  the underlying groups are identical in constituents and rank order;
       these communicators differ only by context. MPISIMILAR results of  the
       group  members  of  both  communicators are the same but the rank order
       differs. MPIUNEQUAL results otherwise.


EERRRROORRSS
       Almost all MPI routines return an error value; C routines as the  value
       of  the  function  and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default  error  handler  is  set  to
       MPI::ERRORSTHROWEXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       Before the error value is returned, the current MPI  error  handler  is
       called.  By  default, this error handler aborts the MPI job, except for
       I/O  function  errors.  The  error  handler   may   be   changed   with
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       may be used to cause error values to be returned. Note  that  MPI  does
       not guarantee that an MPI program can continue past an error.





Open MPI 1.2                    September 2006      MPICommcompare(3OpenMPI)