Open MPI logo

MPI_Group_excl(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Group_exclR] - Produces a group by reordering an existing group and taking only unlisted members.

Syntax

C Syntax



C]#include <mpi.h>int MPI_Group_excl(MPI_Group group, int n, const int ranks[], MPI_Group *newgroup)R]Fortran Syntax



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_GROUP_EXCL(GROUP, N, RANKS, NEWGROUP, IERROR) INTEGER GROUP, N, RANKS(*), NEWGROUP, IERRORR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Group_excl(group, n, ranks, newgroup, ierror) TYPE(MPI_Group), INTENT(IN) :: group INTEGER, INTENT(IN) :: n, ranks(n) TYPE(MPI_Group), INTENT(OUT) :: newgroup INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

[bu]
C]groupR] : Group (handle).
[bu]
C]nR] : Number of elements in array ranks (integer).
[bu]
C]ranksR] : Array of integer ranks in group not to appear in newgroup.

Output Parameters

[bu]
C]newgroupR] : New group derived from above, preserving the order defined by group (handle).
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

The function C]MPI_Group_exclR] creates a C]groupR] of processes C]newgroupR] that is obtained by deleting from C]groupR] those processes with ranks C]ranks[0]R], ... C]ranks[n-1]R]. The ordering of processes in C]newgroupR] is identical to the ordering in C]groupR]. Each of the n elements of ranks must be a valid rank in C]groupR] and all elements must be distinct; otherwise, the call is erroneous. If C]nR] = 0, then C]newgroupR] is identical to C]groupR].

Note

Currently, each of the ranks to exclude must be a valid rank in the C]groupR] and all elements must be distinct or the function is erroneous. This restriction is per the draft.

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_range_exclR](3) C]MPI_Group_freeR](3)


Table of Contents

« Return to documentation listing