Determines whether a hyperslab selection is regular
Procedure:
H5S_IS_REGULAR_HYPERSLAB ( space_id )
Signature:
htri_t H5Sis_regular_hyperslab(
hid_t space_id
)
Fortran Interface: h5sis_regular_hyperslab_f
Signature:
SUBROUTINE h5sis_regular_hyperslab_f(space_id, IsRegular, hdferr)
INTEGER(HID_T), INTENT(IN) :: space_id
LOGICAL :: IsRegular
INTEGER, INTENT(OUT) :: hdferr
Inputs:
space_id - The identifier of the dataspace.
Outputs:
IsRegular - TRUE or FALSE for hyperslab selection if successful.
hdferr - Returns 0 if successful and -1 if fails.
Parameters:
hid_t space_id | IN: The identifier of the dataspace |
Description:
H5S_IS_REGULAR_HYPERSLAB takes the dataspace identifier, space_id, and queries the type of the hyperslab selection.
A regular hyperslab selection is a hyperslab selection described by setting the offset, stride, count, and block parameters for a single H5S_SELECT_HYPERSLAB call. If several calls to H5S_SELECT_HYPERSLAB are needed, then the hyperslab selection is irregular.
Returns:
Returns TRUE or FALSE for hyperslab selection if successful.
Returns FAIL on error or when querying other selection types such as point selection.
Example:
if (H5Sis_regular_hyperslab(vspace)) {
status = H5Sget_regular_hyperslab (vspace, start_out, stride_out, count_out, block_out);
printf(" start = [%llu, %llu] \n", (unsigned long long)start_out[0], (unsigned long long)start_out[1]);
printf(" stride = [%llu, %llu] \n", (unsigned long long)stride_out[0], (unsigned long long)stride_out[1]);
printf(" count = [%llu, %llu] \n", (unsigned long long)count_out[0], (unsigned long long)count_out[1]);
printf(" block = [%llu, %llu] \n", (unsigned long long)block_out[0], (unsigned long long)block_out[1]);
}
History:
| Release | Change |
|---|
| 1.10.0 | C function introduced with this release. |
--- Last Modified: May 03, 2019 | 02:08 PM
