diff options
Diffstat (limited to 'group___d_x_p_l.html')
| -rw-r--r-- | group___d_x_p_l.html | 57 |
1 files changed, 56 insertions, 1 deletions
diff --git a/group___d_x_p_l.html b/group___d_x_p_l.html index c0356d8..c7e784d 100644 --- a/group___d_x_p_l.html +++ b/group___d_x_p_l.html @@ -37,7 +37,7 @@ <td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a> -  <span id="projectnumber">1.15.0.97a6efb</span> +  <span id="projectnumber">1.15.0.98b5779</span> </div> <div id="projectbrief">API Reference</div> </td> @@ -153,6 +153,8 @@ $(document).ready(function(){initNavTree('group___d_x_p_l.html',''); initResizab <tr> <td><a class="el" href="group___d_x_p_l.html#gad6fa6bfa5956e8c0bd69c22bde65f84c" title="Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call.">H5Pget_no_selection_io_cause</a> </td><td>Gets the cause for not performing selection or vector I/O on the last parallel I/O call. </td></tr> <tr> +<td><a class="el" href="group___d_x_p_l.html#ga252fe801869970c14a5e800a1ea7ab84" title="Retrieves the type(s) of I/O that HDF5 actually performed on raw data during the last I/O call.">H5Pget_actual_selection_io_mode</a> </td><td>Gets the type(s) (scalar, vector, selection) of raw data I/O performed on the last I/O call. </td></tr> +<tr> <td><a class="el" href="group___d_x_p_l.html#ga6f65ca81d8a10015513a69fe76c5d542" title="Allows the library to modify the contents of the write buffer.">H5Pset_modify_write_buf</a>/<a class="el" href="group___d_x_p_l.html#ga7a3e4d3f7b5c276873d00af3f92cdc22" title="Retrieves the "modify write buffer" property.">H5Pget_modify_write_buf</a> </td><td>Sets/gets a flag allowing the library to modify the contents of the write buffer. </td></tr> <tr> <td>H5Pset_preserve/H5Pget_preserve </td><td>No longer available, deprecated as it no longer has any effect. </td></tr> @@ -262,6 +264,9 @@ Functions</h2></td></tr> <tr class="memitem:gad6fa6bfa5956e8c0bd69c22bde65f84c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_x_p_l.html#gad6fa6bfa5956e8c0bd69c22bde65f84c">H5Pget_no_selection_io_cause</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, uint32_t *no_selection_io_cause)</td></tr> <tr class="memdesc:gad6fa6bfa5956e8c0bd69c22bde65f84c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call. <a href="group___d_x_p_l.html#gad6fa6bfa5956e8c0bd69c22bde65f84c">More...</a><br /></td></tr> <tr class="separator:gad6fa6bfa5956e8c0bd69c22bde65f84c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga252fe801869970c14a5e800a1ea7ab84"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_x_p_l.html#ga252fe801869970c14a5e800a1ea7ab84">H5Pget_actual_selection_io_mode</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, uint32_t *actual_selection_io_mode)</td></tr> +<tr class="memdesc:ga252fe801869970c14a5e800a1ea7ab84"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type(s) of I/O that HDF5 actually performed on raw data during the last I/O call. <a href="group___d_x_p_l.html#ga252fe801869970c14a5e800a1ea7ab84">More...</a><br /></td></tr> +<tr class="separator:ga252fe801869970c14a5e800a1ea7ab84"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6f65ca81d8a10015513a69fe76c5d542"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_x_p_l.html#ga6f65ca81d8a10015513a69fe76c5d542">H5Pset_modify_write_buf</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> modify_write_buf)</td></tr> <tr class="memdesc:ga6f65ca81d8a10015513a69fe76c5d542"><td class="mdescLeft"> </td><td class="mdescRight">Allows the library to modify the contents of the write buffer. <a href="group___d_x_p_l.html#ga6f65ca81d8a10015513a69fe76c5d542">More...</a><br /></td></tr> <tr class="separator:ga6f65ca81d8a10015513a69fe76c5d542"><td class="memSeparator" colspan="2"> </td></tr> @@ -270,6 +275,56 @@ Functions</h2></td></tr> <tr class="separator:ga7a3e4d3f7b5c276873d00af3f92cdc22"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Function Documentation</h2> +<a id="ga252fe801869970c14a5e800a1ea7ab84"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga252fe801869970c14a5e800a1ea7ab84">◆ </a></span>H5Pget_actual_selection_io_mode()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_actual_selection_io_mode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>plist_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t * </td> + <td class="paramname"><em>actual_selection_io_mode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves the type(s) of I/O that HDF5 actually performed on raw data during the last I/O call. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset transfer property list identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">actual_selection_io_mode</td><td>A bitwise set value indicating the type(s) of I/O performed </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> +<dl class="section user"><dt>Motivation:</dt><dd>A user can request selection I/O to be performed via a data transfer property list (DXPL). This can be used to enable collective I/O with type conversion, or with custom VFDs that support vector or selection I/O. However, there are conditions that can cause HDF5 to forgo selection or vector I/O and perform legacy (scalar) I/O instead. This function allows the user to determine which type or types of I/O were actually performed.</dd></dl> +<p><a class="el" href="group___d_x_p_l.html#ga252fe801869970c14a5e800a1ea7ab84" title="Retrieves the type(s) of I/O that HDF5 actually performed on raw data during the last I/O call.">H5Pget_actual_selection_io_mode()</a> allows the user to determine which type(s) of I/O were actually performed on raw data during the last I/O operation which used <code>plist_id</code>. This property is set after all I/O is completed; if I/O fails, it will not be set.</p> +<p><a class="el" href="group___d_x_p_l.html#gad6fa6bfa5956e8c0bd69c22bde65f84c" title="Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call.">H5Pget_no_selection_io_cause()</a> can be used to determine the reason why selection or vector I/O was not performed.</p> +<p>Valid bitflags returned in <code>actual_selection_io_mode</code> are listed as follows.</p> +<ul> +<li><a class="el" href="_h5_ppublic_8h.html#a33a8e40afb222e4c7854ad9aaee140cb">H5D_SCALAR_IO</a> Scalar (or legacy MPIO) I/O was performed</li> +<li><a class="el" href="_h5_ppublic_8h.html#acde6ec06c2ba407bffd67335a82835ae">H5D_VECTOR_IO</a> Vector I/O was performed</li> +<li><a class="el" href="_h5_ppublic_8h.html#ad0795b084ee2432646a985523ff60ed1">H5D_SELECTION_IO</a> Selection I/O was performed</li> +</ul> +<p>0 or more of these can be present in <code>actual_selection_io_mode</code> in a bitwise fashion, since a single operation can trigger multiple instances of I/O, possibly with different types. A value of <code>0</code> indicates no raw data I/O was performed during the operation.</p> +<p>Be aware that this function will only include raw data I/O performed to/from disk as part of the last I/O operation. Any metadata I/O, including attribute and compact dataset I/O, is disregarded. It is also possible that data was cached in the dataset chunk cache or sieve buffer, which may prevent I/O from hitting the disk, and thereby prevent it from being counted by this function.</p> +<dl class="section since"><dt>Since</dt><dd>1.14.3 </dd></dl> + +</div> +</div> <a id="ga3f3df48ce44b6af7517654b23a37fa02"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga3f3df48ce44b6af7517654b23a37fa02">◆ </a></span>H5Pget_btree_ratios()</h2> |