MPIGrouprangeexcl(3OpenMPI) MPIGrouprangeexcl(3OpenMPI)

NAME
       MMPPIIGGrroouupprraannggeeeexxccll  -  Produces  a  group by excluding ranges of pro-
       cesses from an existing group.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIGrouprangeexcl(MPIGroup group, int n, int ranges[][3],
            MPIGroup *newgroup)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIGROUPRANGEEXCL(GROUP, N, RANGES, NEWGROUP, IERROR)
            INTEGER   GROUP, N, RANGES(3,*), NEWGROUP, IERROR


CC++++ SSyynnttaaxx
       #include 
       Group Group::Rangeexcl(int n, const int ranges[][3]) const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       group     Group (handle).

       n         Number of triplets in array ranges (integer).

       ranges    A one-dimensional array  of  integer  triplets  of  the  form
                 (first  rank,  last  rank,  stride),  indicating the ranks in
                 group of processes to be excluded from the output group  new-
                 group.


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

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Each computed rank must be a valid rank in group and all computed ranks
       must be distinct, or else the program is erroneous.

       The  functionality  of  this  routine  is specified to be equivalent to
       expanding the array of ranges to an array of  the  excluded  ranks  and
       passing   the   resulting   array  of  ranks  and  other  arguments  to
       MPIGroupexcl. A call to MPIGroupexcl is equivalent  to  a  call  to
       MPIGrouprangeexcl  with each rank i in ranks replaced by the triplet
       (i,i,1) in the argument ranges.


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




Open MPI 1.2                    September 2006  MPIGrouprangeexcl(3OpenMPI)