MPITypehindexed(3OpenMPI) MPITypehindexed(3OpenMPI)

NAME
       MMPPIITTyyppeehhiinnddeexxeedd  -  Creates an indexed datatype with offsets in bytes
       - use of this routine is deprecated.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPITypehindexed(int count, int *arrayofblocklengths,
            MPIAint *arrayofdisplacements, MPIDatatype oldtype,
            MPIDatatype *newtype)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPITYPEHINDEXED(COUNT, ARRAYOFBLOCKLENGTHS,
                 ARRAYOFDISPLACEMENTS, OLDTYPE, NEWTYPE, IERROR)
            INTEGER   COUNT, ARRAYOFBLOCKLENGTHS(*)
            INTEGER   ARRAYOFDISPLACEMENTS(*), OLDTYPE, NEWTYPE
            INTEGER   IERROR



IINNPPUUTT PPAARRAAMMEETTEERRSS
       count     Number of blocks - also number of entries  in  arrayofdis-
                 placements  and arrayofblocklengths  (integer).

       arrayofblocklengths
                 Number  of elements in each block (array of nonnegative inte-
                 gers).

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

       oldtype   Old datatype (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       newtype   New datatype (handle).


       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Note  that  use  of  this  routine  is  deprecated  as  of  MPI-2.  Use
       MPITypecreatehindexed instead.

       This deprecated routine is not available in C++.

       The  function  is identical to MPITypeindexed, except that block dis-
       placements in arrayofdisplacements are  specified  in  bytes,  rather
       than in multiples of the oldtype extent.

       Assume that oldtype has type map

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

       with extent ex. Let B be the arrayofblocklength argument and D be the
       arrayofdisplacements argument. The newly created datatype has
       n x S^count-1
           (i=0)        B[i]  entries:

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


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
       MPITypecreatehindexed
       MPITypeindexed




Open MPI 1.2                    September 2006     MPITypehindexed(3OpenMPI)