diff options
| author | byrnHDF <byrnHDF@users.noreply.github.com> | 2024-01-29 19:10:27 (GMT) |
|---|---|---|
| committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2024-01-29 19:10:27 (GMT) |
| commit | 63b7d411312cb7c38efd1648363e347f27c24048 (patch) | |
| tree | af34e5dc2c0cdb79bc809e2034f7d8c7fed6e2e4 /develop/group___g_c_p_l.html | |
| parent | 6ba66d0a9efca6f012934bfbeb9bf4ef19465bbd (diff) | |
| download | hdf5-63b7d411312cb7c38efd1648363e347f27c24048.zip hdf5-63b7d411312cb7c38efd1648363e347f27c24048.tar.gz hdf5-63b7d411312cb7c38efd1648363e347f27c24048.tar.bz2 | |
deploy: 365e23340cd001ee751da366235ae420156ad728
Diffstat (limited to 'develop/group___g_c_p_l.html')
| -rw-r--r-- | develop/group___g_c_p_l.html | 274 |
1 files changed, 102 insertions, 172 deletions
diff --git a/develop/group___g_c_p_l.html b/develop/group___g_c_p_l.html index 896339a..9586dec 100644 --- a/develop/group___g_c_p_l.html +++ b/develop/group___g_c_p_l.html @@ -3,7 +3,7 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.9.1"/> +<meta name="generator" content="Doxygen 1.10.0"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>HDF5: Group Creation Properties</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -13,12 +13,13 @@ <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript" src="cookie.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ - $(document).ready(function() { init_search(); }); +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ + $(function() { init_search(); }); /* @license-end */ </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> @@ -37,17 +38,14 @@ <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.5f5f5f0</span> +  <span id="projectnumber">1.15.0.365e233</span> </div> <div id="projectbrief">API Reference</div> </td> <td> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.svg" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" + <span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span> + <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> @@ -61,10 +59,10 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.9.1 --> +<!-- Generated by Doxygen 1.10.0 --> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ -var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search/",'.html'); /* @license-end */ </script> </div><!-- top --> @@ -79,8 +77,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); </div> </div> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ -$(document).ready(function(){initNavTree('group___g_c_p_l.html',''); initResizable(); }); +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +$(function(){initNavTree('group___g_c_p_l.html',''); initResizable(); }); /* @license-end */ </script> <div id="doc-content"> @@ -93,22 +91,27 @@ $(document).ready(function(){initNavTree('group___g_c_p_l.html',''); initResizab <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> +<div id="MSearchResults"> +<div class="SRPage"> +<div id="SRIndex"> +<div id="SRResults"></div> +<div class="SRStatus" id="Loading">Loading...</div> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +</div> +</div> +</div> </div> <div class="header"> <div class="summary"> -<a href="#groups">Modules</a> | +<a href="#groups">Topics</a> | <a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Group Creation Properties<div class="ingroups"><a class="el" href="group___h5_p.html">Property Lists (H5P)</a> » <a class="el" href="group___o_c_p_l.html">Object Creation Properties</a></div></div> </div> + <div class="headertitle"><div class="title">Group Creation Properties<div class="ingroups"><a class="el" href="group___h5_p.html">Property Lists (H5P)</a> » <a class="el" href="group___o_c_p_l.html">Object Creation Properties</a></div></div></div> </div><!--header--> <div class="contents"> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>Use group creation properties to control aspects of group creation such as storage layout, compression, and link creation order tracking. Unlike file access properties, creation properties <em>are</em> stored with the group, and cannot be changed once a group has been created.</p> -<p><a class="anchor" id="table_gcpl_id"></a> +<p>Use group creation properties to control aspects of group creation such as storage layout, compression, and link creation order tracking. Unlike file access properties, creation properties <em>are</em> stored with the group, and cannot be changed once a group has been created. </p><div></div><div> <a class="anchor" id="table_gcpl_id"></a> <table class="doxtable"> <caption>Group creation property list functions (H5P)</caption> <tr> @@ -134,77 +137,64 @@ $(document).ready(function(){initNavTree('group___g_c_p_l.html',''); initResizab <tr> <td><a class="el" href="group___o_c_p_l.html#ga8bc81abfbd0393b0a46e121f817a3f81" title="Sets up use of the Fletcher32 checksum filter.">H5Pset_fletcher32</a> </td><td>Sets up use of the Fletcher32 checksum filter. </td></tr> <tr> -<td><a class="el" href="group___g_c_p_l.html#ga870728af2bf3c0b16edafd762a1c44d6" title="Specifies the anticipated maximum size of a local heap.">H5Pset_local_heap_size_hint</a>/<a class="el" href="group___g_c_p_l.html#ga49e14718767fa160248e3852c2abdd74" title="Retrieves the anticipated size of the local heap for original-style groups.">H5Pget_local_heap_size_hint</a> </td><td>Sets/gets the anticipated maximum size of a local heap. </td></tr> +<td><a class="el" href="#ga870728af2bf3c0b16edafd762a1c44d6" title="Specifies the anticipated maximum size of a local heap.">H5Pset_local_heap_size_hint</a>/<a class="el" href="#ga49e14718767fa160248e3852c2abdd74" title="Retrieves the anticipated size of the local heap for original-style groups.">H5Pget_local_heap_size_hint</a> </td><td>Sets/gets the anticipated maximum size of a local heap. </td></tr> <tr> -<td><a class="el" href="group___g_c_p_l.html#gab463ac9355728469eddfd973b4a5964f" title="Sets the parameters for conversion between compact and dense groups.">H5Pset_link_phase_change</a> </td><td>Sets the parameters for conversion between compact and dense groups. </td></tr> +<td><a class="el" href="#gab463ac9355728469eddfd973b4a5964f" title="Sets the parameters for conversion between compact and dense groups.">H5Pset_link_phase_change</a> </td><td>Sets the parameters for conversion between compact and dense groups. </td></tr> <tr> -<td><a class="el" href="group___g_c_p_l.html#gacab66461dca6c2beafd624c2e4d9f94d" title="Queries the settings for conversion between compact and dense groups.">H5Pget_link_phase_change</a> </td><td>Queries the settings for conversion between compact and dense groups. </td></tr> +<td><a class="el" href="#gacab66461dca6c2beafd624c2e4d9f94d" title="Queries the settings for conversion between compact and dense groups.">H5Pget_link_phase_change</a> </td><td>Queries the settings for conversion between compact and dense groups. </td></tr> <tr> -<td><a class="el" href="group___g_c_p_l.html#gaa8571642d45e73ab5a9ae71cf00501f9" title="Sets estimated number of links and length of link names in a group.">H5Pset_est_link_info</a> </td><td>Sets estimated number of links and length of link names in a group. </td></tr> +<td><a class="el" href="#gaa8571642d45e73ab5a9ae71cf00501f9" title="Sets estimated number of links and length of link names in a group.">H5Pset_est_link_info</a> </td><td>Sets estimated number of links and length of link names in a group. </td></tr> <tr> -<td><a class="el" href="group___g_c_p_l.html#ga701867215546a345dea7b8e9cf7a1b61" title="Returns the estimated link count and average link name length in a group.">H5Pget_est_link_info</a> </td><td>Queries data required to estimate required local heap or object header size. </td></tr> +<td><a class="el" href="#ga701867215546a345dea7b8e9cf7a1b61" title="Returns the estimated link count and average link name length in a group.">H5Pget_est_link_info</a> </td><td>Queries data required to estimate required local heap or object header size. </td></tr> <tr> <td><a class="el" href="group___l_a_p_l.html#gaa46c63c196a0cf5cd94dede039c030f4" title="Sets maximum number of soft or user-defined link traversals.">H5Pset_nlinks</a> </td><td>Sets maximum number of soft or user-defined link traversals. </td></tr> <tr> <td><a class="el" href="group___l_a_p_l.html#ga6bfa33fa9a77011cbdc06d0fbc907177" title="Retrieves the maximum number of link traversals.">H5Pget_nlinks</a> </td><td>Retrieves the maximum number of link traversals. </td></tr> <tr> -<td><a class="el" href="group___g_c_p_l.html#ga24817b5c9553df3872de57c20bf11512" title="Sets creation order tracking and indexing for links in a group.">H5Pset_link_creation_order</a> </td><td>Sets creation order tracking and indexing for links in a group. </td></tr> +<td><a class="el" href="#ga24817b5c9553df3872de57c20bf11512" title="Sets creation order tracking and indexing for links in a group.">H5Pset_link_creation_order</a> </td><td>Sets creation order tracking and indexing for links in a group. </td></tr> <tr> -<td><a class="el" href="group___g_c_p_l.html#gaa2c2f433c7e65f694e0444e7f0ed2d33" title="Queries whether link creation order is tracked and/or indexed in a group.">H5Pget_link_creation_order</a> </td><td>Queries whether link creation order is tracked and/or indexed in a group. </td></tr> +<td><a class="el" href="#gaa2c2f433c7e65f694e0444e7f0ed2d33" title="Queries whether link creation order is tracked and/or indexed in a group.">H5Pget_link_creation_order</a> </td><td>Queries whether link creation order is tracked and/or indexed in a group. </td></tr> <tr> <td><a class="el" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc" title="Sets the character encoding used to encode link and attribute names.">H5Pset_char_encoding</a> </td><td>Sets the character encoding used to encode a string. Use to set ASCII or UTF-8 character encoding for object names. </td></tr> <tr> <td><a class="el" href="group___a_c_p_l.html#ga9b35ef9add6463997330e9b4b606603d" title="Retrieves the character encoding used to create a link or attribute name.">H5Pget_char_encoding</a> </td><td>Retrieves the character encoding used to create a string. </td></tr> </table> -</p> -<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> - <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for Group Creation Properties:</div> -<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> -</div> -<div id="dynsection-0-content" class="dyncontent" style="display:none;"> -<div class="center"><img src="group___g_c_p_l.png" border="0" usemap="#agroup______g__c__p__l" alt=""/></div> -<map name="agroup______g__c__p__l" id="agroup______g__c__p__l"> -<area shape="rect" href="group___o_c_p_l.html" title=" " alt="" coords="5,5,199,31"/> -<area shape="rect" title=" " alt="" coords="247,5,437,31"/> -<area shape="rect" href="group___f_c_p_l.html" title=" " alt="" coords="485,5,660,31"/> -</map> -</div> -<table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> -Modules</h2></td></tr> -<tr class="memitem:group___f_c_p_l"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_c_p_l.html">File Creation Properties</a></td></tr> +</div><div> </div> <table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a> +Topics</h2></td></tr> +<tr class="memitem:group___f_c_p_l" id="r_group___f_c_p_l"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_c_p_l.html">File Creation Properties</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:ga701867215546a345dea7b8e9cf7a1b61"><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___g_c_p_l.html#ga701867215546a345dea7b8e9cf7a1b61">H5Pget_est_link_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned *est_num_entries, unsigned *est_name_len)</td></tr> -<tr class="memdesc:ga701867215546a345dea7b8e9cf7a1b61"><td class="mdescLeft"> </td><td class="mdescRight">Returns the estimated link count and average link name length in a group. <a href="group___g_c_p_l.html#ga701867215546a345dea7b8e9cf7a1b61">More...</a><br /></td></tr> +<tr class="memitem:ga701867215546a345dea7b8e9cf7a1b61" id="r_ga701867215546a345dea7b8e9cf7a1b61"><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="#ga701867215546a345dea7b8e9cf7a1b61">H5Pget_est_link_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned *est_num_entries, unsigned *est_name_len)</td></tr> +<tr class="memdesc:ga701867215546a345dea7b8e9cf7a1b61"><td class="mdescLeft"> </td><td class="mdescRight">Returns the estimated link count and average link name length in a group. <br /></td></tr> <tr class="separator:ga701867215546a345dea7b8e9cf7a1b61"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaa2c2f433c7e65f694e0444e7f0ed2d33"><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___g_c_p_l.html#gaa2c2f433c7e65f694e0444e7f0ed2d33">H5Pget_link_creation_order</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned *crt_order_flags)</td></tr> -<tr class="memdesc:gaa2c2f433c7e65f694e0444e7f0ed2d33"><td class="mdescLeft"> </td><td class="mdescRight">Queries whether link creation order is tracked and/or indexed in a group. <a href="group___g_c_p_l.html#gaa2c2f433c7e65f694e0444e7f0ed2d33">More...</a><br /></td></tr> +<tr class="memitem:gaa2c2f433c7e65f694e0444e7f0ed2d33" id="r_gaa2c2f433c7e65f694e0444e7f0ed2d33"><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="#gaa2c2f433c7e65f694e0444e7f0ed2d33">H5Pget_link_creation_order</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned *crt_order_flags)</td></tr> +<tr class="memdesc:gaa2c2f433c7e65f694e0444e7f0ed2d33"><td class="mdescLeft"> </td><td class="mdescRight">Queries whether link creation order is tracked and/or indexed in a group. <br /></td></tr> <tr class="separator:gaa2c2f433c7e65f694e0444e7f0ed2d33"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gacab66461dca6c2beafd624c2e4d9f94d"><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___g_c_p_l.html#gacab66461dca6c2beafd624c2e4d9f94d">H5Pget_link_phase_change</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned *max_compact, unsigned *min_dense)</td></tr> -<tr class="memdesc:gacab66461dca6c2beafd624c2e4d9f94d"><td class="mdescLeft"> </td><td class="mdescRight">Queries the settings for conversion between compact and dense groups. <a href="group___g_c_p_l.html#gacab66461dca6c2beafd624c2e4d9f94d">More...</a><br /></td></tr> +<tr class="memitem:gacab66461dca6c2beafd624c2e4d9f94d" id="r_gacab66461dca6c2beafd624c2e4d9f94d"><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="#gacab66461dca6c2beafd624c2e4d9f94d">H5Pget_link_phase_change</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned *max_compact, unsigned *min_dense)</td></tr> +<tr class="memdesc:gacab66461dca6c2beafd624c2e4d9f94d"><td class="mdescLeft"> </td><td class="mdescRight">Queries the settings for conversion between compact and dense groups. <br /></td></tr> <tr class="separator:gacab66461dca6c2beafd624c2e4d9f94d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga49e14718767fa160248e3852c2abdd74"><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___g_c_p_l.html#ga49e14718767fa160248e3852c2abdd74">H5Pget_local_heap_size_hint</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, size_t *size_hint)</td></tr> -<tr class="memdesc:ga49e14718767fa160248e3852c2abdd74"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the anticipated size of the local heap for original-style groups. <a href="group___g_c_p_l.html#ga49e14718767fa160248e3852c2abdd74">More...</a><br /></td></tr> +<tr class="memitem:ga49e14718767fa160248e3852c2abdd74" id="r_ga49e14718767fa160248e3852c2abdd74"><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="#ga49e14718767fa160248e3852c2abdd74">H5Pget_local_heap_size_hint</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, size_t *size_hint)</td></tr> +<tr class="memdesc:ga49e14718767fa160248e3852c2abdd74"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the anticipated size of the local heap for original-style groups. <br /></td></tr> <tr class="separator:ga49e14718767fa160248e3852c2abdd74"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaa8571642d45e73ab5a9ae71cf00501f9"><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___g_c_p_l.html#gaa8571642d45e73ab5a9ae71cf00501f9">H5Pset_est_link_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned est_num_entries, unsigned est_name_len)</td></tr> -<tr class="memdesc:gaa8571642d45e73ab5a9ae71cf00501f9"><td class="mdescLeft"> </td><td class="mdescRight">Sets estimated number of links and length of link names in a group. <a href="group___g_c_p_l.html#gaa8571642d45e73ab5a9ae71cf00501f9">More...</a><br /></td></tr> +<tr class="memitem:gaa8571642d45e73ab5a9ae71cf00501f9" id="r_gaa8571642d45e73ab5a9ae71cf00501f9"><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="#gaa8571642d45e73ab5a9ae71cf00501f9">H5Pset_est_link_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned est_num_entries, unsigned est_name_len)</td></tr> +<tr class="memdesc:gaa8571642d45e73ab5a9ae71cf00501f9"><td class="mdescLeft"> </td><td class="mdescRight">Sets estimated number of links and length of link names in a group. <br /></td></tr> <tr class="separator:gaa8571642d45e73ab5a9ae71cf00501f9"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga24817b5c9553df3872de57c20bf11512"><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___g_c_p_l.html#ga24817b5c9553df3872de57c20bf11512">H5Pset_link_creation_order</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned crt_order_flags)</td></tr> -<tr class="memdesc:ga24817b5c9553df3872de57c20bf11512"><td class="mdescLeft"> </td><td class="mdescRight">Sets creation order tracking and indexing for links in a group. <a href="group___g_c_p_l.html#ga24817b5c9553df3872de57c20bf11512">More...</a><br /></td></tr> +<tr class="memitem:ga24817b5c9553df3872de57c20bf11512" id="r_ga24817b5c9553df3872de57c20bf11512"><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="#ga24817b5c9553df3872de57c20bf11512">H5Pset_link_creation_order</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned crt_order_flags)</td></tr> +<tr class="memdesc:ga24817b5c9553df3872de57c20bf11512"><td class="mdescLeft"> </td><td class="mdescRight">Sets creation order tracking and indexing for links in a group. <br /></td></tr> <tr class="separator:ga24817b5c9553df3872de57c20bf11512"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gab463ac9355728469eddfd973b4a5964f"><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___g_c_p_l.html#gab463ac9355728469eddfd973b4a5964f">H5Pset_link_phase_change</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned max_compact, unsigned min_dense)</td></tr> -<tr class="memdesc:gab463ac9355728469eddfd973b4a5964f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the parameters for conversion between compact and dense groups. <a href="group___g_c_p_l.html#gab463ac9355728469eddfd973b4a5964f">More...</a><br /></td></tr> +<tr class="memitem:gab463ac9355728469eddfd973b4a5964f" id="r_gab463ac9355728469eddfd973b4a5964f"><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="#gab463ac9355728469eddfd973b4a5964f">H5Pset_link_phase_change</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned max_compact, unsigned min_dense)</td></tr> +<tr class="memdesc:gab463ac9355728469eddfd973b4a5964f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the parameters for conversion between compact and dense groups. <br /></td></tr> <tr class="separator:gab463ac9355728469eddfd973b4a5964f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga870728af2bf3c0b16edafd762a1c44d6"><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___g_c_p_l.html#ga870728af2bf3c0b16edafd762a1c44d6">H5Pset_local_heap_size_hint</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, size_t size_hint)</td></tr> -<tr class="memdesc:ga870728af2bf3c0b16edafd762a1c44d6"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the anticipated maximum size of a local heap. <a href="group___g_c_p_l.html#ga870728af2bf3c0b16edafd762a1c44d6">More...</a><br /></td></tr> +<tr class="memitem:ga870728af2bf3c0b16edafd762a1c44d6" id="r_ga870728af2bf3c0b16edafd762a1c44d6"><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="#ga870728af2bf3c0b16edafd762a1c44d6">H5Pset_local_heap_size_hint</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, size_t size_hint)</td></tr> +<tr class="memdesc:ga870728af2bf3c0b16edafd762a1c44d6"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the anticipated maximum size of a local heap. <br /></td></tr> <tr class="separator:ga870728af2bf3c0b16edafd762a1c44d6"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Function Documentation</h2> -<a id="ga701867215546a345dea7b8e9cf7a1b61"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga701867215546a345dea7b8e9cf7a1b61">◆ </a></span>H5Pget_est_link_info()</h2> +<a id="ga701867215546a345dea7b8e9cf7a1b61" name="ga701867215546a345dea7b8e9cf7a1b61"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga701867215546a345dea7b8e9cf7a1b61">◆ </a></span>H5Pget_est_link_info()</h2> <div class="memitem"> <div class="memproto"> @@ -212,25 +202,17 @@ Functions</h2></td></tr> <tr> <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_est_link_info </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> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">unsigned * </td> - <td class="paramname"><em>est_num_entries</em>, </td> + <td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>est_num_entries</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">unsigned * </td> - <td class="paramname"><em>est_name_len</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> + <td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>est_name_len</em></span> )</td> </tr> </table> </div><div class="memdoc"> @@ -245,7 +227,7 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<p><a class="el" href="group___g_c_p_l.html#ga701867215546a345dea7b8e9cf7a1b61" title="Returns the estimated link count and average link name length in a group.">H5Pget_est_link_info()</a> retrieves two settings from the group creation property list <code>plist_id:</code> the estimated number of links that are expected to be inserted into a group created with the property list and the estimated average length of those link names.</p> +<p><a class="el" href="#ga701867215546a345dea7b8e9cf7a1b61" title="Returns the estimated link count and average link name length in a group.">H5Pget_est_link_info()</a> retrieves two settings from the group creation property list <code>plist_id:</code> the estimated number of links that are expected to be inserted into a group created with the property list and the estimated average length of those link names.</p> <p>The estimated number of links is returned in <code>est_num_entries</code>. The limit for <code>est_num_entries</code> is 64 K.</p> <p>The estimated average length of the anticipated link names is returned in <code>est_name_len</code>. The limit for <code>est_name_len</code> is 64 K.</p> <p>See <a href="https://portal.hdfgroup.org/display/HDF5/Groups">Group implementations in HDF5</a> for a discussion of the available types of HDF5 group structures.</p> @@ -253,8 +235,8 @@ Functions</h2></td></tr> </div> </div> -<a id="gaa2c2f433c7e65f694e0444e7f0ed2d33"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaa2c2f433c7e65f694e0444e7f0ed2d33">◆ </a></span>H5Pget_link_creation_order()</h2> +<a id="gaa2c2f433c7e65f694e0444e7f0ed2d33" name="gaa2c2f433c7e65f694e0444e7f0ed2d33"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa2c2f433c7e65f694e0444e7f0ed2d33">◆ </a></span>H5Pget_link_creation_order()</h2> <div class="memitem"> <div class="memproto"> @@ -262,19 +244,12 @@ Functions</h2></td></tr> <tr> <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_link_creation_order </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> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">unsigned * </td> - <td class="paramname"><em>crt_order_flags</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> + <td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>crt_order_flags</em></span> )</td> </tr> </table> </div><div class="memdoc"> @@ -288,14 +263,14 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<p><a class="el" href="group___g_c_p_l.html#gaa2c2f433c7e65f694e0444e7f0ed2d33" title="Queries whether link creation order is tracked and/or indexed in a group.">H5Pget_link_creation_order()</a> queries the group or file creation property list, <code>plist_id</code>, and returns a flag indicating whether link creation order is tracked and/or indexed in a group.</p> -<p>See <a class="el" href="group___g_c_p_l.html#ga24817b5c9553df3872de57c20bf11512" title="Sets creation order tracking and indexing for links in a group.">H5Pset_link_creation_order()</a> for a list of valid creation order flags, as passed in <code>crt_order_flags</code>, and their meanings.</p> +<p><a class="el" href="#gaa2c2f433c7e65f694e0444e7f0ed2d33" title="Queries whether link creation order is tracked and/or indexed in a group.">H5Pget_link_creation_order()</a> queries the group or file creation property list, <code>plist_id</code>, and returns a flag indicating whether link creation order is tracked and/or indexed in a group.</p> +<p>See <a class="el" href="#ga24817b5c9553df3872de57c20bf11512" title="Sets creation order tracking and indexing for links in a group.">H5Pset_link_creation_order()</a> for a list of valid creation order flags, as passed in <code>crt_order_flags</code>, and their meanings.</p> <dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> </div> </div> -<a id="gacab66461dca6c2beafd624c2e4d9f94d"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gacab66461dca6c2beafd624c2e4d9f94d">◆ </a></span>H5Pget_link_phase_change()</h2> +<a id="gacab66461dca6c2beafd624c2e4d9f94d" name="gacab66461dca6c2beafd624c2e4d9f94d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gacab66461dca6c2beafd624c2e4d9f94d">◆ </a></span>H5Pget_link_phase_change()</h2> <div class="memitem"> <div class="memproto"> @@ -303,25 +278,17 @@ Functions</h2></td></tr> <tr> <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_link_phase_change </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> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">unsigned * </td> - <td class="paramname"><em>max_compact</em>, </td> + <td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>max_compact</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">unsigned * </td> - <td class="paramname"><em>min_dense</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> + <td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>min_dense</em></span> )</td> </tr> </table> </div><div class="memdoc"> @@ -336,18 +303,18 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<p><a class="el" href="group___g_c_p_l.html#gacab66461dca6c2beafd624c2e4d9f94d" title="Queries the settings for conversion between compact and dense groups.">H5Pget_link_phase_change()</a> queries the maximum number of entries for a compact group and the minimum number of links to require before converting a group to a dense form.</p> +<p><a class="el" href="#gacab66461dca6c2beafd624c2e4d9f94d" title="Queries the settings for conversion between compact and dense groups.">H5Pget_link_phase_change()</a> queries the maximum number of entries for a compact group and the minimum number of links to require before converting a group to a dense form.</p> <p>In the compact format, links are stored as messages in the group's header. In the dense format, links are stored in a fractal heap and indexed with a version 2 B-tree.</p> <p><code>max_compact</code> is the maximum number of links to store as header messages in the group header before converting the group to the dense format. Groups that are in the compact format and exceed this number of links are automatically converted to the dense format.</p> <p><code>min_dense</code> is the minimum number of links to store in the dense format. Groups which are in dense format and in which the number of links falls below this number are automatically converted back to the compact format.</p> <p>In the compact format, links are stored as messages in the group's header. In the dense format, links are stored in a fractal heap and indexed with a version 2 B-tree.</p> -<p>See <a class="el" href="group___g_c_p_l.html#gab463ac9355728469eddfd973b4a5964f" title="Sets the parameters for conversion between compact and dense groups.">H5Pset_link_phase_change()</a> for a discussion of traditional, compact, and dense group storage.</p> +<p>See <a class="el" href="#gab463ac9355728469eddfd973b4a5964f" title="Sets the parameters for conversion between compact and dense groups.">H5Pset_link_phase_change()</a> for a discussion of traditional, compact, and dense group storage.</p> <dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> </div> </div> -<a id="ga49e14718767fa160248e3852c2abdd74"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga49e14718767fa160248e3852c2abdd74">◆ </a></span>H5Pget_local_heap_size_hint()</h2> +<a id="ga49e14718767fa160248e3852c2abdd74" name="ga49e14718767fa160248e3852c2abdd74"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga49e14718767fa160248e3852c2abdd74">◆ </a></span>H5Pget_local_heap_size_hint()</h2> <div class="memitem"> <div class="memproto"> @@ -355,19 +322,12 @@ Functions</h2></td></tr> <tr> <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_local_heap_size_hint </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> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">size_t * </td> - <td class="paramname"><em>size_hint</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> + <td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>size_hint</em></span> )</td> </tr> </table> </div><div class="memdoc"> @@ -381,13 +341,13 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<p><a class="el" href="group___g_c_p_l.html#ga49e14718767fa160248e3852c2abdd74" title="Retrieves the anticipated size of the local heap for original-style groups.">H5Pget_local_heap_size_hint()</a> queries the group creation property list, <code>plist_id</code>, for the anticipated size of the local heap, <code>size_hint</code>, for original-style groups, i.e., for groups of the style used prior to HDF5 Release 1.8.0. See <a class="el" href="group___g_c_p_l.html#ga870728af2bf3c0b16edafd762a1c44d6" title="Specifies the anticipated maximum size of a local heap.">H5Pset_local_heap_size_hint()</a> for further discussion.</p> +<p><a class="el" href="#ga49e14718767fa160248e3852c2abdd74" title="Retrieves the anticipated size of the local heap for original-style groups.">H5Pget_local_heap_size_hint()</a> queries the group creation property list, <code>plist_id</code>, for the anticipated size of the local heap, <code>size_hint</code>, for original-style groups, i.e., for groups of the style used prior to HDF5 Release 1.8.0. See <a class="el" href="#ga870728af2bf3c0b16edafd762a1c44d6" title="Specifies the anticipated maximum size of a local heap.">H5Pset_local_heap_size_hint()</a> for further discussion.</p> <dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> </div> </div> -<a id="gaa8571642d45e73ab5a9ae71cf00501f9"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaa8571642d45e73ab5a9ae71cf00501f9">◆ </a></span>H5Pset_est_link_info()</h2> +<a id="gaa8571642d45e73ab5a9ae71cf00501f9" name="gaa8571642d45e73ab5a9ae71cf00501f9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa8571642d45e73ab5a9ae71cf00501f9">◆ </a></span>H5Pset_est_link_info()</h2> <div class="memitem"> <div class="memproto"> @@ -395,25 +355,17 @@ Functions</h2></td></tr> <tr> <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_est_link_info </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> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">unsigned </td> - <td class="paramname"><em>est_num_entries</em>, </td> + <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>est_num_entries</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">unsigned </td> - <td class="paramname"><em>est_name_len</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> + <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>est_name_len</em></span> )</td> </tr> </table> </div><div class="memdoc"> @@ -428,7 +380,7 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<p><a class="el" href="group___g_c_p_l.html#gaa8571642d45e73ab5a9ae71cf00501f9" title="Sets estimated number of links and length of link names in a group.">H5Pset_est_link_info()</a> inserts two settings into the group creation property list plist_id: the estimated number of links that are expected to be inserted into a group created with the property list and the estimated average length of those link names.</p> +<p><a class="el" href="#gaa8571642d45e73ab5a9ae71cf00501f9" title="Sets estimated number of links and length of link names in a group.">H5Pset_est_link_info()</a> inserts two settings into the group creation property list plist_id: the estimated number of links that are expected to be inserted into a group created with the property list and the estimated average length of those link names.</p> <p>The estimated number of links is passed in <code>est_num_entries</code>. The limit for <code>est_num_entries</code> is 64 K.</p> <p>The estimated average length of the anticipated link names is passed in <code>est_name_len</code>. The limit for <code>est_name_len</code> is 64 K.</p> <p>The values for these two settings are multiplied to compute the initial local heap size (for old-style groups, if the local heap size hint is not set) or the initial object header size for (new-style compact groups; see <a href="https://portal.hdfgroup.org/display/HDF5/Groups">Group implementations in HDF5</a>). Accurately setting these parameters will help reduce wasted file space.</p> @@ -438,8 +390,8 @@ Functions</h2></td></tr> </div> </div> -<a id="ga24817b5c9553df3872de57c20bf11512"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga24817b5c9553df3872de57c20bf11512">◆ </a></span>H5Pset_link_creation_order()</h2> +<a id="ga24817b5c9553df3872de57c20bf11512" name="ga24817b5c9553df3872de57c20bf11512"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga24817b5c9553df3872de57c20bf11512">◆ </a></span>H5Pset_link_creation_order()</h2> <div class="memitem"> <div class="memproto"> @@ -447,19 +399,12 @@ Functions</h2></td></tr> <tr> <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_link_creation_order </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> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">unsigned </td> - <td class="paramname"><em>crt_order_flags</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> + <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>crt_order_flags</em></span> )</td> </tr> </table> </div><div class="memdoc"> @@ -473,7 +418,7 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<p><a class="el" href="group___g_c_p_l.html#ga24817b5c9553df3872de57c20bf11512" title="Sets creation order tracking and indexing for links in a group.">H5Pset_link_creation_order()</a> sets flags for tracking and indexing links on creation order in groups created with the group (or file) creation property list <code>plist_id</code>.</p> +<p><a class="el" href="#ga24817b5c9553df3872de57c20bf11512" title="Sets creation order tracking and indexing for links in a group.">H5Pset_link_creation_order()</a> sets flags for tracking and indexing links on creation order in groups created with the group (or file) creation property list <code>plist_id</code>.</p> <p><code>crt_order_flags</code> contains flags with the following meanings:</p> <table class="doxtable"> <tr> @@ -482,7 +427,7 @@ Functions</h2></td></tr> <td><a class="el" href="_h5_ppublic_8h.html#adfd355619b7da5792a16d7bc491f963d">H5P_CRT_ORDER_INDEXED</a> </td><td>Link creation order is indexed (requires <a class="el" href="_h5_ppublic_8h.html#aa52f444ce2ba8bc5a062612f195e899f">H5P_CRT_ORDER_TRACKED</a>) </td></tr> </table> <p>The default behavior is that links are tracked and indexed by name, and link creation order is neither tracked nor indexed. The name is always the primary index for links in a group.</p> -<p><a class="el" href="group___g_c_p_l.html#ga24817b5c9553df3872de57c20bf11512" title="Sets creation order tracking and indexing for links in a group.">H5Pset_link_creation_order()</a> can be used to set link creation order tracking, or to set link creation order tracking and indexing.</p> +<p><a class="el" href="#ga24817b5c9553df3872de57c20bf11512" title="Sets creation order tracking and indexing for links in a group.">H5Pset_link_creation_order()</a> can be used to set link creation order tracking, or to set link creation order tracking and indexing.</p> <p>If (<a class="el" href="_h5_ppublic_8h.html#aa52f444ce2ba8bc5a062612f195e899f">H5P_CRT_ORDER_TRACKED</a> | <a class="el" href="_h5_ppublic_8h.html#adfd355619b7da5792a16d7bc491f963d">H5P_CRT_ORDER_INDEXED</a>) is specified for <code>crt_order_flags</code>, then links will be tracked and indexed by creation order. The creation order is added as a secondary index and enables faster queries and iterations by creation order.</p> <p>If just <a class="el" href="_h5_ppublic_8h.html#aa52f444ce2ba8bc5a062612f195e899f">H5P_CRT_ORDER_TRACKED</a> is specified for <code>crt_order_flags</code>, then links will be tracked by creation order, but not indexed by creation order. Queries and iterations by creation order will work but will be much slower for large groups than if <a class="el" href="_h5_ppublic_8h.html#adfd355619b7da5792a16d7bc491f963d">H5P_CRT_ORDER_INDEXED</a> had been included.</p> <dl class="section note"><dt>Note</dt><dd>If a creation order index is to be built, it must be specified in the group creation property list. HDF5 currently provides no mechanism to turn on link creation order tracking at group creation time and to build the index later.</dd></dl> @@ -490,8 +435,8 @@ Functions</h2></td></tr> </div> </div> -<a id="gab463ac9355728469eddfd973b4a5964f"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gab463ac9355728469eddfd973b4a5964f">◆ </a></span>H5Pset_link_phase_change()</h2> +<a id="gab463ac9355728469eddfd973b4a5964f" name="gab463ac9355728469eddfd973b4a5964f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab463ac9355728469eddfd973b4a5964f">◆ </a></span>H5Pset_link_phase_change()</h2> <div class="memitem"> <div class="memproto"> @@ -499,25 +444,17 @@ Functions</h2></td></tr> <tr> <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_link_phase_change </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> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">unsigned </td> - <td class="paramname"><em>max_compact</em>, </td> + <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>max_compact</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">unsigned </td> - <td class="paramname"><em>min_dense</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> + <td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>min_dense</em></span> )</td> </tr> </table> </div><div class="memdoc"> @@ -532,15 +469,15 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<p><a class="el" href="group___g_c_p_l.html#gab463ac9355728469eddfd973b4a5964f" title="Sets the parameters for conversion between compact and dense groups.">H5Pset_link_phase_change()</a> sets the maximum number of entries for a compact group and the minimum number of links to allow before converting a dense group back to the compact format.</p> +<p><a class="el" href="#gab463ac9355728469eddfd973b4a5964f" title="Sets the parameters for conversion between compact and dense groups.">H5Pset_link_phase_change()</a> sets the maximum number of entries for a compact group and the minimum number of links to allow before converting a dense group back to the compact format.</p> <p><code>max_compact</code> is the maximum number of links to store as header messages in the group header before converting the group to the dense format. Groups that are in compact format and which exceed this number of links are automatically converted to dense format.</p> <p><code>min_dense</code> is the minimum number of links to store in the dense format. Groups which are in dense format and in which the number of links falls below this threshold are automatically converted to compact format.</p> <dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> </div> </div> -<a id="ga870728af2bf3c0b16edafd762a1c44d6"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga870728af2bf3c0b16edafd762a1c44d6">◆ </a></span>H5Pset_local_heap_size_hint()</h2> +<a id="ga870728af2bf3c0b16edafd762a1c44d6" name="ga870728af2bf3c0b16edafd762a1c44d6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga870728af2bf3c0b16edafd762a1c44d6">◆ </a></span>H5Pset_local_heap_size_hint()</h2> <div class="memitem"> <div class="memproto"> @@ -548,19 +485,12 @@ Functions</h2></td></tr> <tr> <td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_local_heap_size_hint </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> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td> </tr> <tr> <td class="paramkey"></td> <td></td> - <td class="paramtype">size_t </td> - <td class="paramname"><em>size_hint</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> + <td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size_hint</em></span> )</td> </tr> </table> </div><div class="memdoc"> @@ -574,13 +504,13 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> -<p><a class="el" href="group___g_c_p_l.html#ga870728af2bf3c0b16edafd762a1c44d6" title="Specifies the anticipated maximum size of a local heap.">H5Pset_local_heap_size_hint()</a> is used with original-style HDF5 groups (see “Motivation” below) to specify the anticipated maximum local heap size, size_hint, for groups created with the group creation property list <code>plist_id</code>. The HDF5 library then uses <code>size_hint</code> to allocate contiguous local heap space in the file for each group created with <code>plist_id</code>.</p> +<p><a class="el" href="#ga870728af2bf3c0b16edafd762a1c44d6" title="Specifies the anticipated maximum size of a local heap.">H5Pset_local_heap_size_hint()</a> is used with original-style HDF5 groups (see “Motivation” below) to specify the anticipated maximum local heap size, size_hint, for groups created with the group creation property list <code>plist_id</code>. The HDF5 library then uses <code>size_hint</code> to allocate contiguous local heap space in the file for each group created with <code>plist_id</code>.</p> <p>For groups with many members or very few members, an appropriate initial value of <code>size_hint</code> would be the anticipated number of group members times the average length of group member names, plus a small margin: </p><div class="fragment"><div class="line">size_hint = max_number_of_group_members *</div> <div class="line"> (average_length_of_group_member_link_names + 2)</div> </div><!-- fragment --><p> If it is known that there will be groups with zero members, the use of a group creation property list with <code>size_hint</code> set to to 1 (one) will guarantee the smallest possible local heap for each of those groups.</p> <p>Setting <code>size_hint</code> to zero (0) causes the library to make a reasonable estimate for the default local heap size.</p> <dl class="section user"><dt>Motivation:</dt><dd>In situations where backward-compatibility is required, specifically, when libraries prior to HDF5 Release 1.8.0 may be used to read the file, groups must be created and maintained in the original style. This is HDF5's default behavior. If backward compatibility with pre-1.8.0 libraries is not a concern, greater efficiencies can be obtained with the new-format compact and indexed groups. See <a href="https://portal.hdfgroup.org/display/HDF5/Groups">Group implementations in HDF5</a> in the <a class="el" href="group___h5_g.html">Groups (H5G)</a> API introduction (at the bottom).<br /> - <a class="el" href="group___g_c_p_l.html#ga870728af2bf3c0b16edafd762a1c44d6" title="Specifies the anticipated maximum size of a local heap.">H5Pset_local_heap_size_hint()</a> is useful for tuning file size when files contain original-style groups with either zero members or very large numbers of members.<br /> + <a class="el" href="#ga870728af2bf3c0b16edafd762a1c44d6" title="Specifies the anticipated maximum size of a local heap.">H5Pset_local_heap_size_hint()</a> is useful for tuning file size when files contain original-style groups with either zero members or very large numbers of members.<br /> The original style of HDF5 groups, the only style available prior to HDF5 Release 1.8.0, was well-suited for moderate-sized groups but was not optimized for either very small or very large groups. This original style remains the default, but two new group implementations were introduced in HDF5 Release 1.8.0: compact groups to accommodate zero to small numbers of members and indexed groups for thousands or tens of thousands of members ... or millions, if that's what your application requires.<br /> The local heap size hint, <code>size_hint</code>, is a performance tuning parameter for original-style groups. As indicated above, an HDF5 group may have zero, a handful, or tens of thousands of members. Since the original style of HDF5 groups stores the metadata for all of these group members in a uniform format in a local heap, the size of that metadata (and hence, the size of the local heap) can vary wildly from group to group. To intelligently allocate space and to avoid unnecessary fragmentation of the local heap, it can be valuable to provide the library with a hint as to the local heap's likely eventual size. This can be particularly valuable when it is known that a group will eventually have a great many members. It can also be useful in conserving space in a file when it is known that certain groups will never have any members.</dd></dl> <dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> @@ -594,7 +524,7 @@ Functions</h2></td></tr> <ul> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li> </ul> </div> </body> |