Open MPI logo

MPI_Group_difference(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Group_differenceR] - Makes a group from the difference of two groups.

Syntax

C Syntax



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



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



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

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

Output Parameters

[bu]
C]newgroupR] : Difference group (handle).
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

The set-like operations are defined as follows: * C]unionR] [en] All elements of the first group (C]group1R]), followed by all elements of second group (C]group2R]) that are not in the first group * C]intersectR] [en] all elements of the first group that are also in the second group, ordered as in first group * C]differenceR] [en] all elements of the first group that are not in the second group, ordered as in the first group

Note that for these operations the order of processes in the output group is determined primarily by order in the first group (if possible) and then, if necessary, by order in the second group. Neither union nor intersection are commutative, but both are associative.

The new group can be empty, that is, equal to C]MPI_GROUP_EMPTYR].

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.

See Also

C]MPI_Group_freeR](3)


Table of Contents

« Return to documentation listing