Blame man/man3/MPI_Register_datarep.3

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