Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_pack_external_size(3openmpi) [osx man page]

MPI_Pack_external_size(3OpenMPI)										  MPI_Pack_external_size(3OpenMPI)

NAME
MPI_Pack_external_size - Calculates upper bound on space needed to write to a portable format SYNTAX
C Syntax #include <mpi.h> int MPI_Pack_external_size(char *datarep, int incount, MPI_Datatype datatype, MPI_Aint *size) Fortran Syntax INCLUDE 'mpif.h' MPI_PACK_EXTERNAL_SIZE(DATAREP, INCOUNT, DATATYPE, SIZE, IERROR) INTEGER INCOUNT, DATATYPE, IERROR INTEGER (KIND=MPI_ADDRESS_KIND) SIZE CHARACTER*(*) DATAREP C++ Syntax #include <mpi.h> MPI::Aint MPI::Datatype::Pack_external_size(const char* datarep, int incount) const INPUT PARAMETERS
datarep Data representation (string). incount Number of input data items (integer). datatype Datatype of each input data item (handle). OUTPUT PARAMETERS
size Upper bound on size of packed message, in bytes (integer). IERROR Fortran only: Error status (integer). DESCRIPTION
MPI_Pack_external_size allows the application to find out how much space is needed to pack a message in the portable format defined by the MPI Forum. It returns in size an upper bound on the increment in position that would occur in a call to MPI_Pack_external with the same values for datarep, incount, and datatype. The call returns an upper bound, rather than an exact bound, as the exact amount of space needed to pack the message may depend on context and alignment (e.g., the first message packed in a packing unit may take more space). NOTES
The datarep argument specifies the data format. The only valid value in the current version of MPI is "external32". The argument is pro- vided for future extensibility. 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++ func- tions 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. 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. See the MPI man page for a full list of MPI error codes. SEE ALSO
MPI_Pack_external MPI_Unpack_external Open MPI 1.2 September 2006 MPI_Pack_external_size(3OpenMPI)

Check Out this Related Man Page

MPI_File_get_view(3OpenMPI)											       MPI_File_get_view(3OpenMPI)

NAME
MPI_File_get_view - Returns the process's view of data in the file. SYNTAX
C Syntax #include <mpi.h> int MPI_File_get_view(MPI_File fh, MPI_Offset *disp, MPI_Datatype *etype, MPI_Datatype *filetype, char *datarep) Fortran Syntax (see FORTRAN 77 NOTES) INCLUDE 'mpif.h' MPI_FILE_GET_VIEW(FH, DISP, ETYPE, FILETYPE, DATAREP, IERROR) INTEGER FH, ETYPE, FILETYPE, IERROR CHARACTER*(*) DATAREP INTEGER(KIND=MPI_OFFSET_KIND) DISP C++ Syntax #include <mpi.h> void MPI::File::Get_view(MPI::Offset& disp, MPI::Datatype& etype, MPI::Datatype& filetype, char* datarep) const INPUT PARAMETER
fh File handle (handle). OUTPUT PARAMETERS
disp Displacement (integer). etype Elementary data type (handle). filetype File type (handle). See Restrictions, below. datarep Data representation (string). IERROR Fortran only: Error status (integer). DESCRIPTION
The MPI_File_get_view routine returns the process's view of the data in the file. The current values of the displacement, etype, and file- type are returned in disp, etype, and filetype, respectively. The MPI_File_get_view interface allows the user to pass a data-representation string via the datarep argument. FORTRAN 77 NOTES The MPI standard prescribes portable Fortran syntax for the DISP argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax. INTEGER*MPI_OFFSET_KIND DISP where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the length of the declared integer in bytes. 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++ func- tions 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. Before the error value is returned, the current MPI error handler is called. For MPI I/O function errors, the default error handler is set to MPI_ERRORS_RETURN. The error handler may be changed with MPI_File_set_errhandler; the predefined error handler MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI does not guarantee that an MPI program can continue past an error. Open MPI 1.2 September 2006 MPI_File_get_view(3OpenMPI)
Man Page

Featured Tech Videos