openmpi/ompi/mpi/man/man3/MPI_Comm_compare.3

.\"Copyright 2006, Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.TH MPI_Comm_compare 3OpenMPI "September 2006" "Open MPI 1.2" " "
.SH NAME
\fBMPI_Comm_compare \fP \-  Compares two communicators.

.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Comm_compare(MPI_Comm \fIcomm1\fP, MPI_Comm\fI comm2\fP, int\fI *result\fP)

.SH Fortran Syntax
.nf
INCLUDE 'mpif.h'
MPI_COMM_COMPARE(\fICOMM1, COMM2, RESULT, IERROR\fP)
	INTEGER	\fICOMM1, COMM2, RESULT, IERROR\fP

.SH C++ Syntax
.nf
#include <mpi.h>
static int Comm::Compare(const Comm& \fIcomm1\fP, const Comm& \fIcomm2\fP)

.SH INPUT PARAMETERS
.ft R
.TP 1i
comm1
Comm1 (handle).
.TP 1i
comm2
Comm2 (handle).

.SH OUTPUT PARAMETERS
.ft R
.TP 1i
result
Result of comparison (integer). 
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer). 

.SH DESCRIPTION
.ft R
MPI_IDENT results if and only if comm1 and comm2 are handles for the same object (identical groups and same contexts). MPI_CONGRUENT results if the underlying groups are identical in constituents and rank order; these communicators differ only by context. MPI_SIMILAR results of the group members of both communicators are the same but the rank order differs. MPI_UNEQUAL results otherwise.

.SH 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.
.sp
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.  

' @(#)MPI_Comm_compare.3 1.20 06/03/09
Fixes trac:850, updates man pages This commit was SVN r13456. The following Trac tickets were found above: Ticket 850 --> https://svn.open-mpi.org/trac/ompi/ticket/850 2007-02-02 00:57:48 +03:00			`.\"Copyright 2006, Sun Microsystems, Inc.`
Initial man pages for all the MPI APIs. There are 304 of them. Also a general man page for mpi,openmpi,MPI, and OpenMPI. Extra work is needed so they get installed properly. This commit was SVN r11871. 2006-09-28 22:39:36 +04:00			`.\" Copyright (c) 1996 Thinking Machines Corporation`
			`.TH MPI_Comm_compare 3OpenMPI "September 2006" "Open MPI 1.2" " "`
			`.SH NAME`
			`\fBMPI_Comm_compare \fP \- Compares two communicators.`

			`.SH SYNTAX`
			`.ft R`
			`.SH C Syntax`
			`.nf`
			`#include <mpi.h>`
			`int MPI_Comm_compare(MPI_Comm \fIcomm1\fP, MPI_Comm\fI comm2\fP, int\fI *result\fP)`

			`.SH Fortran Syntax`
			`.nf`
			`INCLUDE 'mpif.h'`
			`MPI_COMM_COMPARE(\fICOMM1, COMM2, RESULT, IERROR\fP)`
			`INTEGER \fICOMM1, COMM2, RESULT, IERROR\fP`

			`.SH C++ Syntax`
			`.nf`
			`#include <mpi.h>`
			`static int Comm::Compare(const Comm& \fIcomm1\fP, const Comm& \fIcomm2\fP)`

			`.SH INPUT PARAMETERS`
			`.ft R`
			`.TP 1i`
			`comm1`
			`Comm1 (handle).`
			`.TP 1i`
			`comm2`
			`Comm2 (handle).`

			`.SH OUTPUT PARAMETERS`
			`.ft R`
			`.TP 1i`
			`result`
			`Result of comparison (integer).`
			`.ft R`
			`.TP 1i`
			`IERROR`
			`Fortran only: Error status (integer).`

			`.SH DESCRIPTION`
			`.ft R`
			`MPI_IDENT results if and only if comm1 and comm2 are handles for the same object (identical groups and same contexts). MPI_CONGRUENT results if the underlying groups are identical in constituents and rank order; these communicators differ only by context. MPI_SIMILAR results of the group members of both communicators are the same but the rank order differs. MPI_UNEQUAL results otherwise.`

			`.SH 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.`
			`.sp`
			`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.`

			`' @(#)MPI_Comm_compare.3 1.20 06/03/09`