1MPI_Group_compare(3) LAM/MPI MPI_Group_compare(3)
2
6 MPI_Group_compare - Compares two groups
7
9 #include <mpi.h>
10 int MPI_Group_compare(MPI_Group g1, MPI_Group g2,
11 int *pres)
12
14 g1 - group1 (handle)
15 g2 - group2 (handle)
16
19 pres - integer which is MPI_IDENT if the order and members of the two
20 groups are the same, MPI_SIMILAR if only the members are the
21 same, and MPI_UNEQUAL otherwise
22
25 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
26 an additional argument ierr at the end of the argument list. ierr is
27 an integer and has the same meaning as the return value of the routine
28 in C. In Fortran, MPI routines are subroutines, and are invoked with
29 the call statement.
30 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
32 Fortran.
33
36 If an error occurs in an MPI function, the current MPI error handler is
37 called to handle it. By default, this error handler aborts the MPI
38 job. The error handler may be changed with MPI_Errhandler_set ; the
39 predefined error handler MPI_ERRORS_RETURN may be used to cause error
40 values to be returned (in C and Fortran; this error handler is less
41 useful in with the C++ MPI bindings. The predefined error handler
42 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
43 needs to be recovered). Note that MPI does not guarantee that an MPI
44 program can continue past an error.
45 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
47 value; C routines as the value of the function and Fortran routines in
48 the last argument. The C++ bindings for MPI do not return error val‐
49 ues; instead, error values are communicated by throwing exceptions of
50 type MPI::Exception (but not by default). Exceptions are only thrown
51 if the error value is not MPI::SUCCESS .
52 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
55 functions will return upon an error, there will be no way to recover
56 what the actual error value was.
57 MPI_SUCCESS
58 - No error; MPI routine completed successfully.
59 MPI_ERR_GROUP
60 - Null group passed to function.
61 MPI_ERR_ARG
62 - Invalid argument. Some argument is invalid and is not identi‐
63 fied by a specific error class. This is typically a NULL
64 pointer or other such error.
65 MPI_ERR_OTHER
66 - This error is returned when some part of the LAM/MPI implemen‐
67 tation is unable to acquire memory.
68
71 For more information, please see the official MPI Forum web site, which
72 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
73 ments contain detailed information about each MPI function (most of
74 which is not duplicated in these man pages).
75 http://www.mpi-forum.org/
77
81 The LAM Team would like the thank the MPICH Team for the handy program
82 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
83 ing/sowing.tar.gz ), the initial formatting, and some initial text for
84 most of the MPI-1 man pages.
85
87 gcmp.c
88LAM/MPI 7.1.2 2/23/2006 MPI_Group_compare(3)