Skip to content

Commit d4b9892

Browse files
gasagnasimonbyrne
authored andcommitted
clarify docs (#313)
clarify that `Type_Create_Subarray` assumes zero-based indexing
1 parent f471b62 commit d4b9892

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/datatypes.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,10 +126,10 @@ end
126126
127127
Creates a data type describing an `ndims`-dimensional subarray of size `array_of_subsizes`
128128
of an `ndims-dimensional` array of size `array_of_sizes` and element type `oldtype`,
129-
starting at the top-left location `array_of_starts`. The parameter `order` refers to
130-
the memory layout of the parent array, and can be either `MPI_ORDER_C` or
131-
`MPI_ORDER_FORTRAN`. Note that, like other MPI data types, the type returned by this
132-
function should be committed with `MPI_Type_commit`.
129+
starting at the top-left location `array_of_starts`. Zero-based indexing is assumed. The
130+
parameter `order` refers to the memory layout of the parent array, and can be either
131+
`MPI_ORDER_C` or `MPI_ORDER_FORTRAN`. Note that, like other MPI data types, the type
132+
returned by this function should be committed with `MPI_Type_commit`.
133133
"""
134134
function Type_Create_Subarray(ndims::Integer,
135135
array_of_sizes::MPIBuffertype{Cint},

0 commit comments

Comments
 (0)