SYNTAX

   C Syntax
          #include <mpi.h>

          int MPI_Type_create_indexed_block(int count, int blocklength, const int array_of_displacements[], MPI_Datatype oldtype, MPI_Datatype *newtype)

          int MPI_Type_create_hindexed_block(int count, int blocklength, const MPI_Aint array_of_displacements[], MPI_Datatype oldtype, MPI_Datatype *newtype)

   Fortran Syntax
          USE MPI
          ! or the older form: INCLUDE 'mpif.h'
          MPI_TYPE_CREATE_INDEXED_BLOCK(COUNT, BLOCKLENGTH,
                       ARRAY_OF_DISPLACEMENTS, OLDTYPE, NEWTYPE, IERROR)
               INTEGER COUNT, BLOCKLENGTH, ARRAY_OF_DISPLACEMENTS(*),
                       OLDTYPE, NEWTYPE, IERROR

          MPI_TYPE_CREATE_HINDEXED_BLOCK(COUNT, BLOCKLENGTH,
                       ARRAY_OF_DISPLACEMENTS, OLDTYPE, NEWTYPE, IERROR)
               INTEGER COUNT, BLOCKLENGTH, OLDTYPE, NEWTYPE
               INTEGER(KIND=MPI_ADDRESS_KIND) ARRAY_OF_DISPLACEMENTS(*)
               INTEGER IERROR

   Fortran 2008 Syntax
          USE mpi_f08
          MPI_Type_create_indexed_block(count, blocklength, array_of_displacements,
                       oldtype, newtype, ierror)
               INTEGER, INTENT(IN) :: count, blocklength,
               array_of_displacements(count)
               TYPE(MPI_Datatype), INTENT(IN) :: oldtype
               TYPE(MPI_Datatype), INTENT(OUT) :: newtype
               INTEGER, OPTIONAL, INTENT(OUT) :: ierror

          MPI_Type_create_hindexed_block(count, blocklength, array_of_displacements,
                       oldtype, newtype, ierror)
               INTEGER, INTENT(IN) :: count, blocklength
               INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) ::
               array_of_displacements(count)
               TYPE(MPI_Datatype), INTENT(IN) :: oldtype
               TYPE(MPI_Datatype), INTENT(OUT) :: newtype
               INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT PARAMETERS

       • count: Length of array of displacements (integer).

       • blocklength: Size of block (integer).

       • array_of_displacements:  Array  of displacements (array of integers). In units of the extent of oldtype
         for MPI_Type_create_indexed_block and bytes for MPI_Type_create_hindexed_block.

       • oldtype: Old data type (handle).

OUTPUT PARAMETERS

       • newtype: New data type (handle).

       • ierror: Fortran only: Error status (integer).

DESCRIPTION

       MPI_Type_create_indexed_block and MPI_Type_create_hindexed_block create an indexed  data  type  with  the
       same   block   length   for   all   blocks.   The   only   difference   between   the  two  functions  is
       MPI_Type_create_indexed_block takes an array of displacements in units of the  extent  of  oldtype  while
       MPI_Type_create_hindexed_block takes displacements in bytes.

ERRORS

       Almost  all  MPI  routines  return  an  error  value; C routines as the return result of the function and
       Fortran routines in the last argument.

       Before the error value is returned, the current MPI  error  handler  associated  with  the  communication
       object  (e.g.,  communicator, window, file) is called.  If no communication object is associated with the
       MPI call, then the call is considered attached to MPI_COMM_SELF and will call the  associated  MPI  error
       handler.   When   MPI_COMM_SELF   is   not  initialized  (i.e.,  before  MPI_Init/MPI_Init_thread,  after
       MPI_Finalize, or when using the Sessions Model exclusively) the error raises the initial  error  handler.
       The  initial  error handler can be changed by calling MPI_Comm_set_errhandler on MPI_COMM_SELF when using
       the World model, or the mpi_initial_errhandler CLI argument to mpiexec or info  key  to  MPI_Comm_spawn/‐
       MPI_Comm_spawn_multiple.   If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN
       error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is  called  for  all
       other MPI functions.

       Open MPI includes three predefined error handlers that can be used:

       • MPI_ERRORS_ARE_FATAL Causes the program to abort all connected MPI processes.

       • MPI_ERRORS_ABORT An error handler that can be invoked on a communicator, window, file, or session. When
         called  on  a  communicator,  it  acts  as if MPI_Abort was called on that communicator. If called on a
         window or file, acts as if MPI_Abort was called on a communicator containing the group of processes  in
         the corresponding window or file. If called on a session, aborts only the local process.

       • MPI_ERRORS_RETURN Returns an error code to the application.

       MPI applications can also implement their own error handlers by calling:

       • MPI_Comm_create_errhandler then MPI_Comm_set_errhandler

       • MPI_File_create_errhandler then MPI_File_set_errhandler

       • MPI_Session_create_errhandler then MPI_Session_set_errhandler or at MPI_Session_init

       • MPI_Win_create_errhandler then MPI_Win_set_errhandler

       Note that MPI does not guarantee that an MPI program can continue past an error.

       See the MPI man page for a full list of MPI error codes.

       See the Error Handling section of the MPI-3.1 standard for more information.

       SEE ALSO:

          • MPI_Type_indexed

COPYRIGHT

       2003-2025, The Open MPI Community

                                                  Feb 17, 2025                  MPI_TYPE_CREATE_INDEXED_BLOCK(3)