From 155171fd2e0b3f3d357631bec57ab6ba08f1184f Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Thu, 17 Apr 2003 15:18:14 -0500 Subject: [svn-r6697] Purpose: Add new function Add operands to 2 existing functions Comment out functions not in R1.6 Description: H5Sget_select_type -- Added new function. H5Sselect_hyperslab -- Added operands H5S_SELECT_AND, H5S_SELECT_XOR, and H5S_SELECT_NOTB, H5S_SELECT_NOTA. Reformatted part of Description source code, with minor copy-edits. H5Sselect_elements -- Added operands H5S_SELECT_APPEND, H5S_SELECT_PREPEND. Commented out these hyperslab functions since they are not "turned on" for Release 1.6: H5Scombine_hyperslab H5Scombine_select H5Sselect_select and the corresponding FORTRAN routines Platforms tested: Safari, IE 5 --- doc/html/RM_H5S.html | 233 +++++++++++++++++++++++++++++++++------------------ 1 file changed, 153 insertions(+), 80 deletions(-) diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index cae5eb8..9b29d93 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -75,6 +75,7 @@ elements of a dataset.
  • H5Sextent_copy
  • H5Sset_extent_simple
  • H5Sset_extent_none +
  • H5Sget_select_type
  • H5Sget_select_npoints
  • H5Sget_select_hyper_nblocks
  • H5Sget_select_hyper_blocklist @@ -87,10 +88,9 @@ elements of a dataset.
  • H5Sselect_none
  • H5Sselect_valid
  • H5Sselect_hyperslab -
  • H5Scombine_hyperslab -
  • H5Scombine_select -
  • H5Sselect_select -
  • H5Sget_select_type + + + @@ -118,31 +118,31 @@ facilitate moving easily between them.
  • h5sis_simple_f
  • h5soffset_simple_f
  • h5sget_simple_extent_dims_f -      
  • h5sget_simple_extent_ndims_f +      
  • h5sget_simple_extent_npoints_f
  • h5sget_simple_extent_type_f +
  • h5sextent_class_f -->
  • h5sextent_copy_f
  • h5sset_extent_simple_f
  • h5sset_extent_none_f +
  • h5sget_select_type_f
  • h5sget_select_npoints_f
  • h5sget_select_hyper_nblocks_f
  • h5sget_select_hyper_blocklist_f + +      
  • h5sget_select_elem_npoints_f
  • h5sget_select_elem_pointlist_f - -      
  • h5sselect_elements_f
  • h5sselect_all_f
  • h5sselect_none_f
  • h5sselect_valid_f
  • h5sselect_hyperslab_f -
  • h5scombine_hyperslab_f -
  • h5scombine_select_f -
  • h5sselect_select_f -
  • h5sget_select_type_f + + + @@ -315,13 +315,13 @@ of the HDF5 User's Guide.. coord array also specifies the order in which the array elements are iterated through when I/O is performed. Duplicate coordinate locations are not checked for. -

    +

    The selection operator op determines how the new selection is to be combined with the previously existing selection for the dataspace. The following operators are supported: -

    - +
    +
    H5S_SELECT_SET @@ -331,12 +331,20 @@ of the HDF5 User's Guide.. H5S_SELECT_OR Adds the new selection to the existing selection. +
    + H5S_SELECT_APPEND + + Adds the new selection following the last element of the existing selection. +
    + H5S_SELECT_PREPEND   + + Adds the new selection preceding the first element of the existing selection.
    -     - 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. + + When operator H5S_SELECT_OR + is used to combine a new selection with an existing selection, + the selection ordering is reset to C array ordering.
    Parameters:
    hid_t space_id @@ -863,10 +871,9 @@ of the HDF5 User's Guide.. The selection operator op determines how the new selection is to be combined with the already existing selection for the dataspace. -

    The following operators are supported: -

    - +
    +
    H5S_SELECT_SET @@ -876,53 +883,77 @@ of the HDF5 User's Guide.. H5S_SELECT_OR Adds the new selection to the existing selection. +    + (Binary OR) +
    + H5S_SELECT_AND + + Retains only the overlapping portions of the new selection and + the existing selection. +    + (Binary AND) +
    + H5S_SELECT_XOR + + Retains only the elements that are members of the new selection or + the existing selection, excluding elements that are members of + both selections. +    + (Binary exclusive-OR, XOR) +
    + H5S_SELECT_NOTB   + + Retains only elements of the existing selection that are not in + the new selection. +
    + H5S_SELECT_NOTA + + Retains only elements of the new selection that are not in + the existing selection.
    -     + -

    -The start array determines the starting coordinates -of the hyperslab -to select. -

    -The stride array chooses array locations -from the dataspace -with each value in the stride array determining how -many elements to move -in each dimension. Setting a value in the stride -array to 1 moves to -each element in that dimension of the dataspace; setting a value of 2 in a -location in the stride array moves to every other -element in that -dimension of the dataspace. In other words, the stride -determines the -number of elements to move from the start location -in each dimension. -Stride values of 0 are not allowed. If the stride -parameter is NULL, -a contiguous hyperslab is selected (as if each value in the -stride array -was set to all 1's). -

    -The count array determines how many blocks to -select from the dataspace, in each dimension. -

    -The block array determines -the size of the element block selected from the dataspace. -If the block -parameter is set to NULL, the block size defaults -to a single element -in each dimension (as if the block array was set to all 1's). -

    -For example, in a 2-dimensional dataspace, setting -start to [1,1], -stride to [4,4], count to [3,7], and -block to [2,2] selects -21 2x2 blocks of array elements starting with location (1,1) and selecting -blocks at locations (1,1), (5,1), (9,1), (1,5), (5,5), etc. -

    -Regions selected with this function call default to C order iteration when -I/O is performed. +

    + The start array determines the starting coordinates + of the hyperslab to select. +

    + The stride array chooses array locations + from the dataspace with each value in the stride + array determining how many elements to move in each dimension. + Setting a value in the stride array to 1 moves to + each element in that dimension of the dataspace; setting a value + of 2 in alocation in the stride array + moves to every other element in that dimension of the dataspace. + In other words, the stride determines the + number of elements to move from the start location + in each dimension. + Stride values of 0 are not allowed. + If the stride parameter is NULL, + a contiguous hyperslab is selected (as if each value in the + stride array were set to all 1's). +

    + The count array determines how many blocks to + select from the dataspace, in each dimension. +

    + The block array determines + the size of the element block selected from the dataspace. + If the block parameter is set to NULL, + the block size defaults to a single element in each dimension + (as if the block array were set to all + 1's). +

    + For example, in a 2-dimensional dataspace, setting + start to [1,1], + stride to [4,4], + count to [3,7], and + block to [2,2] + selects 21 2x2 blocks of array elements starting with + location (1,1) and selecting blocks at locations + (1,1), (5,1), (9,1), (1,5), (5,5), etc. +

    + Regions selected with this function call default to C order + iteration when I/O is performed.

    Parameters:
    hid_t space_id @@ -1186,52 +1217,97 @@ I/O is performed. -
    + -
    + -
    + -
    + -
    + - +
    Name: H5Sget_select_type - +
    Signature: +
    H5S_sel_type H5Sget_select_type(hid_t space_id) +
    Purpose: +
    Determines the type of the dataspace selection. +
    Description: +
    H5Sget_select_type retrieves the + type of selection currently defined for the dataspace + space_id. +
    Parameters: +
    +
    hid_t space_id +
    Dataspace identifier. +
    +
    Returns: +
    Returns the dataspace selection type, a value of + the enumerated datatype H5S_sel_type, + if successful. + Valid return values are as follows: +
    + + +
    + H5S_SEL_NONE + + No selection is defined. +
    + H5S_SEL_POINTS + + A sequence of points is selected. +
    + H5S_SEL_HYPERSLABS + + A hyperslab or compound hyperslab is selected. +
    + H5S_SEL_ALL + + The entire dataset is selected. +
    +
    + Otherwise returns a negative value.
    Non-C API(s):
    @@ -1242,9 +1318,6 @@ I/O is performed.
    - - -
    Name: H5Sclose @@ -1316,7 +1389,7 @@ And in this document, the Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 7 April 2003 +Last modified: 17 April 2003 -- cgit v0.12