133 lines
2.9 KiB
Groff
133 lines
2.9 KiB
Groff
.TH MPI_Group_excl 3 "2/3/2025" " " "MPI"
|
|
.SH NAME
|
|
MPI_Group_excl \- Produces a group by reordering an existing group and taking only unlisted members
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.fi
|
|
.nf
|
|
int MPI_Group_excl(MPI_Group group, int n, const int ranks[],
|
|
MPI_Group *newgroup)
|
|
.fi
|
|
|
|
|
|
.SH INPUT PARAMETERS
|
|
.PD 0
|
|
.TP
|
|
.B group
|
|
- group (handle)
|
|
.PD 1
|
|
.PD 0
|
|
.TP
|
|
.B n
|
|
- number of elements in array ranks (integer)
|
|
.PD 1
|
|
.PD 0
|
|
.TP
|
|
.B ranks
|
|
- array of integer ranks of processes in group not to appear in newgroup (integer)
|
|
.PD 1
|
|
|
|
.SH OUTPUT PARAMETERS
|
|
.PD 0
|
|
.TP
|
|
.B newgroup
|
|
- new group derived from above, preserving the order defined by group (handle)
|
|
.PD 1
|
|
|
|
.SH NOTE
|
|
The MPI standard requires that each of the ranks to excluded must be
|
|
a valid rank in the group and all elements must be distinct or the
|
|
function is erroneous.
|
|
|
|
.SH THREAD AND INTERRUPT SAFETY
|
|
|
|
This routine is thread-safe. This means that this routine may be
|
|
safely used by multiple threads without the need for any user-provided
|
|
thread locks. However, the routine is not interrupt safe. Typically,
|
|
this is due to the use of memory allocation routines such as
|
|
.I malloc
|
|
or other non-MPICH runtime routines that are themselves not interrupt-safe.
|
|
|
|
.SH NOTES FOR FORTRAN
|
|
All MPI routines in Fortran (except for
|
|
.I MPI_WTIME
|
|
and
|
|
.I MPI_WTICK
|
|
) have
|
|
an additional argument
|
|
.I ierr
|
|
at the end of the argument list.
|
|
.I 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
|
|
.I call
|
|
statement.
|
|
|
|
All MPI objects (e.g.,
|
|
.I MPI_Datatype
|
|
,
|
|
.I MPI_Comm
|
|
) are of type
|
|
.I INTEGER
|
|
in Fortran.
|
|
|
|
.SH ERRORS
|
|
|
|
All MPI routines (except
|
|
.I MPI_Wtime
|
|
and
|
|
.I 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
|
|
.I MPI_Comm_set_errhandler
|
|
(for communicators),
|
|
.I MPI_File_set_errhandler
|
|
(for files), and
|
|
.I MPI_Win_set_errhandler
|
|
(for
|
|
RMA windows). The MPI-1 routine
|
|
.I MPI_Errhandler_set
|
|
may be used but
|
|
its use is deprecated. The predefined error handler
|
|
.I MPI_ERRORS_RETURN
|
|
may be used to cause error values to be returned.
|
|
Note that MPI does
|
|
.B not
|
|
guarantee that an MPI program can continue past
|
|
an error; however, MPI implementations will attempt to continue whenever
|
|
possible.
|
|
|
|
.PD 0
|
|
.TP
|
|
.B MPI_SUCCESS
|
|
- No error; MPI routine completed successfully.
|
|
.PD 1
|
|
.PD 0
|
|
.TP
|
|
.B MPI_ERR_ARG
|
|
- Invalid argument. Some argument is invalid and is not
|
|
identified by a specific error class (e.g.,
|
|
.I MPI_ERR_RANK
|
|
).
|
|
.PD 1
|
|
.PD 0
|
|
.TP
|
|
.B MPI_ERR_GROUP
|
|
- Null or invalid group passed to function.
|
|
.PD 1
|
|
.PD 0
|
|
.TP
|
|
.B MPI_ERR_OTHER
|
|
- Other error; use
|
|
.I MPI_Error_string
|
|
to get more information
|
|
about this error code.
|
|
.PD 1
|
|
|
|
.SH SEE ALSO
|
|
MPI_Group_free
|
|
.br
|