Blame man/man3/MPI_Register_datarep.3

Packit 0848f5
.TH MPI_Register_datarep 3 "11/10/2017" " " "MPI"
Packit 0848f5
.SH NAME
Packit 0848f5
MPI_Register_datarep \-  Register functions for user-defined data  representations 
Packit 0848f5
.SH SYNOPSIS
Packit 0848f5
.nf
Packit 0848f5
int MPI_Register_datarep(ROMIO_CONST char *datarep,
Packit 0848f5
                       MPI_Datarep_conversion_function *read_conversion_fn,
Packit 0848f5
                       MPI_Datarep_conversion_function *write_conversion_fn,
Packit 0848f5
                       MPI_Datarep_extent_function *dtype_file_extent_fn,
Packit 0848f5
                       void *extra_state)
Packit 0848f5
.fi
Packit 0848f5
.SH INPUT PARAMETERS
Packit 0848f5
.PD 0
Packit 0848f5
.TP
Packit 0848f5
.B datarep 
Packit 0848f5
- data representation name (string)
Packit 0848f5
.PD 1
Packit 0848f5
.PD 0
Packit 0848f5
.TP
Packit 0848f5
.B read_conversion_fn 
Packit 0848f5
- function invoked to convert from file representation to
Packit 0848f5
native representation (function)
Packit 0848f5
.PD 1
Packit 0848f5
.PD 0
Packit 0848f5
.TP
Packit 0848f5
.B write_conversion_fn 
Packit 0848f5
- function invoked to convert from native representation to
Packit 0848f5
file representation (function)
Packit 0848f5
.PD 1
Packit 0848f5
.PD 0
Packit 0848f5
.TP
Packit 0848f5
.B dtype_file_extent_fn 
Packit 0848f5
- function invoked to get the exted of a datatype as represented
Packit 0848f5
in the file (function)
Packit 0848f5
.PD 1
Packit 0848f5
.PD 0
Packit 0848f5
.TP
Packit 0848f5
.B extra_state 
Packit 0848f5
- pointer to extra state that is passed to each of the
Packit 0848f5
three functions
Packit 0848f5
.PD 1
Packit 0848f5
Packit 0848f5
.SH NOTES
Packit 0848f5
This function allows the user to provide routines to convert data from
Packit 0848f5
an external representation, used within a file, and the native representation,
Packit 0848f5
used within the CPU.  There is one predefined data representation,
Packit 0848f5
.I external32
Packit 0848f5
\&.
Packit 0848f5
Please consult the MPI-2 standard for details on this
Packit 0848f5
function.
Packit 0848f5
Packit 0848f5
.SH NOTES FOR FORTRAN
Packit 0848f5
All MPI routines in Fortran (except for 
Packit 0848f5
.I MPI_WTIME
Packit 0848f5
and 
Packit 0848f5
.I MPI_WTICK
Packit 0848f5
) have
Packit 0848f5
an additional argument 
Packit 0848f5
.I ierr
Packit 0848f5
at the end of the argument list.  
Packit 0848f5
.I ierr
Packit 0848f5
is an integer and has the same meaning as the return value of the routine
Packit 0848f5
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
Packit 0848f5
.I call
Packit 0848f5
statement.
Packit 0848f5
Packit 0848f5
All MPI objects (e.g., 
Packit 0848f5
.I MPI_Datatype
Packit 0848f5
, 
Packit 0848f5
.I MPI_Comm
Packit 0848f5
) are of type 
Packit 0848f5
.I INTEGER
Packit 0848f5
in Fortran.
Packit 0848f5