diff options
Diffstat (limited to 'doc/html/RM_H5S.html')
| -rw-r--r-- | doc/html/RM_H5S.html | 278 |
1 files changed, 249 insertions, 29 deletions
diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index 6230e56..64fd250 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -18,7 +18,10 @@ HDF5/H5S Draft API Specification H5S <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> @@ -36,27 +39,62 @@ elements of a dataset. <ul> <li><a href="#Dataspace-Create">H5Screate</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-SelectNpoints">H5Sselect_npoints</a> - <li><a href="#Dataspace-SelectElements">H5Sselect_elements</a> + <li><a href="#Dataspace-ExtentClass">H5Sextent_class</a> + <li><a href="#Dataspace-ExtentCopy">H5Sextent_copy</a> </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Dataspace-ExtentNpoints">H5Sextent_npoints</a> - <li><a href="#Dataspace-ExtentNdims">H5Sextent_ndims</a> - <li><a href="#Dataspace-ExtentDims">H5Sextent_dims</a> - <li><a href="#Dataspace-GetClass">H5Sget_class</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-GetSpaceType">H5Sget_space_type</a> </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Dataspace-SetExtentSimple">H5Sset_extent_simple</a> - <li><a href="#Dataspace-IsSimple">H5Sis_simple</a> + <li><a href="#Dataspace-SelectElements">H5Sselect_elements</a> + <li><a href="#Dataspace-SelectAll">H5Sselect_all</a> + <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> +<p> +The following H5S functions are included in the HDF5 specification, +but have not yet been implemented. They are described in the +<a href="Datatypes.html">The Data Type Interface (H5T)</a> section +of the <cite>HDF5 User's Guide.</cite>. +<table border=0> +<tr><td valign=top> +<ul> + <li>H5Scommit + <li>H5Sis_subspace + <li>H5Slock + <li>H5Sopen +</ul> +</td><td> </td><td valign=top> +<ul> + <li>H5Sselect_name + <li>H5Sselect_op + <li>H5Sselect_order +</ul> +</td><td> </td><td valign=top> +<ul> + <li>H5Ssubspace + <li>H5Ssubspace_name + <li>H5Ssubspace_location +</ul> +</td></tr> +</table> + <hr> <dl> @@ -196,18 +234,89 @@ elements of a dataset. </dl> +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SelectAll">H5Sselect_all</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Sselect_all</code>(<em>hid_t</em> <code>space_id</code>) +<dt><strong>Purpose:</strong> + <dd>Selects the entire dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Sselect_all</code> selects the entire extent + of the dataspace <code>space_id</code>. + <p> + More specifically, <code>H5Sselect_all</code> selects + the special <tt>5S_SELECT_ALL</tt> region for the dataspace + <code>space_id</code>. <tt>H5S_SELECT_ALL</tt> selects the + entire dataspace for any dataspace it is applied to. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>IN: The identifier for the dataspace in which the + selection is being made. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SelectNone">H5Sselect_none</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Sselect_none</code>(<em>hid_t</em> <code>space_id</code>) +<dt><strong>Purpose:</strong> + <dd>Resets the selection region to include no elements. +<dt><strong>Description:</strong> + <dd><code>H5Sselect_none</code> resets the selection region + for the dataspace <code>space_id</code> to include no elements. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>IN: The identifier for the dataspace in which the + selection is being reset. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SelectValid">H5Sselect_valid</a> +<dt><strong>Signature:</strong> + <dd><em>hbool_t</em> <code>H5Sselect_valid</code>(<em>hid_t</em> <code>space_id</code>) +<dt><strong>Purpose:</strong> + <dd>Verifies that the selection is within the extent of the dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Sselect_valid</code> 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. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>The identifier for the dataspace in which the + selection is being reset. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns <tt>TRUE</tt> if the selection is contained within + the extent and <tt>FALSE</tt> if it is not. + Returns <tt>FAIL</tt> (<tt>-1</tt>) on error conditions + such as the selection or extent not being defined. +</dl> + <hr> <dl> -<dt><strong>Name:</strong> <a name="Dataspace-ExtentNpoints">H5Sextent_npoints</a> +<dt><strong>Name:</strong> <a name="Dataspace-ExtentNpoints">H5Sget_simple_extent_npoints</a> <dt><strong>Signature:</strong> - <dd><em>hsize_t</em> <code>H5Sextent_npoints</code>(<em>hid_t </em><code>space_id</code>) + <dd><em>hsize_t</em> <code>H5Sget_simple_extent_npoints</code>(<em>hid_t </em><code>space_id</code>) <dt><strong>Purpose:</strong> <dd>Determines the number of elements in a dataspace. <dt><strong>Description:</strong> - <dd><code>H5Sextent_npoints</code> determines the number of elements + <dd><code>H5Sget_simple_extent_npoints</code> determines the number of elements in a dataspace. For example, a simple 3-dimensional dataspace with dimensions 2, 3, and 4 would have 24 elements. <dt><strong>Parameters:</strong> @@ -223,13 +332,13 @@ elements of a dataset. <hr> <dl> -<dt><strong>Name:</strong> <a name="Dataspace-SelectNpoints">H5Sselect_npoints</a> +<dt><strong>Name:</strong> <a name="Dataspace-SelectNpoints">H5Sget_select_npoints</a> <dt><strong>Signature:</strong> - <dd><em>hsize_t</em> <code>H5Sselect_npoints</code>(<em>hid_t</em> <code>space_id</code>) + <dd><em>hsize_t</em> <code>H5Sget_select_npoints</code>(<em>hid_t</em> <code>space_id</code>) <dt><strong>Purpose:</strong> <dd>Determines the number of elements in a dataspace. <dt><strong>Description:</strong> - <dd><code>H5Sselect_npoints</code> determines the number of elements + <dd><code>H5Sget_select_npoints</code> determines the number of elements in the current selection of a dataspace. <dt><strong>Parameters:</strong> <dl> @@ -237,20 +346,20 @@ elements of a dataset. <dd>Dataspace identifier. </dl> <dt><strong>Returns:</strong> - <dd>Returns a dataspace identifier if successful; + <dd>Returns the number of elements in the selection if successful; otherwise FAIL (-1). </dl> <hr> <dl> -<dt><strong>Name:</strong> <a name="Dataspace-ExtentNdims">H5Sextent_ndims</a> +<dt><strong>Name:</strong> <a name="Dataspace-ExtentNdims">H5Sget_simple_extent_ndims</a> <dt><strong>Signature:</strong> - <dd><em>int</em> <code>H5Sextent_ndims</code>(<em>hid_t</em> <code>space_id</code>) + <dd><em>int</em> <code>H5Sget_simple_extent_ndims</code>(<em>hid_t</em> <code>space_id</code>) <dt><strong>Purpose:</strong> <dd>Determines the dimensionality of a dataspace. <dt><strong>Description:</strong> - <dd><code>H5Sextent_ndims</code> determines the dimensionality (or rank) + <dd><code>H5Sget_simple_extent_ndims</code> determines the dimensionality (or rank) of a dataspace. <dt><strong>Parameters:</strong> <dl> @@ -265,16 +374,16 @@ elements of a dataset. <hr> <dl> -<dt><strong>Name:</strong> <a name="Dataspace-ExtentDims">H5Sextent_dims</a> +<dt><strong>Name:</strong> <a name="Dataspace-ExtentDims">H5Sget_simple_extent_dims</a> <dt><strong>Signature:</strong> - <dd><em>int</em> <code>H5Sextent_dims</code>(<em>hid_t</em> <code>space_id</code>, + <dd><em>int</em> <code>H5Sget_simple_extent_dims</code>(<em>hid_t</em> <code>space_id</code>, <em>hsize_t *</em><code>dims</code>, <em>hsize_t *</em><code>maxdims</code> ) <dt><strong>Purpose:</strong> <dd>Retrieves dataspace dimension size and maximum size. <dt><strong>Description:</strong> - <dd><code>H5Sextent_dims</code> returns the size and maximum sizes + <dd><code>H5Sget_simple_extent_dims</code> returns the size and maximum sizes of each dimension of a dataspace through the <code>dims</code> and <code>maxdims</code> parameters. <dt><strong>Parameters:</strong> @@ -294,9 +403,35 @@ elements of a dataset. <hr> <dl> +<dt><strong>Name:</strong> <a name="Dataspace-GetSpaceType">H5Sget_space_type</a> +<dt><strong>Signature:</strong> + <dd><em>H5S_class_t</em> <code>H5Sget_space_type</code>(<em>hid_t</em> <code>space_id</code>) +<dt><strong>Purpose:</strong> + <dd>Determine the current class of a dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Sget_space_type</code> queries a dataspace to determine the + current class of a dataspace. + <p> + The function returns a class name, one of the following: + <code>H5S_SCALAR</code>, + <code>H5S_SIMPLE</code>, or + <code>H5S_NONE</code>. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>Dataspace identifier. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a dataspace class name if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> <dt><strong>Name:</strong> <a name="Dataspace-SetExtentSimple">H5Sset_extent_simple</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5S_set_extent_simple</code>(<em>hid_t</em> <code>space_id</code>, + <dd><em>herr_t</em> <code>H5Sset_extent_simple</code>(<em>hid_t</em> <code>space_id</code>, <em>int</em> <code>rank</code>, <em>const hsize_t *</em><code>current_size</code>, <em>const hsize_t *</em><code>maximum_size</code> @@ -304,7 +439,7 @@ elements of a dataset. <dt><strong>Purpose:</strong> <dd>Sets or resets the size of an existing dataspace. <dt><strong>Description:</strong> - <dd><code>H5S_set_extent_simple</code> sets or resets the size of + <dd><code>H5Sset_extent_simple</code> sets or resets the size of an existing dataspace. <p> <code>rank</code> is the dimensionality, or number of @@ -360,19 +495,51 @@ elements of a dataset. <hr> <dl> -<dt><strong>Name:</strong> <a name="Dataspace-GetClass">H5Sget_class</a> +<dt><strong>Name:</strong> <a name="Dataspace-OffsetSimple">H5Soffset_simple</a> <dt><strong>Signature:</strong> - <dd><em>H5S_class_t</em> <code>H5Sget_class</code>(<em>hid_t</em> <code>space_id</code>) + <dd><em>herr_t</em> <code>H5Soffset_simple</code>(<em>hid_t</em> <code>space_id</code>, + <em>const hssize_t *</em><code>offset</code> + ) +<dt><strong>Purpose:</strong> + <dd>Sets the offset of a simple dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Soffset_simple</code> sets the offset of a + simple dataspace <code>space_id</code>. The <code>offset</code> + 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 <TT>NULL</TT>, the offset for the dataspace + is reset to 0. + <p> + This function allows the same shaped selection to be moved + to different locations within a dataspace without requiring it + to be redefined. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>IN: The identifier for the dataspace object to reset. + <dt><em>const hssize_t *</em><code>offset</code> + <dd>IN: The offset at which to position the selection. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-ExtentClass">H5Sextent_class</a> +<dt><strong>Signature:</strong> + <dd><em>H5S_class_t</em> <code>H5Sextent_class</code>(<em>hid_t</em> <code>space_id</code>) <dt><strong>Purpose:</strong> <dd>Determine the current class of a dataspace. <dt><strong>Description:</strong> - <dd><code>H5Sget_class</code> queries a dataspace to determine the + <dd><code>H5Sextent_class</code> queries a dataspace to determine the current class of a dataspace. <p> The function returns a class name, one of the following: <code>H5S_SCALAR</code>, - <code>H5S_SIMPLE</code>, or - <code>H5S_NONE</code>. + <code>H5S_SIMPLE</code>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>space_id</code> @@ -380,6 +547,56 @@ elements of a dataset. </dl> <dt><strong>Returns:</strong> <dd>Returns a dataspace class name if successful; + otherwise H5S_NO_CLASS (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-ExtentCopy">H5Sextent_copy</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Sextent_copy</code>(<em>hid_t</em> <code>dest_space_id</code>, + <em>hid_t</em> <code>source_space_id</code> + ) +<dt><strong>Purpose:</strong> + <dd>Copies the extent of a dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Sextent_copy</code> copies the extent from + <code>source_space_id</code> to <code>dest_space_id</code>. + This action may change the type of the dataspace. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>dest_space_id</code> + <dd>IN: The identifier for the dataspace from which + the extent is copied. + <dt><em>hid_t</em> <code>source_space_id</code> + <dd>IN: The identifier for the dataspace to which + the extent is copied. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SetExtentNone">H5Sset_extent_none</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Sset_extent_none</code>(<em>hid_t</em> <code>space_id</code>) +<dt><strong>Purpose:</strong> + <dd>Removes the extent from a dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Sset_extent_none</code> removes the extent from + a dataspace and sets the type to <tt>H5S_NONE</tt>. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>The identifier for the dataspace from which + the extent is to be removed. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; otherwise FAIL (-1). </dl> @@ -515,7 +732,10 @@ I/O is performed. H5S <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> @@ -523,7 +743,7 @@ H5S <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 1 September 1998 </body> </html> |