From ca9639706e25a27c20a5566af1202205b701653f Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 20 Oct 1998 22:33:19 -0500 Subject: [svn-r769] H5.intro.html Revised and extended hyperslab selection image. Added section "Selecting a union of hyperslabs." IH_map*.gif (6 new files) New images for "Intro to HDF5." As a composite, these replace H5.intro.datamap.gif. H5.intro.datamap.gif Removed. Replaced by the composite IH_map*.gif. RM_H5RA.html (new file) RM_H5Front.html Tools.html Ragged.html H5.user.html Changed all H5R functions to H5RA. Changed Ragged Array API references from H5R to H5RA. Changed links to RM_H5R.html to RM_H5RA.html. RM_H5R.html Removed. Replaced by RM_H5RA.html. --- doc/html/H5.intro.datamap.gif | Bin 10240 -> 0 bytes doc/html/H5.intro.html | 431 +++++++++++++++++++++++++++++++++++++++++- doc/html/H5.user.html | 2 +- doc/html/IH_map1.gif | Bin 0 -> 2560 bytes doc/html/IH_map2.gif | Bin 0 -> 2560 bytes doc/html/IH_map3.gif | Bin 0 -> 3072 bytes doc/html/IH_map4.gif | Bin 0 -> 3072 bytes doc/html/IH_mapFoot.gif | Bin 0 -> 1024 bytes doc/html/IH_mapHead.gif | Bin 0 -> 2048 bytes doc/html/RM_H5Front.html | 6 +- doc/html/RM_H5R.html | 248 ------------------------ doc/html/RM_H5RA.html | 248 ++++++++++++++++++++++++ doc/html/Ragged.html | 12 +- doc/html/Tools.html | 4 +- 14 files changed, 688 insertions(+), 263 deletions(-) delete mode 100644 doc/html/H5.intro.datamap.gif create mode 100644 doc/html/IH_map1.gif create mode 100644 doc/html/IH_map2.gif create mode 100644 doc/html/IH_map3.gif create mode 100644 doc/html/IH_map4.gif create mode 100644 doc/html/IH_mapFoot.gif create mode 100644 doc/html/IH_mapHead.gif delete mode 100644 doc/html/RM_H5R.html create mode 100644 doc/html/RM_H5RA.html diff --git a/doc/html/H5.intro.datamap.gif b/doc/html/H5.intro.datamap.gif deleted file mode 100644 index 6df224d..0000000 Binary files a/doc/html/H5.intro.datamap.gif and /dev/null differ diff --git a/doc/html/H5.intro.html b/doc/html/H5.intro.html index feab1c1..d00552f 100644 --- a/doc/html/H5.intro.html +++ b/doc/html/H5.intro.html @@ -4,7 +4,7 @@ Introduction to HDF5 - + H5S   H5T   @@ -52,7 +52,7 @@ tools required to meet specific aspects of the HDF5 data-handling requirements. --> @@ -69,7 +69,7 @@ HDF5 Reference Manual  H5G   H5P   H5S   H5T   diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html deleted file mode 100644 index 4e1fd7c..0000000 --- a/doc/html/RM_H5R.html +++ /dev/null @@ -1,248 +0,0 @@ - - -HDF5/H5R Draft API Specification - - - - -
-
-HDF5 Reference Manual  -H5   -H5A   -H5D   -H5E   -H5F   -H5G   -H5P   -H5R   -H5S   -H5T   -H5Z   -Tools   - -
-
- -
-

H5R: Ragged Array Interface

-
- -

Ragged Array API Functions

- - -
- -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!
- -
-

-These functions enable the user to store and retrieve data in ragged arrays. - - - - -
- -       - -
- -

- - - -

-
-
Name: H5Rcreate -
Signature: -
H5Rcreate( , - , - - ) -
Purpose: -
-
Description: -
H5Rcreate -
Parameters: -
-
-
-
-
-
-
-
-
Returns: -
Returns SUCCEED (0) if successful; - otherwise FAIL (-1). -
- - -
-
-
Name: H5Ropen -
Signature: -
H5Ropen( , - , - - ) -
Purpose: -
-
Description: -
H5Ropen -
Parameters: -
-
-
-
-
-
-
-
-
Returns: -
Returns SUCCEED (0) if successful; - otherwise FAIL (-1). -
- - -
-
-
Name: H5Rclose -
Signature: -
H5Rclose( , - , - - ) -
Purpose: -
-
Description: -
H5Rclose -
Parameters: -
-
-
-
-
-
-
-
-
Returns: -
Returns SUCCEED (0) if successful; - otherwise FAIL (-1). -
- - -
-
-
Name: H5Rwrite -
Signature: -
H5Rwrite( , - , - - ) -
Purpose: -
-
Description: -
H5Rwrite -

- Datatype conversion takes place at the time of a read or write - and is automatic. See the - Data Conversion - section of The Data Type Interface (H5T) in the - HDF5 User's Guide for a discussion of - data conversion, including the range of conversions currently - supported by the HDF5 libraries. -

Parameters: -
-
-
-
-
-
-
-
-
Returns: -
Returns SUCCEED (0) if successful; - otherwise FAIL (-1). -
- - -
-
-
Name: H5Rread -
Signature: -
H5Rread( , - , - - ) -
Purpose: -
-
Description: -
H5Rread -

- Datatype conversion takes place at the time of a read or write - and is automatic. See the - Data Conversion - section of The Data Type Interface (H5T) in the - HDF5 User's Guide for a discussion of - data conversion, including the range of conversions currently - supported by the HDF5 libraries. -

Parameters: -
-
-
-
-
-
-
-
-
Returns: -
Returns SUCCEED (0) if successful; - otherwise FAIL (-1). -
- - -
-
-HDF5 Reference Manual  -H5   -H5A   -H5D   -H5E   -H5F   -H5G   -H5P   -H5R   -H5S   -H5T   -H5Z   -Tools   - -
-
- -
-HDF Help Desk - -
-Last modified: 1 September 1998 - - - diff --git a/doc/html/RM_H5RA.html b/doc/html/RM_H5RA.html new file mode 100644 index 0000000..2b2d80e --- /dev/null +++ b/doc/html/RM_H5RA.html @@ -0,0 +1,248 @@ + + +HDF5/H5RA Draft API Specification + + + + +
+
+HDF5 Reference Manual  +H5   +H5A   +H5D   +H5E   +H5F   +H5G   +H5P   +H5RA   +H5S   +H5T   +H5Z   +Tools   + +
+
+ +
+

H5RA: Ragged Array Interface

+
+ +

Ragged Array API Functions

+ + +
+ +The H5RA 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!
+ +
+

+These functions enable the user to store and retrieve data in ragged arrays. + + + + +
+ +       + +
+ +

+ + + +

+
+
Name: H5RAcreate +
Signature: +
H5RAcreate( , + , + + ) +
Purpose: +
+
Description: +
H5RAcreate +
Parameters: +
+
+
+
+
+
+
+
+
Returns: +
Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
+ + +
+
+
Name: H5RAopen +
Signature: +
H5RAopen( , + , + + ) +
Purpose: +
+
Description: +
H5RAopen +
Parameters: +
+
+
+
+
+
+
+
+
Returns: +
Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
+ + +
+
+
Name: H5RAclose +
Signature: +
H5RAclose( , + , + + ) +
Purpose: +
+
Description: +
H5RAclose +
Parameters: +
+
+
+
+
+
+
+
+
Returns: +
Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
+ + +
+
+
Name: H5RAwrite +
Signature: +
H5RAwrite( , + , + + ) +
Purpose: +
+
Description: +
H5RAwrite +

+ Datatype conversion takes place at the time of a read or write + and is automatic. See the + Data Conversion + section of The Data Type Interface (H5T) in the + HDF5 User's Guide for a discussion of + data conversion, including the range of conversions currently + supported by the HDF5 libraries. +

Parameters: +
+
+
+
+
+
+
+
+
Returns: +
Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
+ + +
+
+
Name: H5RAread +
Signature: +
H5RAread( , + , + + ) +
Purpose: +
+
Description: +
H5RAread +

+ Datatype conversion takes place at the time of a read or write + and is automatic. See the + Data Conversion + section of The Data Type Interface (H5T) in the + HDF5 User's Guide for a discussion of + data conversion, including the range of conversions currently + supported by the HDF5 libraries. +

Parameters: +
+
+
+
+
+
+
+
+
Returns: +
Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
+ + +
+
+HDF5 Reference Manual  +H5   +H5A   +H5D   +H5E   +H5F   +H5G   +H5P   +H5RA   +H5S   +H5T   +H5Z   +Tools   + +
+
+ +
+HDF Help Desk + +
+Last modified: 1 September 1998 + + + diff --git a/doc/html/Ragged.html b/doc/html/Ragged.html index 1ccce6e..42e6e0d 100644 --- a/doc/html/Ragged.html +++ b/doc/html/Ragged.html @@ -10,7 +10,7 @@
-The H5R Interface is strictly experimental at this time; +The H5RA 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. @@ -67,7 +67,7 @@ Do not create any archives using this interface!

2. Opening and Closing

-
hid_t H5Rcreate (hid_t location, const char +
hid_t H5RAcreate (hid_t location, const char *name, hid_t type, hid_t plist)
This function creates a new ragged array by creating the @@ -81,7 +81,7 @@ Do not create any archives using this interface! cannot be created.

-
hid_t H5Ropen (hid_t location, const char +
hid_t H5RAopen (hid_t location, const char *name)
This function opens a ragged array by opening the specified group and the component datasets (which should not be accessed @@ -89,7 +89,7 @@ Do not create any archives using this interface! be opened.

-
herr_t H5Rclose (hid_t array) +
herr_t H5RAclose (hid_t array)
All ragged arrays should be closed by calling this function. The group and component datasets will be closed automatically by the library. @@ -104,7 +104,7 @@ Do not create any archives using this interface! number of rows on which to operate.
-
herr_t H5Rwrite (hid_t array_id, hssize_t +
herr_t H5RAwrite (hid_t array_id, hssize_t start_row, hsize_t nrows, hid_t type, hsize_t size[], void *buf[]) @@ -119,7 +119,7 @@ Do not create any archives using this interface! the first row on which to operate.

-
herr_t H5Rread (hid_t array_id, hssize_t +
herr_t H5RAread (hid_t array_id, hssize_t start_row, hsize_t nrows, hid_t type, hsize_t size[], void *buf[]) diff --git a/doc/html/Tools.html b/doc/html/Tools.html index f5c1578..bf44249 100644 --- a/doc/html/Tools.html +++ b/doc/html/Tools.html @@ -16,7 +16,7 @@ HDF5/Tools Draft API Specification H5G   H5P   H5S   H5T   @@ -243,7 +243,7 @@ These tools enable the user to examine HDF5 files interactively. H5G   H5P   H5S   H5T   -- cgit v0.12