![]() |
HDF5
1.15.0.fb38a8b
API Reference
|
Macros | |
#define | H5Tarray_create H5Tarray_create2 |
#define | H5Tget_array_dims H5Tget_array_dims2 |
Functions | |
hid_t | H5Tarray_create2 (hid_t base_id, unsigned ndims, const hsize_t dim[]) |
Creates an array datatype object. More... | |
int | H5Tget_array_ndims (hid_t type_id) |
Returns the rank of an array datatype. More... | |
int | H5Tget_array_dims2 (hid_t type_id, hsize_t dims[]) |
Retrieves sizes of array dimensions. More... | |
hid_t | H5Tarray_create1 (hid_t base_id, int ndims, const hsize_t dim[], const int perm[]) |
Creates an array datatype object. More... | |
int | H5Tget_array_dims1 (hid_t type_id, hsize_t dims[], int perm[]) |
Retrieves sizes of array dimensions. More... | |
#define H5Tarray_create H5Tarray_create2 |
H5Tarray_create() is a macro that is mapped to either H5Tarray_create1() or H5Tarray_create2().
#define H5Tget_array_dims H5Tget_array_dims2 |
H5Tget_array_dims() is a macro that is mapped to either H5Tget_array_dims1() or H5Tget_array_dims2().
Creates an array datatype object.
[in] | base_id | Datatype identifier for the array base datatype |
[in] | ndims | Rank of the array |
[in] | dim | Size of each array dimension |
[in] | perm | Dimension permutation (Currently not implemented.) |
H5Tarray_create1() creates a new array datatype object.
base_id
is the datatype of every element of the array, i.e., of the number at each position in the array.
rank
is the number of dimensions and the size of each dimension is specified in the array dims. The value of rank is currently limited to H5S_MAX_RANK and must be greater than 0 (zero). All dimension sizes specified in dims must be greater than 0 (zero).
The array perm
is designed to contain the dimension permutation, i.e. C versus FORTRAN array order. (The parameter perm is currently unused and is not yet implemented.)
Creates an array datatype object.
[in] | base_id | Datatype identifier for the array base datatype |
[in] | ndims | Rank of the array |
[in] | dim | Size of each array dimension |
H5Tarray_create2() creates a new array datatype object.
base_id
is the datatype of every element of the array, i.e., of the number at each position in the array.
ndims
is the number of dimensions and the size of each dimension is specified in the array dim
. The value of rank
is currently limited to H5S_MAX_RANK and must be greater than 0 (zero). All dimension sizes specified in dim
must be greater than 0 (zero).
Retrieves sizes of array dimensions.
[in] | type_id | Datatype identifier |
[out] | dims | Sizes of array dimensions |
[out] | perm | Dimension permutations (This parameter is not used.) |
H5Tget_array_dims1() returns the sizes of the dimensions and the dimension permutations of the specified array datatype object.
The sizes of the dimensions are returned in the array dims
.
Retrieves sizes of array dimensions.
[in] | type_id | Datatype identifier |
[out] | dims | Sizes of array dimensions |
H5Tget_array_dims2() returns the sizes of the dimensions of the specified array datatype object in the array dims
.
int H5Tget_array_ndims | ( | hid_t | type_id | ) |
Returns the rank of an array datatype.
[in] | type_id | Datatype identifier |
H5Tget_array_ndims() returns the rank, i.e., the number of dimensions, of an array datatype object.