Provided by: mpi-doc_1.2.7-10ubuntu1_all bug

NAME

       MPI_Group_excl  -   Produces  a  group  by  reordering  an  existing group and taking only
       unlisted members

SYNOPSIS

       #include "mpi.h"
       int MPI_Group_excl ( MPI_Group group, int n, int *ranks, MPI_Group *newgroup )

INPUT PARAMETERS

       group  - group (handle)
       n      - number of elements in array ranks (integer)
       ranks  - array of integer ranks in group not to appear in newgroup

OUTPUT PARAMETER

       newgroup
              - new group derived from above, preserving the order defined by group (handle)

NOTE

       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.

NOTES FOR FORTRAN

       All  MPI  routines  in  Fortran  (except  for MPI_WTIME and MPI_WTICK ) have an additional
       argument ierr at the end of the argument list.  ierr  is  an  integer  and  has  the  same
       meaning  as  the  return  value  of  the  routine  in  C.   In  Fortran,  MPI routines are
       subroutines, and are invoked with the call statement.

       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran.

ERRORS

       All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value;  C  routines  as
       the  value of the function and Fortran routines in the last argument.  Before the value is
       returned, the current MPI error handler is called.  By default, this error handler  aborts
       the  MPI  job.   The error handler may be changed with MPI_Errhandler_set ; the predefined
       error handler MPI_ERRORS_RETURN may be used to cause error values to  be  returned.   Note
       that MPI does not guarentee that an MPI program can continue past an error.

       MPI_SUCCESS
              - No error; MPI routine completed successfully.
       MPI_ERR_GROUP
              - Null group passed to function.
       MPI_ERR_INTERN
              -  This  error  is returned when some part of the MPICH implementation is unable to
              acquire memory.
       MPI_ERR_ARG
              - Invalid argument.  Some argument is invalid and is not identified by  a  specific
              error class (e.g., MPI_ERR_RANK ).
       MPI_ERR_RANK
              -  Invalid  source or destination rank.  Ranks must be between zero and the size of
              the  communicator  minus  one;  ranks  in  a  receive  (  MPI_Recv  ,  MPI_Irecv  ,
              MPI_Sendrecv , etc.) may also be MPI_ANY_SOURCE .

SEE ALSO

       MPI_Group_free

LOCATION

       group_excl.c

                                            11/14/2001                          MPI_Group_excl(3)