MPIGroupincl(3OpenMPI) MPIGroupincl(3OpenMPI)

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


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIGroupincl(MPIGroup group, int n, int *ranks,
            MPIGroup *newgroup)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIGROUPINCL(GROUP, N, RANKS, NEWGROUP, IERROR)
            INTEGER   GROUP, N, RANKS(*), NEWGROUP, IERROR


CC++++ SSyynnttaaxx
       #include 
       Group Group::Incl(int n, const int ranks[]) const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       group     Group (handle).

       n         Number  of  elements  in  array  ranks  (and  size  of   new-
                 group)(integer).

       ranks     Ranks  of  processes in group to appear in newgroup (array of
                 integers).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       newgroup  New group derived from above, in the order defined  by  ranks
                 (handle).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       The  function MPIGroupincl creates a group groupout that consists of
       the n processes in  group  with  ranks  rank[0],  ...,  rank[n-1];  the
       process  with  rank i in groupout is the process 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, or else the program is erroneous. If
       n = 0, then  groupout  is  MPIGROUPEMPTY.  This  function  can,  for
       instance, be used to reorder the elements of a group.


NNOOTTEE
       This  implementation  does not currently check to ensure that there are
       no duplicates in the list of ranks.


EERRRROORRSS
       Almost all MPI routines return an error value; C routines as the  value
       of  the  function  and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default  error  handler  is  set  to
       MPI::ERRORSTHROWEXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       Before the error value is returned, the current MPI  error  handler  is
       called.  By  default, this error handler aborts the MPI job, except for
       I/O  function  errors.  The  error  handler   may   be   changed   with
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       may be used to cause error values to be returned. Note  that  MPI  does
       not guarantee that an MPI program can continue past an error.


SEE ALSO
       MPIGroupcompare
       MPIGrouprangeincl
       MPIGroupfree




Open MPI 1.2                    September 2006        MPIGroupincl(3OpenMPI)