1MPI_Group_range_excl(3) LAM/MPI MPI_Group_range_excl(3)
2
6 MPI_Group_range_excl - Produces a group by excluding ranges of pro‐
7 cesses from an existing group
8
10 #include <mpi.h>
11 int MPI_Group_range_excl(MPI_Group g, int n,
12 int ranges[][3], MPI_Group *png)
13
15 group - group (handle)
16 n - number of elements in array ranges (integer)
17 ranges - a one-dimensional array of integer triplets of the form (first
18 rank, last rank, stride), indicating the ranks in g of processes
19 to be excluded from the output group png .
20
24 png - new group derived from above, preserving the order in group
25 (handle)
26
29 Each of the ranks to exclude must be a valid rank in the group and all
30 elements must be distinct or the function is erroneous.
31 When a group is no longer being used, it should be freed with
33 MPI_Group_free .
34
38 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
39 an additional argument ierr at the end of the argument list. ierr is
40 an integer and has the same meaning as the return value of the routine
41 in C. In Fortran, MPI routines are subroutines, and are invoked with
42 the call statement.
43 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
45 Fortran.
46
49 If an error occurs in an MPI function, the current MPI error handler is
50 called to handle it. By default, this error handler aborts the MPI
51 job. The error handler may be changed with MPI_Errhandler_set ; the
52 predefined error handler MPI_ERRORS_RETURN may be used to cause error
53 values to be returned (in C and Fortran; this error handler is less
54 useful in with the C++ MPI bindings. The predefined error handler
55 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
56 needs to be recovered). Note that MPI does not guarantee that an MPI
57 program can continue past an error.
58 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
60 value; C routines as the value of the function and Fortran routines in
61 the last argument. The C++ bindings for MPI do not return error val‐
62 ues; instead, error values are communicated by throwing exceptions of
63 type MPI::Exception (but not by default). Exceptions are only thrown
64 if the error value is not MPI::SUCCESS .
65 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
68 functions will return upon an error, there will be no way to recover
69 what the actual error value was.
70 MPI_SUCCESS
71 - No error; MPI routine completed successfully.
72 MPI_ERR_GROUP
73 - Null group passed to function.
74 MPI_ERR_OTHER
75 - This error is returned when some part of the LAM/MPI implemen‐
76 tation is unable to acquire memory.
77 MPI_ERR_RANK
78 - Invalid source or destination rank. Ranks must be between
79 zero and the size of the communicator minus one; ranks in a
80 receive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
81 be MPI_ANY_SOURCE .
82 MPI_ERR_ARG
84 - Invalid argument. Some argument is invalid and is not identi‐
85 fied by a specific error class. This is typically a NULL
86 pointer or other such error.
87
90 MPI_Group_free
91
94 For more information, please see the official MPI Forum web site, which
95 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
96 ments contain detailed information about each MPI function (most of
97 which is not duplicated in these man pages).
98 http://www.mpi-forum.org/
100
104 The LAM Team would like the thank the MPICH Team for the handy program
105 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
106 ing/sowing.tar.gz ), the initial formatting, and some initial text for
107 most of the MPI-1 man pages.
108
110 grexcl.c
111LAM/MPI 7.1.2 2/23/2006 MPI_Group_range_excl(3)