1
1

man: Add man of MPI_Message_{c2f,f2c} and MPI_Op_commutative.

These routines were added in MPI-2.2 but were missing in OMPI man pages.
Этот коммит содержится в:
KAWASHIMA Takahiro 2015-10-19 13:43:36 +09:00
родитель 9942d5a933
Коммит bffc7b6c8f
5 изменённых файлов: 77 добавлений и 1 удалений

Просмотреть файл

@ -4,7 +4,7 @@
.\" $COPYRIGHT$
.TH MPI_Comm_f2c 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_Comm_f2c, MPI_Comm_c2f, MPI_File_f2c, MPI_File_c2f, MPI_Info_f2c, MPI_Info_c2f, MPI_Op_f2c, MPI_Op_c2f, MPI_Request_f2c, MPI_Request_c2f, MPI_Type_f2c, MPI_Type_c2f, MPI_Win_f2c, MPI_Win_c2f \fP \- Translates a C handle into a Fortran handle, or vice versa.
\fBMPI_Comm_f2c, MPI_Comm_c2f, MPI_File_f2c, MPI_File_c2f, MPI_Info_f2c, MPI_Info_c2f, MPI_Message_f2c, MPI_Message_c2f, MPI_Op_f2c, MPI_Op_c2f, MPI_Request_f2c, MPI_Request_c2f, MPI_Type_f2c, MPI_Type_c2f, MPI_Win_f2c, MPI_Win_c2f \fP \- Translates a C handle into a Fortran handle, or vice versa.
.SH SYNTAX
.ft R
@ -23,6 +23,9 @@ MPI_Fint MPI_Group_c2f(MPI Group \fIgroup\fP)
MPI_Info MPI_Info_f2c(MPI_Fint \fIinfo\fP)
MPI_Fint MPI_Info_c2f(MPI_Info \fIinfo\fP)
MPI_Message MPI_Message_f2c(MPI_Fint \fImessage\fP)
MPI_Fint MPI_Message_c2f(MPI_Message \fImessage\fP)
MPI_Op MPI_Op_f2c(MPI_Fint \fIop\fP)
MPI_Fint MPI_Op_c2f(MPI_Op \fIop\fP)

1
ompi/mpi/man/man3/MPI_Message_c2f.3in Обычный файл
Просмотреть файл

@ -0,0 +1 @@
.so man3/MPI_Comm_f2c.3

1
ompi/mpi/man/man3/MPI_Message_f2c.3in Обычный файл
Просмотреть файл

@ -0,0 +1 @@
.so man3/MPI_Comm_f2c.3

68
ompi/mpi/man/man3/MPI_Op_commutative.3in Обычный файл
Просмотреть файл

@ -0,0 +1,68 @@
.\" -*- nroff -*-
.\" Copyright 2015 FUJITSU LIMITED. All rights reserved.
.\" $COPYRIGHT$
.TH MPI_Op_commutative 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_Op_commutative\fP \- Query of commutativity of reduction operation.
.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Op_commutative(MPI_Op \fIop\fP, int *\fIcommute\fP)
.fi
.SH Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_OP_COMMUTATIVE(\fIOP, COMMUTE, IERROR\fP)
LOGICAL \fICOMMUTE\fP
INTEGER \fIOP, IERROR\fP
.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_Op_commutative(\fIop\fP, \fIcommute\fP, \fIierror\fP)
TYPE(MPI_Op), INTENT(IN) :: \fIop\fP
INTEGER, INTENT(OUT) :: \fIcommute\fP
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
.fi
.SH C++ Syntax
.nf
#include <mpi.h>
bool Op::Is_commutative()
.fi
.SH INPUT PARAMETER
.TP 1i
op
Operation (handle).
.SH OUTPUT PARAMETERS
.ft R
.TP 1i
commute
True if op is commutative, false otherwise (logical).
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer).
.SH DESCRIPTION
.ft R
Reduction operations can be queried for their commutativity.
.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.
.SH SEE ALSO
.sp
MPI_Op_create

Просмотреть файл

@ -235,6 +235,8 @@ mpi_api_man_pages = \
mpi/man/man3/MPI_Keyval_create.3 \
mpi/man/man3/MPI_Keyval_free.3 \
mpi/man/man3/MPI_Lookup_name.3 \
mpi/man/man3/MPI_Message_c2f.3 \
mpi/man/man3/MPI_Message_f2c.3 \
mpi/man/man3/MPI_Mprobe.3 \
mpi/man/man3/MPI_Mrecv.3 \
mpi/man/man3/MPI_Neighbor_allgather.3 \
@ -248,6 +250,7 @@ mpi_api_man_pages = \
mpi/man/man3/MPI_Neighbor_alltoallw.3 \
mpi/man/man3/MPI_Ineighbor_alltoallw.3 \
mpi/man/man3/MPI_Op_c2f.3 \
mpi/man/man3/MPI_Op_commutative.3 \
mpi/man/man3/MPI_Op_create.3 \
mpi/man/man3/MPI_Open_port.3 \
mpi/man/man3/MPI_Op_f2c.3 \