ca9639706e
Revised and extended hyperslab selection image. Added section "Selecting a union of hyperslabs." IH_map*.gif (6 new files) New images for "Intro to HDF5." As a composite, these replace H5.intro.datamap.gif. H5.intro.datamap.gif Removed. Replaced by the composite IH_map*.gif. RM_H5RA.html (new file) RM_H5Front.html Tools.html Ragged.html H5.user.html Changed all H5R functions to H5RA. Changed Ragged Array API references from H5R to H5RA. Changed links to RM_H5R.html to RM_H5RA.html. RM_H5R.html Removed. Replaced by RM_H5RA.html.
249 lines
6.6 KiB
HTML
249 lines
6.6 KiB
HTML
<html>
|
|
<head><title>
|
|
HDF5/H5RA Draft API Specification
|
|
</title></head>
|
|
|
|
<body>
|
|
|
|
<hr>
|
|
<center>
|
|
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
|
|
<a href="RM_H5.html">H5</a>
|
|
<a href="RM_H5A.html">H5A</a>
|
|
<a href="RM_H5D.html">H5D</a>
|
|
<a href="RM_H5E.html">H5E</a>
|
|
<a href="RM_H5F.html">H5F</a>
|
|
<a href="RM_H5G.html">H5G</a>
|
|
<a href="RM_H5P.html">H5P</a>
|
|
H5RA
|
|
<a href="RM_H5S.html">H5S</a>
|
|
<a href="RM_H5T.html">H5T</a>
|
|
<a href="RM_H5Z.html">H5Z</a>
|
|
<a href="Tools.html">Tools</a>
|
|
<!--
|
|
<a href="Glossary.html">Glossary</a>
|
|
-->
|
|
</center>
|
|
<hr>
|
|
|
|
<center>
|
|
<h1>H5RA: Ragged Array Interface</h1>
|
|
</center>
|
|
|
|
<h2>Ragged Array API Functions</h2>
|
|
<table border=1>
|
|
<tr><th align=left>
|
|
<font color=red>
|
|
The H5RA Interface is strictly experimental at this time;
|
|
the interface may change dramatically or support for ragged arrays
|
|
may be unavailable in future in releases. As a result, future releases
|
|
may be unable to retrieve data stored with this interface.
|
|
<p><center>Use these functions at your own risk!<br>
|
|
Do not create any archives using this interface!</center>
|
|
</font>
|
|
</th></tr>
|
|
</table>
|
|
<p>
|
|
These functions enable the user to store and retrieve data in ragged arrays.
|
|
|
|
|
|
<table border=0>
|
|
<tr><td valign=top>
|
|
<ul>
|
|
<li><a href="#Ragged-Create">H5RAcreate</a>
|
|
<li><a href="#Ragged-Open">H5RAopen</a>
|
|
<li><a href="#Ragged-Close">H5RAclose</a>
|
|
</ul>
|
|
</td><td> </td><td valign=top>
|
|
<ul>
|
|
<li><a href="#Ragged-Write">H5RAwrite</a>
|
|
<li><a href="#Ragged-Read">H5RAread</a>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p>
|
|
|
|
|
|
|
|
<hr>
|
|
<dl>
|
|
<dt><strong>Name:</strong> <a name="Ragged-Create">H5RAcreate</a>
|
|
<dt><strong>Signature:</strong>
|
|
<dd><em> </em> <code>H5RAcreate</code>(<em> </em> <code> </code>,
|
|
<em> </em> <code> </code>,
|
|
<em> </em> <code> </code>
|
|
)
|
|
<dt><strong>Purpose:</strong>
|
|
<dd>
|
|
<dt><strong>Description:</strong>
|
|
<dd><code>H5RAcreate</code>
|
|
<dt><strong>Parameters:</strong>
|
|
<dl>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
</dl>
|
|
<dt><strong>Returns:</strong>
|
|
<dd>Returns SUCCEED (0) if successful;
|
|
otherwise FAIL (-1).
|
|
</dl>
|
|
|
|
|
|
<hr>
|
|
<dl>
|
|
<dt><strong>Name:</strong> <a name="Ragged-Open">H5RAopen</a>
|
|
<dt><strong>Signature:</strong>
|
|
<dd><em> </em> <code>H5RAopen</code>(<em> </em> <code> </code>,
|
|
<em> </em> <code> </code>,
|
|
<em> </em> <code> </code>
|
|
)
|
|
<dt><strong>Purpose:</strong>
|
|
<dd>
|
|
<dt><strong>Description:</strong>
|
|
<dd><code>H5RAopen</code>
|
|
<dt><strong>Parameters:</strong>
|
|
<dl>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
</dl>
|
|
<dt><strong>Returns:</strong>
|
|
<dd>Returns SUCCEED (0) if successful;
|
|
otherwise FAIL (-1).
|
|
</dl>
|
|
|
|
|
|
<hr>
|
|
<dl>
|
|
<dt><strong>Name:</strong> <a name="Ragged-Close">H5RAclose</a>
|
|
<dt><strong>Signature:</strong>
|
|
<dd><em> </em> <code>H5RAclose</code>(<em> </em> <code> </code>,
|
|
<em> </em> <code> </code>,
|
|
<em> </em> <code> </code>
|
|
)
|
|
<dt><strong>Purpose:</strong>
|
|
<dd>
|
|
<dt><strong>Description:</strong>
|
|
<dd><code>H5RAclose</code>
|
|
<dt><strong>Parameters:</strong>
|
|
<dl>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
</dl>
|
|
<dt><strong>Returns:</strong>
|
|
<dd>Returns SUCCEED (0) if successful;
|
|
otherwise FAIL (-1).
|
|
</dl>
|
|
|
|
|
|
<hr>
|
|
<dl>
|
|
<dt><strong>Name:</strong> <a name="Ragged-Write">H5RAwrite</a>
|
|
<dt><strong>Signature:</strong>
|
|
<dd><em> </em> <code>H5RAwrite</code>(<em> </em> <code> </code>,
|
|
<em> </em> <code> </code>,
|
|
<em> </em> <code> </code>
|
|
)
|
|
<dt><strong>Purpose:</strong>
|
|
<dd>
|
|
<dt><strong>Description:</strong>
|
|
<dd><code>H5RAwrite</code>
|
|
<p>
|
|
Datatype conversion takes place at the time of a read or write
|
|
and is automatic. See the
|
|
<a href="Datatypes.html#Datatypes-DataConversion">Data Conversion</a>
|
|
section of <cite>The Data Type Interface (H5T)</cite> in the
|
|
<cite>HDF5 User's Guide</cite> for a discussion of
|
|
data conversion, including the range of conversions currently
|
|
supported by the HDF5 libraries.
|
|
<dt><strong>Parameters:</strong>
|
|
<dl>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
</dl>
|
|
<dt><strong>Returns:</strong>
|
|
<dd>Returns SUCCEED (0) if successful;
|
|
otherwise FAIL (-1).
|
|
</dl>
|
|
|
|
|
|
<hr>
|
|
<dl>
|
|
<dt><strong>Name:</strong> <a name="Ragged-Read">H5RAread</a>
|
|
<dt><strong>Signature:</strong>
|
|
<dd><em> </em> <code>H5RAread</code>(<em> </em> <code> </code>,
|
|
<em> </em> <code> </code>,
|
|
<em> </em> <code> </code>
|
|
)
|
|
<dt><strong>Purpose:</strong>
|
|
<dd>
|
|
<dt><strong>Description:</strong>
|
|
<dd><code>H5RAread</code>
|
|
<p>
|
|
Datatype conversion takes place at the time of a read or write
|
|
and is automatic. See the
|
|
<a href="Datatypes.html#Datatypes-DataConversion">Data Conversion</a>
|
|
section of <cite>The Data Type Interface (H5T)</cite> in the
|
|
<cite>HDF5 User's Guide</cite> for a discussion of
|
|
data conversion, including the range of conversions currently
|
|
supported by the HDF5 libraries.
|
|
<dt><strong>Parameters:</strong>
|
|
<dl>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
<dt><em> </em> <code> </code>
|
|
<dd>
|
|
</dl>
|
|
<dt><strong>Returns:</strong>
|
|
<dd>Returns SUCCEED (0) if successful;
|
|
otherwise FAIL (-1).
|
|
</dl>
|
|
|
|
|
|
<hr>
|
|
<center>
|
|
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
|
|
<a href="RM_H5.html">H5</a>
|
|
<a href="RM_H5A.html">H5A</a>
|
|
<a href="RM_H5D.html">H5D</a>
|
|
<a href="RM_H5E.html">H5E</a>
|
|
<a href="RM_H5F.html">H5F</a>
|
|
<a href="RM_H5G.html">H5G</a>
|
|
<a href="RM_H5P.html">H5P</a>
|
|
H5RA
|
|
<a href="RM_H5S.html">H5S</a>
|
|
<a href="RM_H5T.html">H5T</a>
|
|
<a href="RM_H5Z.html">H5Z</a>
|
|
<a href="Tools.html">Tools</a>
|
|
<!--
|
|
<a href="Glossary.html">Glossary</a>
|
|
-->
|
|
</center>
|
|
<hr>
|
|
|
|
<address>
|
|
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
|
|
|
|
<br>
|
|
Last modified: 1 September 1998
|
|
|
|
</body>
|
|
</html>
|