trusty (3) MPI_Type_create_hindexed.openmpi.3.gz

NAME

       MPI_Type_create_hindexed - Creates an indexed data type with offsets in bytes.

SYNTAX

C Syntax

       #include <mpi.h>
       int MPI_Type_create_hindexed(int count, int array_of_blocklengths[],
            MPI_Aint array_of_displacements[], MPI_Datatype oldtype,
            MPI_Datatype *newtype)

Fortran Syntax (see FORTRAN 77 NOTES)

       INCLUDE 'mpif.h'
       MPI_TYPE_CREATE_HINDEXED(COUNT, ARRAY_OF_BLOCKLENGTHS,
            ARRAY_OF_DISPLACEMENTS, OLDTYPE, NEWTYPE, IERROR)
            INTEGER   COUNT, ARRAY_OF_BLOCKLENGTHS(*), OLDTYPE, NEWTYPE, IERROR
            INTEGER(KIND=MPI_ADDRESS_KIND) ARRAY_OF_DISPLACEMENTS(*)

C++ Syntax

       #include <mpi.h>
       MPI::Datatype MPI::Datatype::Create_hindexed(int count,
            const int array_of_blocklengths[],
            const MPI::Aint array_of_displacements[]) const

INPUT PARAMETERS

       count     Number of blocks (nonnegative integer).

       array_of_blocklengths
                 Number of elements in each block (array of nonnegative integers).

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

       oldtype   Old data type (handle).

OUTPUT PARAMETERS

       newtype   New data type (handle).

       IERROR    Fortran only: Error status (integer).

DESCRIPTION

       MPI_Type_create_hindexed   is   identical   to  MPI_Type_indexed,  except  that  block  displacements  in
       array_of_displacements 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 array_of_blocklengths argument and D be the array_of_displacements argument.
       The newly created data type 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)}

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

FORTRAN 77 NOTES

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

            INTEGER*MPI_ADDRESS_KIND ARRAY_OF_DISPLACEMENTS(*)

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

ERRORS

       Almost all MPI routines return an error value; C routines as  the  value  of  the  function  and  Fortran
       routines in the last argument. C++ functions do not return errors. If the default error handler is set to
       MPI::ERRORS_THROW_EXCEPTIONS, 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
       MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN 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 the MPI(3) man page for a full list of MPI error codes.

SEE ALSO

       MPI_Type_indexed
       MPI_Type_hindexed