From dd99ecc1bc61eaf352e9e83322ff6c77b9ddcd2f Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Wed, 9 Sep 1998 17:48:37 -0500 Subject: [PATCH] [svn-r680] H5.user.html A little editorial cleanup. Added link to Ragged.html, Ragged Arrays. Added link to Environment.html, Environmental Variables and Configuration Parameters. Added link to Copyright.html. Ragged.html Added "Use at your own risk" notice. Environment.html New file for environmental variables and configuration parameters. Datatypes.html Added the following datatypes: H5T_NATIVE_HSIZE H5T_NATIVE_HSSIZE H5T_NATIVE_HERR H5T_NATIVE_HBOOL Section 8, "Data Conversions" Added named link tag to catch hyperlink from RM. Revised "Note:" to emphasize limited inate data-conversion capability. Copyright.html New file. Copyright statement, linked into User's Guide and Reference Manual. Glossary.html Unlinked for Beta. General Changed email link at bottom of "user guide level documents" (as contrasted with "developer guide level documents" listed on the lower half of the User's Guide front page) to HDF Help Desk, hdfhelp@ncsa.uiuc.edu. Changed the following function names: From: To: H5version H5get_libversion H5vers_check H5check_version H5Anum_attrs H5Aget_num_attrs H5Fget_create_template() H5Fget_create_plist() H5Fget_access_template() H5Fget_access_plist() H5Gstat H5Gget_stat H5Sextent_npoints H5Sget_simple_extent_npoints H5Sextent_ndims H5Sget_simple_extent_ndims H5Sextent_dims H5Sget_simple_extent_dims H5Sget_class H5Sget_simple_extent_type H5Sselect_npoints H5Sget_select_npoints --- doc/html/Attributes.html | 11 +++++++--- doc/html/Caching.html | 12 ++++++++++ doc/html/Datasets.html | 12 ++++++++++ doc/html/Dataspaces.html | 26 +++++++++++++++++----- doc/html/Datatypes.html | 47 +++++++++++++++++++++++++++++++++++----- doc/html/Debugging.html | 12 ++++++++++ doc/html/Errors.html | 12 ++++++++++ doc/html/Files.html | 12 ++++++++++ doc/html/Filters.html | 12 ++++++++++ doc/html/Groups.html | 12 ++++++++++ doc/html/H5.user.html | 41 +++++++++++++++++++++++++++-------- doc/html/Properties.html | 12 ++++++++++ doc/html/Ragged.html | 25 +++++++++++++++++++++ doc/html/Version.html | 18 ++++++++++++--- 14 files changed, 238 insertions(+), 26 deletions(-) diff --git a/doc/html/Attributes.html b/doc/html/Attributes.html index 85fe70f034..f78b23e8ae 100644 --- a/doc/html/Attributes.html +++ b/doc/html/Attributes.html @@ -165,13 +165,18 @@ This function returns the length of the attribute's name (which may be longer than buf_size) on success or negative for failure.

-
int H5Anum_attrs (hid_t loc_id) +
int H5Aget_num_attrs (hid_t loc_id)
This function returns the number of attributes attached to a dataset or group, loc_id. This function returns non-negative for success or negative for failure. -
-
HDF Support
+
+
+HDF Help Desk + +
+Last modified: 3 September 1998 + diff --git a/doc/html/Caching.html b/doc/html/Caching.html index 4e5a6ace80..7ecfbe8262 100644 --- a/doc/html/Caching.html +++ b/doc/html/Caching.html @@ -72,11 +72,23 @@ the pointer arguments may be null pointers. + + + +
+
+HDF Help Desk +
+ +Last modified: 9 September 1998 + diff --git a/doc/html/Datasets.html b/doc/html/Datasets.html index e0f9680354..eaa282cd58 100644 --- a/doc/html/Datasets.html +++ b/doc/html/Datasets.html @@ -829,11 +829,23 @@ H5Pset_external (plist, "scan3.data", 0, 16); + + + +
+
+HDF Help Desk +
+ +Last modified: 9 September 1998 + diff --git a/doc/html/Dataspaces.html b/doc/html/Dataspaces.html index de097fca74..3136dd2b0c 100644 --- a/doc/html/Dataspaces.html +++ b/doc/html/Dataspaces.html @@ -298,7 +298,7 @@ failure.
-hsize_t H5Sextent_npoints (hid_t space)
+hsize_t H5Sget_simple_extent_npoints (hid_t space)
This function determines the number of elements in a dataspace. For example, a @@ -308,7 +308,7 @@ Returns the number of elements in the dataspace, negative on failure.
-int H5Sextent_ndims (hid_t space)
+int H5Sget_simple_extent_ndims (hid_t space)
This function determines the dimensionality (or rank) of a dataspace. @@ -316,7 +316,7 @@ Returns the number of dimensions in the dataspace, negative on failure.
-herr_t H5Sextent_dims (hid_t space, hsize_t *dims, +herr_t H5Sget_simple_extent_dims (hid_t space, hsize_t *dims, hsize_t *max)
@@ -481,7 +481,7 @@ the selection or extent is not defined).
-hsize_t H5Sselect_npoints (hid_t space)
+hsize_t H5Sget_select_npoints (hid_t space)
This function determines the number of elements in the current selection @@ -556,13 +556,27 @@ is returned.
+Last -modified: Thu May 28 15:12:04 EST 1998  +
+--> +Last + + + +
+
+HDF Help Desk + +
+Last modified: 3 September 1998 + diff --git a/doc/html/Datatypes.html b/doc/html/Datatypes.html index 4c57359807..248966c3ec 100644 --- a/doc/html/Datatypes.html +++ b/doc/html/Datatypes.html @@ -777,6 +777,22 @@ H5T_NATIVE_LDOUBLE long double + + H5T_NATIVE_HSIZE + hsize_t + + + H5T_NATIVE_HSSIZE + hssize_t + + + H5T_NATIVE_HERR + herr_t + + + H5T_NATIVE_HBOOL + hbool_t + @@ -1024,7 +1040,9 @@ hid_t dset4 = H5Dcreate (file, "dset4", t2, space, H5P_DEFAULT); +

8. Data Conversion

+

The library is capable of converting data from one type to another and does so automatically when reading or writing the @@ -1049,11 +1067,18 @@ hid_t dset4 = H5Dcreate (file, "dset4", t2, space, H5P_DEFAULT); conversion functions than calling an application-defined conversion function). -

Note: The alpha version of the library does not contain - a full set of conversions. It can convert from one integer - format to another and one struct to another. It can also - perform byte swapping when the source and destination types are - otherwise the same. +

Note: The HDF5 library contains a deliberately limited + set of conversion routines. It can convert from one integer + format to another, from one floating point format to another, + and from one struct to another. It can also perform byte + swapping when the source and destination types are otherwise + the same. The library does not contain any functions for + converting data between integer and floating point formats. + It is anticipated that some users will find it necessary to + develop float to integer or integer to float conversion functions + at the application level; if they wish, users are invited to + submit those functions to be considered for inclusion in future + versions of the library.

A conversion path contains a source and destination data type and each path contains a hard conversion function @@ -1383,12 +1408,24 @@ H5Tregister_soft ("cus2be", H5T_INTEGER, H5T_INTEGER, cray_ushort2be); conversion path whether that conversion path was actually used or not. + + + +

+
+HDF Help Desk +
+ +Last modified: 9 September 1998 + diff --git a/doc/html/Debugging.html b/doc/html/Debugging.html index bd531f878e..45b9a84887 100644 --- a/doc/html/Debugging.html +++ b/doc/html/Debugging.html @@ -401,11 +401,23 @@ H5E.c:336: warning: trace info was not inserted modified. + + + +
+
+HDF Help Desk +
+ +Last modified: 9 September 1998 + diff --git a/doc/html/Errors.html b/doc/html/Errors.html index 4c3637d3a5..37ef1b8fcd 100644 --- a/doc/html/Errors.html +++ b/doc/html/Errors.html @@ -271,11 +271,23 @@ H5Ewalk_cb(int n, H5E_error_t *err_desc, void *client_data) + + + +
+
+HDF Help Desk +
+ +Last modified: 9 September 1998 + diff --git a/doc/html/Files.html b/doc/html/Files.html index 36512f7823..07ecead114 100644 --- a/doc/html/Files.html +++ b/doc/html/Files.html @@ -527,12 +527,24 @@ + + + +
+
+HDF Help Desk +
+ +Last modified: 9 September 1998 + diff --git a/doc/html/Filters.html b/doc/html/Filters.html index d7a0abad3c..16c0135b34 100644 --- a/doc/html/Filters.html +++ b/doc/html/Filters.html @@ -459,11 +459,23 @@ H5Z: filter statistics accumulated over life of library: + + + +
+
+HDF Help Desk +
+ +Last modified: 9 September 1998 + diff --git a/doc/html/Groups.html b/doc/html/Groups.html index f37a411908..a313f6c1b2 100644 --- a/doc/html/Groups.html +++ b/doc/html/Groups.html @@ -304,11 +304,23 @@ string is returned. + + + +
+
+HDF Help Desk +
+ +Last modified: 9 September 1998 + diff --git a/doc/html/H5.user.html b/doc/html/H5.user.html index a7b59e89e6..30372433a5 100644 --- a/doc/html/H5.user.html +++ b/doc/html/H5.user.html @@ -16,17 +16,17 @@ A guide to the H5F interface.
  • Datasets - A guide to the H5D interface. -
  • Data types - +
  • Data Types - A guide to the H5T interface. -
  • Data spaces - +
  • Data Spaces - A guide to the H5S interface.
  • Groups - A guide to the H5G interface.
  • Attributes - A guide to the H5A interface. -
  • Property lists - +
  • Property Lists - A guide to the H5P interface. -
  • Error handling - +
  • Error Handling - A guide to the H5E interface.
  • Filters - A guide to the H5Z interface. @@ -34,6 +34,12 @@ A guide for meta and raw data caching.
  • Debugging - A guide to debugging HDF5 API calls. +
  • Environment Variables and + Configuration Parameters - + A list of HDF5 environment variables and configuration parameters. +
  • Ragged Arrays - + A guide to the H5R interface. +   (Experimental)

    The following documents form a loosely organized developer's guide to @@ -46,28 +52,45 @@ A description of HDF5 version numbers.

  • I/O Pipeline - A description of the raw data I/O pipeline. -
  • Working with external files - +
  • Working with External Files - A guide to the use of multiple files with HDF5.
  • Large Datasets - A guide to accessing large datasets on small computers. -
  • Memory management - +
  • Memory Management - A white paper about memory management issues in HDF5. -
  • Coding style - +
  • Coding Style - A white paper about coding style in the HDF5 library code. -
  • HDF4/HDF5 compatibility - +
  • HDF4/HDF5 Compatibility - A white paper about compatibility issues between HDF4 and HDF5. -
  • Chunking performance study - +
  • Chunking Performance Study - A white paper describing the HDF5 chunking performance. + + +
    +
    + + +
    +HDF Help Desk +
    +Last modified: 9 September 1998 + +    		 +Copyright   +
    + diff --git a/doc/html/Properties.html b/doc/html/Properties.html index 5b6c03fe86..842c3a88d9 100644 --- a/doc/html/Properties.html +++ b/doc/html/Properties.html @@ -70,12 +70,24 @@ are defined above for H5Pcreate(). + + + +
    +
    +HDF Help Desk +
    + +Last modified: 9 September 1998 + diff --git a/doc/html/Ragged.html b/doc/html/Ragged.html index aaa653b834..1ccce6e29d 100644 --- a/doc/html/Ragged.html +++ b/doc/html/Ragged.html @@ -7,6 +7,19 @@

    Ragged Arrays

    + + +
    + +The H5R Interface is strictly experimental at this time; +the interface may change dramatically or support for ragged arrays +may be unavailable in future in releases. As a result, future releases +may be unable to retrieve data stored with this interface. +

    Use these functions at your own risk!
    +Do not create any archives using this interface!
    +     +
    +

    1. Introduction

    Ragged arrays should be considered alpha quality. They were @@ -128,11 +141,23 @@ with buf containing the original input values. + + + +

    +
    +HDF Help Desk +
    + +Last modified: 8 September 1998 + diff --git a/doc/html/Version.html b/doc/html/Version.html index 3b35124290..abc55158ce 100644 --- a/doc/html/Version.html +++ b/doc/html/Version.html @@ -94,7 +94,7 @@ include file and determine the version of the include files.

    -
    herr_t H5version (unsigned *majnum, unsigned +
    herr_t H5get_libversion (unsigned *majnum, unsigned *minnum, unsigned *relnum)
    This function returns through its arguments the version numbers for the library to which the application is linked. @@ -112,20 +112,32 @@ standard error stream and aborts with a core dump.

    -
    herr_t H5vers_check (unsigned majnum, +
    herr_t H5check_version (unsigned majnum, unsigned minnum, unsigned relnum)
    This function is called by the H5check() macro with the include file version constants. The function compares its arguments to the result returned by - H5version() and if a mismatch is detected prints + H5get_libversion() and if a mismatch is detected prints an error message on the standard error stream and aborts. + + + +
    +
    +HDF Help Desk + +
    +Last modified: 3 September 1998 +