MPI_GROUP_RANGE_INCL, MPI_Group_range_incl

Purpose

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

C synopsis

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

C++ synopsis

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

FORTRAN synopsis

include 'mpif.h' or use mpi
MPI_GROUP_RANGE_INCL(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 a one-dimensional array of integer triplets of the form
     (first_rank, last_rank, stride) indicating ranks in group of tasks to
     be included in newgroup (IN)

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

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

Description

This subroutine creates a new group consisting of selected ranges of tasks
from an existing group. The function of this subroutine is equivalent to
expanding the array of ranges to an array of the included ranks and passing
the resulting array of ranks and other arguments to MPI_GROUP_INCL. A call
to MPI_GROUP_INCL is equivalent to a call to MPI_GROUP_RANGE_INCL 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
     nranks > groupsize

MPI not initialized

MPI already finalized

Related information

     MPI_GROUP_EXCL
     MPI_GROUP_INCL