0b8baa217d
This commit contains the following changes: The C++ bindings were removed from the standard in MPI-3.0. This commit removes the entirety of the C++ bindings as well as the support configury. Removes all references to C++ from the man pages. This includes the bindings themselves, all references to what C++ bindings return, all not-available comments, and differences between C++ and other language bindings. If the user passes --enable-mpi-cxx, --enable-mpi-cxx-seek, or --enable-cxx-exceptions, print a warning message an abort configure. Signed-off-by: Jeff Squyres <jsquyres@cisco.com> Signed-off-by: Nathan Hjelm <hjelmn@google.com>
86 строки
2.5 KiB
Plaintext
86 строки
2.5 KiB
Plaintext
.\" -*- nroff -*-
|
|
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
|
|
.\" Copyright 2006-2008 Sun Microsystems, Inc.
|
|
.\" Copyright (c) 1996 Thinking Machines Corporation
|
|
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
|
|
.\" $COPYRIGHT$
|
|
.TH MPI_Group_union 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
|
.SH NAME
|
|
\fBMPI_Group_union \fP \- Produces a group by combining two groups.
|
|
|
|
.SH SYNTAX
|
|
.ft R
|
|
.SH C Syntax
|
|
.nf
|
|
#include <mpi.h>
|
|
int MPI_Group_union(MPI_Group \fIgroup1\fP, MPI_Group \fIgroup2\fP,
|
|
MPI_Group *\fInewgroup\fP)
|
|
|
|
.fi
|
|
.SH Fortran Syntax
|
|
.nf
|
|
USE MPI
|
|
! or the older form: INCLUDE 'mpif.h'
|
|
MPI_GROUP_UNION(\fIGROUP1, GROUP2, NEWGROUP, IERROR\fP)
|
|
INTEGER \fIGROUP1, GROUP2, NEWGROUP, IERROR\fP
|
|
|
|
.fi
|
|
.SH Fortran 2008 Syntax
|
|
.nf
|
|
USE mpi_f08
|
|
MPI_Group_union(\fIgroup1\fP, \fIgroup2\fP, \fInewgroup\fP, \fIierror\fP)
|
|
TYPE(MPI_Group), INTENT(IN) :: \fIgroup1\fP, \fIgroup2\fP
|
|
TYPE(MPI_Group), INTENT(OUT) :: \fInewgroup\fP
|
|
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
|
|
|
|
.fi
|
|
.SH INPUT PARAMETERS
|
|
.ft R
|
|
.TP 1i
|
|
group1
|
|
First group (handle).
|
|
.TP 1i
|
|
group2
|
|
Second group (handle).
|
|
|
|
.SH OUTPUT PARAMETERS
|
|
.ft R
|
|
.TP 1i
|
|
newgroup
|
|
Union group (handle).
|
|
.ft R
|
|
.TP 1i
|
|
IERROR
|
|
Fortran only: Error status (integer).
|
|
|
|
.SH DESCRIPTION
|
|
.ft R
|
|
The set-like operations are defined as follows:
|
|
.TP
|
|
o
|
|
union -- All elements of the first group (group1), followed by all elements
|
|
of second group (group2) not in first.
|
|
.TP
|
|
o
|
|
intersect -- all elements of the first group that are also in the second
|
|
group, ordered as in first group.
|
|
.TP
|
|
o
|
|
difference -- all elements of the first group that are not in the second group, ordered as in the first group.
|
|
.sp
|
|
.LP
|
|
Note that for these operations the order of processes in the output group is determined primarily by order in the first group (if possible) and then, if necessary, by order in the second group. Neither union nor intersection are commutative, but both are associative.
|
|
.sp
|
|
The new group can be empty, that is, equal to MPI_GROUP_EMPTY.
|
|
|
|
.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.
|
|
.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.
|
|
|
|
.SH SEE ALSO
|
|
MPI_Group_free
|
|
.br
|
|
|