summaryrefslogtreecommitdiffstats
path: root/doc/html/Dataspaces.html
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1999-07-06 16:56:15 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1999-07-06 16:56:15 (GMT)
commitd70b72d630cba4d78cca0f134e6aa26318efff27 (patch)
treee15ba2e8cd116865c0911a5420b6abc7e855e0cc /doc/html/Dataspaces.html
parente186d84c5f19ea24d300f0771994628d87a2848d (diff)
downloadhdf5-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/Dataspaces.html')
-rw-r--r--doc/html/Dataspaces.html50
1 files changed, 38 insertions, 12 deletions
diff --git a/doc/html/Dataspaces.html b/doc/html/Dataspaces.html
index 4f404fd..46eec9c 100644
--- a/doc/html/Dataspaces.html
+++ b/doc/html/Dataspaces.html
@@ -256,9 +256,8 @@ by calling <TT>H5Sclose()</TT>.
<DD>
This function creates a new dataspace of a particular <I>type</I>. The
-types currently supported are H5S_SCALAR, H5S_SIMPLE, or H5S_NONE, although
-others are planned to be added later. The H5S_NONE dataspace can only hold a
-selection, not an extent.
+types currently supported are H5S_SCALAR and H5S_SIMPLE;
+others are planned to be added later.
</DD>
<DT>
@@ -345,7 +344,7 @@ H5S_SIMPLE and the extent is set as specified.
<TT>herr_t H5Sset_extent_none (hid_t <I>space</I>)</TT></DT>
<DD>
-Removes the extent from a dataspace and sets the type to H5S_NONE.
+Removes the extent from a dataspace and sets the type to H5S_NO_CLASS.
</DD>
<DT>
@@ -417,11 +416,24 @@ This function selects a hyperslab region to add to the current selected region
for the <I>space</I> dataspace. The <I>start</I>, <I>stride</I>, <I>count</I>
and <I>block</I> arrays must be the same size as the rank of the dataspace.
The selection operator <I>op</I> determines how the new selection is to be
-combined with the already existing selection for the dataspace. Currently,
-only the H5S_SELECT_SET operator is supported, which replaces the existing
-selection with the parameters from this call. Overlapping blocks are not
-supported with the H5S_SELECT_SET operator.
-<P>The <I>start</I> array determines the starting coordinates of the hyperslab
+combined with the already existing selection for the dataspace.
+Currently, 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 <I>start</I> array determines the starting coordinates of the hyperslab
to select. The <I>stride</I> array chooses array locations from the dataspace
with each value in the <I>stride</I> array determining how many elements to move
in each dimension. Setting a value in the <I>stride</I> array to 1 moves to
@@ -459,9 +471,23 @@ iterated through when I/O is performed. Duplicate coordinate locations are not
checked for.
<P>The selection operator <I>op</I> determines how the new selection is to be
-combined with the already existing selection for the dataspace. Currently,
-only the H5S_SELECT_SET operator is supported, which replaces the existing
-selection with the parameters from this call. When operators other than
+combined with the already existing 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
H5S_SELECT_SET are used to combine a new selection with an existing selection,
the selection ordering is reset to 'C' array ordering.
</DD>