summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1999-08-24 20:14:18 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1999-08-24 20:14:18 (GMT)
commit48b014bc9a8c11bb6d31be59c4b37b0b638c5f03 (patch)
treeba5752a0118dd1bccbe2f913be75bd2adac89bc8 /doc
parent8cffd507bf54afd838712a49a2fc1195151aae17 (diff)
downloadhdf5-48b014bc9a8c11bb6d31be59c4b37b0b638c5f03.zip
hdf5-48b014bc9a8c11bb6d31be59c4b37b0b638c5f03.tar.gz
hdf5-48b014bc9a8c11bb6d31be59c4b37b0b638c5f03.tar.bz2
[svn-r1587]
RM_H5S.html Added H5Sget_select_hyper_nblocks, H5Sget_select_hyper_blocklist, H5Sget_select_elem_npoints, H5Sget_select_elem_pointlist, and H5Sget_select_bounds. RM_H5Front.html As functions were added to the Reference Manual (above), they were removed from "functions missing in the RM" list in this document.
Diffstat (limited to 'doc')
-rw-r--r--doc/html/RM_H5Front.html112
-rw-r--r--doc/html/RM_H5S.html215
2 files changed, 207 insertions, 120 deletions
diff --git a/doc/html/RM_H5Front.html b/doc/html/RM_H5Front.html
index 8e3f96a..3d68ab4 100644
--- a/doc/html/RM_H5Front.html
+++ b/doc/html/RM_H5Front.html
@@ -117,12 +117,6 @@ Manual that accompanies this Beta release; they will be documented in
the final Release 1.2. Brief descriptions, as extracted from comments
in the source code, are appended below.
- H5Sget_select_hyper_nblocks
- H5Sget_select_elem_npoints
- H5Sget_select_hyper_blocklist
- H5Sget_select_elem_pointlist
- H5Sget_select_bounds
-
H5Tenum_create
H5Tenum_insert
H5Tenum_nameof
@@ -134,112 +128,6 @@ in the source code, are appended below.
H5Tregister
-
-/*--------------------------------------------------------------------------
- NAME
- H5Sget_select_hyper_nblocks
- PURPOSE
- Get the number of hyperslab blocks in current hyperslab selection
- USAGE
- hssize_t H5Sget_select_hyper_nblocks(dsid)
- hid_t dsid; IN: Dataspace ID of selection to query
- RETURNS
- The number of hyperslab blocks in selection on success, negative on failure
- DESCRIPTION
- Returns the number of hyperslab blocks in current selection for dataspace.
---------------------------------------------------------------------------*/
-
-/*--------------------------------------------------------------------------
- NAME
- H5Sget_select_elem_npoints
- PURPOSE
- Get the number of points in current element selection
- USAGE
- hssize_t H5Sget_select_elem_npoints(dsid)
- hid_t dsid; IN: Dataspace ID of selection to query
- RETURNS
- The number of element points in selection on success, negative on failure
- DESCRIPTION
- Returns the number of element points in current selection for dataspace.
---------------------------------------------------------------------------*/
-
-/*--------------------------------------------------------------------------
- NAME
- H5Sget_select_hyper_blocklist
- PURPOSE
- Get the list of hyperslab blocks currently selected
- USAGE
- herr_t H5Sget_select_hyper_blocklist(dsid, hsize_t *buf)
- hid_t dsid; IN: Dataspace ID of selection to query
- hsize_t startblock; IN: Hyperslab block to start with
- hsize_t numblocks; IN: Number of hyperslab blocks to get
- hsize_t *buf; OUT: List of hyperslab blocks selected
- RETURNS
- Non-negative on success, negative on failure
- DESCRIPTION
- Puts a list of the hyperslab blocks into the user's buffer. The blocks
- start with the 'startblock'th block in the list of blocks and put
- 'numblocks' number of blocks into the user's buffer (or until the end of
- the list of blocks, whichever happen first)
- The block coordinates have the same dimensionality (rank) as the
- dataspace they are located within. The list of blocks is formatted as
- follows: <"start" coordinate> immediately followed by <"opposite" corner
- coordinate>, followed by the next "start" and "opposite" coordinate, etc.
- until all the block information requested has been put into the user's
- buffer.
- No guarantee of any order of the blocks is implied.
---------------------------------------------------------------------------*/
-
-/*--------------------------------------------------------------------------
- NAME
- H5Sget_select_elem_pointlist
- PURPOSE
- Get the list of element points currently selected
- USAGE
- herr_t H5Sget_select_elem_pointlist(dsid, hsize_t *buf)
- hid_t dsid; IN: Dataspace ID of selection to query
- hsize_t startpoint; IN: Element point to start with
- hsize_t numpoints; IN: Number of element points to get
- hsize_t *buf; OUT: List of element points selected
- RETURNS
- Non-negative on success, negative on failure
- DESCRIPTION
- Puts a list of the element points into the user's buffer. The points
- start with the 'startpoint'th block in the list of points and put
- 'numpoints' number of points into the user's buffer (or until the end of
- the list of points, whichever happen first)
- The point coordinates have the same dimensionality (rank) as the
- dataspace they are located within. The list of points is formatted as
- follows: <coordinate> followed by the next coordinate, etc. until all the
- point information in the selection have been put into the user's buffer.
- The points are returned in the order they will be iterated through
- when a selection is read/written from/to disk.
---------------------------------------------------------------------------*/
-
-/*--------------------------------------------------------------------------
- NAME
- H5Sget_select_bounds
- PURPOSE
- Gets the bounding box containing the selection.
- USAGE
- herr_t H5S_get_select_bounds(space, start, end)
- hid_t dsid; IN: Dataspace ID of selection to query
- hsize_t *start; OUT: Starting coordinate of bounding box
- hsize_t *end; OUT: Opposite coordinate of bounding box
- RETURNS
- Non-negative on success, negative on failure
- DESCRIPTION
- Retrieves the bounding box containing the current selection and places
- it into the user's buffers. The start and end buffers must be large
- enough to hold the dataspace rank number of coordinates. The bounding box
- exactly contains the selection, ie. if a 2-D element selection is currently
- defined with the following points: (4,5), (6,8) (10,7), the bounding box
- with be (4, 5), (10, 8). Calling this function on a "none" selection
- returns fail.
- The bounding box calculations _does_ include the current offset of the
- selection within the dataspace extent.
---------------------------------------------------------------------------*/
-
/*-------------------------------------------------------------------------
* Function: H5Tenum_create
*
diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html
index fda39d7..3b48f37 100644
--- a/doc/html/RM_H5S.html
+++ b/doc/html/RM_H5S.html
@@ -55,22 +55,28 @@ elements of a dataset.
<tr><td valign=top>
<ul>
<li><a href="#Dataspace-Create">H5Screate</a>
+ <li><a href="#Dataspace-Copy">H5Scopy</a>
+ <li><a href="#Dataspace-Close">H5Sclose</a>
<li><a href="#Dataspace-CreateSimple">H5Screate_simple</a>
<li><a href="#Dataspace-IsSimple">H5Sis_simple</a>
<li><a href="#Dataspace-OffsetSimple">H5Soffset_simple</a>
- <li><a href="#Dataspace-Copy">H5Scopy</a>
- <li><a href="#Dataspace-ExtentClass">H5Sextent_class</a>
- <li><a href="#Dataspace-ExtentCopy">H5Sextent_copy</a>
+ <li><a href="#Dataspace-ExtentDims">H5Sget_simple_extent_dims</a>
+ <li><a href="#Dataspace-ExtentNdims">H5Sget_simple_extent_ndims</a>
+ <li><a href="#Dataspace-ExtentNpoints">H5Sget_simple_extent_npoints</a>
+ <li><a href="#Dataspace-ExtentType">H5Sget_simple_extent_type</a>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
+ <li><a href="#Dataspace-ExtentClass">H5Sextent_class</a>
+ <li><a href="#Dataspace-ExtentCopy">H5Sextent_copy</a>
<li><a href="#Dataspace-SetExtentSimple">H5Sset_extent_simple</a>
<li><a href="#Dataspace-SetExtentNone">H5Sset_extent_none</a>
<li><a href="#Dataspace-SelectNpoints">H5Sget_select_npoints</a>
- <li><a href="#Dataspace-ExtentDims">H5Sget_simple_extent_dims</a>
- <li><a href="#Dataspace-ExtentNdims">H5Sget_simple_extent_ndims</a>
- <li><a href="#Dataspace-ExtentNpoints">H5Sget_simple_extent_npoints</a>
- <li><a href="#Dataspace-ExtentType">H5Sget_simple_extent_type</a>
+ <li><a href="#Dataspace-SelectHyperNBlocks">H5Sget_select_hyper_nblocks</a>
+ <li><a href="#Dataspace-SelectHyperBlockList">H5Sget_select_hyper_blocklist</a>
+ <li><a href="#Dataspace-SelectElemNPoints">H5Sget_select_elem_npoints</a>
+ <li><a href="#Dataspace-SelectElemPointList">H5Sget_select_elem_pointlist</a>
+ <li><a href="#Dataspace-SelectBounds">H5Sget_select_bounds</a>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
@@ -79,7 +85,6 @@ elements of a dataset.
<li><a href="#Dataspace-SelectNone">H5Sselect_none</a>
<li><a href="#Dataspace-SelectValid">H5Sselect_valid</a>
<li><a href="#Dataspace-SelectHyperslab">H5Sselect_hyperslab</a>
- <li><a href="#Dataspace-Close">H5Sclose</a>
</ul>
</td></tr>
</table>
@@ -738,6 +743,200 @@ I/O is performed.
<hr>
<dl>
+<dt><strong>Name:</strong> <a name="Dataspace-SelectHyperNBlocks">H5Sget_select_hyper_nblocks</a>
+<dt><strong>Signature:</strong>
+ <dd><em>hssize_t </em><code>H5Sget_select_hyper_nblocks</code>(<em>hid_t </em><code>space_id</code>
+ )
+<dt><strong>Purpose:</strong>
+ <dd>Get number of hyperslab blocks.
+<dt><strong>Description:</strong>
+ <dd><code>H5Sget_select_hyper_nblocks</code> returns the
+ number of hyperslab blocks in the current dataspace selection.
+<dt><strong>Parameters:</strong>
+ <dl>
+ <dt><em>hid_t</em> <code>space_id</code>
+ <dd>Identifier of dataspace to query.
+ </dl>
+<dt><strong>Returns:</strong>
+ <dd>Returns the number of hyperslab blocks in
+ the current dataspace selection if successful.
+ Otherwise returns a negative value.
+</dl>
+
+
+<hr>
+<dl>
+<dt><strong>Name:</strong> <a name="Dataspace-SelectHyperBlockList">H5Sget_select_hyper_blocklist</a>
+<dt><strong>Signature:</strong>
+ <dd><em>herr_t </em><code>H5Sget_select_hyper_blocklist</code>(<em>hid_t </em><code>space_id</code>,
+ <em>hsize_t </em><code>startblock</code>,
+ <em>hsize_t </em><code>numblocks</code>,
+ <em>hsize_t *</em><code>buf</code>
+ )
+<dt><strong>Purpose:</strong>
+ <dd>Gets the list of hyperslab blocks currently selected.
+<dt><strong>Description:</strong>
+ <dd><code>H5Sget_select_hyper_blocklist</code> returns a list of
+ the hyperslab blocks currently selected. Starting with the
+ <code>startblock</code>-th 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>
+ The block coordinates have the same dimensionality (rank)
+ as the dataspace they are located within. The list of blocks
+ is formatted as follows:
+ <br>&nbsp;&nbsp;&nbsp;&nbsp;
+ &lt;"start" coordinate&gt;, immediately followed by
+ <br>&nbsp;&nbsp;&nbsp;&nbsp;
+ &lt;"opposite" corner coordinate&gt;, followed by
+ <br>&nbsp;&nbsp;&nbsp;&nbsp;
+ the next "start" and "opposite" coordinates,
+ <br>&nbsp;&nbsp;&nbsp;&nbsp;
+ etc.
+ <br>
+ until all of the selected blocks have been listed.
+ <p>
+ No guarantee is implied as the order in which blocks are listed.
+<dt><strong>Parameters:</strong>
+ <dl>
+ <dt><em>hid_t</em> <code>space_id</code>
+ <dd>IN: Dataspace identifier of selection to query.
+ <dt><em>hsize_t </em><code>startblock</code>
+ <dd>IN: Hyperslab block to start with.
+ <dt><em>hsize_t </em><code>numblocks</code>
+ <dd>IN: Number of hyperslab blocks to get.
+ <dt><em>hsize_t *</em><code>buf</code>
+ <dd>OUT: List of hyperslab blocks selected.
+ </dl>
+<dt><strong>Returns:</strong>
+ <dd>Returns a non-negative value if successful;
+ otherwise returns a negative value.
+</dl>
+
+
+
+<hr>
+<dl>
+<dt><strong>Name:</strong> <a name="Dataspace-SelectElemNPoints">H5Sget_select_elem_npoints</a>
+<dt><strong>Signature:</strong>
+ <dd><em>hssize_t </em><code>H5Sget_select_elem_npoints</code>(<em>hid_t </em><code>space_id</code>
+ )
+<dt><strong>Purpose:</strong>
+ <dd>Gets the number of element points in the current selection.
+<dt><strong>Description:</strong>
+ <dd><code>H5Sget_select_elem_npoints</code> returns
+ the number of element points in the current dataspace selection.
+<dt><strong>Parameters:</strong>
+ <dl>
+ <dt><em>hid_t</em> <code>space_id</code>
+ <dd>Identifier of dataspace to query.
+ </dl>
+<dt><strong>Returns:</strong>
+ <dd>Returns the number of element points in the current dataspace selection if successful.
+ Otherwise returns a negative value.
+</dl>
+
+
+<hr>
+<dl>
+<dt><strong>Name:</strong> <a name="Dataspace-SelectElemPointList">H5Sget_select_elem_pointlist</a>
+<dt><strong>Signature:</strong>
+ <dd><em>herr_t </em><code>H5Sget_select_elem_pointlist</code>(<em>hid_t </em><code>space_id</code>
+ <em>hsize_t </em><code>startpoint</code>,
+ <em>hsize_t </em><code>numpoints</code>,
+ <em>hsize_t *</em><code>buf</code>
+ )
+<dt><strong>Purpose:</strong>
+ <dd>Gets the list of element points currently selected.
+<dt><strong>Description:</strong>
+ <dd><code>H5Sget_select_elem_pointlist</code> returns the list of
+ element points in the current dataspace selection. Starting with
+ the <code>startpoint</code>-th point 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>
+ 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>&nbsp;&nbsp;&nbsp;&nbsp;
+ &lt;coordinate&gt;, followed by
+ <br>&nbsp;&nbsp;&nbsp;&nbsp;
+ the next coordinate,
+ <br>&nbsp;&nbsp;&nbsp;&nbsp;
+ etc.
+ <br>
+ until all of the selected element points have been listed.
+ <p>
+ The points are returned in the order they will be iterated through
+ when the selection is read/written from/to disk.
+<dt><strong>Parameters:</strong>
+ <dl>
+ <dt><em>hid_t</em> <code>space_id</code>
+ <dd>IN: Dataspace identifier of selection to query.
+ <dt><em>hsize_t </em><code>startpoint</code>
+ <dd>IN: Element point to start with.
+ <dt><em>hsize_t </em><code>numpoints</code>
+ <dd>IN: Number of element points to get.
+ <dt><em>hsize_t *</em><code>buf</code>
+ <dd>OUT: List of element points selected.
+ </dl>
+<dt><strong>Returns:</strong>
+ <dd>Returns a non-negative value if successful;
+ otherwise returns a negative value.
+</dl>
+
+
+
+<hr>
+<dl>
+<dt><strong>Name:</strong> <a name="Dataspace-SelectBounds">H5Sget_select_bounds</a>
+<dt><strong>Signature:</strong>
+ <dd><em>herr_t </em><code>H5Sget_select_bounds</code>(<em>hid_t </em><code>space_id</code>
+ <em>hsize_t *</em><code>start</code>,
+ <em>hsize_t *</em><code>end</code>
+ )
+<dt><strong>Purpose:</strong>
+ <dd>Gets the bounding box containing the selection.
+<dt><strong>Description:</strong>
+ <dd><code>H5Sget_select_bounds</code> retrieves the coordinates of
+ bounding box containing the current selection and places
+ them into user-supplied buffers.
+ <p>
+ The <code>start</code> and <code>end</code> buffers must be large
+ enough to hold the dataspace rank number of coordinates.
+ <p>
+ The bounding box exactly contains the selection.
+ I.e., if a 2-dimensional element selection is currently
+ defined with the points (4,5), (6,8), and (10,7), then the
+ bounding box will be (4, 5), (10, 8).
+ <p>
+ Calling this function on a <code>none</code> selection returns
+ <code>FAIL</code>.
+ <p>
+ The bounding box calculation includes the current offset of the
+ selection within the dataspace extent.
+<dt><strong>Parameters:</strong>
+ <dl>
+ <dt><em>hid_t</em> <code>space_id</code>
+ <dd>Identifier of dataspace to query.
+ <em>hsize_t *</em><code>start</code>
+ <dd>OUT: Starting coordinates of the bounding box.
+ <em>hsize_t *</em><code>end</code>
+ <dd>OUT: Ending coordinates of the bounding box,
+ i.e., the coordinates of the diagonally opposite corner.
+ </dl>
+<dt><strong>Returns:</strong>
+ <dd>Returns a negative value if successful;
+ otherwise returns a negative value.
+</dl>
+
+
+<hr>
+<dl>
<dt><strong>Name:</strong> <a name="Dataspace-Close">H5Sclose</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Sclose</code>(<em>hid_t </em><code>space_id</code>