philipp/hdf5
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[svn-r1719] RM_H5A.html

Browse Source 
H5Aread: Corrected description of buf.
RM_H5P.html
	H5Pset_buffer: Expanded description of buffer size requirements.
	  Minor copy edits.
RM_H5S.html
	H5Sselect_elements, H5Sselect_hyperslab: Corrected op return type.
This commit is contained in:
Frank Baker
1999-10-04 16:54:22 -05:00
parent 538b76ea64
commit 636ab41cf0
3 changed files with 18 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/html/RM_H5P.html
View File

@@ -1997,15 +1997,21 @@ parallel HDF5 library.</i>
<dd> Given a dataset transfer property list, <code>H5Pset_buffer</code>
sets the maximum size
for the type conversion buffer and background buffer and
optionally supply pointers to application-allocated buffers.
optionally supplies pointers to application-allocated buffers.
If the buffer size is smaller than the entire amount of data
being transferred between application and file, and a type
conversion buffer or background buffer is required then
strip mining will be used. However, certain restrictions
apply for the size of buffer which can be used for strip
mining. For instance, when strip mining a 100x200x300
hyperslab of a simple data space the buffer must be large
enough to hold a 1x200x300 slab.
being transferred between the application and the file, and a type
conversion buffer or background buffer is required, then
strip mining will be used.
<p>
Note that there are minimum size requirements for the buffer.
Strip mining can only break the data up along the first dimension,
so the buffer must be large enough to accommodate a complete slice
that encompasses all of the remaining dimensions.
For example, when strip mining a 100x200x300 hyperslab
of a simple data space, the buffer must be large enough to
hold 1x200x300 data elements.
When strip mining a 100x200x300x150 hyperslab of a simple data space,
the buffer must be large enough to hold 1x200x300x150 data elements.
<p>
If <code>tconv</code> and/or <code>bkg</code> are null pointers,
then buffers will be allocated and freed during the data transfer.