MPI_Group_incl(3)

NAME
     MPI_Group_incl - Produces a group by reordering an existing group and
     taking only listed members

SYNOPSIS
     C:

          #include <mpi.h>

          int MPI_Group_incl ( group, n, ranks, group_out )
          MPI_Group group, *group_out;
          int       n, *ranks;


     C++:

          #include <mpi.h>

          Group Group::Incl(
          int               n,
          const int         ranks[]) const


     Fortran:

          INCLUDE "mpif.h" (or USE MPI)

          INTEGER group, n, ranks(*), newgroup, ierror

          CALL MPI_GROUP_INCL(group, n, ranks(*), newgroup, ierror)


STANDARDS
     This release implements the MPI 1.2 standard, as documented by the MPI
     Forum in the spring 1997 release of MPI:  A Message Passing Interface
     Standard.

DESCRIPTION
     The MPI_Group_incl routine produces a group by reordering an existing
     group and taking only listed members.  This routine accepts the following
     parameters:

     group     Specifies the group (handle)

     n         Specifies the number of elements in array ranks (and the size
               of group_out) (integer)

     ranks     Specifies the ranks of the processes in group to appear in
               group_out (integer array)
     group_out Returns a new group derived from group, in the order defined by
               ranks (handle)

     ierror    Specifies the return code value for successful completion,
               which is in MPI_SUCCESS.  MPI_SUCCESS is defined in the mpif.h
               file.

NOTES
     Currently, this implementation does not check to determine if the list of
     ranks to include are valid ranks in the group.