mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-01-30 15:32:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Elaborate how cd_values get stored (#2522)

Browse Source
This commit is contained in:
Mark (he/his) C. Miller 2023-03-08 14:46:10 -08:00 committed by GitHub
parent d6f931d67b
commit befbbd0b6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/H5Ppublic.h
View File

@ -2321,10 +2321,13 @@ H5_DLL herr_t H5Pset_deflate(hid_t plist_id, unsigned level);
* (#H5Z_FILTER_DEFLATE) and the Fletcher32 error detection filter
* (#H5Z_FILTER_FLETCHER32).
*
* The array \p c_values contains \p cd_nelmts integers which are
* auxiliary data for the filter. The integer values will be
* stored in the dataset object header as part of the filter
* information.
* The array \p cd_values contains \p cd_nelmts unsigned integers
* which are auxiliary data for the filter. The values are typically
* used as parameters to control the filter. In a filter's
* \p set_local method (called from \p H5Dcreate), the values are
* interpreted and possibly modified before they are used to control
* the filter. These, possibly modified values, are then stored in
* the dataset object header as auxiliary data for the filter.
*
* The \p flags argument is a bit vector with the following
* fields specifying certain general properties of the filter: