MPI_GROUP_RANGE_EXCL, MPI_Group_range_excl

Purpose

Creates a new group by removing selected ranges of tasks from an existing
group.

C synopsis

#include <mpi.h>
int MPI_Group_range_excl(MPI_Group group,int n,
    int ranges[][3],MPI_Group *newgroup);

C++ synopsis

#include mpi.h
MPI::Group MPI::Group::Range_excl(int n, const int ranges[][3])
                                  const;

FORTRAN synopsis

include 'mpif.h' or use mpi
MPI_GROUP_RANGE_EXCL(INTEGER GROUP,INTEGER N,INTEGER RANGES(3,*),
    INTEGER NEWGROUP,INTEGER IERROR)

Parameters

group
     is the group (handle) (IN)

n
     is the number of triplets in array ranges (integer) (IN)

ranges
     is an array of integer triplets of the form (first rank, last rank,
     stride) specifying the ranks in group of tasks that are to be excluded
     from the output group newgroup. (IN)

newgroup
     is the new group derived from above that preserves the order in group
     (handle) (OUT)

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

Description

This subroutine creates a new group by removing selected ranges of tasks
from an existing group. Each computed rank must be a valid rank in group
and all computed ranks must be distinct.

The function of this subroutine is equivalent to expanding the array ranges
to an array of the excluded ranks and passing the resulting array of ranks
and other arguments to MPI_GROUP_EXCL. A call to MPI_GROUP_EXCL is
equivalent to a call to MPI_GROUP_RANGE_EXCL with each rank i in ranks
replaced by the triplet (i,i,1) in the argument ranges.

Errors

Invalid group

Invalid size
     n < 0 or n > groupsize

Invalid rank(s)
     a computed rank < 0 or >= groupsize

Duplicate rank(s)

Invalid stride(s)
     stride[i] = 0

Too many ranks
     Number of ranks > groupsize

MPI not initialized

MPI already finalized

Related information

     MPI_GROUP_EXCL
     MPI_GROUP_INCL