MPI_Group_excl(3)                  Open MPI                  MPI_Group_excl(3)



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


SYNTAX
C Syntax
       #include <mpi.h>
       int MPI_Group_excl(MPI_Group group, int n, int *ranks,
            MPI_Group *newgroup)


Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_GROUP_EXCL(GROUP, N, RANKS, NEWGROUP, IERROR)
            INTEGER   GROUP, N, RANKS(*), NEWGROUP, IERROR


C++ Syntax
       #include <mpi.h>
       Group Group::Excl(int n, const int ranks[]) const


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 PARAMETERS
       newgroup  New group derived from above, preserving the order defined by
                 group (handle).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       The function MPI_Group_excl 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.


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.


ERRORS
       Almost all MPI routines return an error value; C routines as the value
       of the function and Fortran routines in the last argument. C++
       functions do not return errors. If the default error handler is set to
       MPI::ERRORS_THROW_EXCEPTIONS, 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
       MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN
       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
       MPI_Group_range_excl
       MPI_Group_free




1.4.1                            Jan 14, 2010                MPI_Group_excl(3)
