Open MPI logo

MPI_Comm_compare(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Comm_compareR] - Compares two communicators.

Syntax

C Syntax



C]#include <mpi.h>int MPI_Comm_compare(MPI_Comm comm1, MPI_Comm comm2, int *result)R]Fortran Syntax



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_COMM_COMPARE(COMM1, COMM2, RESULT, IERROR) INTEGER COMM1, COMM2, RESULT, IERRORR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Comm_compare(comm1, comm2, result, ierror) TYPE(MPI_Comm), INTENT(IN) :: comm1, comm2 INTEGER, INTENT(OUT) :: result INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

[bu]
C]comm1R] : Comm1 (handle).
[bu]
C]comm2R] : Comm2 (handle).

Output Parameters

[bu]
C]resultR] : Result of comparison (integer).
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_IDENTR] C]resultR]s if and only if C]comm1R] and C]comm2R] are handles for the same object (identical groups and same contexts). C]MPI_CONGRUENTR] results if the underlying groups are identical in constituents and rank order; these communicators differ only by context. C]MPI_SIMILARR] results of the group members of both communicators are the same but the rank order differs. C]MPI_UNEQUALR] 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. 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 C]MPI_Comm_set_errhandlerR]; the predefined error handler C]MPI_ERRORS_RETURNR] 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.


Table of Contents

« Return to documentation listing