MPI_TYPE_CREATE_HVECTOR(3)

πŸ’– MPI_TYPE_CREATE_HVECTOR(3) πŸ’–

okay bestie, welcome to the Open MPI glow-up of MPI_TYPE_CREATE_HVECTOR(3) β€” yes, the one and only. grab your emotional support iced coffee and let’s get into it 🧚


πŸ¦‹ NAME πŸ¦‹

MPI_Type_create_hvector β€” creates a vector (strided) data type with offset in bytes. slay.


✨ SYNTAX ✨

πŸ’» C Syntax πŸ’»

          #include <mpi.h>

          int MPI_Type_create_hvector(int count, int blocklength,
               MPI_Aint stride, MPI_Datatype oldtype, MPI_Datatype *newtype)

🧑 Fortran Syntax 🧑

          USE MPI
          ! or the older form: INCLUDE 'mpif.h'
          MPI_TYPE_CREATE_HVECTOR(COUNT, BLOCKLENGTH, STRIDE, OLDTYPE,
               NEWTYPE, IERROR)

               INTEGER COUNT, BLOCKLENGTH, OLDTYPE, NEWTYPE, IERROR
               INTEGER(KIND=MPI_ADDRESS_KIND) STRIDE

🩡 Fortran 2008 Syntax 🩡

          USE mpi_f08
          MPI_Type_create_hvector(count, blocklength, stride, oldtype, newtype,
                       ierror)
               INTEGER, INTENT(IN) :: count, blocklength
               INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: stride
               TYPE(MPI_Datatype), INTENT(IN) :: oldtype
               TYPE(MPI_Datatype), INTENT(OUT) :: newtype
               INTEGER, OPTIONAL, INTENT(OUT) :: ierror

🌸 INPUT PARAMETERS 🌸

  • count β€” number of blocks (nonnegative integer). like, how many blocks are we stacking, bestie? πŸ’…
  • blocklength β€” number of elements in each block (nonnegative integer). the lil squad inside every block ✨
  • stride β€” number of bytes between start of each block (integer). yes, bytes, not elements β€” this is the whole plot twist 🫢
  • oldtype β€” old data type (handle). the blueprint we’re building from πŸŽ€

πŸŽ€ OUTPUT PARAMETERS πŸŽ€

  • newtype β€” new data type (handle). the fresh new icon we just created πŸ‘‘
  • ierror β€” Fortran only: error status (integer). the vibe check in integer form πŸ’€

πŸ¦‹ DESCRIPTION πŸ¦‹

MPI_Type_create_hvector creates a vector (strided) data type with offset in bytes. this routine replaces MPI_Type_hvector, which is deprecated. bestie, do not keep using the deprecated one just because it’s familiar β€” we are moving on πŸ™ˆ

the function MPI_Type_create_hvector is identical to MPI_Type_vector, except that stride is given in bytes, rather than in elements. the use for both types of vector constructors is illustrated in the examples in the Datatype chapter of the MPI Standard. iykyk πŸ“š

assume that oldtype has type map

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

with extent ex. let bl be the blocklength. the newly created datatype has a type map with count * bl * n entries:

          {(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) + (bl -1) * ex),...,(type(n-1),
          disp(n-1) + (bl -1) * ex), (type(0), disp(0) + stride),
          ...,(type(n-1), disp(n-1) + stride), ..., (type(0),
          disp(0) + stride + (bl - 1) * ex), ..., (type(n-1),
          disp(n-1) + stride + (bl -1) * ex), ..., (type(0),
          disp(0) + stride * (count -1)), ...,(type(n-1),
          disp(n-1) + stride * (count -1)), ..., (type(0),
          disp(0) + stride * (count -1) + (bl -1) * ex), ...,
          (type(n-1), disp(n-1) + stride * (count -1) + (bl -1) * ex)}

πŸ’€ 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. fr fr, check your errors.

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. dramatic? yes. effective? also yes 😭
  • 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. very β€œknow your context” energy πŸ’…
  • MPI_ERRORS_RETURN β€” returns an error code to the application. the β€œhand me the receipts” option 🧾

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. bestie, this is not a β€œwalk it off” situation πŸ’€

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_create_hindexed
  • MPI_Type_vector

2003-2026, The Open MPI Community


okay bye bestie πŸ’– this page is from Open MPI, dated Sep 11, 2026, and it’s literally called MPI_TYPE_CREATE_HVECTOR(3). periodt. πŸŽ€βœ¨

πŸ“¦ where this page comes from