NAME

MPI_Group_compare - Compares two groups

SYNOPSIS

#include <mpi.h> 
int MPI_Group_compare(MPI_Group g1 , MPI_Group g2 , int *result ); 
#include <pmpi.h> 
int PMPI_Group_compare(MPI_Group g1 , MPI_Group g2 , int *result ); 

INPUT PARAMETERS

g1 - group (handle)

g2 - group (handle)

OUTPUT PARAMETER

result - the result of the comparison (integer).

DESCRIPTION

The MPI_Group_compare() function is used to compare two groups g1 and g2 . If the two groups are identical, then MPI_IDENT is returned in result . If they contain the same processes, but with a different order of ranks, then MPI_SIMILAR is returned. Otherwise MPI_UNEQUAL is returned in result .

Note that the groups must be valid (not MPI_GROUP_NULL). PMPI_Group_compare() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

MPI_SUCCESS - No error;

MPI_ERR_GROUP - Invalid group;

MPI_ERR_ARG - Invalid output pointer.

SEE ALSO

MPI_Comm_compare (3) MPI_Group_rank (3) MPI_Group_size (3) MPI_Group_free (3)

• Lockless
• MPI Documentation
• MPI_Group_compare