Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_pack_external_size(3) [debian man page]

MPI_Pack_external_size(3)						MPI						 MPI_Pack_external_size(3)

NAME
MPI_Pack_external_size - Returns the upper bound on the amount of space needed to pack a message using MPI_Pack_external. SYNOPSIS
int MPI_Pack_external_size(char *datarep, int incount, MPI_Datatype datatype, MPI_Aint *size) INPUT PARAMETERS
datarep - data representation (string) incount - number of input data items (integer) datatype - datatype of each input data item (handle) OUTPUT PARAMETERS
size - output buffer size, in bytes (address integer) THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as malloc or other non-MPICH runtime routines that are themselves not interrupt-safe. NOTES FOR FORTRAN
All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument list. ierr is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the call statement. All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran. ERRORS
All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler may be changed with MPI_Comm_set_errhandler (for communicators), MPI_File_set_errhandler (for files), and MPI_Win_set_errhandler (for RMA windows). The MPI-1 routine MPI_Errhandler_set may be used but its use is deprecated. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarentee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible. MPI_SUCCESS - No error; MPI routine completed successfully. MPI_ERR_TYPE - Invalid datatype argument. May be an uncommitted MPI_Datatype (see MPI_Type_commit ). MPI_ERR_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., MPI_ERR_RANK ). LOCATION
pack_external_size.c 8/2/2008 MPI_Pack_external_size(3)

Check Out this Related Man Page

MPI_Type_extent(3)							MPI							MPI_Type_extent(3)

NAME
MPI_Type_extent - Returns the extent of a datatype SYNOPSIS
int MPI_Type_extent(MPI_Datatype datatype, MPI_Aint *extent) INPUT PARAMETERS
datatype - datatype (handle) OUTPUT PARAMETER
extent - datatype extent (address integer) THREAD AND INTERRUPT SAFETY
This routine is both thread- and interrupt-safe. This means that this routine may safely be used by multiple threads and from within a signal handler. DEPRECATED FUNCTION
The MPI-2 standard deprecated a number of routines because MPI-2 provides better versions. This routine is one of those that was depre- cated. The routine may continue to be used, but new code should use the replacement routine. The replacement for this routine is MPI_Type_get_extent . NOTES FOR FORTRAN
All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument list. ierr is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the call statement. All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran. ERRORS
All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler may be changed with MPI_Comm_set_errhandler (for communicators), MPI_File_set_errhandler (for files), and MPI_Win_set_errhandler (for RMA windows). The MPI-1 routine MPI_Errhandler_set may be used but its use is deprecated. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarentee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible. MPI_SUCCESS - No error; MPI routine completed successfully. MPI_ERR_TYPE - Invalid datatype argument. May be an uncommitted MPI_Datatype (see MPI_Type_commit ). LOCATION
type_extent.c 7/29/2010 MPI_Type_extent(3)
Man Page