diff options
author | Frank Baker <fbaker@hdfgroup.org> | 1999-07-06 16:56:15 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 1999-07-06 16:56:15 (GMT) |
commit | d70b72d630cba4d78cca0f134e6aa26318efff27 (patch) | |
tree | e15ba2e8cd116865c0911a5420b6abc7e855e0cc /doc/html/RM_H5S.html | |
parent | e186d84c5f19ea24d300f0771994628d87a2848d (diff) | |
download | hdf5-d70b72d630cba4d78cca0f134e6aa26318efff27.zip hdf5-d70b72d630cba4d78cca0f134e6aa26318efff27.tar.gz hdf5-d70b72d630cba4d78cca0f134e6aa26318efff27.tar.bz2 |
[svn-r1425]
RM_H5S.html
Dataspaces.html
H5Sselect_hyperslab
H5Sselect_elements
Add H5S_SELECT_OR operator.
Converted operator list to a table.
H5Sextent_copy
Corrected source and destination descriptions. (RM_H5S.html only)
H5Screate
Removed unused H5S_NONE dataspace type.
H5Sset_extent_none
Corrected reset class type to H5S_NO_CLASS (previously said H5S_NONE).
RM_H5G.html
H5Gget_linkval
Corrected descriptions of 'loc_id', 'name', and 'value'.
Corrected "Purpose".
Emphasized need to call H5Gget_objinfo first.
H5Gset_comment
H5Gget_comment
Corrected description of 'loc_id'.
H5Gget_objinfo
Corrected description of 'loc_id'.
Added H5G_TYPE to list of valid values of 'type'.
RM_H5F.html
ExternalFiles.html
H5Fmount
H5Funmount
Corrected description of 'loc_id'.
Changed function descriptions in ExternalFiles.html to correspond to RM.
RM_H5T.html
Moved H5Tget_class and H5Tget_size to "General Datatype Operations" in top index.
Diffstat (limited to 'doc/html/RM_H5S.html')
-rw-r--r-- | doc/html/RM_H5S.html | 54 |
1 files changed, 39 insertions, 15 deletions
diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index 5a7e33e..c8f0e04 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -123,10 +123,9 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Description:</strong> <dd><code>H5Screate</code> creates a new dataspace of a particular <code>type</code>. - The types currently supported are <code>H5S_SCALAR</code>, - <code>H5S_SIMPLE</code>, and <code>H5S_NONE</code>; - others are planned to be added later. The <code>H5S_NONE</code> - dataspace can only hold a selection, not an extent. + The types currently supported are <code>H5S_SCALAR</code> and + <code>H5S_SIMPLE</code>; + others are planned to be added later. <dt><strong>Parameters:</strong> <dl> <dt><em>H5S_class_t</em> <code>type</code> @@ -226,10 +225,23 @@ of the <cite>HDF5 User's Guide.</cite>. <P> The selection operator <code>op</code> determines how the new selection is to be combined with the previously existing - selection for the dataspace. Currently, only the - <code>H5S_SELECT_SET</code> operator is supported, which - replaces the existing selection with the parameters from - this call. When operators other than <code>H5S_SELECT_SET</code> + selection for the dataspace. + The following operators are supported: + <dir> + <table width=80% border=0> + <tr><td valign=top> + <code>H5S_SELECT_SET</code> + </td><td valign=top> + Replaces the existing selection with the parameters from this call. + Overlapping blocks are not supported with this operator. + </td></tr><tr><td valign=top> + <code>H5S_SELECT_OR</code> + </td><td valign=top> + Adds the new selection to the existing selection. + </td></tr> + </table> + </dir> + When operators other than <code>H5S_SELECT_SET</code> are used to combine a new selection with an existing selection, the selection ordering is reset to 'C' array ordering. <dt><strong>Parameters:</strong> @@ -584,10 +596,10 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dest_space_id</code> - <dd>IN: The identifier for the dataspace from which + <dd>IN: The identifier for the dataspace to which the extent is copied. <dt><em>hid_t</em> <code>source_space_id</code> - <dd>IN: The identifier for the dataspace to which + <dd>IN: The identifier for the dataspace from which the extent is copied. </dl> <dt><strong>Returns:</strong> @@ -605,7 +617,7 @@ of the <cite>HDF5 User's Guide.</cite>. <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>. + a dataspace and sets the type to <tt>H5S_NO_CLASS</tt>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>space_id</code> @@ -644,10 +656,22 @@ of the <cite>HDF5 User's Guide.</cite>. selection is to be combined with the already existing selection for the dataspace. <p> - Currently, only the <code>H5S_SELECT_SET</code> operator is - supported; it replaces the existing selection with the - parameters from this call. Overlapping blocks are not - supported with the <code>H5S_SELECT_SET</code> operator. + The following operators are supported: + <dir> + <table width=80% border=0> + <tr><td valign=top> + <code>H5S_SELECT_SET</code> + </td><td valign=top> + Replaces the existing selection with the parameters from this call. + Overlapping blocks are not supported with this operator. + </td></tr><tr><td valign=top> + <code>H5S_SELECT_OR</code> + </td><td valign=top> + Adds the new selection to the existing selection. + </td></tr> + </table> + </dir> + <P> The <code>start</code> array determines the starting coordinates of the hyperslab |