Blame man/man3/MPIR_Type_indexed.3

Packit Service c5cf8c
.TH MPIR_Type_indexed 3 "11/12/2019" " " "MPI"
Packit Service c5cf8c
.SH NAME
Packit Service c5cf8c
MPIR_Type_indexed \-  create an indexed datatype 
Packit Service c5cf8c
.SH SYNOPSIS
Packit Service c5cf8c
.nf
Packit Service c5cf8c
int MPIR_Type_indexed(int count,
Packit Service c5cf8c
const int *blocklength_array,
Packit Service c5cf8c
const void *displacement_array,
Packit Service c5cf8c
int dispinbytes, MPI_Datatype oldtype, MPI_Datatype * newtype)
Packit Service c5cf8c
.fi
Packit Service c5cf8c
.SH INPUT PARAMETERS
Packit Service c5cf8c
.PD 0
Packit Service c5cf8c
.TP
Packit Service c5cf8c
.B count 
Packit Service c5cf8c
- number of blocks in type
Packit Service c5cf8c
.PD 1
Packit Service c5cf8c
.PD 0
Packit Service c5cf8c
.TP
Packit Service c5cf8c
.B blocklength_array 
Packit Service c5cf8c
- number of elements in each block
Packit Service c5cf8c
.PD 1
Packit Service c5cf8c
.PD 0
Packit Service c5cf8c
.TP
Packit Service c5cf8c
.B displacement_array 
Packit Service c5cf8c
- offsets of blocks from start of type (see next
Packit Service c5cf8c
parameter for units)
Packit Service c5cf8c
.PD 1
Packit Service c5cf8c
.PD 0
Packit Service c5cf8c
.TP
Packit Service c5cf8c
.B dispinbytes 
Packit Service c5cf8c
- if nonzero, then displacements are in bytes (the
Packit Service c5cf8c
displacement_array is an array of ints), otherwise they in terms of
Packit Service c5cf8c
extent of oldtype (the displacement_array is an array of MPI_Aints)
Packit Service c5cf8c
.PD 1
Packit Service c5cf8c
.PD 0
Packit Service c5cf8c
.TP
Packit Service c5cf8c
.B oldtype 
Packit Service c5cf8c
- type (using handle) of datatype on which new type is based
Packit Service c5cf8c
.PD 1
Packit Service c5cf8c
Packit Service c5cf8c
.SH OUTPUT PARAMETERS
Packit Service c5cf8c
.PD 0
Packit Service c5cf8c
.TP
Packit Service c5cf8c
.B newtype 
Packit Service c5cf8c
- handle of new indexed datatype
Packit Service c5cf8c
.PD 1
Packit Service c5cf8c
Packit Service c5cf8c
.SH RETURN VALUE
Packit Service c5cf8c
0 on success, -1 on failure.