MPI_Group_compare function

Article
09/14/2018

Compares two groups for member equality.

Syntax

int MPIAPI MPI_Group_compare(
        MPI_Group group1,
        MPI_Group group2,
  _Out_ int       *result
);

Parameters

group1

The first group.

group2

The second group.

result [out]

On return, points to an integer that indicates the results of the comparison.

MPI_IDENT

Indicates that the group members and group order is exactly the same in both groups. For example, the function returns this value if group1 and group2 are the same handle.

MPI_SIMILAR

Indicates that the group members are the same but the order is different.

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_GROUP_COMPARE(GROUP1, GROUP2, RESULT, IERROR)
        INTEGER GROUP1, GROUP2, 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

Share via