96 lines
2.9 KiB
Groff
96 lines
2.9 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "MPI_STATUS_F2C" "3" "Feb 14, 2025" "" "Open MPI"
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.sp
|
|
\fI\%MPI_Status_f2c\fP, \fI\%MPI_Status_f2c\fP \- Translates a C status into a Fortran
|
|
INTEGER\-style status, or vice versa.
|
|
.SH SYNTAX
|
|
.SS C Syntax
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
#include <mpi.h>
|
|
|
|
int MPI_Status_f2c(const MPI_Fint *f_status, MPI_Status *c_status)
|
|
int MPI_Status_c2f(const MPI_Status *c_status, MPI_Fint *f_status)
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH PARAMETERS
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fBf_status\fP : mpi\-style INTEGER MPI status object
|
|
.IP \(bu 2
|
|
\fBc_status\fP : C\-style MPI status object
|
|
.UNINDENT
|
|
.SH DESCRIPTION
|
|
.sp
|
|
These two procedures are provided in C to convert from a Fortran status
|
|
(which is an array of integers) to a C status (which is a structure),
|
|
and vice versa. The conversion occurs on all the information in status,
|
|
including that which is hidden. That is, no status information is lost
|
|
in the conversion.
|
|
.sp
|
|
When using \fI\%MPI_Status_f2c\fP, if \fBf_status\fP is a valid Fortran status, but
|
|
not the Fortran value of \fBMPI_STATUS_IGNORE\fP or \fBMPI_STATUSES_IGNORE\fP, then
|
|
\fI\%MPI_Status_f2c\fP returns in \fBc_status\fP a valid C status with the same
|
|
content. If \fBf_status\fP is the Fortran value of \fBMPI_STATUS_IGNORE\fP or
|
|
\fBMPI_STATUSES_IGNORE\fP, or if \fBf_status\fP is not a valid Fortran status, then
|
|
the call is erroneous.
|
|
.sp
|
|
When using \fI\%MPI_Status_c2f\fP, the opposite conversion is applied. If
|
|
\fBc_status\fP is \fBMPI_STATUS_IGNORE\fP or \fBMPI_STATUSES_IGNORE\fP, or if \fBc_status\fP is
|
|
not a valid C status, then the call is erroneous.
|
|
.sp
|
|
The input status has the same source, tag and error code values as the
|
|
output status, and returns the same answers when queried for count,
|
|
elements, and cancellation. The conversion function may be called with
|
|
an input status argument that has an undefined error field, in which
|
|
case the value of the error field in the output status argument is
|
|
undefined.
|
|
.SH NOTES
|
|
.sp
|
|
These functions are only available in C; they are not available in any
|
|
of the Fortran MPI interfaces.
|
|
.sp
|
|
\fBSEE ALSO:\fP
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
\fI\%MPI_Status_f082c\fP \fI\%MPI_Status_f2f08\fP
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH COPYRIGHT
|
|
2003-2025, The Open MPI Community
|
|
.\" Generated by docutils manpage writer.
|
|
.
|