
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>
71 строка
2.5 KiB
Plaintext
71 строка
2.5 KiB
Plaintext
.\" -*- nroff -*-
|
|
.\" Copyright (c) 2010-2014 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_Attr_delete 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
|
.SH NAME
|
|
\fBMPI_Attr_delete\fP \- Deletes attribute value associated with a key -- use of this routine is deprecated.
|
|
|
|
.SH SYNTAX
|
|
.ft R
|
|
.SH C Syntax
|
|
.nf
|
|
#include <mpi.h>
|
|
int MPI_Attr_delete(MPI_Comm\fI comm\fP, int\fI keyval\fP)
|
|
|
|
.fi
|
|
.SH Fortran Syntax
|
|
.nf
|
|
INCLUDE 'mpif.h'
|
|
MPI_ATTR_DELETE(\fICOMM\fP,\fI KEYVAL\fP, \fIIERROR\fP)
|
|
INTEGER \fICOMM\fP,\fI KEYVAL\fP,\fI IERROR\fP
|
|
|
|
|
|
.fi
|
|
.SH INPUT PARAMETERS
|
|
.ft R
|
|
.TP 1i
|
|
comm
|
|
Communicator to which attribute is attached (handle).
|
|
.TP 1i
|
|
keyval
|
|
The key value of the deleted attribute (integer).
|
|
|
|
.SH OUTPUT PARAMETER
|
|
.ft R
|
|
.TP 1i
|
|
IERROR
|
|
Fortran only: Error status (integer).
|
|
|
|
.SH DESCRIPTION
|
|
Note that use of this routine is \fIdeprecated\fP as of MPI-2, and
|
|
was \fIdeleted\fP in MPI-3. Please use MPI_Comm_delete_attr. This
|
|
function does not have a mpi_f08 binding.
|
|
.sp
|
|
Delete attribute from cache by key. This function invokes the attribute delete function delete_fn specified when the keyval was created. The call will fail if the delete_fn function returns an error code other than MPI_SUCCESS.
|
|
|
|
Whenever a communicator is replicated using the function MPI_Comm_dup, all callback copy functions for attributes that are currently set are invoked (in arbitrary order). Whenever a communicator is deleted using the function MPI_Comm_free, all callback delete functions for attributes that are currently set are invoked.
|
|
|
|
|
|
.SH NOTES
|
|
Note that it is not defined by the MPI standard what happens if the
|
|
delete_fn callback invokes other MPI functions. In Open MPI, it is
|
|
not valid for delete_fn callbacks (or any of their children) to add or
|
|
delete attributes on the same object on which the delete_fn callback
|
|
is being invoked.
|
|
|
|
|
|
.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_Comm_delete_attr
|
|
.br
|
|
|