[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_Group_compare 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_Group_compare \fP \- Compares two groups. |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .SH C Syntax |
---|
| 9 | .nf |
---|
| 10 | #include <mpi.h> |
---|
| 11 | int MPI_Group_compare(MPI_Group \fIgroup1\fP, MPI_Group\fI group2\fP, |
---|
| 12 | int\fI *result\fP) |
---|
| 13 | |
---|
| 14 | .SH Fortran Syntax |
---|
| 15 | .nf |
---|
| 16 | INCLUDE 'mpif.h' |
---|
| 17 | MPI_GROUP_COMPARE(\fIGROUP1, GROUP2, RESULT, IERROR\fP) |
---|
| 18 | INTEGER \fIGROUP1, GROUP2, RESULT, IERROR\fP |
---|
| 19 | |
---|
| 20 | .SH C++ Syntax |
---|
| 21 | .nf |
---|
| 22 | #include <mpi.h> |
---|
| 23 | static int Group::Compare(const Group& \fIgroup1\fP, const Group& \fIgroup2\fP) |
---|
| 24 | |
---|
| 25 | .SH INPUT PARAMETERS |
---|
| 26 | .ft R |
---|
| 27 | .TP 1i |
---|
| 28 | group1 |
---|
| 29 | First group (handle). |
---|
| 30 | .TP 1i |
---|
| 31 | group2 |
---|
| 32 | Second group (handle). |
---|
| 33 | |
---|
| 34 | .SH OUTPUT PARAMETERS |
---|
| 35 | .ft R |
---|
| 36 | .TP 1i |
---|
| 37 | result |
---|
| 38 | Integer which is MPI_IDENT if the order and members of the two groups are the same, MPI_SIMILAR if only the members are the same, and MPI_UNEQUAL otherwise. |
---|
| 39 | .ft R |
---|
| 40 | .TP 1i |
---|
| 41 | IERROR |
---|
| 42 | Fortran only: Error status (integer). |
---|
| 43 | |
---|
| 44 | .SH DESCRIPTION |
---|
| 45 | .ft R |
---|
| 46 | MPI_IDENT results if the group members and group order is exactly the same in both groups. This happens for instance if group1 and group2 are the same handle. MPI_SIMILAR results if the group members are the same but the order is different. MPI_UNEQUAL results otherwise. |
---|
| 47 | |
---|
| 48 | .SH ERRORS |
---|
| 49 | 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. |
---|
| 50 | .sp |
---|
| 51 | Before the error value is returned, the current MPI error handler is |
---|
| 52 | 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. |
---|
| 53 | |
---|