Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Compares two communicator handles.
Syntax
int MPIAPI MPI_Comm_compare(
MPI_Comm comm1,
MPI_Comm comm2,
_Out_ int *result
);
Parameters
comm1
A handle for the first communicator to compare.
comm2
A handle for the second communicator to compare.
result [out]
On return, a pointer to the results of the comparison.
The possible values are.
MPI_IDENT
Indicates that the two handles are for the same object. The handles reference identical groups and contexts.
MPI_CONGRUENT
Indicates that the underlying groups have identical members in the same rank order. These communicators differ only by context.
MPI_SIMILAR
Indicates that the underlying groups have identical members, but they are in different rank orders.
MPI_UNEQUAL
Indicates that the handles are for different objects.
Return value
Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.
In Fortran, the return value is stored in the IERROR parameter.
Fortran
MPI_COMM_COMPARE(COMM1,COMM2,RESULT,IERROR)
INTEGER COMM1, COMM1, RESULT, IERROR
Requirements
Product |
HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities |
Header |
Mpi.h; Mpif.h |
Library |
Msmpi.lib |
DLL |
Msmpi.dll |