MPI_GROUP_EXCL, MPI_Group_excl

Purpose

Creates a new group by excluding selected tasks of an existing group.

C synopsis

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

C++ synopsis

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

FORTRAN synopsis

include 'mpif.h' or use mpi
MPI_GROUP_EXCL(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 (integer) (IN)

ranks
     is the array of integer ranks in group that is not to appear in
     newgroup (IN)

newgroup
     is the new group derived from the above, preserving the order defined
     by group (handle) (OUT)

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

Description

This subroutine removes selected tasks from an existing group to create a
new group.

MPI_GROUP_EXCL creates a group of tasks newgroup obtained by deleting from
group tasks with ranks ranks[0],... ranks[n-1]. The ordering of tasks in
newgroup is identical to the ordering 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 identical to 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_INCL
     MPI_GROUP_RANGE_EXCL