Open MPI logo

MPI_Group_compare(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Group_compareR] - Compares two groups.

Syntax

C Syntax



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



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



C]USE mpi_f08MPI_Group_compare(group1, group2, result, ierror) TYPE(MPI_Group), INTENT(IN) :: group1, group2 INTEGER, INTENT(OUT) :: result INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

[bu]
C]group1R] : First group (handle).
[bu]
C]group2R] : Second group (handle).

Output Parameters

[bu]
C]resultR] : 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.
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_IDENTR] results if the group members and group order is exactly the same in both groups. This happens for instance if C]group1R] and C]group2R] are the same handle. C]MPI_SIMILARR] results if the group members are the same but the order is different. 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