summaryrefslogtreecommitdiffstats
path: root/doc/html/RM_H5P.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/RM_H5P.html')
-rw-r--r--doc/html/RM_H5P.html126
1 files changed, 0 insertions, 126 deletions
diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html
index 661325b..65ec152 100644
--- a/doc/html/RM_H5P.html
+++ b/doc/html/RM_H5P.html
@@ -233,8 +233,6 @@ which require many different parameters to be easily manipulated.
<li><a href="#Property-SetEdcCheck">H5Pset_edc_check</a>
<li><a href="#Property-GetEdcCheck">H5Pget_edc_check</a>
<li><a href="#Property-SetFilterCallback">H5Pset_filter_callback</a>
- <li><a href="#Property-SetHyperCache">H5Pset_hyper_cache</a> *
- <li><a href="#Property-GetHyperCache">H5Pget_hyper_cache</a> *
<li><a href="#Property-SetHyperVectorSize">H5Pset_hyper_vector_size</a>
<li><a href="#Property-GetHyperVectorSize">H5Pget_hyper_vector_size</a>
<li><a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a>
@@ -322,7 +320,6 @@ See further notes in the description of each function.
<li><a href="#Property-GetFilter">H5Pget_filter</a>
<li><a href="#Property-GetFilterById">H5Pget_filter_by_id</a>
<li><a href="#Property-GetGCReferences">H5Pget_gc_references</a>
- <li><a href="#Property-GetHyperCache">H5Pget_hyper_cache</a> *
<li><a href="#Property-GetHyperVectorSize">H5Pget_hyper_vector_size</a>
<li><a href="#Property-GetIstoreK">H5Pget_istore_k</a>
<li><a href="#Property-GetLayout">H5Pget_layout</a>
@@ -383,7 +380,6 @@ See further notes in the description of each function.
<li><a href="#Property-SetFilterCallback">H5Pset_filter_callback</a>
<li><a href="#Property-SetFletcher32">H5Pset_fletcher32</a>
<li><a href="#Property-SetGCReferences">H5Pset_gc_references</a>
- <li><a href="#Property-SetHyperCache">H5Pset_hyper_cache</a> *
<li><a href="#Property-SetHyperVectorSize">H5Pset_hyper_vector_size</a>
<li><a href="#Property-SetIstoreK">H5Pset_istore_k</a>
<li><a href="#Property-SetLayout">H5Pset_layout</a>
@@ -575,8 +571,6 @@ facilitate moving easily between them.</i>
<li><a href="#Property-GetPreserve">h5pget_preserve_f</a>
<li><a href="#Property-SetEdcCheck">h5pset_edc_check_f</a>
<li><a href="#Property-GetEdcCheck">h5pget_edc_check_f</a>
- <li><a href="#Property-SetHyperCache">h5pset_hyper_cache_f</a>
- <li><a href="#Property-GetHyperCache">h5pget_hyper_cache_f</a>
<li><a href="#Property-SetHyperVectorSize">h5pset_hyper_vector_size_f</a>
<li><a href="#Property-GetHyperVectorSize">h5pget_hyper_vector_size_f</a>
<li><a href="#Property-SetBTreeRatios">h5pset_btree_ratios_f</a>
@@ -4724,126 +4718,6 @@ END LIBRARY-SET OPTION TAGS -->
<hr>
<dl>
- <dt><strong>Name:</strong> <a name="Property-SetHyperCache">H5Pset_hyper_cache</a>
- <dt><strong>Signature:</strong>
- <dd><em>herr_t</em> <code>H5Pset_hyper_cache</code>(<em>hid_t</em> <code>plist</code>,
- <em>unsigned</em> <code>cache</code>,
- <em>unsigned</em> <code>limit</code>
- )
- <dt><strong>Purpose:</strong>
- <dd>Indicates whether to cache hyperslab blocks during I/O.
- <dt><strong>Description:</strong>
- <dd>[<strong>NOTE:</strong>
- <span class="1_4_compat">
- This function is deprecated in HDF5 Release 1.6
- and will eventually be removed from the HDF5 distribution.
- It is provided in this release only to enable backward compatibility
- with HDF5 Releases 1.4.<i>x</i>
- and is enabled only if the HDF5 library is configured
- with the flag <code>H5_WANT_H5_V1_4_COMPAT</code>;
- the function is not enabled in the binaries distributed by NCSA.
- </span>]
- <p>
- Given a dataset transfer property list, <code>H5Pset_hyper_cache</code>
- indicates whether to cache hyperslab blocks during I/O,
- a process which can significantly increase I/O speeds.
- <p>
- When working with hyperslab selections, it is possible to
- significantly speed up I/O operations by retrieving an
- entire hyperslab from the file in one operation and
- caching it in memory.
- The <code>cache</code> parameter specifies whether to turn
- caching on for hyperslab I/O operations.
- If <code>cache</code> is set to <code>1</code>,
- caching is turned on;
- if set to <code>0</code>, caching is turned off.
- <p>
- The parameter <code>limit</code> sets the maximum size of the
- hyperslab block to cache. If a block is smaller than that limit,
- it may still not be cached if no memory is available.
- Setting <code>limit</code> to <code>0</code> (zero) indicates
- no limitation on the size of block to attempt to cache.
- <p>
- The default is to cache blocks with no limit on block size
- for serial I/O and to not cache blocks for parallel I/O.
- <dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>plist</code>
- <dd>IN: Dataset transfer property list identifier.
- <dt><em>unsigned</em> <code>cache</code>
- <dd>IN: A flag indicating whether caching is to be
- set to on (<code>1</code>) or off (<code>0</code>).
- <dt><em>unsigned</em> <code>limit</code>
- <dd>IN: Maximum size of the hyperslab block to cache.
- <code>0</code> (zero) indicates no limit.
- </dl>
- <dt><strong>Returns:</strong>
- <dd>Returns a non-negative value if successful;
- otherwise returns a negative value.
- <dt><strong>Non-C API(s):</strong>
- <dd><a href="fortran/h5p_FORTRAN.html#h5pset_hyper_cache_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
- <!--
- <img src="Graphics/Java.gif">
- <img src="Graphics/C++.gif">
- -->
-</dl>
-
-
-<hr>
-<dl>
- <dt><strong>Name:</strong> <a name="Property-GetHyperCache">H5Pget_hyper_cache</a>
- <dt><strong>Signature:</strong>
- <dd><em>herr_t</em> <code>H5Pget_hyper_cache</code>(<em>hid_t</em> <code>plist</code>,
- <em>unsigned</em> *<code>cache</code>,
- <em>unsigned</em> *<code>limit</code>
- )
- <dt><strong>Purpose:</strong>
- <dd>[<strong>NOTE:</strong>
- <span class="1_4_compat">
- This function is deprecated in HDF5 Release 1.6
- and will eventually be removed from the HDF5 distribution.
- It is provided in this release only to enable backward compatibility
- with HDF5 Releases 1.4.<i>x</i>
- and is enabled only if the HDF5 library is configured
- with the flag <code>H5_WANT_H5_V1_4_COMPAT</code>;
- the function is not enabled in the binaries distributed by NCSA.
- </span>]
- <p>
- Returns information regarding the caching of hyperslab blocks during I/O.
- <dt><strong>Description:</strong>
- <dd>Given a dataset transfer property list, <code>H5Pget_hyper_cache</code>
- returns instructions regarding the caching of hyperslab blocks during I/O.
- These parameters are set with the <code>H5Pset_hyper_cache</code> function.
- <dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>plist</code>
- <dd>IN: Dataset transfer property list identifier.
- <dt><em>unsigned</em> *<code>cache</code>
- <dd>OUT: A flag indicating whether caching is
- set to on (<code>1</code>) or off (<code>0</code>).
- <dt><em>unsigned</em> *<code>limit</code>
- <dd>OUT: Maximum size of the hyperslab block to cache.
- <code>0</code> (zero) indicates no limit.
- </dl>
- <dt><strong>Returns:</strong>
- <dd>Returns a non-negative value if successful;
- otherwise returns a negative value.
- <dt><strong>Non-C API(s):</strong>
- <dd><a href="fortran/h5p_FORTRAN.html#h5pget_hyper_cache_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
- <!--
- <img src="Graphics/Java.gif">
- <img src="Graphics/C++.gif">
- -->
-</dl>
-
-
-
-
-
-<hr>
-<dl>
<dt><strong>Name:</strong> <a name="Property-SetHyperVectorSize">H5Pset_hyper_vector_size</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_hyper_vector_size</code>(<em>hid_t</em> <code>dxpl_id</code>,
generated by cgit v0.12 at 2024-12-28 21:03:57 (GMT)