MPI_GROUP_INCL, MPI_Group_incl

Purpose

Creates a new group consisting of selected tasks from an existing group.

C synopsis

#include <mpi.h>
int MPI_Group_incl(MPI_Group group,int n,int *ranks,
    MPI_Group *newgroup);

C++ synopsis

#include mpi.h
MPI::Group MPI::Group::Incl(int n, const int ranks[]) const;

FORTRAN synopsis

include 'mpif.h' or use mpi
MPI_GROUP_INCL(INTEGER GROUP,INTEGER N,INTEGER RANKS(*),
      INTEGER NEWGROUP,INTEGER IERROR)

Parameters

group
     is the group (handle) (IN)

n
     is the number of elements in array ranks and the size of newgroup
     (integer) (IN)

ranks
     is the ranks of tasks in group to appear in newgroup (array of
     integers) (IN)

newgroup
     is the new group derived from above in the order defined by ranks
     (handle) (OUT)

IERROR
     is the FORTRAN return code. It is always the last argument.

Description

This subroutine creates a new group consisting of selected tasks from an
existing group.

MPI_GROUP_INCL creates a group newgroup consisting of n tasks in group with
ranks rank[0], ..., rank[n-1]. The task with rank i in newgroup is the task
with rank ranks[i] in group.

Each of the n elements of ranks must be a valid rank in group and all
elements must be distinct. If n = 0, newgroup is MPI_GROUP_EMPTY. This
function can be used to reorder the elements of a group.

Errors

Invalid group

Invalid size
     n < 0 or n > groupsize

Invalid rank(s)
     ranks[i] < 0 or ranks[i] >= groupsize

Duplicate rank(s)

MPI not initialized

MPI already finalized

Related information

     MPI_GROUP_EXCL
     MPI_GROUP_RANGE_EXCL