This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

MPI_Group_compare(3OpenMPI)                                                      MPI_Group_compare(3OpenMPI)



NAME
       MPI_Group_compare  - Compares two groups.


SYNTAX
C Syntax
       #include <mpi.h>
       int MPI_Group_compare(MPI_Group group1, MPI_Group group2,
            int *result)


Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_GROUP_COMPARE(GROUP1, GROUP2, RESULT, IERROR)
            INTEGER   GROUP1, GROUP2, RESULT, IERROR


C++ Syntax
       #include <mpi.h>
       static int Group::Compare(const Group& group1, const Group& group2)


INPUT PARAMETERS
       group1    First group (handle).

       group2    Second group (handle).


OUTPUT PARAMETERS
       result    Integer  which  is  MPI_IDENT  if  the  order  and  members of the two groups are the same,
                 MPI_SIMILAR if only the members are the same, and MPI_UNEQUAL otherwise.

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPI_IDENT results if the group members and group order is exactly the same in both groups. This  hap-pens happens
       pens  for instance if group1 and group2 are the same handle. MPI_SIMILAR results if the group members
       are the same but the order is different. MPI_UNEQUAL results otherwise.


ERRORS
       Almost all MPI routines return an error value; C routines as the value of the  function  and  Fortran
       routines  in  the  last argument. C++ functions do not return errors. If the default error handler is
       set to MPI::ERRORS_THROW_EXCEPTIONS, 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
       MPI_Comm_set_errhandler;  the  predefined  error handler MPI_ERRORS_RETURN 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                    MPI_Group_compare(3OpenMPI)