MPI_Type_create_struct function
Defines a new data type with a specified data type, displacement, and size for each block of data.
Syntax
int MPIAPI MPI_Type_create_struct(
int count,
_In_count_(count) int array_of_blocklengths[],
_In_count_(count) MPI_Aint array_of_displacements[],
_In_count_(count) MPI_Datatype array_of_types[],
_Out_ MPI_Datatype *newtype
);
Parameters
count
The number of blocks and the number of entries in the array_of_blocklengths, array_of_displacements and array_of_types parameters.array_of_blocklengths
The number of elements of each block.array_of_displacements
The displacement of each individual block in bytes.array_of_types
The data type of each individual block.newtype [out]
On return, contains an MPI_Datatype handle that represents the new data type.
Return value
Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.
In Fortran, the return value is stored in the IERROR parameter.
Fortran
MPI_TYPE_CREATE_STRUCT(COUNT, ARRAY_OF_BLOCKLENGTHS, ARRAY_OF_DISPLACEMENTS, ARRAY_OF_TYPES, NEWTYPE, IERROR)
COUNT, ARRAY_OF_BLOCKLENGTHS, ARRAY_OF_DISPLACEMENTS, ARRAY_OF_TYPES, NEWTYPE, IERROR
Remarks
This function replaces the MPI_Type_struct function, which is deprecated.
Requirements
Product |
HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities |
Header |
Mpi.h; Mpif.h |
Library |
Msmpi.lib |
DLL |
Msmpi.dll |