Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_type_create_struct(3openmpi) [osx man page]

MPI_Type_create_struct(3OpenMPI)										  MPI_Type_create_struct(3OpenMPI)

NAME
MPI_Type_create_struct - Creates a structured data type. SYNTAX
C Syntax #include <mpi.h> int MPI_Type_create_struct(int count, int array_of_blocklengths[], MPI_Aint array_of_displacements[], MPI_Datatype array_of_types[], MPI_Datatype *newtype) Fortran Syntax (see FORTRAN 77 NOTES) INCLUDE 'mpif.h' MPI_TYPE_CREATE_STRUCT(COUNT, ARRAY_OF_BLOCKLENGTHS, ARRAY_OF_DISPLACEMENTS, ARRAY_OF_TYPES, NEWTYPE, IERROR) INTEGER COUNT, ARRAY_OF_BLOCKLENGTHS(*), ARRAY_OF_TYPES(*), INTEGER NEWTYPE, IERROR INTEGER(KIND=MPI_ADDRESS_KIND) ARRAY_OF_DISPLACEMENTS(*) C++ Syntax #include <mpi.h> static MPI::Datatype MPI::Datatype::Create_struct(int count, const int array_of_blocklengths[], const MPI::Aint array_of_displacements[], const MPI::Datatype array_of_types[]) INPUT PARAMETERS
count Number of blocks (integer) -- also number of entries in arrays array_of_types, array_of_displacements, and array_of_blocklengths. array_of_blocklengths Number of elements in each block (array of integers). array_of_displacements Byte displacement of each block (array of integers). array_of_types Type of elements in each block (array of handles to data-type objects). OUTPUT PARAMETERS
newtype New data type (handle). IERROR Fortran only: Error status (integer). DESCRIPTION
MPI_Type_create_struct creates a structured data type. This routine replaces MPI_Type_struct, which is now deprecated. NOTE - This routine replaces MPI_Type_struct, which is deprecated. See the man page MPI_Type_struct(3) for information about that routine. FORTRAN 77 NOTES The MPI standard prescribes portable Fortran syntax for the ARRAY_OF_DISPLACEMENTS(*) argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax INTEGER*MPI_ADDRESS_KIND ARRAY_OF_DISPLACEMENTS(*) where MPI_ADDRESS_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. 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 ALSO
MPI_Type_struct MPI_Type_create_hindexed Open MPI 1.2 September 2006 MPI_Type_create_struct(3OpenMPI)

Check Out this Related Man Page

MPI_Type_create_struct(3)						MPI						 MPI_Type_create_struct(3)

NAME
MPI_Type_create_struct - Create an MPI datatype from a general set of datatypes, displacements, and block sizes SYNOPSIS
int MPI_Type_create_struct(int count, int array_of_blocklengths[], MPI_Aint array_of_displacements[], MPI_Datatype array_of_types[], MPI_Datatype *newtype) INPUT PARAMETERS
count - number of blocks (integer) --- also number of entries in arrays array_of_types, array_of_displacements and array_of_blocklengths array_of_blocklength - number of elements in each block (array of integer) array_of_displacements - byte displacement of each block (array of address integer) array_of_types - type of elements in each block (array of handles to datatype objects) OUTPUT PARAMETER
newtype - new datatype (handle) 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_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., MPI_ERR_RANK ). MPI_ERR_TYPE - Invalid datatype argument. May be an uncommitted MPI_Datatype (see MPI_Type_commit ). LOCATION
type_create_struct.c 7/29/2010 MPI_Type_create_struct(3)
Man Page