DragonFly On-Line Manual Pages

Search: Section:  

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,
                                MPICH2_CONST int array_of_blocklengths[],
                                MPICH2_CONST MPI_Aint array_of_displacements[],
                                MPICH2_CONST 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

       src/mpi/datatype/type_create_struct.c

                                   9/20/2012         MPI_Type_create_struct(3)

Search: Section: