MPITypecreatestruct(3OpenMPI) MPITypecreatestruct(3OpenMPI)

NAME
       MMPPIITTyyppeeccrreeaatteessttrruucctt - Creates a structured data type.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPITypecreatestruct(int count, int arrayofblocklengths[],
            MPIAint arrayofdisplacements[], MPIDatatype arrayoftypes[],
            MPIDatatype *newtype)


FFoorrttrraann SSyynnttaaxx ((sseeee FFOORRTTRRAANN 7777 NNOOTTEESS))
       INCLUDE 'mpif.h'
       MPITYPECREATESTRUCT(COUNT, ARRAYOFBLOCKLENGTHS,
                 ARRAYOFDISPLACEMENTS, ARRAYOFTYPES, NEWTYPE, IERROR)
            INTEGER   COUNT, ARRAYOFBLOCKLENGTHS(*), ARRAYOFTYPES(*),
            INTEGER NEWTYPE, IERROR
            INTEGER(KIND=MPIADDRESSKIND) ARRAYOFDISPLACEMENTS(*)


CC++++ SSyynnttaaxx
       #include 
       static MPI::Datatype MPI::Datatype::Createstruct(int count,
            const int arrayofblocklengths[], const MPI::Aint
            arrayofdisplacements[], const MPI::Datatype
            arrayoftypes[])


IINNPPUUTT PPAARRAAMMEETTEERRSS
       count     Number  of  blocks  (integer)  -  also  number of entries in
                 arrays    arrayoftypes,     arrayofdisplacements,     and
                 arrayofblocklengths.

       arrayofblocklengths
                 Number of elements in each block (array of integers).

       arrayofdisplacements
                 Byte displacement of each block (array of integers).

       arrayoftypes
                 Type of elements in each block (array of handles to data-type
                 objects).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       newtype   New data type (handle).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPITypecreatestruct creates a structured  data  type.  This  routine
       replaces MPITypestruct, which is now deprecated.

       NOTE  - This routine replaces MPITypestruct, which is deprecated. See
       the man page MPITypestruct(3) for information about that routine.


FFOORRTTRRAANN 7777 NNOOTTEESS
       The  MPI  standard  prescribes  portable   Fortran   syntax   for   the
       ARRAYOFDISPLACEMENTS(*)  argument  only  for  Fortran 90.  FORTRAN 77
       users may use the non-portable syntax

            INTEGER*MPIADDRESSKIND ARRAYOFDISPLACEMENTS(*)

       where MPIADDRESSKIND is a constant defined in mpif.h  and  gives  the
       length of the declared integer in bytes.


EERRRROORRSS
       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::ERRORSTHROWEXCEPTIONS, 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
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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
       MPITypestruct
       MPITypecreatehindexed




Open MPI 1.2                    September 2006MPITypecreatestruct(3OpenMPI)