From 1fe42a257ee12f0a7e113079401fa51b566f1bef Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Thu, 26 Aug 2004 12:25:36 -0500 Subject: [svn-r9161] Purpose: Revise H5Premove_filter H5Pset_chunk bug fix Correct H5Premove signature Formatting fix Description: H5Premove_filter -- editorial and technical revisions replaced F90 description H5Pset_chunk -- specified units of chunk size as "dataset elements" fixes Bugzilla #110 H5Premove -- corrected signature, removing duplicate mention of parameters Corrected "electronic versus print" formatting error in functions index Platforms tested: Mozilla Misc. update: --- doc/html/RM_H5P.html | 113 ++++++++++++++++++++++++++++----------------------- 1 file changed, 63 insertions(+), 50 deletions(-) diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index a872178..9f6a3d8 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -73,7 +73,7 @@ which require many different parameters to be easily manipulated.

The C Interfaces: - --> -
@@ -154,12 +154,12 @@ which require many different parameters to be easily manipulated.
  • H5Pset_fapl_stream
  • H5Pget_fapl_stream - - +
  • H5Pget_driver -
  • H5Pset_meta_block_size
  • H5Pget_meta_block_size
  • H5Pset_sieve_buf_size @@ -179,7 +179,7 @@ which require many different parameters to be easily manipulated.
  • xxx
  • xxx   || --> -
      @@ -211,7 +211,7 @@ which require many different parameters to be easily manipulated.
  • H5Pset_compression
  • H5Pget_compression --> -
  • H5Pset_fill_value
  • H5Pget_fill_value
  • H5Pfill_value_defined @@ -225,13 +225,13 @@ which require many different parameters to be easily manipulated.
  • H5Pget_filter
  • H5Pget_filter_by_id
  • H5Pmodify_filter +
  • H5Premove_filter
  • H5Pset_fletcher32
  • H5Pset_shuffle
  • H5Pset_szip
  • H5Pset_external
  • H5Pget_external_count
  • H5Pget_external -
  • H5Premove_filter

    Dataset Access, Memory, and
    Transfer Properties     @@ -268,11 +268,13 @@ which require many different parameters to be easily manipulated. ||   Available only in the parallel HDF5 library.

    • --- FOR USE WITH ELECTRONIC VERSION -----------------------------------> + - + + + - - + + - - + + - + - + - +

    -
    Name: H5Pdelete_filter +
    Name: H5Premove_filter
    Signature:
    herr_t H5Premove_filter(hid_t plist, H5Z_filter_t filter @@ -1419,10 +1422,11 @@ SUBROUTINE
    Delete one or more filters in the filter pipeline.
    Description:
    H5Premove_filter removes the specified - filter from the filter pipeline in plist. + filter from the filter pipeline in the + dataset creation property list plist.

    The filter parameter specifies the filter to be removed. - Valid values of filters to remove are as follows: + Valid values for use in filter are as follows:

    @@ -1454,9 +1458,9 @@ SUBROUTINE

    - Additionally, user defined filters can be removed with this routine - as well by passing the filter ID they were registered with the library - with. + Additionally, user-defined filters can be removed with this routine + by passing the filter identifier with which they were registered + with the HDF5 Library.

    Attempting to remove a filter that is not in the permanent filter pipeline is an error. @@ -1467,9 +1471,9 @@ SUBROUTINE

    Parameters:
    hid_t plist_id -
    IN: Property list identifier. +
    IN: Dataset creation property list identifier.
    H5Z_filter_t filter -
    IN: Type of filter to be deleted. +
    IN: Filter to be deleted.
    Returns:
    Returns a non-negative value if successful; @@ -1479,19 +1483,20 @@ SUBROUTINE 
     SUBROUTINE h5premove_filter_f(prp_id, filter, hdferr) 
+
   IMPLICIT NONE
-  INTEGER(HID_T), INTENT(IN) :: prp_id      ! Property list identifier
-  INTEGER, INTENT(IN)        :: filter      ! Filter to be modified
-                                            ! Valid values are:
-                                            !
-                                            ! H5Z_FILTER_ALL_F
-                                            ! H5Z_FILTER_DEFLATE_F
-                                            ! H5Z_FILTER_SHUFFLE_F
-                                            ! H5Z_FILTER_FLETCHER32_F
-                                            ! H5Z_FILTER_SZIP_F
-                                            !
-  INTEGER, INTENT(OUT)       :: hdferr      ! Error code
-                                            ! 0 on success and -1 on failure
+  INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset creation property 
+                                       ! list identifier
+  INTEGER, INTENT(IN) :: filter        ! Filter to be removed
+                                       ! Valid values are:
+                                       !     H5Z_FILTER_ALL_F
+                                       !     H5Z_FILTER_DEFLATE_F
+                                       !     H5Z_FILTER_SHUFFLE_F
+                                       !     H5Z_FILTER_FLETCHER32_F
+                                       !     H5Z_FILTER_SZIP_F
+                                       !
+  INTEGER, INTENT(OUT) :: hdferr       ! Error code
+                                       ! 0 on success, -1 on failure
 END SUBROUTINE h5premove_filter_f
    @@ -5539,7 +5544,7 @@ END SUBROUTINE h5pregister_f
    Name: H5Premove
    Signature: -
    herr_t H5Premove(plid, name) +
    herr_t H5Premove( hid_t plid; const char *name ) @@ -6093,22 +6098,30 @@ END SUBROUTINE h5pset_cache_f
    H5Pset_chunk sets the size of the chunks used to store a chunked layout dataset. This function is only valid for dataset creation property lists. +

    The ndims parameter currently must be the same size - as the rank of the dataset. The values of the dim + as the rank of the dataset. +

    + The values of the dim array define the size of the chunks to store the dataset's raw data. - As a side-effect, the layout of the dataset is changed to - H5D_CHUNKED, if it is not already. + The unit of measure for dim values is + dataset elements. +

    + As a side-effect of this function, the layout of the dataset is + changed to H5D_CHUNKED, if it is not already so set. + (See H5Pset_layout.)

    Parameters:
      - - + + - - + + - - + +
      hid_t plistIN: Identifier for property list to query.
      hid_t plistIN: Identifier for property list to query.
      int ndimsIN: The number of dimensions of each chunk.
      int ndimsIN: The number of dimensions of each chunk.
      const hsize_t * dim    IN: An array containing the size of each chunk.
      const hsize_t * dim    IN: An array defining the size, in dataset elements, + of each chunk.
    Returns:
    Returns a non-negative value if successful; @@ -9695,7 +9708,7 @@ And in this document, the Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 -- cgit v0.12