summaryrefslogtreecommitdiffstats
path: root/src/H5Pdcpl.c
diff options
context:
space:
mode:
authorMuQun Yang <ymuqun@hdfgroup.org>2005-04-27 15:19:31 (GMT)
committerMuQun Yang <ymuqun@hdfgroup.org>2005-04-27 15:19:31 (GMT)
commitaffa4e9bff471a56eed7524a0c7ad9a6e0ae3d13 (patch)
treecb650ed302919714f8d45aaac5425fbad85716b9 /src/H5Pdcpl.c
parent676ecf88dd607777ac11f68de0aecbc524ca88bc (diff)
downloadhdf5-affa4e9bff471a56eed7524a0c7ad9a6e0ae3d13.zip
hdf5-affa4e9bff471a56eed7524a0c7ad9a6e0ae3d13.tar.gz
hdf5-affa4e9bff471a56eed7524a0c7ad9a6e0ae3d13.tar.bz2
[svn-r10677] Purpose:
Add some comments for H5Pset_scaleoffset. Description: Solution: Platforms tested: No need to test. Misc. update:
Diffstat (limited to 'src/H5Pdcpl.c')
-rw-r--r--src/H5Pdcpl.c15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/H5Pdcpl.c b/src/H5Pdcpl.c
index 4bd477a..3359b52 100644
--- a/src/H5Pdcpl.c
+++ b/src/H5Pdcpl.c
@@ -1267,6 +1267,21 @@ done:
* Purpose: Sets scaleoffset filter for a dataset creation property list
* and user-supplied parameters
*
+ * Parameters: scale_factor:
+ for integer datatype,
+ this parameter will be
+ minimum-bits, if this value is set to 0,
+ scaleoffset filter will calculate the minimum-bits.
+
+ For floating-point datatype,
+ For variable-minimum-bits method, this will be
+ the decimal precision of the filter,
+ For fixed-minimum-bits method, this will be
+ the minimum-bit of the filter.
+ scale_type: 0 for floating-point variable-minimum-bits,
+ 1 for floating-point fixed-minimum-bits,
+ other values, for integer datatype
+
* Return: Non-negative on success/Negative on failure
*
* Programmer: Xiaowen Wu