Last modified: 23 February 2016

Name: H5Pset_chunk_opts

Signature:
herr_t H5Pset_chunk_opts( hid_t dcpl_id, unsigned opts )

Purpose:
Sets the edge chunk option in a dataset creation property list.

Motivation:
H5Pset_chunk_opts is used to specify storage options for chunks on the edge of a dataset’s dataspace. This capability allows the user to tune performance in cases where the dataset size may not be a multiple of the chunk size and the handling of partial edge chunks can impact performance.

Description:
H5Pset_chunk_opts sets the edge chunk option in the dataset creation property list dcpl_id.

The available option is detailed in the parameters section below. Only chunks that are not completely filled by the dataset’s dataspace are affected by this option. Such chunks are referred to as partial edge chunks.

Parameters:
hid_t dcpl_id   IN: Dataset creation property list identifier
unsigned opts   IN: Edge chunk option flag. Valid values are:

H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS
     When enabled, filters are not applied to partial edge chunks.

When disabled, partial edge chunks are filtered.

Enabling this option will improve performance when appending to the dataset and, when compression filters are used, prevent reallocation of these chunks.

Datasets created with this option enabled will be inaccessible with HDF5 Library versions before Release 1.10.

Default: Disabled
 

(zero)
     Disables option; partial edge chunks will be compressed.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran Interface:
None

See Also:

History:
Release     Change
1.10.0 C function introduced with this release.