MPIGroupexcl(3OpenMPI) MPIGroupexcl(3OpenMPI)

NAME
       MMPPIIGGrroouuppeexxccll  -  Produces a group by reordering an existing group and
       taking only unlisted members.


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


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


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


IINNPPUUTT PPAARRAAMMEETTEERRSS
       group     Group (handle).

       n         Number of elements in array ranks (integer).

       ranks     Array of integer ranks in group not to appear in newgroup.


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

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       The  function MPIGroupexcl creates a group of processes newgroup that
       is obtained by deleting from group those processes with ranks ranks[0],
       ...  ranks[n-1].  The ordering of processes 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; otherwise, the call is
       erroneous. If n = 0, then newgroup is identical to group.


NNOOTTEE
       Currently, each of the ranks to exclude must be a  valid  rank  in  the
       group  and  all elements must be distinct or the function is erroneous.
       This restriction is per the draft.


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
       MPIGrouprangeexcl
       MPIGroupfree




Open MPI 1.2                    September 2006        MPIGroupexcl(3OpenMPI)