MPITypecontiguous(3OpenMPI) MPITypecontiguous(3OpenMPI)

NAME
       MMPPIITTyyppeeccoonnttiigguuoouuss - Creates a contiguous datatype.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPITypecontiguous(int count, MPIDatatype oldtype,
            MPIDatatype *newtype)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPITYPECONTIGUOUS(COUNT, OLDTYPE, NEWTYPE, IERROR)
            INTEGER   COUNT, OLDTYPE, NEWTYPE, IERROR


CC++++ SSyynnttaaxx
       #include 
       Datatype Datatype::Createcontiguous(int count) const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       count     Replication count (nonnegative integer).

       oldtype   Old datatype (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       newtype   New datatype (handle).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       The  simplest datatype constructor is MPITypecontiguous, which allows
       replication of a datatype into contiguous locations.

       newtype is the datatype obtained by concatenating count copies of  old-
       type.  Concatenation is defined using the extent of oldtype as the size
       of the concatenated copies.

       EExxaammppllee:: Let oldtype have type  map  {(double,  0),  (char,  8)},  with
       extent  16, and let count = 3. The type map of the datatype returned by
       newtype is

           {(double, 0), (char, 8), (double, 16), (char, 24),
           (double, 32), (char, 40)];

       i.e., alternating double and char elements, with  displacements  0,  8,
       16, 24, 32, 40.

       In general, assume that the type map of oldtype is

           {(type(0), disp(0)),...,(type(n-1), disp(n-1))},

       with  extent ex. Then newtype has a type map with count times n entries
       defined by:

           {(type(0), disp(0)), ...,(type(n-1), disp(n-1)),
           (type(0), disp(0) + ex), ...,(type(n-1),
           disp(n-1) + ex), ...,(type(0), disp(0) + ex * (count - 1)),
           ...,(type(n-1), disp(n-1) + ex * (count - 1))}.

       For more information about derived datatypes, see Section 3.12  of  the
       MPI-1 Standard.


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.




Open MPI 1.2                    September 2006   MPITypecontiguous(3OpenMPI)