MPI_Comm_compare(3)

MPI_Comm_compare - Compares two communicators

Showing IRIX 6.5.30 (default release). Added in IRIX 6.5.19.

NAME
     MPI_Comm_compare - Compares two communicators

SYNOPSIS
     C:

          #include <mpi.h>

          int MPI_Comm_compare ( comm1, comm2, result )
          MPI_Comm  comm1;
          MPI_Comm  comm2;
          int       *result;


     C++:

          #include <mpi.h>

          static int Comm::Compare(
          const Comm&       comm1,
          const Comm&       comm2)


     Fortran:

          INCLUDE "mpif.h" (or USE MPI)

          INTEGER comm1, comm2, result, ierror

          CALL MPI_COMM_COMPARE(comm1, comm2, result,
          ierror)


STANDARDS
     This release implements the MPI 1.2 standard, as documented by the MPI
     Forum in the spring 1997 release of MPI:  A Message Passing Interface
     Standard.

DESCRIPTION
     The MPI_Comm_compare routine compares two communicators.  This routine
     accepts the following parameters:

     comm1     Specifies the first communicator to be compared (handle)

     comm2     Specifies the second communicator to be compared (handle)

     result    Returns integer result.  Predefined values are as follows:

                  MPI_IDENT      The contexts and groups are the same.
                  MPI_CONGRUENT  Different contexts but identical groups.

                  MPI_SIMILAR    Different contexts but similar groups.

                  MPI_UNEQUAL    Unequal contexts and groups.  ierror
                                 Specifies the return code value for
                                 successful completion, which is in
                                 MPI_SUCCESS.  MPI_SUCCESS is defined in the
                                 mpif.h file.