17.2.410. MPI_Type_indexed

MPI_Type_indexed, MPI_Type_create_hindexed - 创建一个索引化的数据类型。

17.2.410.1. 语法

17.2.410.1.1. C语言语法

#include <mpi.h>

int MPI_Type_indexed(int count, const int array_of_blocklengths[],
     const int array_of_displacements[], MPI_Datatype oldtype,
     MPI_Datatype *newtype)

int MPI_Type_create_hindexed(int count,
     const int array_of_blocklengths[],
     const MPI_Aint array_of_displacements[], MPI_Datatype oldtype,
     MPI_Datatype *newtype)

17.2.410.1.2. Fortran语法

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_TYPE_INDEXED(COUNT, ARRAY_OF_BLOCKLENGTHS,
             ARRAY_OF_DISPLACEMENTS, OLDTYPE, NEWTYPE, IERROR)
     INTEGER COUNT, ARRAY_OF_BLOCKLENGTHS(*)
     INTEGER ARRAY_OF_DISPLACEMENTS(*), OLDTYPE, NEWTYPE
     INTEGER IERROR

MPI_TYPE_CREATE_HINDEXED(COUNT, ARRAY_OF_BLOCKLENGTHS,
             ARRAY_OF_DISPLACEMENTS, OLDTYPE, NEWTYPE, IERROR)
     INTEGER COUNT, ARRAY_OF_BLOCKLENGTHS(*)
     INTEGER OLDTYPE, NEWTYPE
     INTEGER(KIND=MPI_ADDRESS_KIND) ARRAY_OF_DISPLACEMENTS(*)
     INTEGER IERROR

17.2.410.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Type_indexed(count, array_of_blocklengths, array_of_displacements,
             oldtype, newtype, ierror)
     INTEGER, INTENT(IN) :: count, array_of_blocklengths(count),
     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(count, array_of_blocklengths,
             array_of_displacements, oldtype, newtype, ierror)
     INTEGER, INTENT(IN) :: count, array_of_blocklengths(count)
     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

17.2.410.2. 输入参数

  • count: 块数量 —— 也是array_of_displacements和array_of_blocklengths数组中的条目数（非负整数）。

  • array_of_blocklengths: 每个块中的元素数量（非负整数数组）。

  • array_of_displacements: 每个块的位移量，对于MPI_Type_indexed以oldtype的跨度为倍数，对于MPI_Type_create_hindexed以字节为单位（MPI_TYPE_INDEXED使用整数数组，MPI_TYPE_CREATE_HINDEXED使用MPI_Aint数组）。

  • oldtype: 旧数据类型（句柄）。

17.2.410.3. 输出参数

  • newtype: 新数据类型（句柄）。

  • ierror: 仅限Fortran：错误状态（整数）。

17.2.410.4. 描述

函数 MPI_Type_indexed 允许将旧数据类型复制为一系列块（每个块是旧数据类型的串联），其中每个块可以包含不同数量的副本并具有不同的位移。所有块位移都是旧数据类型范围的倍数。

示例： 假设oldtype的类型映射为{(double, 0), (char, 8)}，其范围为16。设B = (3, 1)，D = (4, 0)。调用MPI_Type_indexed(2, B, D, oldtype, newtype)将返回一个具有类型映射的数据类型

{(double, 64), (char, 72), (double, 80), (char, 88),
(double, 96), (char, 104),
(double, 0), (char, 8)}

也就是说，从位移4 x 16 = 64处开始有三份旧类型的副本，以及从位移0处开始的一份副本。

通常假设 oldtype 具有类型映射

{(type(0), disp(0)), ..., (type(n-1), disp(n-1))},
设范围ex。令B为array_of_blocklength参数，D为array_of_displacements参数。新创建的数据类型具有
n x S ^count-1
    i = 0           B[i]  entries:

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

调用MPI_Type_vector(count, blocklength, stride, oldtype, newtype) 等同于调用MPI_Type_indexed(count, B, D, oldtype, newtype)，其中

    D[j] = j * stride, j = 0,..., count-1

and

    B[j] = blocklength, j = 0, .., count-1

函数 MPI_Type_create_hindexed 与 MPI_Type_indexed 功能相同， 区别在于 array_of_displacements 中的块位移是以字节为单位指定的，而不是以 oldtype 范围的倍数形式指定。

17.2.410.5. 错误

几乎所有MPI例程都会返回一个错误值；C语言例程通过函数返回值返回，Fortran例程则通过最后一个参数返回。

在返回错误值之前，会调用与通信对象（如通信器、窗口、文件）关联的当前MPI错误处理程序。如果MPI调用未关联任何通信对象，则该调用被视为附加到MPI_COMM_SELF，并将调用关联的MPI错误处理程序。当MPI_COMM_SELF未初始化时（即在MPI_Init/MPI_Init_thread之前、MPI_Finalize之后，或仅使用会话模型时），错误会触发初始错误处理程序。初始错误处理程序可通过在使用世界模型时调用MPI_Comm_set_errhandler来修改MPI_COMM_SELF，或通过mpiexec的mpi_initial_errhandler命令行参数，或MPI_Comm_spawn/MPI_Comm_spawn_multiple的info键来设置。如果未设置其他适当的错误处理程序，则MPI I/O函数将调用MPI_ERRORS_RETURN错误处理程序，而其他所有MPI函数将调用MPI_ERRORS_ABORT错误处理程序。

Open MPI 包含三个可使用的预定义错误处理器：

  • MPI_ERRORS_ARE_FATAL 导致程序中止所有连接的MPI进程。

  • MPI_ERRORS_ABORT 一个可在通信器、窗口、文件或会话上调用的错误处理程序。当在通信器上调用时，其行为类似于在该通信器上调用MPI_Abort。如果在窗口或文件上调用，则行为类似于在包含对应窗口或文件中进程组的通信器上调用MPI_Abort。如果在会话上调用，则仅中止本地进程。

  • MPI_ERRORS_RETURN 向应用程序返回一个错误代码。

MPI应用程序也可以通过调用以下方式实现自己的错误处理程序：

请注意，MPI不保证MPI程序在出现错误后能够继续运行。

查看MPI手册页获取完整的MPI错误代码列表。

有关更多信息，请参阅MPI-3.1标准中的错误处理部分。

另请参阅