mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-10-01 04:03:33 +03:00
2212 lines
163 KiB
HTML
2212 lines
163 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.7"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>HDF5: Dataspaces (H5S)</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript">var page_layout=1;</script>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
|
|
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
|
|
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">HDF5<span id="projectnumber"> 1.15.0.405d1b9</span>
|
|
</div>
|
|
<div id="projectbrief">API Reference</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.7 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="_getting_started.html"><span>Getting started</span></a></li>
|
|
<li><a href="_u_g.html"><span>User Guide</span></a></li>
|
|
<li><a href="_r_m.html"><span>Reference Manual</span></a></li>
|
|
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
|
|
<li><a href="_t_n.html"><span>Technical Notes</span></a></li>
|
|
<li><a href="_r_f_c.html"><span>RFCs</span></a></li>
|
|
<li><a href="_s_p_e_c.html"><span>Specifications</span></a></li>
|
|
<li><a href="_g_l_s.html"><span>Glossary</span></a></li>
|
|
<li><a href="_about.html"><span>About</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<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)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('group___h5_s.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<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="#define-members">Macros</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Dataspaces (H5S)</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Use the functions in this module to manage HDF5 dataspaces <em>and</em> selections.</p>
|
|
<p>HDF5 dataspaces describe the <em>shape</em> of datasets in memory or in HDF5 files. Dataspaces can be empty (<a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aa3d83ec70c1a824a2d821bf8464488bc5">H5S_NULL</a>), a singleton (<a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aaf6a34a2439db8aa7bb63ed0c4aaa5eb8">H5S_SCALAR</a>), or a multi-dimensional, regular grid (<a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aac4ee937dcccfd99f885626983e7d2750">H5S_SIMPLE</a>). Dataspaces can be re-shaped.</p>
|
|
<p>Subsets of dataspaces can be "book-marked" or used to restrict I/O operations using <em>selections</em>. Furthermore, certain set operations are supported for selections. </p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ga35e289baf490229e233296929fbf5208"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#ga35e289baf490229e233296929fbf5208">H5Sencode</a>   <a class="el" href="group___h5_s.html#ga178ec7b8769ad5704a170d9bd3421074">H5Sencode2</a></td></tr>
|
|
<tr class="separator:ga35e289baf490229e233296929fbf5208"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga2b53128a39c8f104c1c9c2a91590fcc1"><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___h5_s.html#ga2b53128a39c8f104c1c9c2a91590fcc1">H5Sclose</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td></tr>
|
|
<tr class="memdesc:ga2b53128a39c8f104c1c9c2a91590fcc1"><td class="mdescLeft"> </td><td class="mdescRight">Releases and terminates access to a dataspace. <br /></td></tr>
|
|
<tr class="separator:ga2b53128a39c8f104c1c9c2a91590fcc1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae7578a93bb7b22989bcb737f26b60ad1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#gae7578a93bb7b22989bcb737f26b60ad1">H5Scombine_hyperslab</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0f">H5S_seloper_t</a> op, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> start[], const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> stride[], const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> count[], const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> block[])</td></tr>
|
|
<tr class="memdesc:gae7578a93bb7b22989bcb737f26b60ad1"><td class="mdescLeft"> </td><td class="mdescRight">Performs an operation on a hyperslab and an existing selection and returns the resulting selection. <br /></td></tr>
|
|
<tr class="separator:gae7578a93bb7b22989bcb737f26b60ad1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga356600d12d3cf0db53cc27b212d75b08"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#ga356600d12d3cf0db53cc27b212d75b08">H5Scombine_select</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space1_id, <a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0f">H5S_seloper_t</a> op, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space2_id)</td></tr>
|
|
<tr class="memdesc:ga356600d12d3cf0db53cc27b212d75b08"><td class="mdescLeft"> </td><td class="mdescRight">Combine two hyperslab selections with an operation, returning a dataspace with the resulting selection. <br /></td></tr>
|
|
<tr class="separator:ga356600d12d3cf0db53cc27b212d75b08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae5e26a8f8191768a600d40ec518ed66b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#gae5e26a8f8191768a600d40ec518ed66b">H5Scopy</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td></tr>
|
|
<tr class="memdesc:gae5e26a8f8191768a600d40ec518ed66b"><td class="mdescLeft"> </td><td class="mdescRight">Creates an exact copy of a dataspace. <br /></td></tr>
|
|
<tr class="separator:gae5e26a8f8191768a600d40ec518ed66b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabee514327cba34ca9951b24fa14fb083"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#gabee514327cba34ca9951b24fa14fb083">H5Screate</a> (<a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0a">H5S_class_t</a> type)</td></tr>
|
|
<tr class="memdesc:gabee514327cba34ca9951b24fa14fb083"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new dataspace of a specified type. <br /></td></tr>
|
|
<tr class="separator:gabee514327cba34ca9951b24fa14fb083"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8e35eea5738b4805856eac7d595254ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#ga8e35eea5738b4805856eac7d595254ae">H5Screate_simple</a> (int rank, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> dims[], const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> maxdims[])</td></tr>
|
|
<tr class="memdesc:ga8e35eea5738b4805856eac7d595254ae"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new simple dataspace and opens it for access. <br /></td></tr>
|
|
<tr class="separator:ga8e35eea5738b4805856eac7d595254ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0ac0ebd5f292460354f574476be49fad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#ga0ac0ebd5f292460354f574476be49fad">H5Sdecode</a> (const void *buf)</td></tr>
|
|
<tr class="memdesc:ga0ac0ebd5f292460354f574476be49fad"><td class="mdescLeft"> </td><td class="mdescRight">Decodes a binary object description of data space and returns a new object handle. <br /></td></tr>
|
|
<tr class="separator:ga0ac0ebd5f292460354f574476be49fad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga178ec7b8769ad5704a170d9bd3421074"><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___h5_s.html#ga178ec7b8769ad5704a170d9bd3421074">H5Sencode2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, void *buf, size_t *nalloc, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl)</td></tr>
|
|
<tr class="memdesc:ga178ec7b8769ad5704a170d9bd3421074"><td class="mdescLeft"> </td><td class="mdescRight">Encodes a data space object description into a binary buffer. <br /></td></tr>
|
|
<tr class="separator:ga178ec7b8769ad5704a170d9bd3421074"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0eae5447eaabaa9444fac0464cd1b8d5"><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___h5_s.html#ga0eae5447eaabaa9444fac0464cd1b8d5">H5Sextent_copy</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_id)</td></tr>
|
|
<tr class="memdesc:ga0eae5447eaabaa9444fac0464cd1b8d5"><td class="mdescLeft"> </td><td class="mdescRight">Copies the extent of a dataspace. <br /></td></tr>
|
|
<tr class="separator:ga0eae5447eaabaa9444fac0464cd1b8d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae58bca0c154ceaed9ad36c58c78e145c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#gae58bca0c154ceaed9ad36c58c78e145c">H5Sextent_equal</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space1_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space2_id)</td></tr>
|
|
<tr class="memdesc:gae58bca0c154ceaed9ad36c58c78e145c"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether two dataspace extents are equal. <br /></td></tr>
|
|
<tr class="separator:gae58bca0c154ceaed9ad36c58c78e145c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabc974bbc041538a1d3032729df2ddfc0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#gabc974bbc041538a1d3032729df2ddfc0">H5Sget_regular_hyperslab</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> start[], <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> stride[], <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> count[], <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> block[])</td></tr>
|
|
<tr class="memdesc:gabc974bbc041538a1d3032729df2ddfc0"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a regular hyperslab selection. <br /></td></tr>
|
|
<tr class="separator:gabc974bbc041538a1d3032729df2ddfc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga645591ec939b89732c10efd5867a6205"><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___h5_s.html#ga645591ec939b89732c10efd5867a6205">H5Sget_select_bounds</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> start[], <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> end[])</td></tr>
|
|
<tr class="memdesc:ga645591ec939b89732c10efd5867a6205"><td class="mdescLeft"> </td><td class="mdescRight">Gets the bounding box containing the current selection. <br /></td></tr>
|
|
<tr class="separator:ga645591ec939b89732c10efd5867a6205"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga217b839584cd7c7995b47fc30fe92f4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#ga217b839584cd7c7995b47fc30fe92f4c">H5Sget_select_elem_npoints</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid)</td></tr>
|
|
<tr class="memdesc:ga217b839584cd7c7995b47fc30fe92f4c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of element points in the current selection. <br /></td></tr>
|
|
<tr class="separator:ga217b839584cd7c7995b47fc30fe92f4c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga61459c488147254d1d06537a9ab6e2d4"><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___h5_s.html#ga61459c488147254d1d06537a9ab6e2d4">H5Sget_select_elem_pointlist</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> startpoint, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> numpoints, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> buf[])</td></tr>
|
|
<tr class="memdesc:ga61459c488147254d1d06537a9ab6e2d4"><td class="mdescLeft"> </td><td class="mdescRight">Gets the list of element points currently selected. <br /></td></tr>
|
|
<tr class="separator:ga61459c488147254d1d06537a9ab6e2d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8534829a8db2eca8e987bb9fe8a3d628"><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___h5_s.html#ga8534829a8db2eca8e987bb9fe8a3d628">H5Sget_select_hyper_blocklist</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> startblock, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> numblocks, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> buf[])</td></tr>
|
|
<tr class="memdesc:ga8534829a8db2eca8e987bb9fe8a3d628"><td class="mdescLeft"> </td><td class="mdescRight">Gets the list of hyperslab blocks currently selected. <br /></td></tr>
|
|
<tr class="separator:ga8534829a8db2eca8e987bb9fe8a3d628"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad873b2f3b82ee8c426c26ceeb1c67f86"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#gad873b2f3b82ee8c426c26ceeb1c67f86">H5Sget_select_hyper_nblocks</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid)</td></tr>
|
|
<tr class="memdesc:gad873b2f3b82ee8c426c26ceeb1c67f86"><td class="mdescLeft"> </td><td class="mdescRight">Get number of hyperslab blocks. <br /></td></tr>
|
|
<tr class="separator:gad873b2f3b82ee8c426c26ceeb1c67f86"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1a44dde97206f40f366f99d9c39b6046"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#ga1a44dde97206f40f366f99d9c39b6046">H5Sget_select_npoints</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid)</td></tr>
|
|
<tr class="memdesc:ga1a44dde97206f40f366f99d9c39b6046"><td class="mdescLeft"> </td><td class="mdescRight">Determines the number of elements in a dataspace selection. <br /></td></tr>
|
|
<tr class="separator:ga1a44dde97206f40f366f99d9c39b6046"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga51ae555e5b2492d95c7fefab2e0d5018"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304">H5S_sel_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#ga51ae555e5b2492d95c7fefab2e0d5018">H5Sget_select_type</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid)</td></tr>
|
|
<tr class="memdesc:ga51ae555e5b2492d95c7fefab2e0d5018"><td class="mdescLeft"> </td><td class="mdescRight">Determines the type of the dataspace selection. <br /></td></tr>
|
|
<tr class="separator:ga51ae555e5b2492d95c7fefab2e0d5018"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac494409b615d8e67c5edd9eb2848b2f3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#gac494409b615d8e67c5edd9eb2848b2f3">H5Sget_simple_extent_dims</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> dims[], <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> maxdims[])</td></tr>
|
|
<tr class="memdesc:gac494409b615d8e67c5edd9eb2848b2f3"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves dataspace dimension size and maximum size. <br /></td></tr>
|
|
<tr class="separator:gac494409b615d8e67c5edd9eb2848b2f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae5282a81692b80b5b19dd12d05b9b28e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#gae5282a81692b80b5b19dd12d05b9b28e">H5Sget_simple_extent_ndims</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td></tr>
|
|
<tr class="memdesc:gae5282a81692b80b5b19dd12d05b9b28e"><td class="mdescLeft"> </td><td class="mdescRight">Determines the dimensionality of a dataspace. <br /></td></tr>
|
|
<tr class="separator:gae5282a81692b80b5b19dd12d05b9b28e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9d369fe1e01a95710d320bc5fd32cf83"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#ga9d369fe1e01a95710d320bc5fd32cf83">H5Sget_simple_extent_npoints</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td></tr>
|
|
<tr class="memdesc:ga9d369fe1e01a95710d320bc5fd32cf83"><td class="mdescLeft"> </td><td class="mdescRight">Determines the number of elements in a dataspace. <br /></td></tr>
|
|
<tr class="separator:ga9d369fe1e01a95710d320bc5fd32cf83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf63af02b385e80c8c10b1c43763c251f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0a">H5S_class_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#gaf63af02b385e80c8c10b1c43763c251f">H5Sget_simple_extent_type</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td></tr>
|
|
<tr class="memdesc:gaf63af02b385e80c8c10b1c43763c251f"><td class="mdescLeft"> </td><td class="mdescRight">Determines the current class of a dataspace. <br /></td></tr>
|
|
<tr class="separator:gaf63af02b385e80c8c10b1c43763c251f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8a5bc33fae4be442093329f2cfec3f49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#ga8a5bc33fae4be442093329f2cfec3f49">H5Sis_regular_hyperslab</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid)</td></tr>
|
|
<tr class="memdesc:ga8a5bc33fae4be442093329f2cfec3f49"><td class="mdescLeft"> </td><td class="mdescRight">Determines if a hyperslab selection is regular. <br /></td></tr>
|
|
<tr class="separator:ga8a5bc33fae4be442093329f2cfec3f49"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab0b1560f7c8402986f332522e2adae1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#gab0b1560f7c8402986f332522e2adae1d">H5Sis_simple</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td></tr>
|
|
<tr class="memdesc:gab0b1560f7c8402986f332522e2adae1d"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a dataspace is a simple dataspace. <br /></td></tr>
|
|
<tr class="separator:gab0b1560f7c8402986f332522e2adae1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0ccb190f72fe41a927407ffb9f19ef1b"><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___h5_s.html#ga0ccb190f72fe41a927407ffb9f19ef1b">H5Smodify_select</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space1_id, <a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0f">H5S_seloper_t</a> op, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space2_id)</td></tr>
|
|
<tr class="memdesc:ga0ccb190f72fe41a927407ffb9f19ef1b"><td class="mdescLeft"> </td><td class="mdescRight">Refines a hyperslab selection with an operation, using a second hyperslab to modify it. <br /></td></tr>
|
|
<tr class="separator:ga0ccb190f72fe41a927407ffb9f19ef1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8e31da08f4110c3c7dfb18e9758e180d"><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___h5_s.html#ga8e31da08f4110c3c7dfb18e9758e180d">H5Soffset_simple</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, const <a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> *offset)</td></tr>
|
|
<tr class="memdesc:ga8e31da08f4110c3c7dfb18e9758e180d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the offset of a simple dataspace. <br /></td></tr>
|
|
<tr class="separator:ga8e31da08f4110c3c7dfb18e9758e180d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga75b79e15e8fa3e591f7ab25a8624e690"><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___h5_s.html#ga75b79e15e8fa3e591f7ab25a8624e690">H5Ssel_iter_close</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> sel_iter_id)</td></tr>
|
|
<tr class="memdesc:ga75b79e15e8fa3e591f7ab25a8624e690"><td class="mdescLeft"> </td><td class="mdescRight">Closes a dataspace selection iterator. <br /></td></tr>
|
|
<tr class="separator:ga75b79e15e8fa3e591f7ab25a8624e690"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac73247e4ef206a47c8aa97dd2ff5febe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#gac73247e4ef206a47c8aa97dd2ff5febe">H5Ssel_iter_create</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid, size_t elmt_size, unsigned flags)</td></tr>
|
|
<tr class="memdesc:gac73247e4ef206a47c8aa97dd2ff5febe"><td class="mdescLeft"> </td><td class="mdescRight">Creates a dataspace selection iterator for a dataspace's selection. <br /></td></tr>
|
|
<tr class="separator:gac73247e4ef206a47c8aa97dd2ff5febe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga793fb6ff150f45d43e379995b5c0d297"><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___h5_s.html#ga793fb6ff150f45d43e379995b5c0d297">H5Ssel_iter_get_seq_list</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> sel_iter_id, size_t maxseq, size_t maxelmts, size_t *nseq, size_t *nelmts, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *off, size_t *len)</td></tr>
|
|
<tr class="memdesc:ga793fb6ff150f45d43e379995b5c0d297"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a list of offset / length sequences for the elements in an iterator. <br /></td></tr>
|
|
<tr class="separator:ga793fb6ff150f45d43e379995b5c0d297"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga411bbc06a31814bff9f476712c2a791c"><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___h5_s.html#ga411bbc06a31814bff9f476712c2a791c">H5Ssel_iter_reset</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> sel_iter_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td></tr>
|
|
<tr class="memdesc:ga411bbc06a31814bff9f476712c2a791c"><td class="mdescLeft"> </td><td class="mdescRight">Resets a dataspace selection iterator back to an initial state. <br /></td></tr>
|
|
<tr class="separator:ga411bbc06a31814bff9f476712c2a791c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga64f08c187b899f2728d4ac016d44f890"><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___h5_s.html#ga64f08c187b899f2728d4ac016d44f890">H5Sselect_adjust</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid, const <a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> *offset)</td></tr>
|
|
<tr class="memdesc:ga64f08c187b899f2728d4ac016d44f890"><td class="mdescLeft"> </td><td class="mdescRight">Adjusts a selection by subtracting an offset. <br /></td></tr>
|
|
<tr class="separator:ga64f08c187b899f2728d4ac016d44f890"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae183b79831506fd4b0c3ba9821eab33e"><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___h5_s.html#gae183b79831506fd4b0c3ba9821eab33e">H5Sselect_all</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid)</td></tr>
|
|
<tr class="memdesc:gae183b79831506fd4b0c3ba9821eab33e"><td class="mdescLeft"> </td><td class="mdescRight">Selects an entire dataspace. <br /></td></tr>
|
|
<tr class="separator:gae183b79831506fd4b0c3ba9821eab33e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga57e5eba2d1b282803835ba3f7e0b9bfa"><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___h5_s.html#ga57e5eba2d1b282803835ba3f7e0b9bfa">H5Sselect_copy</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_id)</td></tr>
|
|
<tr class="memdesc:ga57e5eba2d1b282803835ba3f7e0b9bfa"><td class="mdescLeft"> </td><td class="mdescRight">Copies a selection from one dataspace to another. <br /></td></tr>
|
|
<tr class="separator:ga57e5eba2d1b282803835ba3f7e0b9bfa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2f4407dd73d0ec37e5d9e80e4382483d"><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___h5_s.html#ga2f4407dd73d0ec37e5d9e80e4382483d">H5Sselect_elements</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0f">H5S_seloper_t</a> op, size_t num_elem, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *coord)</td></tr>
|
|
<tr class="memdesc:ga2f4407dd73d0ec37e5d9e80e4382483d"><td class="mdescLeft"> </td><td class="mdescRight">Selects array elements to be included in the selection for a dataspace. <br /></td></tr>
|
|
<tr class="separator:ga2f4407dd73d0ec37e5d9e80e4382483d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6adfdf1b95dc108a65bf66e97d38536d"><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___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d">H5Sselect_hyperslab</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0f">H5S_seloper_t</a> op, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> start[], const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> stride[], const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> count[], const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> block[])</td></tr>
|
|
<tr class="memdesc:ga6adfdf1b95dc108a65bf66e97d38536d"><td class="mdescLeft"> </td><td class="mdescRight">Selects a hyperslab region to add to the current selected region. <br /></td></tr>
|
|
<tr class="separator:ga6adfdf1b95dc108a65bf66e97d38536d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga51472bcb9af024675fba6294a6aefa5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#ga51472bcb9af024675fba6294a6aefa5e">H5Sselect_intersect_block</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *start, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *end)</td></tr>
|
|
<tr class="memdesc:ga51472bcb9af024675fba6294a6aefa5e"><td class="mdescLeft"> </td><td class="mdescRight">Checks if current selection intersects with a block. <br /></td></tr>
|
|
<tr class="separator:ga51472bcb9af024675fba6294a6aefa5e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac59773d4a0953cb2db0ed57a05699095"><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___h5_s.html#gac59773d4a0953cb2db0ed57a05699095">H5Sselect_none</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid)</td></tr>
|
|
<tr class="memdesc:gac59773d4a0953cb2db0ed57a05699095"><td class="mdescLeft"> </td><td class="mdescRight">Resets the selection region to include no elements. <br /></td></tr>
|
|
<tr class="separator:gac59773d4a0953cb2db0ed57a05699095"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1e914ba45afb15ded99a0afeaf124c04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#ga1e914ba45afb15ded99a0afeaf124c04">H5Sselect_project_intersection</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_space_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_space_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_intersect_space_id)</td></tr>
|
|
<tr class="memdesc:ga1e914ba45afb15ded99a0afeaf124c04"><td class="mdescLeft"> </td><td class="mdescRight">Projects the intersection of two source selections to a destination selection. <br /></td></tr>
|
|
<tr class="separator:ga1e914ba45afb15ded99a0afeaf124c04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafc6cafae877900ee060709eaa0b9b261"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#gafc6cafae877900ee060709eaa0b9b261">H5Sselect_shape_same</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space1_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space2_id)</td></tr>
|
|
<tr class="memdesc:gafc6cafae877900ee060709eaa0b9b261"><td class="mdescLeft"> </td><td class="mdescRight">Checks if two selections are the same shape. <br /></td></tr>
|
|
<tr class="separator:gafc6cafae877900ee060709eaa0b9b261"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1abfdec1248c262ca8791b5308e67d4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_s.html#ga1abfdec1248c262ca8791b5308e67d4b">H5Sselect_valid</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> spaceid)</td></tr>
|
|
<tr class="memdesc:ga1abfdec1248c262ca8791b5308e67d4b"><td class="mdescLeft"> </td><td class="mdescRight">Verifies that the selection is within the extent of the dataspace. <br /></td></tr>
|
|
<tr class="separator:ga1abfdec1248c262ca8791b5308e67d4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gacf8a5c48d7b7edb5ff73d9d02dbd073d"><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___h5_s.html#gacf8a5c48d7b7edb5ff73d9d02dbd073d">H5Sset_extent_none</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td></tr>
|
|
<tr class="memdesc:gacf8a5c48d7b7edb5ff73d9d02dbd073d"><td class="mdescLeft"> </td><td class="mdescRight">Resets the extent of a dataspace back to "none". <br /></td></tr>
|
|
<tr class="separator:gacf8a5c48d7b7edb5ff73d9d02dbd073d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf2526a41d2f4506e2c52098510517343"><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___h5_s.html#gaf2526a41d2f4506e2c52098510517343">H5Sset_extent_simple</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, int rank, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> dims[], const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> max[])</td></tr>
|
|
<tr class="memdesc:gaf2526a41d2f4506e2c52098510517343"><td class="mdescLeft"> </td><td class="mdescRight">Sets or resets the size of an existing dataspace. <br /></td></tr>
|
|
<tr class="separator:gaf2526a41d2f4506e2c52098510517343"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga82cf9f6af03ad89be21c36922e03baea"><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___h5_s.html#ga82cf9f6af03ad89be21c36922e03baea">H5Sencode1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, void *buf, size_t *nalloc)</td></tr>
|
|
<tr class="memdesc:ga82cf9f6af03ad89be21c36922e03baea"><td class="mdescLeft"> </td><td class="mdescRight">Encodes a data space object description into a binary buffer. <br /></td></tr>
|
|
<tr class="separator:ga82cf9f6af03ad89be21c36922e03baea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="ga35e289baf490229e233296929fbf5208" name="ga35e289baf490229e233296929fbf5208"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga35e289baf490229e233296929fbf5208">◆ </a></span>H5Sencode</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define H5Sencode   <a class="el" href="group___h5_s.html#ga178ec7b8769ad5704a170d9bd3421074">H5Sencode2</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p><a class="el" href="group___h5_s.html#ga35e289baf490229e233296929fbf5208">H5Sencode()</a> is a macro that is mapped to either <a class="el" href="group___h5_s.html#ga82cf9f6af03ad89be21c36922e03baea" title="Encodes a data space object description into a binary buffer.">H5Sencode1()</a> or <a class="el" href="group___h5_s.html#ga178ec7b8769ad5704a170d9bd3421074" title="Encodes a data space object description into a binary buffer.">H5Sencode2()</a>.<br />
|
|
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga2b53128a39c8f104c1c9c2a91590fcc1" name="ga2b53128a39c8f104c1c9c2a91590fcc1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga2b53128a39c8f104c1c9c2a91590fcc1">◆ </a></span>H5Sclose()</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> H5Sclose </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Releases and terminates access to a dataspace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier</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>
|
|
<p><a class="el" href="group___h5_s.html#ga2b53128a39c8f104c1c9c2a91590fcc1" title="Releases and terminates access to a dataspace.">H5Sclose()</a> releases a dataspace. Further access through the dataspace identifier is illegal. Failure to release a dataspace with this call will result in resource leaks.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine introduced in this release. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae7578a93bb7b22989bcb737f26b60ad1" name="gae7578a93bb7b22989bcb737f26b60ad1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae7578a93bb7b22989bcb737f26b60ad1">◆ </a></span>H5Scombine_hyperslab()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Scombine_hyperslab </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0f">H5S_seloper_t</a> </td>
|
|
<td class="paramname"><em>op</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>start</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>stride</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>count</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>block</em>[] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Performs an operation on a hyperslab and an existing selection and returns the resulting selection. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Operation to perform on the current selection </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>Offset of the start of of the hyperslab </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">stride</td><td>Hyperslab stride </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of blocks included in the hyperslab </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>Size of a block in the hyperslab</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a dataspace identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#gae7578a93bb7b22989bcb737f26b60ad1" title="Performs an operation on a hyperslab and an existing selection and returns the resulting selection.">H5Scombine_hyperslab()</a> combines a hyperslab selection specified by <code>start</code>, <code>stride</code>, <code>count</code> and <code>block</code> with the current selection for the dataspace <code>space_id</code>, creating a new dataspace to return the generated selection. If the current selection is not a hyperslab, it is freed and the hyperslab parameters passed in are combined with the <a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304a865473ae023d0ac257aeb9424f363e75">H5S_SEL_ALL</a> hyperslab (ie. a selection composing the entire current extent). If either <code>stride</code> or <code>block</code> is NULL, then it will be set to <code>1</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.10.6 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga356600d12d3cf0db53cc27b212d75b08" name="ga356600d12d3cf0db53cc27b212d75b08"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga356600d12d3cf0db53cc27b212d75b08">◆ </a></span>H5Scombine_select()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Scombine_select </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space1_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0f">H5S_seloper_t</a> </td>
|
|
<td class="paramname"><em>op</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space2_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Combine two hyperslab selections with an operation, returning a dataspace with the resulting selection. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space1_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Selection operator </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space2_id</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a dataspace identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#ga356600d12d3cf0db53cc27b212d75b08" title="Combine two hyperslab selections with an operation, returning a dataspace with the resulting selectio...">H5Scombine_select()</a> combines two hyperslab selections <code>space1_id</code> and <code>space2_id</code> with an operation, returning a new dataspace with the resulting selection. The dataspace extent from <code>space1_id</code> is copied for the dataspace extent of the newly created dataspace.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.10.6 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae5e26a8f8191768a600d40ec518ed66b" name="gae5e26a8f8191768a600d40ec518ed66b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae5e26a8f8191768a600d40ec518ed66b">◆ </a></span>H5Scopy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Scopy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates an exact copy of a dataspace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a dataspace identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#gae5e26a8f8191768a600d40ec518ed66b" title="Creates an exact copy of a dataspace.">H5Scopy()</a> creates a new dataspace which is an exact copy of the dataspace identified by <code>space_id</code>. The dataspace identifier returned from this function should be released with <a class="el" href="group___h5_s.html#ga2b53128a39c8f104c1c9c2a91590fcc1" title="Releases and terminates access to a dataspace.">H5Sclose()</a> or resource leaks will occur.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine introduced. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gabee514327cba34ca9951b24fa14fb083" name="gabee514327cba34ca9951b24fa14fb083"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gabee514327cba34ca9951b24fa14fb083">◆ </a></span>H5Screate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Screate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0a">H5S_class_t</a> </td>
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a new dataspace of a specified type. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type of dataspace to be created</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a dataspace identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#gabee514327cba34ca9951b24fa14fb083" title="Creates a new dataspace of a specified type.">H5Screate()</a> creates a new dataspace of a particular type. Currently supported types are <a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aaf6a34a2439db8aa7bb63ed0c4aaa5eb8">H5S_SCALAR</a>, <a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aac4ee937dcccfd99f885626983e7d2750">H5S_SIMPLE</a>, and <a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aa3d83ec70c1a824a2d821bf8464488bc5">H5S_NULL</a>.</p>
|
|
<p>Further dataspace types may be added later.</p>
|
|
<p>A scalar dataspace, <a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aaf6a34a2439db8aa7bb63ed0c4aaa5eb8">H5S_SCALAR</a>, has a single element, though that element may be of a complex datatype, such as a compound or array datatype. By convention, the rank of a scalar dataspace is always <code>0</code> (zero); think of it geometrically as a single, dimensionless point, though that point can be complex.</p>
|
|
<p>A simple dataspace, <a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aac4ee937dcccfd99f885626983e7d2750">H5S_SIMPLE</a>, consists of a regular array of elements.</p>
|
|
<p>A null dataspace, <a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aa3d83ec70c1a824a2d821bf8464488bc5">H5S_NULL</a>, has no data elements.</p>
|
|
<p>The dataspace identifier returned by this function can be released with <a class="el" href="group___h5_s.html#ga2b53128a39c8f104c1c9c2a91590fcc1" title="Releases and terminates access to a dataspace.">H5Sclose()</a> so that resource leaks will not occur.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine introduced. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8e35eea5738b4805856eac7d595254ae" name="ga8e35eea5738b4805856eac7d595254ae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8e35eea5738b4805856eac7d595254ae">◆ </a></span>H5Screate_simple()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Screate_simple </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>rank</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>dims</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>maxdims</em>[] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a new simple dataspace and opens it for access. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">rank</td><td>Number of dimensions of dataspace </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dims</td><td>Array specifying the size of each dimension </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">maxdims</td><td>Array specifying the maximum size of each dimension</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a dataspace identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#ga8e35eea5738b4805856eac7d595254ae" title="Creates a new simple dataspace and opens it for access.">H5Screate_simple()</a> creates a new simple dataspace and opens it for access, returning a dataspace identifier.</p>
|
|
<p><code>rank</code> is the number of dimensions used in the dataspace.</p>
|
|
<p><code>dims</code> is a one-dimensional array of size rank specifying the size of each dimension of the dataset. <code>maxdims</code> is an array of the same size specifying the upper limit on the size of each dimension.</p>
|
|
<p>Any element of <code>dims</code> can be <code>0</code> (zero). Note that no data can be written to a dataset if the size of any dimension of its current dataspace is <code>0</code>. This is sometimes a useful initial state for a dataset.</p>
|
|
<p><code>maxdims</code> may be the null pointer, in which case the upper limit is the same as <code>dims</code>. Otherwise, no element of <code>maxdims</code> should be smaller than the corresponding element of <code>dims</code>.</p>
|
|
<p>If an element of <code>maxdims</code> is <a class="el" href="_h5_spublic_8h.html#a5af9ab788797b2ea9a4843857674ac18">H5S_UNLIMITED</a>, the maximum size of the corresponding dimension is unlimited.</p>
|
|
<p>Any dataset with an unlimited dimension must also be chunked; see <a class="el" href="group___d_c_p_l.html#ga3584d592e377da3604b7604e266dcf5b" title="Sets the size of the chunks used to store a chunked layout dataset.">H5Pset_chunk()</a>. Similarly, a dataset must be chunked if <code>dims</code> does not equal <code>maxdims</code>.</p>
|
|
<p>The dataspace identifier returned from this function must be released with <a class="el" href="group___h5_s.html#ga2b53128a39c8f104c1c9c2a91590fcc1" title="Releases and terminates access to a dataspace.">H5Sclose()</a> or resource leaks will occur.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Once a dataspace has been created, specific regions or elements in the dataspace can be selected and selections can be removed, as well. For example, <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> selects a region in a dataspace and <a class="el" href="group___h5_s.html#ga2f4407dd73d0ec37e5d9e80e4382483d" title="Selects array elements to be included in the selection for a dataspace.">H5Sselect_elements()</a> selects array elements in a dataspace. These functions are used for subsetting. <a class="el" href="group___h5_s.html#gac59773d4a0953cb2db0ed57a05699095" title="Resets the selection region to include no elements.">H5Sselect_none()</a> removes all selections from a dataspace and is used in Parallel HDF5 when a process does not have or need to write data.</dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine introduced.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga0ac0ebd5f292460354f574476be49fad" name="ga0ac0ebd5f292460354f574476be49fad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga0ac0ebd5f292460354f574476be49fad">◆ </a></span>H5Sdecode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Sdecode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>buf</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Decodes a binary object description of data space and returns a new object handle. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Buffer for the data space object to be decoded</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a dataspace identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p>Given an object description of a dataspace in binary in a buffer, <a class="el" href="group___h5_s.html#ga0ac0ebd5f292460354f574476be49fad" title="Decodes a binary object description of data space and returns a new object handle.">H5Sdecode()</a> reconstructs the HDF5 data type object and returns a new object handle for it. The binary description of the object is encoded by <a class="el" href="group___h5_s.html#ga35e289baf490229e233296929fbf5208">H5Sencode()</a>. The user is responsible for passing in the right buffer. The types of dataspace addressed in this function are null, scalar, and simple space. For a simple dataspace, the selection information (for example, hyperslab selection) is also encoded and decoded. A complex dataspace has not been implemented in the library.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga82cf9f6af03ad89be21c36922e03baea" name="ga82cf9f6af03ad89be21c36922e03baea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga82cf9f6af03ad89be21c36922e03baea">◆ </a></span>H5Sencode1()</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> H5Sencode1 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>obj_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>buf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>nalloc</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Encodes a data space object description into a binary buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">buf</td><td>Buffer for the object to be encoded into; If the provided buffer is NULL, only the size of buffer needed is returned through <code>nalloc</code>. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">nalloc</td><td>The size of the allocated buffer</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="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000086">Deprecated:</a></b></dt><dd>Deprecated in favor of <a class="el" href="group___h5_s.html#ga178ec7b8769ad5704a170d9bd3421074" title="Encodes a data space object description into a binary buffer.">H5Sencode2()</a></dd></dl>
|
|
<p>Given the data space identifier <code>obj_id</code>, <a class="el" href="group___h5_s.html#ga82cf9f6af03ad89be21c36922e03baea" title="Encodes a data space object description into a binary buffer.">H5Sencode1()</a> converts a data space description into binary form in a buffer. Using this binary form in the buffer, a data space object can be reconstructed using <a class="el" href="group___h5_s.html#ga0ac0ebd5f292460354f574476be49fad" title="Decodes a binary object description of data space and returns a new object handle.">H5Sdecode()</a> to return a new object handle (<code>hid_t</code>) for this data space.</p>
|
|
<p>A preliminary <a class="el" href="group___h5_s.html#ga82cf9f6af03ad89be21c36922e03baea" title="Encodes a data space object description into a binary buffer.">H5Sencode1()</a> call can be made to find out the size of the buffer needed. This value is returned as <code>nalloc</code>. That value can then be assigned to <code>nalloc</code> for a second <a class="el" href="group___h5_s.html#ga82cf9f6af03ad89be21c36922e03baea" title="Encodes a data space object description into a binary buffer.">H5Sencode1()</a> call, which will retrieve the actual encoded object.</p>
|
|
<p>If the library finds out <code>nalloc</code> is not big enough for the object, it simply returns the size of the buffer needed through <code>nalloc</code> without encoding the provided buffer.</p>
|
|
<p>The types of data space addressed in this function are null, scalar, and simple space. For a simple data space, the information on the selection, for example, hyperslab selection, is also encoded and decoded. A complex data space has not been implemented in the library.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.12.0 The function <a class="el" href="group___h5_s.html#ga35e289baf490229e233296929fbf5208">H5Sencode()</a> was renamed <a class="el" href="group___h5_s.html#ga82cf9f6af03ad89be21c36922e03baea" title="Encodes a data space object description into a binary buffer.">H5Sencode1()</a> and deprecated. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga178ec7b8769ad5704a170d9bd3421074" name="ga178ec7b8769ad5704a170d9bd3421074"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga178ec7b8769ad5704a170d9bd3421074">◆ </a></span>H5Sencode2()</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> H5Sencode2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>obj_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>buf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>nalloc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>fapl</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Encodes a data space object description into a binary buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">buf</td><td>Buffer for the object to be encoded into; If the provided buffer is NULL, only the size of buffer needed is returned through <code>nalloc</code>. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">nalloc</td><td>The size of the allocated buffer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">fapl</td><td>File access property list identifier</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>
|
|
<p>Given the data space identifier <code>obj_id</code>, <a class="el" href="group___h5_s.html#ga178ec7b8769ad5704a170d9bd3421074" title="Encodes a data space object description into a binary buffer.">H5Sencode2()</a> converts a data space description into binary form in a buffer. Using this binary form in the buffer, a data space object can be reconstructed with <a class="el" href="group___h5_s.html#ga0ac0ebd5f292460354f574476be49fad" title="Decodes a binary object description of data space and returns a new object handle.">H5Sdecode()</a> to return a new object handle (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>) for this data space.</p>
|
|
<p>A preliminary <a class="el" href="group___h5_s.html#ga178ec7b8769ad5704a170d9bd3421074" title="Encodes a data space object description into a binary buffer.">H5Sencode2()</a> call can be made to determine the size of the buffer needed. This value is returned in <code>nalloc</code>. That value can then be assigned to <code>nalloc</code> for a second <a class="el" href="group___h5_s.html#ga178ec7b8769ad5704a170d9bd3421074" title="Encodes a data space object description into a binary buffer.">H5Sencode2()</a> call, which will retrieve the actual encoded object.</p>
|
|
<p>If the library determines that <code>nalloc</code> is not big enough for the object, it simply returns the size of the buffer needed through <code>nalloc</code> without encoding the provided buffer.</p>
|
|
<p>The file access property list <code>fapl_id</code> is used to control the encoding via the <em>libver_bounds</em> property (see <a class="el" href="group___f_a_p_l.html#gacbe1724e7f70cd17ed687417a1d2a910" title="Controls the range of library release versions used when creating objects in a file.">H5Pset_libver_bounds()</a>). If the <em>libver_bounds</em> property is missing, <a class="el" href="group___h5_s.html#ga178ec7b8769ad5704a170d9bd3421074" title="Encodes a data space object description into a binary buffer.">H5Sencode2()</a> proceeds as if the <em>libver_bounds</em> property were set to (<a class="el" href="_h5_fpublic_8h.html#a2d963b599894f684571fbd4d5e8a96a2abed98059b4a02d048b1eb3985fba5fa1">H5F_LIBVER_EARLIEST</a>, <a class="el" href="_h5_fpublic_8h.html#a47d050173da48a2b85c730446f0771c0">H5F_LIBVER_LATEST</a>). (Functionally, <a class="el" href="group___h5_s.html#ga82cf9f6af03ad89be21c36922e03baea" title="Encodes a data space object description into a binary buffer.">H5Sencode1()</a> is identical to <a class="el" href="group___h5_s.html#ga178ec7b8769ad5704a170d9bd3421074" title="Encodes a data space object description into a binary buffer.">H5Sencode2()</a> with <em>libver_bounds</em> set to (<a class="el" href="_h5_fpublic_8h.html#a2d963b599894f684571fbd4d5e8a96a2abed98059b4a02d048b1eb3985fba5fa1">H5F_LIBVER_EARLIEST</a>, <a class="el" href="_h5_fpublic_8h.html#a47d050173da48a2b85c730446f0771c0">H5F_LIBVER_LATEST</a>).)</p>
|
|
<p>The types of data space that are addressed in this function are null, scalar, and simple space. For a simple data space, the information on the selection, for example, hyperslab selection, is also encoded and decoded. A complex data space has not been implemented in the library.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Motivation: This function was introduced in HDF5-1.12 as part of the <a class="el" href="group___h5_s.html#ga35e289baf490229e233296929fbf5208">H5Sencode()</a> format change to enable 64-bit selection encodings and a dataspace selection that is tied to a file. See the <a href="https://support.hdfgroup.org/releases/hdf5/documentation/release_specifics/new_features_1_12.md">New Features in HDF5 Release 1.12</a> as well as the <a href="https://support.hdfgroup.org/releases/hdf5/documentation/rfc/H5Sencode_format.docx.pdf">RFC H5Sencode() / H5Sdecode() Format Change</a>.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga0eae5447eaabaa9444fac0464cd1b8d5" name="ga0eae5447eaabaa9444fac0464cd1b8d5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga0eae5447eaabaa9444fac0464cd1b8d5">◆ </a></span>H5Sextent_copy()</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> H5Sextent_copy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>dst_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>src_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copies the extent of a dataspace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dst_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">src_id</td><td>Dataspace identifier</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>
|
|
<p><a class="el" href="group___h5_s.html#ga0eae5447eaabaa9444fac0464cd1b8d5" title="Copies the extent of a dataspace.">H5Sextent_copy()</a> copies the extent from <code>src_id</code> to <code>dst_id</code>. This action may change the type of the dataspace.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine was introduced. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae58bca0c154ceaed9ad36c58c78e145c" name="gae58bca0c154ceaed9ad36c58c78e145c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae58bca0c154ceaed9ad36c58c78e145c">◆ </a></span>H5Sextent_equal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Sextent_equal </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space1_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space2_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines whether two dataspace extents are equal. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space1_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space2_id</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#gae58bca0c154ceaed9ad36c58c78e145c" title="Determines whether two dataspace extents are equal.">H5Sextent_equal()</a> determines whether the dataspace extents of two dataspaces, <code>space1_id</code> and <code>space2_id</code>, are equal.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gabc974bbc041538a1d3032729df2ddfc0" name="gabc974bbc041538a1d3032729df2ddfc0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gabc974bbc041538a1d3032729df2ddfc0">◆ </a></span>H5Sget_regular_hyperslab()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Sget_regular_hyperslab </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>start</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>stride</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>count</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>block</em>[] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves a regular hyperslab selection. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">start</td><td>Offset of the start of the regular hyperslab </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">stride</td><td>Stride of the regular hyperslab </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">count</td><td>Number of blocks in the regular hyperslab </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">block</td><td>Size of a block in the regular hyperslab</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>
|
|
<p><a class="el" href="group___h5_s.html#gabc974bbc041538a1d3032729df2ddfc0" title="Retrieves a regular hyperslab selection.">H5Sget_regular_hyperslab()</a> takes the dataspace identifier, <code>spaceid</code>, and retrieves the values of <code>start</code>, <code>stride</code>, <code>count</code>, and <code>block</code> for the regular hyperslab selection.</p>
|
|
<p>A regular hyperslab selection is a hyperslab selection described by setting the <code>offset</code>, <code>stride</code>, <code>count</code>, and <code>block</code> parameters to the <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> call. If several calls to <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> are needed, the hyperslab selection is irregular.</p>
|
|
<p>See <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> for descriptions of <code>offset</code>, <code>stride</code>, <code>count</code>, and <code>block</code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>If a hyperslab selection is originally regular, then becomes irregular through selection operations, and then becomes regular again, the final regular selection may be equivalent but not identical to the original regular selection.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga645591ec939b89732c10efd5867a6205" name="ga645591ec939b89732c10efd5867a6205"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga645591ec939b89732c10efd5867a6205">◆ </a></span>H5Sget_select_bounds()</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> H5Sget_select_bounds </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>start</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>end</em>[] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the bounding box containing the current selection. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">start</td><td>Starting coordinates of the bounding box </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">end</td><td>Ending coordinates of the bounding box, i.e., the coordinates of the diagonally opposite corner</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>
|
|
<p><a class="el" href="group___h5_s.html#ga645591ec939b89732c10efd5867a6205" title="Gets the bounding box containing the current selection.">H5Sget_select_bounds()</a> retrieves the coordinates of the bounding box containing the current selection and places them into user-supplied buffers.</p>
|
|
<p>The <code>start</code> and <code>end</code> buffers must be large enough to hold the dataspace rank number of coordinates.</p>
|
|
<p>The bounding box exactly contains the selection. I.e., if a 2-dimensional element selection is currently defined as containing the points (4,5), (6,8), and (10,7), then the bounding box will be (4, 5), (10, 8).</p>
|
|
<p>The bounding box calculation includes the current offset of the selection within the dataspace extent.</p>
|
|
<p>Calling this function on a <em>none</em> selection will fail.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.6.0 The <code>start</code> and <code>end</code> parameters have changed from type <code>hsize_t</code> * to <code>hssize_t</code> *. </dd>
|
|
<dd>
|
|
1.4.0 Fortran subroutine was introduced. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga217b839584cd7c7995b47fc30fe92f4c" name="ga217b839584cd7c7995b47fc30fe92f4c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga217b839584cd7c7995b47fc30fe92f4c">◆ </a></span>H5Sget_select_elem_npoints()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> H5Sget_select_elem_npoints </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the number of element points in the current selection. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the number of element points in the current dataspace selection if successful. Otherwise returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#ga217b839584cd7c7995b47fc30fe92f4c" title="Gets the number of element points in the current selection.">H5Sget_select_elem_npoints()</a> returns the number of element points in the current dataspace selection, so that the element points can be retrieved with <a class="el" href="group___h5_s.html#ga61459c488147254d1d06537a9ab6e2d4" title="Gets the list of element points currently selected.">H5Sget_select_elem_pointlist()</a>. (This is similar to the way that <a class="el" href="group___h5_s.html#gad873b2f3b82ee8c426c26ceeb1c67f86" title="Get number of hyperslab blocks.">H5Sget_select_hyper_nblocks()</a> and <a class="el" href="group___h5_s.html#ga8534829a8db2eca8e987bb9fe8a3d628" title="Gets the list of hyperslab blocks currently selected.">H5Sget_select_hyper_blocklist()</a> work with hyperslab selections.)</p>
|
|
<p>Coincidentally, <a class="el" href="group___h5_s.html#ga1a44dde97206f40f366f99d9c39b6046" title="Determines the number of elements in a dataspace selection.">H5Sget_select_npoints()</a> and <a class="el" href="group___h5_s.html#ga217b839584cd7c7995b47fc30fe92f4c" title="Gets the number of element points in the current selection.">H5Sget_select_elem_npoints()</a> will always return the same value when an element selection is queried, but <a class="el" href="group___h5_s.html#ga217b839584cd7c7995b47fc30fe92f4c" title="Gets the number of element points in the current selection.">H5Sget_select_elem_npoints()</a> does not work with other selection types.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga61459c488147254d1d06537a9ab6e2d4" name="ga61459c488147254d1d06537a9ab6e2d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga61459c488147254d1d06537a9ab6e2d4">◆ </a></span>H5Sget_select_elem_pointlist()</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> H5Sget_select_elem_pointlist </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>startpoint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>numpoints</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>buf</em>[] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the list of element points currently selected. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">startpoint</td><td>Element point to start with </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">numpoints</td><td>Number of element points to get </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>List of element points selected</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>
|
|
<p><a class="el" href="group___h5_s.html#ga61459c488147254d1d06537a9ab6e2d4" title="Gets the list of element points currently selected.">H5Sget_select_elem_pointlist()</a> returns the list of element points in the current dataspace selection <code>space_id</code>. Starting with the <code>startpoint</code> in the list of points, <code>numpoints</code> points are put into the user's buffer. If the user's buffer fills up before <code>numpoints</code> points are inserted, the buffer will contain only as many points as fit.</p>
|
|
<p>The element point coordinates have the same dimensionality (rank) as the dataspace they are located within. The list of element points is formatted as follows:<br />
|
|
<coordinate>, followed by<br />
|
|
the next coordinate,<br />
|
|
etc.<br />
|
|
until all of the selected element points have been listed.</p>
|
|
<p>The points are returned in the order they will be iterated through when the selection is read/written from/to disk.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8534829a8db2eca8e987bb9fe8a3d628" name="ga8534829a8db2eca8e987bb9fe8a3d628"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8534829a8db2eca8e987bb9fe8a3d628">◆ </a></span>H5Sget_select_hyper_blocklist()</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> H5Sget_select_hyper_blocklist </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>startblock</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>numblocks</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>buf</em>[] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the list of hyperslab blocks currently selected. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">startblock</td><td>Hyperslab block to start with </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">numblocks</td><td>Number of hyperslab blocks to get </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>List of hyperslab blocks selected</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>
|
|
<p><a class="el" href="group___h5_s.html#ga8534829a8db2eca8e987bb9fe8a3d628" title="Gets the list of hyperslab blocks currently selected.">H5Sget_select_hyper_blocklist()</a> returns a list of the hyperslab blocks currently selected. Starting with the <code>startblock-th</code> block in the list of blocks, <code>numblocks</code> blocks are put into the user's buffer. If the user's buffer fills up before <code>numblocks</code> blocks are inserted, the buffer will contain only as many blocks as fit.</p>
|
|
<p>The block coordinates have the same dimensionality (rank) as the dataspace they are located within. The list of blocks is formatted as follows:<br />
|
|
<"start" coordinate>, immediately followed by<br />
|
|
<"opposite" corner coordinate>, followed by<br />
|
|
the next "start" and "opposite" coordinates,<br />
|
|
etc. until all of the selected blocks have been listed.<br />
|
|
No guarantee of any order of the blocks is implied.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gad873b2f3b82ee8c426c26ceeb1c67f86" name="gad873b2f3b82ee8c426c26ceeb1c67f86"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad873b2f3b82ee8c426c26ceeb1c67f86">◆ </a></span>H5Sget_select_hyper_nblocks()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> H5Sget_select_hyper_nblocks </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get number of hyperslab blocks. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the number of hyperslab blocks in the current dataspace selection if successful. Otherwise returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#gad873b2f3b82ee8c426c26ceeb1c67f86" title="Get number of hyperslab blocks.">H5Sget_select_hyper_nblocks()</a> returns the number of hyperslab blocks in the current dataspace selection.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1a44dde97206f40f366f99d9c39b6046" name="ga1a44dde97206f40f366f99d9c39b6046"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1a44dde97206f40f366f99d9c39b6046">◆ </a></span>H5Sget_select_npoints()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> H5Sget_select_npoints </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines the number of elements in a dataspace selection. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the number of elements in the selection if successful; otherwise returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#ga1a44dde97206f40f366f99d9c39b6046" title="Determines the number of elements in a dataspace selection.">H5Sget_select_npoints()</a> determines the number of elements in the current selection of a dataspace. It works with any selection type, and is the correct way to retrieve the number of elements in a selection.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine introduced in this release. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga51ae555e5b2492d95c7fefab2e0d5018" name="ga51ae555e5b2492d95c7fefab2e0d5018"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga51ae555e5b2492d95c7fefab2e0d5018">◆ </a></span>H5Sget_select_type()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304">H5S_sel_type</a> H5Sget_select_type </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines the type of the dataspace selection. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the dataspace selection type, a value of the enumerated datatype <a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304">H5S_sel_type</a>, if successful.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#ga51ae555e5b2492d95c7fefab2e0d5018" title="Determines the type of the dataspace selection.">H5Sget_select_type()</a> retrieves the type of dataspace selection currently defined for the dataspace <code>space_id</code>. Valid values for the dataspace selection type are:</p>
|
|
<table class="doxtable">
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304a32f16dbbc97e97e62e566547a02e0959">H5S_SEL_NONE</a> </td><td>No selection is defined </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304a858daf05b19591a8f5d6ffbee281f81c">H5S_SEL_POINTS</a> </td><td>A sequence of points is selected </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304aeb9dc925cd7c6a6702fc9c766e20b01a">H5S_SEL_HYPERSLABS</a> </td><td>A hyperslab or compound hyperslab is selected </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304a865473ae023d0ac257aeb9424f363e75">H5S_SEL_ALL</a> </td><td>The entire dataset is selected </td></tr>
|
|
</table>
|
|
<p>Otherwise returns a negative value.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac494409b615d8e67c5edd9eb2848b2f3" name="gac494409b615d8e67c5edd9eb2848b2f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac494409b615d8e67c5edd9eb2848b2f3">◆ </a></span>H5Sget_simple_extent_dims()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int H5Sget_simple_extent_dims </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>dims</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>maxdims</em>[] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves dataspace dimension size and maximum size. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">dims</td><td>Pointer to array to store the size of each dimension </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">maxdims</td><td>Pointer to array to store the maximum size of each dimension</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#gac494409b615d8e67c5edd9eb2848b2f3" title="Retrieves dataspace dimension size and maximum size.">H5Sget_simple_extent_dims()</a> returns the size and maximum sizes of each dimension of a dataspace <code>space_id</code> through the <code>dims</code> and <code>maxdims</code> parameters.</p>
|
|
<p>Either or both of <code>dims</code> and <code>maxdims</code> may be NULL.</p>
|
|
<p>If a value in the returned array <code>maxdims</code> is <a class="el" href="_h5_spublic_8h.html#a5af9ab788797b2ea9a4843857674ac18">H5S_UNLIMITED</a> (-1), the maximum size of that dimension is unlimited.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine introduced. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae5282a81692b80b5b19dd12d05b9b28e" name="gae5282a81692b80b5b19dd12d05b9b28e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae5282a81692b80b5b19dd12d05b9b28e">◆ </a></span>H5Sget_simple_extent_ndims()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int H5Sget_simple_extent_ndims </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines the dimensionality of a dataspace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#gae5282a81692b80b5b19dd12d05b9b28e" title="Determines the dimensionality of a dataspace.">H5Sget_simple_extent_ndims()</a> determines the dimensionality (or rank) of a dataspace.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine introduced. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9d369fe1e01a95710d320bc5fd32cf83" name="ga9d369fe1e01a95710d320bc5fd32cf83"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9d369fe1e01a95710d320bc5fd32cf83">◆ </a></span>H5Sget_simple_extent_npoints()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> H5Sget_simple_extent_npoints </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines the number of elements in a dataspace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the number of elements in the dataspace if successful; otherwise returns a negative value.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#ga9d369fe1e01a95710d320bc5fd32cf83" title="Determines the number of elements in a dataspace.">H5Sget_simple_extent_npoints()</a> determines the number of elements in a dataspace <code>space_id</code>. For example, a simple 3-dimensional dataspace with dimensions 2, 3, and 4 would have 24 elements.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine introduced. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf63af02b385e80c8c10b1c43763c251f" name="gaf63af02b385e80c8c10b1c43763c251f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf63af02b385e80c8c10b1c43763c251f">◆ </a></span>H5Sget_simple_extent_type()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0a">H5S_class_t</a> H5Sget_simple_extent_type </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines the current class of a dataspace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a dataspace class name if successful; otherwise <a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aadab1657d08941e24b5e6d83ca18ecb50">H5S_NO_CLASS</a> (-1).</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#gaf63af02b385e80c8c10b1c43763c251f" title="Determines the current class of a dataspace.">H5Sget_simple_extent_type()</a> determines the current class of a dataspace <code>space_id</code>.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine was introduced. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8a5bc33fae4be442093329f2cfec3f49" name="ga8a5bc33fae4be442093329f2cfec3f49"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8a5bc33fae4be442093329f2cfec3f49">◆ </a></span>H5Sis_regular_hyperslab()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Sis_regular_hyperslab </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines if a hyperslab selection is regular. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#ga8a5bc33fae4be442093329f2cfec3f49" title="Determines if a hyperslab selection is regular.">H5Sis_regular_hyperslab()</a> takes the dataspace identifier, <code>spaceid</code>, and queries the type of the hyperslab selection.</p>
|
|
<p>A regular hyperslab selection is a hyperslab selection described by setting the offset, stride, count, and block parameters for a single <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> call. If several calls to <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> are needed, then the hyperslab selection is irregular.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab0b1560f7c8402986f332522e2adae1d" name="gab0b1560f7c8402986f332522e2adae1d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab0b1560f7c8402986f332522e2adae1d">◆ </a></span>H5Sis_simple()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Sis_simple </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines whether a dataspace is a simple dataspace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#gab0b1560f7c8402986f332522e2adae1d" title="Determines whether a dataspace is a simple dataspace.">H5Sis_simple()</a> determines whether or not a dataspace is a simple dataspace.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Currently, all dataspace objects are simple dataspaces; complex dataspace support will be added in the future.</dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine was introduced. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga0ccb190f72fe41a927407ffb9f19ef1b" name="ga0ccb190f72fe41a927407ffb9f19ef1b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga0ccb190f72fe41a927407ffb9f19ef1b">◆ </a></span>H5Smodify_select()</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> H5Smodify_select </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space1_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0f">H5S_seloper_t</a> </td>
|
|
<td class="paramname"><em>op</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space2_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Refines a hyperslab selection with an operation, using a second hyperslab to modify it. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space1_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Selection operator </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space2_id</td><td>Dataspace identifier</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>
|
|
<p><a class="el" href="group___h5_s.html#ga0ccb190f72fe41a927407ffb9f19ef1b" title="Refines a hyperslab selection with an operation, using a second hyperslab to modify it.">H5Smodify_select()</a> refines an existing hyperslab selection <code>space1_id</code> with an operation <code>op</code>, using a second hyperslab <code>space2_id</code>. The first selection is modified to contain the result of <code>space1_id</code> operated on by <code>space2_id</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.10.6 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8e31da08f4110c3c7dfb18e9758e180d" name="ga8e31da08f4110c3c7dfb18e9758e180d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8e31da08f4110c3c7dfb18e9758e180d">◆ </a></span>H5Soffset_simple()</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> H5Soffset_simple </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> * </td>
|
|
<td class="paramname"><em>offset</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the offset of a simple dataspace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The offset at which to position the selection</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>
|
|
<p><a class="el" href="group___h5_s.html#ga8e31da08f4110c3c7dfb18e9758e180d" title="Sets the offset of a simple dataspace.">H5Soffset_simple()</a> sets the offset of a simple dataspace <code>space_id</code>. The offset array must be the same number of elements as the number of dimensions for the dataspace. If the <code>offset</code> array is set to NULL, the offset for the dataspace is reset to 0 in all dimensions.</p>
|
|
<p>This function allows the same shaped selection to be moved to different locations within a dataspace without requiring it to be redefined.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Until 1.14.4, setting the offset parameter to NULL was considered an error, despite the reference manual stating that it had the behavior described above.</dd></dl>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine was introduced. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga75b79e15e8fa3e591f7ab25a8624e690" name="ga75b79e15e8fa3e591f7ab25a8624e690"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga75b79e15e8fa3e591f7ab25a8624e690">◆ </a></span>H5Ssel_iter_close()</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> H5Ssel_iter_close </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>sel_iter_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Closes a dataspace selection iterator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">sel_iter_id</td><td>Identifier of the dataspace selection iterator</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>
|
|
<p><a class="el" href="group___h5_s.html#ga75b79e15e8fa3e591f7ab25a8624e690" title="Closes a dataspace selection iterator.">H5Ssel_iter_close()</a> closes a dataspace selection iterator specified by <code>sel_iter_id</code>, releasing its state.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac73247e4ef206a47c8aa97dd2ff5febe" name="gac73247e4ef206a47c8aa97dd2ff5febe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac73247e4ef206a47c8aa97dd2ff5febe">◆ </a></span>H5Ssel_iter_create()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Ssel_iter_create </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>elmt_size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned </td>
|
|
<td class="paramname"><em>flags</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a dataspace selection iterator for a dataspace's selection. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">elmt_size</td><td>Size of element in the selection </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Selection iterator flag, valid values are: <ul>
|
|
<li><a class="el" href="_h5_spublic_8h.html#a6d17cb15354aaa5d6a16f66158e6eb1f">H5S_SEL_ITER_GET_SEQ_LIST_SORTED</a> </li>
|
|
<li><a class="el" href="_h5_spublic_8h.html#ac8e372b854ca8250c47f316428af3d1f">H5S_SEL_ITER_SHARE_WITH_DATASPACE</a> </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a valid dataspace selection iterator identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#gac73247e4ef206a47c8aa97dd2ff5febe" title="Creates a dataspace selection iterator for a dataspace's selection.">H5Ssel_iter_create()</a> creates a selection iterator and initializes it to start at the first element selected in the dataspace.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga793fb6ff150f45d43e379995b5c0d297" name="ga793fb6ff150f45d43e379995b5c0d297"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga793fb6ff150f45d43e379995b5c0d297">◆ </a></span>H5Ssel_iter_get_seq_list()</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> H5Ssel_iter_get_seq_list </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>sel_iter_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>maxseq</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>maxelmts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>nseq</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>nelmts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> * </td>
|
|
<td class="paramname"><em>off</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves a list of offset / length sequences for the elements in an iterator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">sel_iter_id</td><td>Identifier of the dataspace selection iterator </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">maxseq</td><td>Maximum number of sequences to retrieve </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">maxelmts</td><td>Maximum number of elements to retrieve in sequences </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">nseq</td><td>Number of sequences retrieved </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">nelmts</td><td>Number of elements retrieved, in all sequences </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">off</td><td>Array of sequence offsets </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">len</td><td>Array of sequence lengths</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>
|
|
<p><a class="el" href="group___h5_s.html#ga793fb6ff150f45d43e379995b5c0d297" title="Retrieves a list of offset / length sequences for the elements in an iterator.">H5Ssel_iter_get_seq_list()</a> retrieves a list of offset / length pairs (a list of "sequences") matching the selected elements for an iterator <code>sel_iter_id</code>, according to the iteration order for the iterator. The lengths returned are in bytes, not elements.</p>
|
|
<p>Note that the iteration order for "all" and "hyperslab" selections is row-major (i.e. "C-ordered"), but the iteration order for "point" selections is "in order selected", unless the <a class="el" href="_h5_spublic_8h.html#a6d17cb15354aaa5d6a16f66158e6eb1f">H5S_SEL_ITER_GET_SEQ_LIST_SORTED</a> flag is passed to <a class="el" href="group___h5_s.html#gac73247e4ef206a47c8aa97dd2ff5febe" title="Creates a dataspace selection iterator for a dataspace's selection.">H5Ssel_iter_create()</a> for a point selection.</p>
|
|
<p><code>maxseq</code> and <code>maxelmts</code> specify the most sequences or elements possible to place into the <code>off</code> and <code>len</code> arrays. <code>nseq</code> and <code>nelmts</code> return the actual number of sequences and elements put into the arrays.</p>
|
|
<p>Each call to <a class="el" href="group___h5_s.html#ga793fb6ff150f45d43e379995b5c0d297" title="Retrieves a list of offset / length sequences for the elements in an iterator.">H5Ssel_iter_get_seq_list()</a> will retrieve the next set of sequences for the selection being iterated over.</p>
|
|
<p>The total number of bytes possible to retrieve from a selection iterator is the <code>elmt_size</code> passed to <a class="el" href="group___h5_s.html#gac73247e4ef206a47c8aa97dd2ff5febe" title="Creates a dataspace selection iterator for a dataspace's selection.">H5Ssel_iter_create()</a> multiplied by the number of elements selected in the dataspace the iterator was created from (which can be retrieved with <a class="el" href="group___h5_s.html#ga1a44dde97206f40f366f99d9c39b6046" title="Determines the number of elements in a dataspace selection.">H5Sget_select_npoints()</a>. When there are no further sequences of elements to retrieve, calls to this routine will set <code>nseq</code> and <code>nelmts</code> to zero.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga411bbc06a31814bff9f476712c2a791c" name="ga411bbc06a31814bff9f476712c2a791c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga411bbc06a31814bff9f476712c2a791c">◆ </a></span>H5Ssel_iter_reset()</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> H5Ssel_iter_reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>sel_iter_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resets a dataspace selection iterator back to an initial state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">sel_iter_id</td><td>Identifier of the dataspace selection iterator to reset </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Identifier of the dataspace with selection to iterate over</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>
|
|
<p><a class="el" href="group___h5_s.html#ga411bbc06a31814bff9f476712c2a791c" title="Resets a dataspace selection iterator back to an initial state.">H5Ssel_iter_reset()</a> resets a dataspace selection iterator back to an initial state so that the iterator may be used for iteration once again.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.12.1 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga64f08c187b899f2728d4ac016d44f890" name="ga64f08c187b899f2728d4ac016d44f890"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga64f08c187b899f2728d4ac016d44f890">◆ </a></span>H5Sselect_adjust()</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> H5Sselect_adjust </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7d9d4293176a8d7535ea6d4038235280">hssize_t</a> * </td>
|
|
<td class="paramname"><em>offset</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adjusts a selection by subtracting an offset. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Offset to subtract</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>
|
|
<p><a class="el" href="group___h5_s.html#ga64f08c187b899f2728d4ac016d44f890" title="Adjusts a selection by subtracting an offset.">H5Sselect_adjust()</a> shifts a dataspace selection by a specified logical offset within the dataspace extent.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>This can be useful for VOL developers to implement chunked datasets.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.10.6 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae183b79831506fd4b0c3ba9821eab33e" name="gae183b79831506fd4b0c3ba9821eab33e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae183b79831506fd4b0c3ba9821eab33e">◆ </a></span>H5Sselect_all()</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> H5Sselect_all </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Selects an entire dataspace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier</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>
|
|
<p><a class="el" href="group___h5_s.html#gae183b79831506fd4b0c3ba9821eab33e" title="Selects an entire dataspace.">H5Sselect_all()</a> selects the entire extent of the dataspace <code>dspace_id</code>.</p>
|
|
<p>More specifically, <a class="el" href="group___h5_s.html#gae183b79831506fd4b0c3ba9821eab33e" title="Selects an entire dataspace.">H5Sselect_all()</a> sets the selection type to <a class="el" href="_h5_spublic_8h.html#a1e9590539381e3922a1582067d496304a865473ae023d0ac257aeb9424f363e75">H5S_SEL_ALL</a>, which specifies the entire dataspace anywhere it is applied.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga57e5eba2d1b282803835ba3f7e0b9bfa" name="ga57e5eba2d1b282803835ba3f7e0b9bfa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga57e5eba2d1b282803835ba3f7e0b9bfa">◆ </a></span>H5Sselect_copy()</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> H5Sselect_copy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>dst_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>src_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copies a selection from one dataspace to another. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dst_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">src_id</td><td>Dataspace identifier</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>
|
|
<p><a class="el" href="group___h5_s.html#ga57e5eba2d1b282803835ba3f7e0b9bfa" title="Copies a selection from one dataspace to another.">H5Sselect_copy()</a> copies all selection information (including offset) from the source dataspace <code>src_id</code> to the destination dataspace <code>dst_id</code>.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.10.6 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga2f4407dd73d0ec37e5d9e80e4382483d" name="ga2f4407dd73d0ec37e5d9e80e4382483d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga2f4407dd73d0ec37e5d9e80e4382483d">◆ </a></span>H5Sselect_elements()</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> H5Sselect_elements </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0f">H5S_seloper_t</a> </td>
|
|
<td class="paramname"><em>op</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>num_elem</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> * </td>
|
|
<td class="paramname"><em>coord</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Selects array elements to be included in the selection for a dataspace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Operator specifying how the new selection is to be combined with the existing selection for the dataspace </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">num_elem</td><td>Number of elements to be selected </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">coord</td><td>A pointer to a buffer containing a serialized copy of a 2-dimensional array of zero-based values specifying the coordinates of the elements in the point selection</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>
|
|
<p><a class="el" href="group___h5_s.html#ga2f4407dd73d0ec37e5d9e80e4382483d" title="Selects array elements to be included in the selection for a dataspace.">H5Sselect_elements()</a> selects array elements to be included in the selection for the <code>space_id</code> dataspace. This is referred to as a point selection.</p>
|
|
<p>The number of elements selected is set in the <code>num_elements</code> parameter.</p>
|
|
<p>The <code>coord</code> parameter is a pointer to a buffer containing a serialized 2-dimensional array of size <code>num_elements</code> by the rank of the dataspace. The array lists dataset elements in the point selection; that is, it's a list of zero-based values specifying the coordinates in the dataset of the selected elements. The order of the element coordinates in the <code>coord</code> array specifies the order in which the array elements are iterated through when I/O is performed. Duplicate coordinate locations are not checked for. See below for examples of the mapping between the serialized contents of the buffer and the point selection array that it represents.</p>
|
|
<p>The selection operator <code>op</code> determines how the new selection is to be combined with the previously existing selection for the dataspace. The following operators are supported:</p>
|
|
<table class="doxtable">
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0fab90faf3dc59ecf6f28197ef471141550">H5S_SELECT_SET</a> </td><td>Replaces the existing selection with the parameters from this call. Overlapping blocks are not supported with this operator. Adds the new selection to the existing selection. </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0fa53c72a22af9e1ad85b53d7d358f4d8ea">H5S_SELECT_APPEND</a> </td><td>Adds the new selection following the last element of the existing selection. </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0fab74102138c99d0aa670dc575602f7208">H5S_SELECT_PREPEND</a> </td><td>Adds the new selection preceding the first element of the existing selection. </td></tr>
|
|
</table>
|
|
<p><b>Mapping the serialized <code>coord</code> buffer to a 2-dimensional point selection array:</b> To illustrate the construction of the contents of the <code>coord</code> buffer, consider two simple examples: a selection of 5 points in a 1-dimensional array and a selection of 3 points in a 4-dimensional array.</p>
|
|
<p>In the 1D case, we will be selecting five points and a 1D dataspace has rank 1, so the selection will be described in a 5-by-1 array. To select the 1st, 14th, 17th, 23rd and 8th elements of the dataset, the selection array would be as follows (remembering that point coordinates are zero-based): <br />
|
|
0 <br />
|
|
13 <br />
|
|
16 <br />
|
|
22 <br />
|
|
7</p>
|
|
<p>This point selection array will be serialized in the <code>coord</code> buffer as: <br />
|
|
0 13 16 22 7</p>
|
|
<p>In the 4D case, we will be selecting three points and a 4D dataspace has rank 4, so the selection will be described in a 3-by-4 array. To select the points (1,1,1,1), (14,6,12,18), and (8,22,30,22), the point selection array would be as follows: <br />
|
|
0 0 0 0 <br />
|
|
13 5 11 17 <br />
|
|
7 21 29 21</p>
|
|
<p>This point selection array will be serialized in the <code>coord</code> buffer as: <br />
|
|
0 0 0 0 13 5 11 17 7 21 29 21</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.6.4 C coord parameter type changed to <code>const</code> hsize_t. </dd>
|
|
<dd>
|
|
1.6.4 Fortran <code>coord</code> parameter type changed to <code>INTEGER(HSIZE_T)</code>. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6adfdf1b95dc108a65bf66e97d38536d" name="ga6adfdf1b95dc108a65bf66e97d38536d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6adfdf1b95dc108a65bf66e97d38536d">◆ </a></span>H5Sselect_hyperslab()</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> H5Sselect_hyperslab </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0f">H5S_seloper_t</a> </td>
|
|
<td class="paramname"><em>op</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>start</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>stride</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>count</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>block</em>[] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Selects a hyperslab region to add to the current selected region. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Operation to perform on current selection </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>Offset of start of hyperslab </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">stride</td><td>Hyperslab stride </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of blocks included in hyperslab </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>Size of block in hyperslab</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>
|
|
<p><a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> selects a hyperslab region to add to the current selected region for the dataspace specified by <code>space_id</code>.</p>
|
|
<p>The <code>start</code>, <code>stride</code>, <code>count</code>, and <code>block</code> arrays must be the same size as the rank of the dataspace. For example, if the dataspace is 4-dimensional, each of these parameters must be a 1-dimensional array of size 4.</p>
|
|
<p>The selection operator <code>op</code> determines how the new selection is to be combined with the already existing selection for the dataspace. The following operators are supported:</p>
|
|
<table class="doxtable">
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0fab90faf3dc59ecf6f28197ef471141550">H5S_SELECT_SET</a> </td><td>Replaces the existing selection with the parameters from this call. Overlapping blocks are not supported with this operator. </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0fa1a8dc2bbb8d8268d6e7665a4664b9ad8">H5S_SELECT_OR</a> </td><td>Adds the new selection to the existing selection. (Binary OR) </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0faae87b1594f2efe5f2717a865211d9418">H5S_SELECT_AND</a> </td><td>Retains only the overlapping portions of the new selection and the existing selection. (Binary AND) </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0fabb86044797fc5a3880d8e52613d63183">H5S_SELECT_XOR</a> </td><td>Retains only the elements that are members of the new selection or the existing selection, excluding elements that are members of both selections. (Binary exclusive-OR, XOR) </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0fad0829c19e4cdae8cdf381abed0379983">H5S_SELECT_NOTB</a> </td><td>Retains only elements of the existing selection that are not in the new selection. </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0fa56efb56861d4c90887500cab2149b804">H5S_SELECT_NOTA</a> </td><td>Retains only elements of the new selection that are not in the existing selection. </td></tr>
|
|
</table>
|
|
<p>The <code>start</code> array specifies the offset of the starting element of the specified hyperslab.</p>
|
|
<p>The <code>stride</code> array chooses array locations from the dataspace with each value in the <code>stride</code> array determining how many elements to move in each dimension. Setting a value in the <code>stride</code> array to <code>1</code> moves to each element in that dimension of the dataspace; setting a value of <code>2</code> in allocation in the <code>stride</code> array moves to every other element in that dimension of the dataspace. In other words, the <code>stride</code> determines the number of elements to move from the <code>start</code> location in each dimension. Stride values of <code>0</code> are not allowed. If the <code>stride</code> parameter is NULL, a contiguous hyperslab is selected (as if each value in the <code>stride</code> array were set to <code>1</code>).</p>
|
|
<p>The <code>count</code> array determines how many blocks to select from the dataspace, in each dimension.</p>
|
|
<p>The <code>block</code> array determines the size of the element block selected from the dataspace. If the <code>block</code> parameter is set to NULL, the block size defaults to a single element in each dimension (as if each value in the <code>block</code> array were set to <code>1</code>).</p>
|
|
<p>For example, consider a 2-dimensional dataspace with hyperslab selection settings as follows: the <code>start</code> offset is specified as [1,1], <code>stride</code> is [4,4], <code>count</code> is [3,7], and <code>block</code> is [2,2]. In C, these settings will specify a hyperslab consisting of 21 2x2 blocks of array elements starting with location (1,1) with the selected blocks at locations (1,1), (5,1), (9,1), (1,5), (5,5), etc.; in Fortran, they will specify a hyperslab consisting of 21 2x2 blocks of array elements starting with location (2,2), since <code>start</code> is 0-based indexed, with the selected blocks at locations (2,2), (6,2), (10,2), (2,6), (6,6), etc.</p>
|
|
<p>Regions selected with this function call default to C order iteration when I/O is performed.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine introduced in this release. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga51472bcb9af024675fba6294a6aefa5e" name="ga51472bcb9af024675fba6294a6aefa5e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga51472bcb9af024675fba6294a6aefa5e">◆ </a></span>H5Sselect_intersect_block()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Sselect_intersect_block </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> * </td>
|
|
<td class="paramname"><em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> * </td>
|
|
<td class="paramname"><em>end</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if current selection intersects with a block. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>Starting coordinate of block </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">end</td><td>Opposite ("ending") coordinate of block</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#ga51472bcb9af024675fba6294a6aefa5e" title="Checks if current selection intersects with a block.">H5Sselect_intersect_block()</a> checks to see if the current selection <code>space_id</code> in the dataspace intersects with the block specified by <code>start</code> and <code>end</code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Assumes that <code>start</code> & <code>end</code> block bounds are inclusive, so <code>start</code> == <code>end</code> value is OK.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.10.6 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac59773d4a0953cb2db0ed57a05699095" name="gac59773d4a0953cb2db0ed57a05699095"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac59773d4a0953cb2db0ed57a05699095">◆ </a></span>H5Sselect_none()</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> H5Sselect_none </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resets the selection region to include no elements. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier</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>
|
|
<p><a class="el" href="group___h5_s.html#gac59773d4a0953cb2db0ed57a05699095" title="Resets the selection region to include no elements.">H5Sselect_none()</a> resets the selection region for the dataspace <code>space_id</code> to include no elements.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1e914ba45afb15ded99a0afeaf124c04" name="ga1e914ba45afb15ded99a0afeaf124c04"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1e914ba45afb15ded99a0afeaf124c04">◆ </a></span>H5Sselect_project_intersection()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Sselect_project_intersection </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>src_space_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>dst_space_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>src_intersect_space_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Projects the intersection of two source selections to a destination selection. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">src_space_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dst_space_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">src_intersect_space_id</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a dataspace with a selection equal to the intersection of <code>src_intersect_space_id</code> and <code>src_space_id</code> projected from <code>src_space</code> to <code>dst_space</code> on success, negative on failure.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#ga1e914ba45afb15ded99a0afeaf124c04" title="Projects the intersection of two source selections to a destination selection.">H5Sselect_project_intersection()</a> computes the intersection between two dataspace selections and projects that intersection into a third selection.This can be useful for VOL developers to implement chunked or virtual datasets.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.10.6 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gafc6cafae877900ee060709eaa0b9b261" name="gafc6cafae877900ee060709eaa0b9b261"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gafc6cafae877900ee060709eaa0b9b261">◆ </a></span>H5Sselect_shape_same()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Sselect_shape_same </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space1_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space2_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if two selections are the same shape. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space1_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space2_id</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#gafc6cafae877900ee060709eaa0b9b261" title="Checks if two selections are the same shape.">H5Sselect_shape_same()</a> checks to see if the current selection in the dataspaces are the same dimensionality and shape.</p>
|
|
<p>This is primarily used for reading the entire selection in one swoop.</p>
|
|
<dl class="section since"><dt>Since</dt><dd>1.10.6 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1abfdec1248c262ca8791b5308e67d4b" name="ga1abfdec1248c262ca8791b5308e67d4b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1abfdec1248c262ca8791b5308e67d4b">◆ </a></span>H5Sselect_valid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Sselect_valid </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>spaceid</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Verifies that the selection is within the extent of the dataspace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">spaceid</td><td>Dataspace identifier</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
|
|
<p><a class="el" href="group___h5_s.html#ga1abfdec1248c262ca8791b5308e67d4b" title="Verifies that the selection is within the extent of the dataspace.">H5Sselect_valid()</a> verifies that the selection for the dataspace <code>space_id</code> is within the extent of the dataspace if the current offset for the dataspace is used.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine introduced in this release. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gacf8a5c48d7b7edb5ff73d9d02dbd073d" name="gacf8a5c48d7b7edb5ff73d9d02dbd073d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gacf8a5c48d7b7edb5ff73d9d02dbd073d">◆ </a></span>H5Sset_extent_none()</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> H5Sset_extent_none </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resets the extent of a dataspace back to "none". </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier</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>
|
|
<p><a class="el" href="group___h5_s.html#gacf8a5c48d7b7edb5ff73d9d02dbd073d" title="Resets the extent of a dataspace back to "none".">H5Sset_extent_none()</a> resets the type of a dataspace to <a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aa3d83ec70c1a824a2d821bf8464488bc5">H5S_NULL</a> with no extent information stored for the dataspace.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.10.7, 1.12.1 The function behavior changed. The previous behavior was to set the class to <a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aadab1657d08941e24b5e6d83ca18ecb50">H5S_NO_CLASS</a>. </dd>
|
|
<dd>
|
|
1.4.0 Fortran subroutine was introduced. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf2526a41d2f4506e2c52098510517343" name="gaf2526a41d2f4506e2c52098510517343"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf2526a41d2f4506e2c52098510517343">◆ </a></span>H5Sset_extent_simple()</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> H5Sset_extent_simple </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
|
|
<td class="paramname"><em>space_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>rank</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>dims</em>[], </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
|
|
<td class="paramname"><em>max</em>[] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets or resets the size of an existing dataspace. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">rank</td><td>Rank, or dimensionality, of the dataspace </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dims</td><td>Array containing current size of dataspace </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">max</td><td>Array containing maximum size of dataspace</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>
|
|
<p><a class="el" href="group___h5_s.html#gaf2526a41d2f4506e2c52098510517343" title="Sets or resets the size of an existing dataspace.">H5Sset_extent_simple()</a> sets or resets the size of an existing dataspace.</p>
|
|
<p><code>dims</code> is an array of size <code>rank</code> that contains the new size of each dimension in the dataspace. <code>max</code> is an array of size <code>rank</code> that contains the maximum size of each dimension in the dataspace.</p>
|
|
<p>Any previous extent is removed from the dataspace, the dataspace type is set to <a class="el" href="_h5_spublic_8h.html#ae53f3c6a52563646fbac9ead8ecdbf0aac4ee937dcccfd99f885626983e7d2750">H5S_SIMPLE</a>, and the extent is set as specified.</p>
|
|
<dl class="section version"><dt>Version</dt><dd>1.4.0 Fortran subroutine was introduced. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<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.7 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|