Open MPI logo

MPI_Group_incl(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Group_inclR] - Produces a group by reordering an existing group and taking only listed members.

Syntax

C Syntax



C]#include <mpi.h>int MPI_Group_incl(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_INCL(GROUP, N, RANKS, NEWGROUP, IERROR) INTEGER GROUP, N, RANKS(*), NEWGROUP, IERRORR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Group_incl(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 (and size of C]newgroupR])(integer).
[bu]
C]ranksR] : Ranks of processes in group to appear in newgroup (array of integers).

Output Parameters

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

Description

The function C]MPI_Group_inclR] creates a group C]group_outR] that consists of the n processes in C]groupR] with ranks C]rank[0]R], ..., C]rank[n-1]R]; the process with rank i in C]group_outR] is the process with rank C]ranks[i]R] in C]groupR]. Each of the n elements of ranks must be a valid rank in C]groupR] and all elements must be distinct, or else the program is erroneous. If C]nR] = 0, then C]group_outR] is C]MPI_GROUP_EMPTYR]. This function can, for instance, be used to reorder the elements of a C]groupR].

Note

This implementation does not currently check to ensure that there are no duplicates in the list of ranks.

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


Table of Contents

« Return to documentation listing