diff options
| author | Frank Baker <fbaker@hdfgroup.org> | 1998-12-21 22:52:56 (GMT) |
|---|---|---|
| committer | Frank Baker <fbaker@hdfgroup.org> | 1998-12-21 22:52:56 (GMT) |
| commit | 82fb21b613326522eb0a51f507fd836fb5879c9a (patch) | |
| tree | 7a115f14a272d6264b2fb6caafcb97bd13f8de08 /doc/html | |
| parent | 4952ed4a3691e8e873fc13dd52a38feb0e0935c0 (diff) | |
| download | hdf5-82fb21b613326522eb0a51f507fd836fb5879c9a.zip hdf5-82fb21b613326522eb0a51f507fd836fb5879c9a.tar.gz hdf5-82fb21b613326522eb0a51f507fd836fb5879c9a.tar.bz2 | |
[svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet
been checked into "HDF5 Development" branch.
General
=======
Various "copy edit" types of repairs.
Revisions to document cross-linking.
Added structural links tying all docs together (banners
at top and bottom of documents, similar to Reference Manual
banners of the Beta release).
Set background color to white in all documents.
NCSAfooterlogo.gif
hdf2.jpg
New image files to make the documents more self-contained
(i.e., to prevent loading images from NCSA and HDF home servers).
index.html
Redesigned to isolate links external to the installation
in a single location.
Intro to HDF5
=============
H5.intro.html
Fixed banner linking Intro to other docs.
Set all URLs to be relative within the distribution; nothing
points back to the HDF server.
Updates to "Limits of the Current Release" and "Changes in
the Current Release."
HDF5 User's Guide
=================
Changed several User Guide section titles such that all
sections that are primarily about a particular interface
are now titled in the format "The xxxxx Interface (H5x)".
H5.user.html
Commented out links to developer docs since they are marked
in MANIFEST as not being for distribution in the release.
Removed 2nd and 3rd indices from page.
Changed "freeform" lists of sections (TOCs) to aligned tables.
Datatypes.html
Removed the sentence "I'm deferring definition until later
since they're probably not as important as the other data
types." from Section 3.3, "Properties of Date and Time
Atomic Types."
Added info regarding 'char' versus 'string' datatypes. Added
as Section 3.7, "Character and String Datatype Issues."
References.html
Commented out substantial material (at end of document) from
References planning document that is not appropriate for
the User Guide but that is worth keeping around.
Groups.html
Final edits from elimination of "current working group."
HDF5 Reference Manual
=====================
Removed "Draft" from the <title>__</title> lines.
RM_H5Front.html
Removed 2nd and 3rd indices from page.
Changed "freeform" lists of sections (TOCs) to aligned tables.
RM_H5F.html
RM_H5P.html
Add file mounting information.
Diffstat (limited to 'doc/html')
37 files changed, 3289 insertions, 456 deletions
diff --git a/doc/html/Attributes.html b/doc/html/Attributes.html index f78b23e..fd917ca 100644 --- a/doc/html/Attributes.html +++ b/doc/html/Attributes.html @@ -1,11 +1,73 @@ -<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> + <html> <head> <title>Attributes</title> </head> - <body> - <h1>Attributes</h1> + <body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + Attributes + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + + <h1>The Attribute Interface (H5A)</h1> <h2>1. Introduction</h2> @@ -171,12 +233,72 @@ This function returns non-negative for success or negative for failure. </dl> + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + Attributes + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 3 September 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/Caching.html b/doc/html/Caching.html index 7ecfbe8..c35cc65 100644 --- a/doc/html/Caching.html +++ b/doc/html/Caching.html @@ -4,7 +4,69 @@ <title>Data Caching</title> </head> - <body> + <body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + Caching + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + <h1>Meta Data Caching</h1> <p>The HDF5 library caches two types of data: meta data and raw @@ -72,6 +134,66 @@ the pointer arguments may be null pointers. </dl> + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + Caching + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + <!-- <hr> <address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address> @@ -88,7 +210,7 @@ Last modified: Tue May 26 15:38:27 EDT 1998 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 9 September 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/Chunking.html b/doc/html/Chunking.html index 3267783..f98196f 100644 --- a/doc/html/Chunking.html +++ b/doc/html/Chunking.html @@ -4,7 +4,69 @@ <title>Dataset Chunking Issues</title> </head> - <body> + <body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + Chunking + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + <h1>Dataset Chunking Issues</h1> <h2>Table of Contents</h2> @@ -182,6 +244,64 @@ added before the second alpha release. +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + Chunking + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + <!-- <hr> @@ -199,7 +319,7 @@ Last modified: Fri Oct 23 10:30:52 EDT 1998 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 26 October 1998 +Last modified: 30 October 1998 </body> diff --git a/doc/html/Datasets.html b/doc/html/Datasets.html index eaa282c..0e64468 100644 --- a/doc/html/Datasets.html +++ b/doc/html/Datasets.html @@ -4,7 +4,67 @@ <title>The Dataset Interface (H5D)</title> </head> - <body> + <body bgcolor="#FFFFFF"> + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + Datasets + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + <h1>The Dataset Interface (H5D)</h1> <h2>1. Introduction</h2> @@ -829,6 +889,66 @@ H5Pset_external (plist, "scan3.data", 0, 16); </table> </center> + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + Datasets + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + <!-- <hr> <address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address> @@ -845,7 +965,7 @@ Last modified: Wed May 13 18:57:47 EDT 1998 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 9 September 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/Dataspaces.html b/doc/html/Dataspaces.html index 1004d3b..97feff6 100644 --- a/doc/html/Dataspaces.html +++ b/doc/html/Dataspaces.html @@ -3,7 +3,68 @@ <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> <TITLE>The Data Space Interface (H5S)</TITLE> </HEAD> -<BODY> +<body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + Dataspaces + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + <H1> The Dataspace Interface (H5S)</H1> @@ -555,7 +616,66 @@ is returned. </DL> -<HR> + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + Dataspaces + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + <!-- <ADDRESS> <A HREF="mailto:matzke@llnl.gov">Robb Matzke</A></ADDRESS> @@ -576,7 +696,7 @@ Last modified: Thu May 28 15:12:04 EST 1998 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 26 October 1998 +Last modified: 30 October 1998 </BODY> </HTML> diff --git a/doc/html/Datatypes.html b/doc/html/Datatypes.html index e02a7f7..604b480 100644 --- a/doc/html/Datatypes.html +++ b/doc/html/Datatypes.html @@ -4,7 +4,69 @@ <title>The Data Type Interface (H5T)</title> </head> - <body> + <body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + Data Types + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + <h1>The Data Type Interface (H5T)</h1> <h2>1. Introduction</h2> @@ -358,9 +420,6 @@ <em>19971205162530</em>; as an integer value in Unix time(2) format; or other variations. - <p>I'm deferring definition until later since they're probably not - as important as the other data types. - <h3>3.4. Properties of Character String Atomic Types</h3> <p>Fixed-length character string types are used to store textual @@ -437,6 +496,88 @@ but the application is responsible for data conversion of these types. + <h3>3.7 Character and String Datatype Issues</h3> + + The <code>H5T_NATIVE_CHAR</code> and <code>H5T_NATIVE_UCHAR</code> + data types are actually numeric data (1-byte integers). If the + application wishes to store character data, then an HDF5 + <em>string</em> data type should be derived from + <code>H5T_C_S1</code> instead. + + <h4>Motivation</h4> + + HDF5 defines at least three classes of data types: + integer data, floating point data, and character data. + However, the C language defines only integer and + floating point data types; character data in C is + overloaded on the 8- or 16-bit integer types and + character strings are overloaded on arrays of those + integer types which, by convention, are terminated with + a zero element. + + In C, the variable <code>unsigned char s[256]</code> is + either an array of numeric data, a single character string + with at most 255 characters, or an array of 256 characters, + depending entirely on usage. For uniformity with the + other <code>H5T_NATIVE_</code> types, HDF5 uses the + numeric interpretation of <code>H5T_NATIVE_CHAR</code> + and <code>H5T_NATIVE_UCHAR</code>. + + + <h4>Usage</h4> + + To store <code>unsigned char s[256]</code> data as an + array of integer values, use the HDF5 data type + <code>H5T_NATIVE_UCHAR</code> and a data space that + describes the 256-element array. Some other application + that reads the data will then be able to read, say, a + 256-element array of 2-byte integers and HDF5 will + perform the numeric translation. + + To store <code>unsigned char s[256]</code> data as a + character string, derive a fixed length string data type + from <code>H5T_C_S1</code> by increasing its size to + 256 characters. Some other application that reads the + data will be able to read, say, a space padded string + of 16-bit characters and HDF5 will perform the character + and padding translations. + + <pre> + hid_t s256 = H5Tcopy(H5T_C_S1); + H5Tset_size(s256, 256); + </pre> + + To store <code>unsigned char s[256]</code> data as + an array of 256 ASCII characters, use an + HDF5 data space to describe the array and derive a + one-character string type from <code>H5T_C_S1</code>. + Some other application will be able to read a subset + of the array as 16-bit characters and HDF5 will + perform the character translations. + The <code>H5T_STR_NULLPAD</code> is necessary because + if <code>H5T_STR_NULLTERM</code> were used + (the default) then the single character of storage + would be for the null terminator and no useful data + would actually be stored (unless the length were + incremented to more than one character). + + <pre> + hid_t s1 = H5Tcopy(H5T_C_S1); + H5Tset_strpad(s1, H5T_STR_NULLPAD); + </pre> + + <h4>Summary</h4> + + The C language uses the term <code>char</code> to + represent one-byte numeric data and does not make + character strings a first-class data type. + HDF5 makes a distinction between integer and + character data and maps the C <code>signed char</code> + (<code>H5T_NATIVE_CHAR</code>) and + <code>unsigned char</code> (<code>H5T_NATIVE_UCHAR</code>) + data types to the HDF5 integer type class. + + <h2>4. Properties of Compound Types</h2> <p>A compound data type is similar to a <code>struct</code> in C @@ -1412,15 +1553,77 @@ H5Tregister(H5T_PERS_SOFT, "cus2be", conversion path whether that conversion path was actually used or not. - - <hr> - <address> - <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> - </address> +<<<<<<< Datatypes.html + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + Data Types + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + +<hr> +<address> +<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> +</address> <!-- Created: Thu Dec 4 14:57:32 EST 1997 --> <!-- hhmts start --> Last modified: Wed Dec 16 13:04:58 EST 1998 <!-- hhmts end --> - - </body> + + +</body> </html> diff --git a/doc/html/Debugging.html b/doc/html/Debugging.html index 45b9a84..34ad4e7 100644 --- a/doc/html/Debugging.html +++ b/doc/html/Debugging.html @@ -4,7 +4,69 @@ <title>Debugging HDF5 Applications</title> </head> - <body> + <body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + Debugging + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + <h1>Debugging HDF5 Applications</h1> <h2>Introduction</h2> @@ -401,6 +463,65 @@ H5E.c:336: warning: trace info was not inserted modified. +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + Debugging + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + <!-- <hr> <address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address> @@ -417,7 +538,7 @@ Last modified: Thu Aug 20 10:43:42 PDT 1998 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 9 September 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/Environment.html b/doc/html/Environment.html index 8308d17..3e2141d 100644 --- a/doc/html/Environment.html +++ b/doc/html/Environment.html @@ -1,5 +1,186 @@ <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> +<<<<<<< Environment.html +<head> +<title>HDF5 Library Environment Variables and Configuration Parameters</title> +</head> + +<body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + Environment + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + +<h1>HDF5 Library Environment Variables and Configuration Parameters</h1> + +<h2>1. Environment Variables</h2> + +The HDF5 library uses UNIX environment variables to control +or adjust certain library features at runtime. The variables and +their defined effects are as follows: + +<dir> +<dl> + <dt><tt>HDF5_DEBUG</tt> + <dd>Defines a list of debugging switches documented in the + <a href="Debugging.html">Debugging</a> section of the + <cite>HDF5 User's Guide</cite>. + + <dt><tt>HDF5_NOCLEANUP</tt> + <dd>When set to a non-empty value, the programs in the test + directory do not remove temporary HDF5 data files. + The default is for each test to remove the files before exit. + + <dt><tt>HDF5_MPI_OPT_TYPES</tt> + (for parallel beta version only) + <dd>When set to <code>1</code>, PHDF5 will use the MPI optimized + code to perform parallel read/write accesses to datasets. + Currently, this optimization fails when accessing extendable + datasets. The default is not to use the optimized code. + + <dt><tt>HDF5_MPI_1_METAWRITE</tt> + (for parallel beta version only) + <dd>When set to <code>1</code>, PHDF5 will write the metadata + via process 0 of each opened parallel HDF5 file. This should + improve I/O throughput. The default is not to use this + optimization. + +</dl> +</dir> + +<h2>2. Configuration Parameters</h2> + +The HDF5 configuration script accepts a list of parameters to control +configuration features when creating the Makefiles for the library. +The command +<br> +<code> configure --help </code> +<br> +will display the current list of parameters and their effects. + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + Environment + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + +<hr> + +<address> +<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> +</address> +======= <head> <title>HDF5 Library Environment Variables and Configuration Parameters</title> @@ -89,14 +270,15 @@ <br> will display the current list of parameters and their effects. - <hr> - <address> - <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> - </address> +<hr> +<address> +<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> +</address> + +Last modified: 25 November 1998 - Last modified: 9 September 1998 - </body> +</body> </html> diff --git a/doc/html/Errors.html b/doc/html/Errors.html index 37ef1b8..8085b40 100644 --- a/doc/html/Errors.html +++ b/doc/html/Errors.html @@ -4,7 +4,69 @@ <title>The Error Handling Interface (H5E)</title> </head> - <body> + <body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + Error Handling + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + <h1>The Error Handling Interface (H5E)</h1> <h2>1. Introduction</h2> @@ -269,6 +331,64 @@ H5Ewalk_cb(int n, H5E_error_t *err_desc, void *client_data) </table> </center> + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + Error Handling + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> <!-- @@ -287,7 +407,7 @@ Last modified: Wed Mar 4 10:06:17 EST 1998 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 9 September 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/Files.html b/doc/html/Files.html index ecec10b..d371697 100644 --- a/doc/html/Files.html +++ b/doc/html/Files.html @@ -4,8 +4,68 @@ <title>HDF5 Files</title> </head> - <body> - <h1>Files</h1> + <body bgcolor="#FFFFFF"> + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + Files + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + <h1>The File Interface (H5F)</h1> <h2>1. Introduction</h2> @@ -529,6 +589,65 @@ </dl> +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + Files + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + <!-- <hr> <address><a href="mailto:koziol@ncsa.uiuc.edu">Quincey Koziol</a></address> @@ -546,7 +665,7 @@ Last modified: Tue Sep 8 14:43:31 EDT 1998 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 9 September 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/Filters.html b/doc/html/Filters.html index 16c0135..9d1553f 100644 --- a/doc/html/Filters.html +++ b/doc/html/Filters.html @@ -4,8 +4,70 @@ <title>Filters</title> </head> - <body> - <h1>Filters</h1> + <body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + Filters + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + + <h1>Filters in HDF5</h1> <b>Note: Transient pipelines described in this document have not been implemented.</b> @@ -459,6 +521,66 @@ H5Z: filter statistics accumulated over life of library: </table> </center> + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + Filters + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + <!-- <hr> <address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address> @@ -475,7 +597,7 @@ Last modified: Thu Aug 6 14:58:42 EDT 1998 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 9 September 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/Glossary.html b/doc/html/Glossary.html index 9c727a4..1a9d9c8 100644 --- a/doc/html/Glossary.html +++ b/doc/html/Glossary.html @@ -1,5 +1,5 @@ <html><head><title> -HDF5 Draft Glossary +HDF5 Glossary </title></head> <body> diff --git a/doc/html/Groups.html b/doc/html/Groups.html index d6999d9..ed09929 100644 --- a/doc/html/Groups.html +++ b/doc/html/Groups.html @@ -4,8 +4,70 @@ <title>Groups</title> </head> - <body> - <h1>Groups</h1> + <body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + Groups + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + + <h1>The Group Interface (H5G)</h1> <h2>1. Introduction</h2> @@ -75,7 +137,7 @@ <td>File ID</td> <td><code>/foo/bar</code></td> <td>The object <code>bar</code> in group <code>foo</code> - in the root group of the specified file.</td> + in the root group.</td> </tr> <tr> @@ -117,7 +179,7 @@ <tr> <td>File ID</td> <td><code>.</code></td> - <td>The specified file.</td> + <td>The root group of the file.</td> </tr> <tr> @@ -256,6 +318,66 @@ string is returned. </dl> + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + Groups + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + <!-- <hr> <address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address> @@ -272,7 +394,7 @@ Last modified: Wed Jul 22 14:24:34 EDT 1998 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 29 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/H5.intro.html b/doc/html/H5.intro.html index f13ad13..69995ea 100644 --- a/doc/html/H5.intro.html +++ b/doc/html/H5.intro.html @@ -16,14 +16,33 @@ --> +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> +Introduction to HDF5 <br> +<a href="H5.user.html">HDF5 User Guide</a> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +<a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> +<a href="index.html">Other HDF5 documents and links</a> +</td></tr> +</table> +</center> +<hr> + + <a name="Intro-Intro"> <h1 ALIGN="CENTER">Introduction to HDF5 Release 1.0</h1></a> -</FONT><FONT FACE="Times"><P>This is an introduction to the HDF5 data model and programming model. Being a <I>Getting Started</I> or <I>QuickStart</I> document, this </FONT><I>Introduction to HDF5</I> <FONT FACE="Times">is intended to provide enough information for you to develop a basic understanding of how HDF5 works and is meant to be used. Knowledge of the current version of HDF will make it easier to follow the text, but it is not required. More complete information of the sort you will need to actually use HDF5 is available in the HDF5 documentation at </FONT><A HREF="http://hdf.ncsa.uiuc.edu/HDF5/"><FONT FACE="Times">http://hdf.ncsa.uiuc.edu/HDF5/</FONT></A><FONT FACE="Times">. Available documents include the following: +</FONT><FONT FACE="Times"><P>This is an introduction to the HDF5 data model and programming model. Being a <I>Getting Started</I> or <I>QuickStart</I> document, this </FONT><I>Introduction to HDF5</I> <FONT FACE="Times">is intended to provide enough information for you to develop a basic understanding of how HDF5 works and is meant to be used. Knowledge of the current version of HDF will make it easier to follow the text, but it is not required. More complete information of the sort you will need to actually use HDF5 is available in <A HREF="index.html">the HDF5 documentation</FONT></a><FONT FACE="Times">. Available documents include the following: <UL> -</FONT><LI><I>HDF5 User’s Guide</I> at <A HREF="http://hdf.ncsa.uiuc.edu/HDF5/H5.user.html">http://hdf.ncsa.uiuc.edu/HDF5/H5.user.html</A>. Where appropriate, this <I>Introduction</I> will refer to specific sections of the <I>User’s Guide</I>. -<LI><I>HDF5 Reference Manual</I> at <A HREF="http://hdf.ncsa.uiuc.edu/HDF5/RM_H5Front.html">http://hdf.ncsa.uiuc.edu/HDF5/RM_H5Front.html</A>.</UL> +</FONT><LI><A HREF="H5.user.html"><I>HDF5 User’s Guide</I></A>. Where appropriate, this <I>Introduction</I> will refer to specific sections of the <I>User’s Guide</I>. +<LI><I><A HREF="RM_H5Front.html">HDF5 Reference Manual</I></A>.</UL> <FONT FACE="Times"><P>Code examples are available in the source code tree when you install HDF5. @@ -143,25 +162,25 @@ The development of HDF5 is motivated by a number of limitations in the current H <LI>A simpler, better-engineered library and API, with improved support for parallel i/o, threads, and other requirements imposed by modern systems and applications.</UL> <H3><A NAME="Intro-Limits">Limitations of the Current Release</A></H3> -<FONT FACE="Times"><P>The beta release includes most of the basic functionality that is planned for the HDF5 library. However, the library does not implement all of the features detailed in the format and API specifications. Here is a listing of some of the limitations of the current release: +<FONT FACE="Times"><P>This release includes the basic functionality that was planned for the HDF5 library. However, the library does not implement all of the features detailed in the format and API specifications. Here is a listing of some of the limitations of the current release: <UL> </FONT><LI>Data compression is supported, though only GZIP is implemented. GZIP, or GNU Zip, is a compression function from the GNU Project. <LI>Some functions for manipulating dataspaces have not been implemented. <FONT FACE="Times"><LI>Some number types, including user-defined number types are not supported. -</FONT><LI>Deletion (unlinking) and renaming objects is not yet implemented. -<LI>The library is not currently thread aware although we have planned for that possibility and intend eventually to implement it.</UL> +</FONT> +<LI>The library is not currently thread aware although we have planned for that possibility and intend eventually to implement it. +<li>The only reference supported in this release is an object reference. +</UL> <H3><A NAME="Intro-Changes">Changes in the Current Release</A></H3> -<P>A detailed listing of changes in HDF5 since the last release (HDF5 1.0 alpha 2.0) can be found in the file <CODE>hdf5/RELEASE </CODE>in the beta code installation. Important changes include: +<P>A detailed listing of changes in HDF5 since the last release (HDF5 1.0 Beta) can be found in the file <CODE>hdf5/RELEASE </CODE>in the code installation. Important changes include: <UL> -<LI>Improvements have been made in the Dataspace API. -<LI>The library has been changed to accommodate raw data filters provided by application-defined modules. Filters implemented so far include a GZIP data compression module, a checksumming module, and a very simple encryption module. -<LI>All integer and floating point formats of supported machines have been implemented, including the `long double' type where applicable. -<LI>A string datatype has been added. -<LI>All number type conversions have been implemented except conversions between integer and floating point. -<LI>New performance-enhancing features have been implemented.</UL> +<li>An object reference has been implemented. +<li>Union selection (unions of hyperslabs) has been implemented. +<li>Fill values have been implemented. +</UL> <p align=right><font size=-1><a href="#Intro-TOC">(Return to TOC)</a></font> <hr> @@ -172,7 +191,7 @@ The development of HDF5 is motivated by a number of limitations in the current H </FONT><I><LI>HDF5 group: </I>a grouping structure containing instances of zero or more groups or datasets, together with supporting metadata. <I><LI>HDF5 dataset:</I> a multidimensional array of data elements, together with supporting metadata. </UL> -<FONT FACE="Times"><P>Working with groups and group members is similar in many ways to working with directories and files in UNIX. As with UNIX directories and files, objects in an HDF5 file are often described by giving their full path names. +<FONT FACE="Times"><P>Working with groups and group members is similar in many ways to working with directories and files in UNIX. As with UNIX directories and files, objects in an HDF5 file are often described by giving their full (or absolute) path names. </FONT><CODE><DL> <DD>/</CODE> signifies the root group. </DD> <CODE><DD>/foo</CODE> signifies a member of the root group called <CODE>foo</CODE>.</DD> @@ -193,7 +212,7 @@ The development of HDF5 is motivated by a number of limitations in the current H </FONT><B><DFN><P>Name.</B></DFN><FONT FACE="Times"> A dataset <I>name</I> is a sequence of alphanumeric ASCII characters. </FONT><B><DFN><P>Datatype.</B></DFN><FONT FACE="Times"> HDF5 allows one to define many different kinds of datatypes. There are two categories of datatypes: <I>atomic</I> datatypes and <I>compound</I> datatypes. Atomic datatypes are those that are not decomposed at the datatype interface level, such as integers and floats. <I><CODE>NATIVE</CODE></I> datatypes are system-specific instances of atomic datatypes. Compound datatypes are made up of atomic datatypes. And <I>named</I> datatypes are either atomic or compound datatypes that are have been specifically designated to be shared across datasets. <I><P>Atomic datatypes</I> include integers and floating-point numbers. Each atomic type belongs to a particular class and has several properties: size, order, precision, and offset. In this introduction, we consider only a few of these properties. -<P>Atomic datatypes include integer, float, date and time, string, bit field, and opaque. <I>(Note: Only integer, float and string classes are available in the current implementation.) +<P>Atomic classes include integer, float, date and time, string, bit field, and opaque. <I>(Note: Only integer, float and string classes are available in the current implementation.) </I><P>Properties of integer types include size, order (endian-ness), and signed-ness (signed/unsigned). <P>Properties of float types include the size and location of the exponent and mantissa, and the location of the sign bit. <P>The datatypes that are supported in the current implementation are: @@ -201,6 +220,7 @@ The development of HDF5 is motivated by a number of limitations in the current H <UL> </FONT><LI>Integer datatypes: 8-bit, 16-bit, 32-bit, and 64-bit integers in both little and big-endian format. <LI>Floating-point numbers: IEEE 32-bit and 64-bit floating-point numbers in both little and big-endian format. +<li>References. <LI>Strings.</UL> <p> @@ -304,24 +324,25 @@ The development of HDF5 is motivated by a number of limitations in the current H </TABLE> </CENTER> -<FONT FACE="Times"><P>See <I>Datatypes</I> at </FONT><A HREF="http://hdf.ncsa.uiuc.edu/HDF5/Datatypes.html">http://hdf.ncsa.uiuc.edu/HDF5/Datatypes.html</A><FONT FACE="Times"> in the<I> HDF User’s Guide</I> for further information. +<FONT FACE="Times"><P>See <A HREF="Datatypes.html"><I>Datatypes</I></A> in the<I> HDF User’s Guide</I> for further information.</font> <FONT FACE="Times"><P>A <I>compound datatype</I> is one in which a collection of simple datatypes are represented as a single unit, similar to a <I>struct</I> in C. The parts of a compound datatype are called <I>members.</I> The members of a compound datatype may be of any datatype, including another compound datatype. It is possible to read members from a compound type without reading the whole type. <p> <ta/FONT><I><P>Named datatypes.</I> Normally each dataset has its own datatype, but sometimes we may want to share a datatype among several datasets. This can be done using a <I>named </I>datatype. A named data type is stored in the file independently of any dataset, and referenced by all datasets that have that datatype. Named datatypes may have an associated attributes list. -See <I>Datatypes</I> at </FONT><A HREF="http://hdf.ncsa.uiuc.edu/HDF5/Datatypes.html">http://hdf.ncsa.uiuc.edu/HDF5/Datatypes.html</A><FONT FACE="Times"> in the<I> HDF User’s Guide</I> for further information. +See <A HREF="Datatypes.html"><I>Datatypes</I></A></font><FONT FACE="Times"> in the<I> HDF User’s Guide</I> for further information. <B><DFN><P>Dataspace.</B> </DFN>A dataset <I>dataspace </I>describes the dimensionality of the dataset. The dimensions of a dataset can be fixed (unchanging), or they may be <I>unlimited</I>, which means that they are extendible (i.e. they can grow larger). <P>Properties of a dataspace consist of the <I>rank </I>(number of dimensions) of the data array, the <I>actual sizes of the dimensions</I> of the array, and the <I>maximum sizes of the dimensions </I>of the array. For a fixed-dimension dataset, the actual size is the same as the maximum size of a dimension. When a dimension is unlimited, the maximum size is set to the </FONT>value <CODE>H5P_UNLIMITED</CODE>.<FONT FACE="Times"> (An example below shows how to create extendible datasets.) -<P>A dataspace can also describe portions of a dataset, making it possible to do partial I/O operations on <I>selections</I>. <I>Selection</I> is supported by the dataspace interface (H5S). Given an n-dimensional dataset, there are currently three ways to do partial selection: +<P>A dataspace can also describe portions of a dataset, making it possible to do partial I/O operations on <I>selections</I>. <I>Selection</I> is supported by the dataspace interface (H5S). Given an n-dimensional dataset, there are currently four ways to do partial selection: <OL> </FONT><LI>Select a logically contiguous n-dimensional hyperslab. <LI>Select a non-contiguous hyperslab consisting of elements or blocks of elements (hyperslabs) that are equally spaced. +<li>Select a union of hyperslabs. <LI>Select a list of independent points. </OL> <FONT FACE="Times"><P>Since I/O operations have two end-points, the raw data transfer functions require two dataspace arguments: one describes the application memory dataspace or subset thereof, and the other describes the file dataspace or subset thereof. -<P>See <I>Dataspaces</I> at </FONT><A HREF="http://hdf.ncsa.uiuc.edu/HDF5/Dataspaces.html">http://hdf.ncsa.uiuc.edu/HDF5/Dataspaces.html</A><FONT FACE="Times"> in the<I> HDF User’s Guide</I> for further information. +<P>See <A HREF="Dataspaces.html"><I>Dataspaces</I></A></font><FONT FACE="Times"> in the<I> HDF User’s Guide</I> for further information. </FONT><B><DFN><P>Storage layout.</B></DFN><FONT FACE="Times"> The HDF5 format makes it possible to store data in a variety of ways. The default storage layout format is <I>contiguous</I>, meaning that data is stored in the same linear way that it is organized in memory. Two other storage layout formats are currently defined for HDF5: <I>compact, </I>and<I> chunked. </I>In the future, other storage layouts may be added.<I> <P>Compact</I> storage is used when the amount of data is small and can be stored directly in the object header. <I>(Note: Compact storage is not supported in this release.)</I> <I><P>Chunked</I> storage involves dividing the dataset into equal-sized "chunks" that are stored separately. Chunking has three important benefits. @@ -331,12 +352,14 @@ See <I>Datatypes</I> at </FONT><A HREF="http://hdf.ncsa.uiuc.edu/HDF5/Datatypes. <LI>It makes it possible to compress large datasets and still achieve good performance when accessing subsets of the dataset. <LI>It makes it possible efficiently to extend the dimensions of a dataset in any direction.</OL> -<P>See <I>Datasets</I> at </FONT><A HREF="http://hdf.ncsa.uiuc.edu/HDF5/Datasets.html">http://hdf.ncsa.uiuc.edu/HDF5/Datasets.html</A><FONT FACE="Times"> in the<I> HDF User’s Guide</I> for further information. +<P> +See <A HREF="Datasets.html"><I>Datasets</I></A> and <A HREF="Chunking.html"><I>Dataset Chunking Issues</I></A></font><FONT FACE="Times"> in the<I> HDF User’s Guide</I> for further information. +We particularly encourage you to read <A HREF="Chunking.html"><I>Dataset Chunking Issues</I></A> since the issue is complex and beyond the scope of this document. </FONT><H3><A NAME="Intro-OAttributes">HDF5 Attributes</A></H3> <I>Attributes </I>are small named datasets that are attached to primary datasets, groups, or named datatypes. Attributes can be used to describe the nature and/or the intended usage of a dataset or group. An attribute has two parts: (1) a <I>name</I> and (2) a <I>value</I>. The value part contains one or more data entries of the same data type. <FONT FACE="Times"><P>The Attribute API (H5A) is used to read or write attribute information. When accessing attributes, they can be identified by name or by an <I>index value</I>. The use of an index value makes it possible to iterate through all of the attributes associated with a given object. <P>The HDF5 format and I/O library are designed with the assumption that attributes are small datasets. They are always stored in the object header of the object they are attached to. Because of this, large datasets should not be stored as attributes. How large is "large" is not defined by the library and is up to the user's interpretation. (Large datasets with metadata can be stored as supplemental datasets in a group with the primary dataset.) -<P>See <I>Attributes</I> at </FONT><A HREF="http://hdf.ncsa.uiuc.edu/HDF5/Attributes.html">http://hdf.ncsa.uiuc.edu/HDF5/Attributes.html</A><FONT FACE="Times"> in the<I> HDF User’s Guide</I> for further information. +<P>See <A HREF="Attributes.html"><I>Attributes</I></A></font><FONT FACE="Times"> in the<I> HDF User’s Guide</I> for further information. <p align=right><font size=-1><a href="#Intro-TOC">(Return to TOC)</a></font> <hr> @@ -363,7 +386,11 @@ Example: <CODE>H5Aget_name</CODE>, which retrieves name of an attribute. <B><LI>H5Z</B>: <B>C</B>ompression registration routine. <BR> Example: <CODE>H5Zregister</CODE>, which registers new compression and uncompression functions for use with the HDF5 library. <B><LI>H5E</B>: <B>E</B>rror handling routines. <BR> -Example: <CODE>H5Eprint</CODE>, which prints the current error stack.</UL> +Example: <CODE>H5Eprint</CODE>, which prints the current error stack. +<B><LI>H5R</B>: <B>R</B>eference routines. <BR> +Example: <CODE>H5Rcreate</CODE>, which creates a reference. +<B><LI>H5I</B>: <B>I</B>dentifier routine. <BR> +Example: <CODE>H5Iget_type</CODE>, which retrieves the type of an object.</UL> <H3><A NAME="Intro-Include">Include Files</A> </H3> <FONT FACE="Times"><P>There are a number definitions and declarations that should be included with any HDF5 program. These definitions and declarations are contained in several <I>include</I> files. The main include </FONT>file is <CODE>hdf5.h</CODE>. This file<FONT FACE="Times"> includes all of the other files that your program is likely to need. <I>Be sure to include </i><code>hdf5.h</code><i> in any program that uses the HDF5 library.</I></FONT> @@ -418,26 +445,25 @@ status = H5Fclose(file); </PRE> </FONT><CODE><PRE>hid_t dataset, datatype, dataspace; /* declare identifiers */ /* -* 1. Create dataspace: Describe the size of the array and -* create the data space for fixed size dataset. -*/ + * Create dataspace: Describe the size of the array and + * create the data space for fixed size dataset. + */ dimsf[0] = NX; dimsf[1] = NY; dataspace = H5Screate_simple(RANK, dimsf, NULL); /* -/* -* 2. Define datatype for the data in the file. -* We will store little endian integer numbers. -*/ + * Define datatype for the data in the file. + * We will store little endian integer numbers. + */ datatype = H5Tcopy(H5T_NATIVE_INT); status = H5Tset_order(datatype, H5T_ORDER_LE); /* -* 3. Create a new dataset within the file using defined -* dataspace and datatype and default dataset creation -* properties. -* NOTE: H5T_NATIVE_INT can be used as datatype if conversion -* to little endian is not needed. -*/ + * Create a new dataset within the file using defined + * dataspace and datatype and default dataset creation + * properties. + * NOTE: H5T_NATIVE_INT can be used as datatype if conversion + * to little endian is not needed. + */ dataset = H5Dcreate(file, DATASETNAME, datatype, dataspace, H5P_DEFAULT);</PRE> </CODE><H4><A NAME="Intro-PMDiscard">How to discard objects when they are no longer needed</A></H4> <FONT FACE="Times"><P>The datatype, dataspace and dataset objects should be released once they are no longer needed by a program. Since each is an independent object, the must be released (or <I>closed</I>) separately. The following lines of code close the datatype, dataspace, and datasets that were created in the preceding section. @@ -456,7 +482,7 @@ status = H5Dwrite(dataset, H5T_NATIVE_INT, H5S_ALL, H5S_ALL, </FONT><P><A HREF="#CreateExample"><FONT FACE="Times">Example 1</FONT></A><FONT FACE="Times"> contains a program that creates a file and a dataset, and writes the dataset to the file. <P>Reading is analogous to writing. If, in the previous example, we wish to read an entire dataset, we would use the same basic calls with the same parameters. Of course, the routine </FONT><CODE>H5Dread</CODE><FONT FACE="Times"> would replace </FONT><CODE>H5Dwrite</CODE><FONT FACE="Courier">.</FONT><FONT FACE="Times"> </FONT><H4><A NAME="Intro-PMGetInfo">Getting information about a dataset</A></H4> -<FONT FACE="Times"><P>Although reading is analogous to writing, it is often necessary to query a file to obtain information about a dataset. For instance, we often need to know about the datatype associated with a dataset, as well dataspace information (e.g. rank and dimensions). There are several "get" routines for obtaining this information The following code segment illustrates how we would get this kind of information: +<FONT FACE="Times"><P>Although reading is analogous to writing, it is often necessary to query a file to obtain information about a dataset. For instance, we often need to know about the datatype associated with a dataset, as well dataspace information (e.g. rank and dimensions). There are several "get" routines for obtaining this information. The following code segment illustrates how we would get this kind of information: </FONT><CODE><PRE>/* * Get datatype and dataspace identifiers and then query * dataset class, order, size, rank and dimensions. @@ -476,25 +502,27 @@ rank = H5Sget_simple_extent_ndims(dataspace); status_n = H5Sget_simple_extent_dims(dataspace, dims_out); printf("rank %d, dimensions %d x %d \n", rank, dims_out[0], dims_out[1]);</PRE> </CODE><H4><A NAME="Intro-PMRdWrPortion">Reading and writing a portion of a dataset</A></H4> -<P>In the previous discussion, we describe how to access an entire dataset with one write (or read) operation. HDF5 also supports access to portions (or selections) of a dataset in one read/write operation. Currently selections are limited to hyperslabs and the lists of independent points. Both types of selection will be discussed in the following sections. Several sample cases of selection reading/writing are shown on the following figure. +<P>In the previous discussion, we describe how to access an entire dataset with one write (or read) operation. HDF5 also supports access to portions (or selections) of a dataset in one read/write operation. Currently selections are limited to hyperslabs, their unions, and the lists of independent points. Both types of selection will be discussed in the following sections. Several sample cases of selection reading/writing are shown on the following figure. <center> <table bgcolor="#FFFFFF" border=1> <tr><td align=center> <img src="IH_mapHead.gif"> </tr></td><tr><td align=center> -<img src="IH_map1.gif"> +a <img src="IH_map1.gif"> </tr></td><tr><td align=center> -<img src="IH_map2.gif"> +b <img src="IH_map2.gif"> </tr></td><tr><td align=center> -<img src="IH_map3.gif"> +c <img src="IH_map3.gif"> </tr></td><tr><td align=center> -<img src="IH_map4.gif"> +d <img src="IH_map4.gif"> </tr></td><tr><td align=center> <img src="IH_mapFoot.gif"> </tr></td> </table> </center> </B><P>In example (a) a single hyperslab is read from the midst of a two-dimensional array in a file and stored in the corner of a smaller two-dimensional array in memory. In (b) a regular series of blocks is read from a two-dimensional array in the file and stored as a contiguous sequence of values at a certain offset in a one-dimensional array in memory. In (c) a sequence of points with no regular pattern is read from a two-dimensional array in a file and stored as a sequence of points with no regular pattern in a three-dimensional array in memory. +In (d) a union of hyperslabs in the file dataspace is read and +the data is stored in another union of hyperslabs in the memory dataspace. <P>As these examples illustrate, whenever we perform partial read/write operations on the data, the following information must be provided: file dataspace, file dataspace selection, memory dataspace and memory dataspace selection. After the required information is specified, actual read/write operation on the portion of data is done in a single call to the HDF5 read/write functions H5Dread(write). <H5><A NAME="Intro-PMSelectHyper">Selecting hyperslabs</A></H5> <FONT FACE="Times"><P>Hyperslabs are portions of datasets. A hyperslab selection can be a logically contiguous collection of points in a dataspace, or it can be regular pattern of points or blocks in a dataspace. The following picture illustrates a selection of regularly spaced 3x2 blocks in an 8x12 dataspace.</FONT> @@ -683,7 +711,8 @@ offset[0] = 1; offset[1] = 2; count[0] = 3; count[1] = 4; -status = H5Sselect_hyperslab(dataspace, H5S_SELECT_SET, offset, NULL, count, NULL);</PRE> +status = H5Sselect_hyperslab(dataspace, H5S_SELECT_SET, offset, NULL, + count, NULL);</PRE> </CODE><FONT FACE="Times"><P>This describes the dataspace from which we wish to read. We need to define the dataspace in memory analogously. Suppose, for instance, that we have in memory a 3 dimensional 7x7x3 array into which we wish to read the 3x4 hyperslab described above beginning at the element </FONT><CODE><3,0,0></CODE><FONT FACE="Times">. Since the in-memory dataspace has three dimensions, we have to describe the hyperslab as an array with three dimensions, with the last dimension being 1: </FONT><CODE><3,4,1></CODE><FONT FACE="Times">. <P>Notice that we must describe two things: the dimensions of the in-memory array, and the size and position of the hyperslab that we wish to read in. The following code illustrates how this would be done. </FONT><CODE><PRE>/* @@ -703,7 +732,8 @@ offset_out[2] = 0; count_out[0] = 3; count_out[1] = 4; count_out[2] = 1; -status = H5Sselect_hyperslab(memspace, H5S_SELECT_SET, offset_out, NULL, count_out, NULL); +status = H5Sselect_hyperslab(memspace, H5S_SELECT_SET, offset_out, NULL, + count_out, NULL); /*</PRE> </CODE><P><A HREF="#CheckAndReadExample"><FONT FACE="Times">Example 2</FONT></A><FONT FACE="Times"> contains a complete program that performs these operations. @@ -1669,14 +1699,14 @@ and create the union with the first hyperslab. Note that when we add the selected hyperslab to the union, the second argument to the <code>H5Sselect_hyperslab</code> function has to be <code>H5S_SELECT_OR</code> instead of <code>H5S_SELECT_SET</code>. -Using <code>H5S_SELECT_SET</code> would be reset the selection to +Using <code>H5S_SELECT_SET</code> would reset the selection to the second hyperslab. <p> Now define the memory dataspace and select the union of the hyperslabs in the memory dataset. <pre> - /* + /* * Create memory dataspace. */ mid = H5Screate_simple(MSPACE_RANK, mdim, NULL); @@ -1700,8 +1730,7 @@ in the memory dataset. Finally we can read the selected data from the file dataspace to the selection in memory with one call to the <code>H5Dread</code> function. -<pre> - ret = H5Dread(dataset, H5T_NATIVE_INT, mid, fid, H5P_DEFAULT, matrix_out); +<pre> ret = H5Dread(dataset, H5T_NATIVE_INT, mid, fid, H5P_DEFAULT, matrix_out); </pre> <P> @@ -1770,7 +1799,7 @@ H5Tinsert (complex_id, "imaginary", HOFFSET(tmp,im), 2 2 2 3 3 2 2 2 3 3 2 2 2 3 3</PRE> -<FONT FACE="Times"><P>The current version of HDF 5 requires you to use <I>chunking</I> in order to define extendible datasets. Chunking makes it possible to extend datasets efficiently, without having to reorganize storage excessively. +<FONT FACE="Times"><P>HDF 5 requires you to use <I>chunking</I> in order to define extendible datasets. Chunking makes it possible to extend datasets efficiently, without having to reorganize storage excessively. <P>The following operations are required in order to write an extendible dataset: <OL> @@ -1784,15 +1813,15 @@ H5Tinsert (complex_id, "imaginary", HOFFSET(tmp,im), at the creation time */ hsize_t maxdims[2] = {H5S_UNLIMITED, H5S_UNLIMITED}; /* - * 1. Create the data space with unlimited dimensions. + * Create the data space with unlimited dimensions. */ dataspace = H5Screate_simple(RANK, dims, maxdims); </PRE> <B><P>Enabling chunking. </B>We can then set the dataset storage layout properties to enable chunking. We do this using the routine <CODE>H5Pset_chunk</CODE><FONT SIZE=4>: </FONT><PRE>hid_t cparms; hsize_t chunk_dims[2] ={2, 5}; /* -* 2. Modify dataset creation properties to enable chunking. -*/ + * Modify dataset creation properties to enable chunking. + */ cparms = H5Pcreate (H5P_DATASET_CREATE); status = H5Pset_chunk( cparms, RANK, chunk_dims); </PRE> @@ -1809,8 +1838,8 @@ dataset = H5Dcreate(file, DATASETNAME, H5T_NATIVE_INT, dataspace, <B><P>Extending dataset size. </B>Finally, when we want to extend the size of the dataset, we invoke <CODE>H5Dextend </CODE>to extend the size of the dataset. In the following example, we extend the dataset along the first dimension, by seven rows, so that the new dimensions are <CODE><10,3></CODE>: <PRE>/* -* Extend the dataset. Dataset becomes 10 x 3. -*/ + * Extend the dataset. Dataset becomes 10 x 3. + */ dims[0] = dims[0] + 7; size[0] = dims[0]; size[1] = dims[1]; @@ -1824,10 +1853,10 @@ status = H5Dextend (dataset, size);</PRE> <CODE>H5Gcreate</CODE>. For example, the following code creates a group called <code>Data</code> in the root group. <pre> - /* - * Create a group in the file. - */ - grp = H5Gcreate(file, "/Data", 0); + /* + * Create a group in the file. + */ + grp = H5Gcreate(file, "/Data", 0); </pre> A group may be created in another group by providing the absolute name of the group to the <code>H5Gcreate</code> @@ -1836,18 +1865,18 @@ to create the group <code>Data_new</code> in the <code>Data</code> group, one can use the following sequence of calls: <pre> - /* - * Create group "Data_new" in the group "Data" by specifying - * absolute name of the group. - */ - grp_new = H5Gcreate(file, "/Data/Data_new", 0); + /* + * Create group "Data_new" in the group "Data" by specifying + * absolute name of the group. + */ + grp_new = H5Gcreate(file, "/Data/Data_new", 0); </pre> or <pre> - /* - * Create group "Data_new" in the "Data" group. - */ - grp_new = H5Gcreate(grp, "Data_new", 0); + /* + * Create group "Data_new" in the "Data" group. + */ + grp_new = H5Gcreate(grp, "Data_new", 0); </pre> Note that the group identifier <code>grp</code> is used as the first parameter in the <code>H5Gcreate</code> function @@ -1868,23 +1897,23 @@ group by specifying its absolute name as illustrated in the following example: <pre> - /* - * Create the dataset "Compressed_Data" in the group using the - * absolute name. The dataset creation property list is modified - * to use GZIP compression with the compression effort set to 6. - * Note that compression can be used only when the dataset is - * chunked. - */ - dims[0] = 1000; - dims[1] = 20; - cdims[0] = 20; - cdims[1] = 20; - dataspace = H5Screate_simple(RANK, dims, NULL); - plist = H5Pcreate(H5P_DATASET_CREATE); - H5Pset_chunk(plist, 2, cdims); - H5Pset_deflate( plist, 6); - dataset = H5Dcreate(file, "/Data/Compressed_Data", H5T_NATIVE_INT, - dataspace, plist); + /* + * Create the dataset "Compressed_Data" in the group using the + * absolute name. The dataset creation property list is modified + * to use GZIP compression with the compression effort set to 6. + * Note that compression can be used only when the dataset is + * chunked. + */ + dims[0] = 1000; + dims[1] = 20; + cdims[0] = 20; + cdims[1] = 20; + dataspace = H5Screate_simple(RANK, dims, NULL); + plist = H5Pcreate(H5P_DATASET_CREATE); + H5Pset_chunk(plist, 2, cdims); + H5Pset_deflate( plist, 6); + dataset = H5Dcreate(file, "/Data/Compressed_Data", H5T_NATIVE_INT, + dataspace, plist); </pre> A relative dataset name may also be used when a dataset is created. First obtain the identifier of the group in which @@ -1892,18 +1921,18 @@ the dataset is to be created. Then create the dataset with <code>H5Dcreate</code> as illustrated in the following example: <pre> - /* - * Open the group. - */ - grp = H5Gopen(file, "Data"); + /* + * Open the group. + */ + grp = H5Gopen(file, "Data"); - /* - * Create the dataset "Compressed_Data" in the "Data" group - * by providing a group identifier and a relative dataset - * name as parameters to the H5Dcreate function. - */ - dataset = H5Dcreate(grp, "Compressed_Data", H5T_NATIVE_INT, - dataspace, plist); + /* + * Create the dataset "Compressed_Data" in the "Data" group + * by providing a group identifier and a relative dataset + * name as parameters to the H5Dcreate function. + */ + dataset = H5Dcreate(grp, "Compressed_Data", H5T_NATIVE_INT, + dataspace, plist); </pre> <p> @@ -1914,24 +1943,24 @@ the absolute name to access the dataset <code>Compressed_Data</code> in the group <code>Data</code> created in the examples above: <pre> - /* - * Open the dataset "Compressed_Data" in the "Data" group. - */ - dataset = H5Dopen(file, "/Data/Compressed_Data"); + /* + * Open the dataset "Compressed_Data" in the "Data" group. + */ + dataset = H5Dopen(file, "/Data/Compressed_Data"); </pre> The same dataset can be accessed in another manner. First access the group to which the dataset belongs, then open the dataset. <pre> - /* - * Open the group "data" in the file. - */ - grp = H5Gopen(file, "Data"); + /* + * Open the group "data" in the file. + */ + grp = H5Gopen(file, "Data"); - /* - * Access the "Compressed_Data" dataset in the group. - */ - dataset = H5Dopen(grp, "Compressed_Data"); + /* + * Access the "Compressed_Data" dataset in the group. + */ + dataset = H5Dopen(grp, "Compressed_Data"); </pre> <p> @@ -1939,7 +1968,8 @@ the dataset. how to create a group in a file and a dataset in a group. It uses the iterator function <code>H5Giterate</code> to find the names of the objects -in the root group. +in the root group, and <code>H5Glink</code> and <code>H5Gunlink</code> +to create a new group name and delete the original name. <H4><A NAME="Intro-PMWorkAttributes">Working with attributes</A></H4> @@ -2994,13 +3024,16 @@ main (void) H5Fclose(file); return 0; -} + </pre> <H4><A NAME="CreateGroups"><A NAME="_Toc429885330"></A>Example 7. Creating groups.</A></H4> -<P>This example shows how to create an HDF5 file with two groups, and to place some datasets within those groups. +<P>This example shows how to create and access a group in an +HDF5 file and to place a dataset within this group. +It also illustrates the usage of the <code>H5Giterate</code>, +<code>H5Glink</code>, and <code>H5Gunlink</code> functions. <PRE> <!-- Insert Example 7, h5_group.c, here. --> @@ -3434,13 +3467,33 @@ attr_info(hid_t loc_id, const char *name, void *opdata) <p align=right><font size=-1><a href="#Intro-TOC">(Return to TOC)</a></font> + + <hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> +Introduction to HDF5 <br> +<a href="H5.user.html">HDF5 User Guide</a> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +<a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> +<a href="index.html">Other HDF5 documents and links</a> +</td></tr> +</table> +</center> +<hr> + + <address> <table width=100% border=0> <tr><td align=left valign=top> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 28 October 1998 +Last modified: 30 October 1998 </td><td align=right valign=top> <a href="Copyright.html">Copyright</a> diff --git a/doc/html/H5.user.html b/doc/html/H5.user.html index 23f28ee..e49e6a4 100644 --- a/doc/html/H5.user.html +++ b/doc/html/H5.user.html @@ -1,53 +1,155 @@ <html> <head> <title> - HDF5 Uer's Guide + HDF5 User's Guide </title> </head> - <body> - <center><h1>A User Guide for HDF5</h1></center> + <body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + +<!-- + + And in this document, the + HDF5 User's Guide: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +--> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + + <center><h1>A User's Guide for HDF5</h1></center> <p>The following documents form a loosely organized user's guide to the HDF5 library. - <ul> - <li><a href="Files.html">HDF5 Files</a> - - A guide to the H5F interface. - <li><a href="Datasets.html">Datasets</a> - - A guide to the H5D interface. - <li><a href="Datatypes.html">Data Types</a> - - A guide to the H5T interface. - <li><a href="Dataspaces.html">Data Spaces</a> - - A guide to the H5S interface. - <li><a href="Groups.html">Groups</a> - - A guide to the H5G interface. - <li><a href="References.html">References and Identifiers</a> - - A guide to the H5R and H5I interfaces. - <li><a href="Attributes.html">Attributes</a> - - A guide to the H5A interface. - <li><a href="Properties.html">Property Lists</a> - - A guide to the H5P interface. - <li><a href="Errors.html">Error Handling</a> - - A guide to the H5E interface. - <li><a href="Filters.html">Filters</a> - - A guide to the H5Z interface. - <li><a href="Caching.html">Caching</a> - - A guide for meta and raw data caching. - <li><a href="Chunking.html">Dataset Chunking</a> - - A guide to the issues and pitfalls of dataset chunking. - <li><a href="Debugging.html">Debugging</a> - - A guide to debugging HDF5 API calls. - <li><a href="Environment.html">Environment Variables and - Configuration Parameters</a> - - A list of HDF5 environment variables and configuration parameters. - <li><a href="ddl.html">DDL for HDF5</a> - - A DDL in BNF for HDF5. - <li><a href="Ragged.html">Ragged Arrays</a> - - A guide to the H5RA interface. +<center> +<table border=0> + +<tr><td valign=top><a href="Files.html">HDF5 Files</a> + </td><td> </td> + <td valign=top>A guide to the <strong>H5F</strong> interface. + </td></tr> + <tr><td valign=top><a href="Datasets.html">Datasets</a> + </td><td></td><td valign=top>A guide to the <strong>H5D</strong> + interface. + </td></tr> + <tr><td valign=top><a href="Datatypes.html">Data Types</a> + </td><td></td><td valign=top>A guide to the <strong>H5T</strong> + interface. + </td></tr> + <tr><td valign=top><a href="Dataspaces.html">Dataspaces</a> + </td><td></td><td valign=top>A guide to the <strong>H5S</strong> + interface. + </td></tr> + <tr><td valign=top><a href="Groups.html">Groups</a> + </td><td></td><td valign=top>A guide to the <strong>H5G</strong> + interface. + </td></tr> + <tr><td valign=top><a href="References.html">References and + Identifiers</a> + </td><td></td><td valign=top>A guide to the <strong>H5R</strong> + and <strong>H5I</strong> interfaces. + </td></tr> + <tr><td valign=top><a href="Attributes.html">Attributes</a> + </td><td></td><td valign=top>A guide to the <strong>H5A</strong> + interface. + </td></tr> + <tr><td valign=top><a href="Properties.html">Property Lists</a> + </td><td></td><td valign=top>A guide to the <strong>H5P</strong> + interface. + </td></tr> + <tr><td valign=top><a href="Errors.html">Error Handling</a> + </td><td></td><td valign=top>A guide to the <strong>H5E</strong> + interface. + </td></tr> + <tr><td valign=top><a href="Filters.html">Filters</a> + </td><td></td><td valign=top>A guide to the <strong>H5Z</strong> + interface. + </td></tr> + <tr><td valign=top><a href="Caching.html">Caching</a> + </td><td></td><td valign=top>A guide for meta and raw data caching. + </td></tr> + <tr><td valign=top><a href="Chunking.html">Dataset Chunking</a> + </td><td></td><td valign=top>A guide to the issues and pitfalls + of dataset chunking. + </td></tr> + <tr><td valign=top><a href="Debugging.html">Debugging</a> + </td><td></td><td valign=top>A guide to debugging HDF5 API calls. + </td></tr> + <tr><td valign=top><a href="Environment.html">Environment Variables + and</a> + <br> <a href="Environment.html">Configuration + Parameters</a> + </td><td></td><td valign=top>A list of HDF5 environment variables + and <br> configuration parameters. + </td></tr> + <tr><td valign=top><a href="ddl.html">DDL for HDF5</a> + </td><td></td><td valign=top>A DDL in BNF for HDF5. + </td></tr> + <tr><td valign=top><hr noshade size=1><a href="Ragged.html">Ragged Arrays</a> + </td><td></td><td valign=top><hr noshade size=1>A guide to the + <strong>H5RA</strong> interface. <em><font color=red>(Experimental)</font></em> - </ul> + </td></tr> +</table> +</center> +<!-- <p>The following documents form a loosely organized developer's guide to aspects of the HDF5 library. (Some of the following documents may be rather out of date as they were working papers for design @@ -71,8 +173,72 @@ <li><a href="study.html">Chunking Performance Study</a> - A white paper describing the HDF5 chunking performance. </ul> +--> +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + +<!-- + + And in this document, the + HDF5 User's Guide: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +--> + +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + <!-- <hr> @@ -91,7 +257,7 @@ Last modified: Wed Aug 19 15:29:11 PDT 1998 <tr><td align=left valign=top> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </td><td align=right valign=top> <a href="Copyright.html">Copyright</a> diff --git a/doc/html/NCSAfooterlogo.gif b/doc/html/NCSAfooterlogo.gif Binary files differnew file mode 100644 index 0000000..b6b1cff --- /dev/null +++ b/doc/html/NCSAfooterlogo.gif diff --git a/doc/html/Properties.html b/doc/html/Properties.html index 842c3a8..174affc 100644 --- a/doc/html/Properties.html +++ b/doc/html/Properties.html @@ -4,8 +4,70 @@ <title>Property List Interface (H5P)</title> </head> - <body> - <h1>Property List Interface (H5P)</h1> + <body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + Property Lists + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + + <h1>The Property List Interface (H5P)</h1> <h2>1. Introduction</h2> @@ -70,6 +132,66 @@ are defined above for <code>H5Pcreate()</code>. </dl> + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + Property Lists + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + <!-- <hr> <address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address> @@ -87,7 +209,7 @@ Last modified: Tue Feb 10 17:26:41 PST 1998 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 9 September 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index 8e4c174..27c96a3 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5 Draft API Specification +HDF5/H5 API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> H5 <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ H5 <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ H5 <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5: General Library Functions</h1> </center> @@ -198,7 +212,19 @@ and it users. <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> H5 <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -206,6 +232,7 @@ H5 <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -213,17 +240,17 @@ H5 <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5A.html b/doc/html/RM_H5A.html index e53a6d4..24debde 100644 --- a/doc/html/RM_H5A.html +++ b/doc/html/RM_H5A.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5A Draft API Specification +HDF5/H5A API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> H5A <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ H5A <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ H5A <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5A: Attribute Interface</h1> </center> @@ -498,7 +512,19 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> H5A <a href="RM_H5D.html">H5D</a> @@ -506,6 +532,7 @@ H5A <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -513,17 +540,17 @@ H5A <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index 22b096c..849ec8d 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5D Draft API Specification +HDF5/H5D API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> H5D @@ -15,6 +28,7 @@ H5D <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ H5D <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5D: Datasets Interface</h1> </center> @@ -406,7 +420,19 @@ and set and retrieve their constant or persistent properties. <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> H5D @@ -414,6 +440,7 @@ H5D <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -421,17 +448,17 @@ H5D <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5E.html b/doc/html/RM_H5E.html index 8efe624..c0b1e66 100644 --- a/doc/html/RM_H5E.html +++ b/doc/html/RM_H5E.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5E Draft API Specification +HDF5/H5E API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ H5E <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ H5E <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5E: Error Interface</h1> </center> @@ -342,7 +356,19 @@ errors within the H5E package. <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -350,6 +376,7 @@ H5E <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -357,17 +384,17 @@ H5E <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index 220a307..4325dd0 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5F Draft API Specification +HDF5/H5F API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ HDF5/H5F Draft API Specification H5F <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ H5F <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5F: File Interface</h1> </center> @@ -49,6 +63,8 @@ documented below. <ul> <li><a href="#File-Flush">H5Fflush</a> <li><a href="#File-Close">H5Fclose</a> + <li><a href="#File-Mount">H5Fmount</a> + <li><a href="#File-Unmount">H5Funmount</a> <li><a href="#File-Reopen">H5Freopen</a> </ul> </td><td> </td><td valign=top> @@ -326,6 +342,78 @@ documented below. <hr> <dl> +<dt><strong>Name:</strong> <a name="File-Mount">H5Fmount</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Fmount</code>(<em>hid_t</em> <code>loc_id</code>, + <em>const char *</em><code>name</code>, + <em>hid_t</em> <code>child_id</code>, + <em>hid_t</em> <code>plist_id</code> + ) +<dt><strong>Purpose:</strong> + <dd>Mounts a file. +<dt><strong>Description:</strong> + <dd><code>H5Fmount</code> mounts the file specified by + <code>child_id</code> onto the group specified by + <code>loc_id</code> and <code>name</code> using + the mount properties <code>plist_id</code>. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>loc_id</code> + <dd>The identifier for the group onto which the + file specified by <code>child_id</code> + is to be mounted. + <dt><em>const char *</em><code>name</code> + <dd>The name of the group onto which the + file specified by <code>child_id</code> + is to be mounted. + <dt><em>hid_t</em> <code>child_id</code> + <dd>The identifier of the file to be mounted. + <dt><em>hid_t</em> <code>plist_id</code> + <dd>The identifier of the property list to be used. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="File-Unmount">H5Funmount</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Funmount</code>(<em>hid_t</em> <code>loc_id</code>, + <em>const char *</em><code>name</code> + ) +<dt><strong>Purpose:</strong> + <dd>Unmounts a file. +<dt><strong>Description:</strong> + <dd>Given a mount point, <code>H5Funmount</code> + dissassociates the mount point's file + from the file mounted there. This function + does not close either file. + <p> + The mount point can either be the group in the + parent or the root group of the mounted file + (both groups have the same name). If the mount + point was opened before the mount then it is the + group in the parent; if it was opened after the + mount then it is the root group of the child. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>loc_id</code> + <dd>The identifier for the location at which + the specified file is to be unmounted. + <dt><em>const char *</em><code>name</code> + <dd>The name of the file to be unmounted. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. +</dl> + + +<hr> +<dl> <dt><strong>Name:</strong> <a name="File-Reopen">H5Freopen</a> <dt><strong>Signature:</strong> <dd><em>hid__t </em><code>H5Freopen</code>(<em>hid_t</em> <code>file_id</code> @@ -353,7 +441,19 @@ documented below. <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -361,6 +461,7 @@ documented below. H5F <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -368,17 +469,17 @@ H5F <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5Front.html b/doc/html/RM_H5Front.html index 8f23c56..7a09042 100644 --- a/doc/html/RM_H5Front.html +++ b/doc/html/RM_H5Front.html @@ -1,12 +1,26 @@ <html> <head><title> -HDF5 Draft API Specification +HDF5 API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -HDF5 Reference Manual +<table cellspacing=0 cellpadding=0 border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +<!-- +And in this document, the +HDF5 Reference Manual +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -14,6 +28,7 @@ HDF5 Reference Manual <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -21,46 +36,92 @@ HDF5 Reference Manual <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> --> +</td></tr> +</table> </center> <hr> + <center> <h1>HDF5: API Specification<br>Reference Manual</h1> </center> - -The HDF5 libraries provide several interfaces, each of which provides the +The HDF5 library provides several interfaces, each of which provides the tools required to meet specific aspects of the HDF5 data-handling requirements. -<ul> - -<li><a href="RM_H5.html">Library Functions</a> -- The general-purpose <strong>H5</strong> functions. -<li><a href="RM_H5A.html">Annotation Interface</a> -- The <strong>H5A</strong> API for annotations. -<li><a href="RM_H5D.html">Dataset Interface</a> -- The <strong>H5D</strong> API for manipulating scientific datasets. -<li><a href="RM_H5E.html">Error Interface</a> -- The <strong>H5E</strong> API for error handling. -<li><a href="RM_H5F.html">File Interface</a> -- The <strong>H5F</strong> API for accessing HDF files. -<li><a href="RM_H5G.html">Group Interface</a> -- The <strong>H5G</strong> API for creating physical groups of objects on disk. -<li><a href="RM_H5I.html">Identifier Interface</a> -- The <strong>H5I</strong> API for working with object identifiers. -<li><a href="RM_H5P.html">Property List Interface</a> -- The <strong>H5P</strong> API for manipulating object property lists. -<li><a href="RM_H5R.html">Reference Interface</a> -- The <strong>H5R</strong> API for references. -<li><a href="RM_H5S.html">Dataspace Interface</a> -- The <strong>H5S</strong> API for defining dataset dataspace. -<li><a href="RM_H5T.html">Datatype Interface</a> -- The <strong>H5T</strong> API for defining dataset element information. -<li><a href="RM_H5Z.html">Compression Interface</a> -- The <strong>H5Z</strong> API for compression. -<li><a href="Tools.html">Tools</a> -- Interactive tools for the examination of existing HDF5 files. +<center> +<table border=0> + +<tr><td valign=top><a href="RM_H5.html">Library Functions</a> + </td><td> </td><td valign=top>The general-purpose <strong>H5</strong> functions. +</td></tr> +<tr><td valign=top><a href="RM_H5A.html">Annotation Interface</a> + </td><td></td><td valign=top>The <strong>H5A</strong> API for annotations. +</td></tr> +<tr><td valign=top><a href="RM_H5D.html">Dataset Interface</a> + </td><td></td><td valign=top>The <strong>H5D</strong> API for manipulating scientific datasets. +</td></tr> +<tr><td valign=top><a href="RM_H5E.html">Error Interface</a> + </td><td></td><td valign=top>The <strong>H5E</strong> API for error handling. +</td></tr> +<tr><td valign=top><a href="RM_H5F.html">File Interface</a> + </td><td></td><td valign=top>The <strong>H5F</strong> API for accessing HDF files. +</td></tr> +<tr><td valign=top><a href="RM_H5G.html">Group Interface</a> + </td><td></td><td valign=top>The <strong>H5G</strong> API for creating physical groups of objects on disk. +</td></tr> +<tr><td valign=top><a href="RM_H5I.html">Identifier Interface</a> + </td><td></td><td valign=top>The <strong>H5I</strong> API for working with object identifiers. +</td></tr> +<tr><td valign=top><a href="RM_H5P.html">Property List Interface</a> + </td><td></td><td valign=top>The <strong>H5P</strong> API for manipulating object property lists. +</td></tr> +<tr><td valign=top><a href="RM_H5R.html">Reference Interface</a> + </td><td></td><td valign=top>The <strong>H5R</strong> API for references. +</td></tr> +<tr><td valign=top><a href="RM_H5S.html">Dataspace Interface</a> + </td><td></td><td valign=top>The <strong>H5S</strong> API for defining dataset dataspace. +</td></tr> +<tr><td valign=top><a href="RM_H5T.html">Datatype Interface</a> + </td><td></td><td valign=top>The <strong>H5T</strong> API for defining dataset element information. +</td></tr> +<tr><td valign=top><a href="RM_H5Z.html">Compression Interface</a> + </td><td></td><td valign=top>The <strong>H5Z</strong> API for compression. +</td></tr> +<tr><td valign=top><a href="Tools.html">Tools</a> + </td><td></td><td valign=top>Interactive tools for the examination of existing HDF5 files. <!-- -<li><a href="Glossary.html">Glossary</a> -- A glossary of data-types used in the APIs. +</td></tr> +<tr><td valign=top><a href="Glossary.html">Glossary</a> + </td><td></td><td valign=top>A glossary of data-types used in the APIs. --> -<hr width=300 align=left> -<li>Experimental interface:<a href="RM_H5RA.html">Ragged Arrays</a> -- The <strong>H5RA</strong> API for ragged arrays. +</td></tr> +<tr><td valign=top><hr noshade size=1>Experimental interface:<br><a href="RM_H5RA.html">Ragged Arrays</a> + </td><td></td><td valign=top><hr noshade size=1><br>The <strong>H5RA</strong> API for ragged arrays. + + +</td></tr> +</table> +</center> -</ul> <hr> <center> -HDF5 Reference Manual +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +<!-- +And in this document, the +HDF5 Reference Manual +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -68,6 +129,7 @@ HDF5 Reference Manual <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -75,18 +137,19 @@ HDF5 Reference Manual <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> --> +</td></tr> +</table> </center> <hr> + <address> <table width=100% border=0> <tr><td align=left valign=top> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </td><td align=right valign=top> <a href="Copyright.html">Copyright</a> diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index fce1706..1e899b9 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5G Draft API Specification +HDF5/H5G API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ HDF5/H5G Draft API Specification <a href="RM_H5F.html">H5F</a> H5G <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ H5G <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5G: Group Interface</h1> </center> @@ -582,14 +596,21 @@ create or access function. </dl> - - - - - <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -597,6 +618,7 @@ create or access function. <a href="RM_H5F.html">H5F</a> H5G <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -604,17 +626,17 @@ H5G <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5I.html b/doc/html/RM_H5I.html index 298eaea..841c859 100644 --- a/doc/html/RM_H5I.html +++ b/doc/html/RM_H5I.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5I Draft API Specification +HDF5/H5I API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ HDF5/H5I Draft API Specification <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> H5I +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ H5I <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5I: Identifier Interface</h1> </center> @@ -103,34 +117,46 @@ This function provides a tool for working with object identifiers. <hr> - <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> <a href="RM_H5E.html">H5E</a> <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> -<a href="RM_H5I.html">H5I</a> +H5I +<br> <a href="RM_H5P.html">H5P</a> -H5R +<a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index 8dda42f..f327114 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5P Draft API Specification +HDF5/H5P API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ HDF5/H5P Draft API Specification <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> H5P <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ H5P <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5P: Property List Interface</h1> </center> @@ -169,6 +183,11 @@ parallel HDF5 library.</i> See <a href="Datasets.html">Datasets</a> in the <cite>HDF User's Guide</cite> for details about raw data transfer properties. + <dt><code>H5P_MOUNT</code> + <dd>Properties for file mounting. + With this parameter, <code>H5Pcreate</code> + creates and returns a new mount property list + initialized with default values. </dl> <dt><strong>Parameters:</strong> <dl> @@ -2059,7 +2078,19 @@ parallel HDF5 library.</i> <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -2067,6 +2098,7 @@ parallel HDF5 library.</i> <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> H5P <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -2074,9 +2106,8 @@ H5P <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> @@ -2085,7 +2116,7 @@ H5P <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index 5af6fad..b558e81 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5R Draft API Specification +HDF5/H5R API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ HDF5/H5R Draft API Specification <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> H5R <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ H5R <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5R: Reference Interface</h1> </center> @@ -180,9 +194,20 @@ is an object reference pointing to a dataset.</i> <hr> - <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -190,6 +215,7 @@ is an object reference pointing to a dataset.</i> <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> H5R <a href="RM_H5RA.html">H5RA</a> @@ -197,17 +223,17 @@ H5R <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5RA.html b/doc/html/RM_H5RA.html index bb7bca4..90c51a8 100644 --- a/doc/html/RM_H5RA.html +++ b/doc/html/RM_H5RA.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5RA Draft API Specification +HDF5/H5RA Experimental API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ HDF5/H5RA Draft API Specification <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> H5RA @@ -22,12 +36,12 @@ H5RA <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5RA: Ragged Array Interface</h1> </center> @@ -308,7 +322,19 @@ name of the ragged array. <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -316,6 +342,7 @@ name of the ragged array. <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> H5RA @@ -323,17 +350,17 @@ H5RA <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index 5d34684..5a7e33e 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5S Draft API Specification +HDF5/H5S API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ HDF5/H5S Draft API Specification <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ H5S <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5S: Dataspace Interface</h1> </center> @@ -724,7 +738,19 @@ I/O is performed. <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -732,6 +758,7 @@ I/O is performed. <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -739,17 +766,17 @@ H5S <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 672ec32..8752446 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5T Draft API Specification +HDF5/H5T API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ HDF5/H5T Draft API Specification <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ HDF5/H5T Draft API Specification H5T <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5T: Datatype Interface</h1> </center> @@ -1744,7 +1758,19 @@ zero. <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -1752,6 +1778,7 @@ zero. <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -1759,17 +1786,17 @@ zero. H5T <a href="RM_H5Z.html">H5Z</a> <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/RM_H5Z.html b/doc/html/RM_H5Z.html index 337552e..a773a29 100644 --- a/doc/html/RM_H5Z.html +++ b/doc/html/RM_H5Z.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/H5Z Draft API Specification +HDF5/H5Z API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ HDF5/H5Z Draft API Specification <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ HDF5/H5Z Draft API Specification <a href="RM_H5T.html">H5T</a> H5Z <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>H5Z: Compression Interface</h1> </center> @@ -104,7 +118,19 @@ See <a href="Compression.html"><cite>Compression</cite></a> in the <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -112,6 +138,7 @@ See <a href="Compression.html"><cite>Compression</cite></a> in the <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -119,17 +146,17 @@ See <a href="Compression.html"><cite>Compression</cite></a> in the <a href="RM_H5T.html">H5T</a> H5Z <a href="Tools.html">Tools</a> -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/Ragged.html b/doc/html/Ragged.html index fa3b61e..53d9f04 100644 --- a/doc/html/Ragged.html +++ b/doc/html/Ragged.html @@ -4,8 +4,70 @@ <title>Ragged Arrays</title> </head> - <body> - <h1>Ragged Arrays</h1> + <body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + Ragged Arrays +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + + <h1>The Ragged Array Interface (H5RA)</h1> <table border=1> <tr><th align=left> @@ -140,6 +202,66 @@ Do not create any archives using this interface!</center> the entire row. This function returns negative for failures with <em>buf</em> containing the original input values. </dl> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + Ragged Arrays +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + <!-- <hr> @@ -157,7 +279,7 @@ Last modified: Fri Aug 28 14:27:19 EDT 1998 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 21 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/References.html b/doc/html/References.html index 88534e5..24a26ee 100644 --- a/doc/html/References.html +++ b/doc/html/References.html @@ -4,8 +4,70 @@ <title>References</title> </head> -<body> -<h1>References</h1> +<body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + References + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + +<h1>The Reference Interface (H5R) and <br> the Indentifier Interface (H5I)</h1> <h2>1. Introduction</h2> @@ -215,7 +277,7 @@ of its raw data and write the dataset to the file. } /* end for */ /* Write the data to the dataset using default transfer properties. */ - H5Dwrite(dataset, H5T_POINTER_OBJECT, H5S_ALL, H5S_ALL, H5P_DEFAULT, data); + H5Dwrite(dataset, H5T_STD_REF_OBJ, H5S_ALL, H5S_ALL, H5P_DEFAULT, data); /* Close everything */ H5Sclose(dataspace); @@ -398,13 +460,8 @@ read in those links. -<hr> -<address> -<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> -</address> - -Last modified: 28 October 1998 +<!-- <h1>Material to Be Omitted!!!</h1> @@ -554,5 +611,74 @@ Notes: to provide users with access to references in a language-appropriate way. </dl> + +--> + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + References + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + +<hr> +<address> +<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> +</address> + +Last modified: 30 October 1998 + </body> </html> diff --git a/doc/html/Tools.html b/doc/html/Tools.html index d41f05e..b850862 100644 --- a/doc/html/Tools.html +++ b/doc/html/Tools.html @@ -1,13 +1,26 @@ <html> <head><title> -HDF5/Tools Draft API Specification +HDF5/Tools API Specification </title></head> -<body> +<body bgcolor="#FFFFFF"> + <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -15,6 +28,7 @@ HDF5/Tools Draft API Specification <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -22,12 +36,12 @@ HDF5/Tools Draft API Specification <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> Tools -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <center> <h1>HDF5 Tools</h1> </center> @@ -259,7 +273,19 @@ These tools enable the user to examine HDF5 files interactively. <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<table border=0 width=98%> +<tr><td valign=top align=left> +<a href="H5.intro.html">Introduction to HDF5</a> <br> +<a href="H5.user.html">HDF5 User Guide</a> <br> +<a href="index.html">Other HDF5 documents and links</a> <br> +<!-- +<a href="Glossary.html">Glossary</a><br> +--> +</td> +<td valign=top align=right> +And in this document, the +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<br> <a href="RM_H5.html">H5</a> <a href="RM_H5A.html">H5A</a> <a href="RM_H5D.html">H5D</a> @@ -267,6 +293,7 @@ These tools enable the user to examine HDF5 files interactively. <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5I.html">H5I</a> +<br> <a href="RM_H5P.html">H5P</a> <a href="RM_H5R.html">H5R</a> <a href="RM_H5RA.html">H5RA</a> @@ -274,17 +301,17 @@ These tools enable the user to examine HDF5 files interactively. <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> Tools -<!-- -<a href="Glossary.html">Glossary</a> ---> +</td></tr> +</table> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 27 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/ddl.html b/doc/html/ddl.html index fcce13e..8405c77 100644 --- a/doc/html/ddl.html +++ b/doc/html/ddl.html @@ -4,7 +4,69 @@ <title>DDL for HDF5</title> </head> -<body> +<body bgcolor="#FFFFFF"> + + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + DDL + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> +<hr> + + <h1>DDL in BNF for HDF5</h1> @@ -197,12 +259,72 @@ GROUP "/" { </pre> </dir> + +<hr> +<center> +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="H5.intro.html">Introduction to HDF5</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> <br> + <a href="index.html">Other HDF5 documents and links</a> <br> + <!-- + <a href="Glossary.html">Glossary</a><br> + --> +</td> +<td valign=top align=right> + And in this document, the + <a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Files.html">Files</a> + <br> + <a href="Datasets.html">Datasets</a> + <a href="Datatypes.html">Data Types</a> + <a href="Dataspaces.html">Dataspaces</a> + <a href="Groups.html">Groups</a> + <a href="References.html">References</a> + <br> + <a href="Attributes.html">Attributes</a> + <a href="Properties.html">Property Lists</a> + <a href="Errors.html">Error Handling</a> + <a href="Filters.html">Filters</a> + <a href="Caching.html">Caching</a> + <br> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + DDL + <a href="Ragged.html">Ragged Arrays</a> +<!-- +<hr> +And in this document, the +<a href="H5.user.html">HDF5 User's Guide</a>: + <a href="Attributes.html">H5A</a> + <a href="Datasets.html">H5D</a> + <a href="Errors.html">H5E</a> + <a href="Files.html">H5F</a> + <a href="Groups.html">H5G</a> + <a href="Properties.html">H5P</a> + <a href="References.html">H5R & H5I</a> + <a href="Ragged.html">H5RA</a> + <a href="Dataspaces.html">H5S</a> + <a href="Datatypes.html">H5T</a> + <a href="Filters.html">H5Z</a> + <a href="Caching.html">Caching</a> + <a href="Chunking.html">Chunking</a> + <a href="Debugging.html">Debugging</a> + <a href="Environment.html">Environment</a> + <a href="ddl.html">DDL</a> +--> +</td></tr> +</table> +</center> + + <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 28 October 1998 +Last modified: 30 October 1998 </body> </html> diff --git a/doc/html/hdf2.jpg b/doc/html/hdf2.jpg Binary files differnew file mode 100644 index 0000000..92b53c9 --- /dev/null +++ b/doc/html/hdf2.jpg diff --git a/doc/html/index.html b/doc/html/index.html index 45652ad..0ad8191 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -9,73 +9,90 @@ <!-- BEGIN MAIN BODY --> -<A HREF="http://www.ncsa.uiuc.edu/"><img border=0 -src="http://www.ncsa.uiuc.edu/Images/NCSAhome/footerlogo.gif" -width=78 height=27 alt="NCSA"></A><P> +<!-- +<img border=0 src="NCSAfooterlogo.gif" width=78 height=27 alt="NCSA"> +--> + +<center> +<br> +<h1><img src="hdf2.jpg" alt="HDF Logo" align=left> HDF5 - A New Generation of HDF <br><font size=-1>The Hierarchical Data Format</font></H1> +</center> -<h1> <A HREF="/whatishdf.html"><img src="/image/hdf2.jpg" alt="What is HDF?"></A -> -HDF5 - A New Generation of HDF</H1> -<hr noshade size=1> +<hr> <CENTER> -<FONT SIZE="3" FACE="arial,helvetica" COLOR="#c80028"> - <B>[</B> <A HREF="/index.html">Home</A> <B>]</B> - <B>[</B> <A HREF="/hdfindex.html">Index</A> <B>]</B> - <B>[</B> <A HREF="/products.html">Products</A> <B>]</B> - <B>[</B> <A HREF="/newsletters.html">Newsletters</A> <B>]</B> - <B>[</B> <A HREF="/docs.html">Documentation</A> <B>]</B> -</FONT> -<BR> -</CENTER> +<table border=0 width=90%> +<tr><td rowspan=2 bgcolor="#BBFFFF" valign=top align=left width=25%> + <center><h3>HDF Links at NCSA</h3></center> + <dl> + <dt><a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> + <dd>Email to HDF Technical Support + <p> + <dt><A HREF="http://hdf.ncsa.uiuc.edu">HDF Home Page</A> + <!-- + <dt><A HREF="http://hdf.ncsa.uiuc.edu/HDF5">The HDF5 Home Page</A> + <dt><A HREF="http://hdf.ncsa.uiuc.edu/products.html">HDF Products</A> + --> + <p> + <dt><A HREF="http://hdf.ncsa.uiuc.edu/newsletters.html">HDF Newsletters</A> + <dd>News about HDF and HDF5 + <p> + <dt><A HREF="ftp://hdf.ncsa.uiuc.edu/pub/dist/HDF5/">HDF5 FTP Archives</A> + <dd>HDF5 source code archives + </dl> +</td><td bgcolor="#FFFFFF" width=4%> +</td><td bgcolor="#BBFFFF" valign=top align=left width=61%> + <center><h3>HDF5 Documentation</h3></center> + +<dl> +<dt><A HREF="H5.intro.html">An Introduction to HDF5</A> + <dd>An introduction to HDF5 programming and an overview of + the design goals behind the HDF5 library and file format +<dt><A HREF="H5.user.html">HDF5 User's Guide</A> + <dd>A collection of chapters on the main HDF5 APIs and + other supporting information +<dt><A HREF="RM_H5Front.html">HDF5 Reference Manual</A> + <dd>A complete reference manual for the HDF5 API +<dt><A HREF="H5.format.html">HDF5 Format Specification</A> + <dd>The complete specification of the HDF5 file format +</dl> +</td></tr><tr><td bgcolor="#FFFFFF"> +</td><td bgcolor="#BBFFFF" valign=top align=left> +<dl> +<dt><A HREF="ph5design.html">Parallel HDF5 Design</A> + <dd>The design specification of the parallel HDF5 API and + an example program +<dt><A HREF="ph5implement.txt">Parallel HDF5 Implementation</A> + <dd>The current status of implmentation of the parallel HDF5 API +</dl> +</td></tr> +<tr><td bgcolor="#BBFFFF" valign=top align=left> +<center><i>(Internet links)</i></center> +</td><td bgcolor="#FFFFFF"> +</td><td bgcolor="#BBFFFF" valign=top align=left> +<center><i>(Local links)</i></center> +</table> +</CENTER> -<UL> -<LI><A HREF="H5.intro.html">An Introduction to HDF5</A> - A brief overview of - the design goals behind the HDF5 library & file format -</LI> -<LI><A HREF="RM_H5Front.html">HDF5 Reference Manual</A> - A complete reference - manual for the HDF5 API -</LI> -<LI><A HREF="H5.user.html">HDF5 User Guide</A> - A collection of chapters on - each of the main HDF5 APIs as well as other supporting information -</LI> -<LI><A HREF="H5.format.html">HDF5 Format Specification</A> - The complete - specification of the HDF5 file format -</LI> -<LI><A HREF="ph5design.html">Parallel HDF5 Design</A> - The design -specification of the parallel HDF5 API and an example program -</LI> -<LI><A HREF="ph5implement.txt">Parallel HDF5 Implementation</A> - The -current status of implmentation of the parallel HDF5 API -</LI> -<LI><A HREF="ftp://hdf.ncsa.uiuc.edu/pub/dist/HDF5/">FTP Archives</A> - A direct -link to the source code archives. -</LI> -<LI><A HREF="planning/hdf5projectplandocument.html">HDF5 Project Plan</A> - Overall project plan for HDF5, March - October, 1998. -</LI> -</UL> <!-- BEGIN FOOTER INFO --> -<P><hr noshade size=1> +<P><hr> <font face="arial,helvetica" size="-1"> - <a href="http://www.ncsa.uiuc.edu/"><img border=0 - src="http://www.ncsa.uiuc.edu/Images/NCSAhome/footerlogo.gif" - width=78 height=27 alt="NCSA"><br> + <a href="http://www.ncsa.uiuc.edu/"> + <img border=0 src="NCSAfooterlogo.gif" width=78 height=27 alt="NCSA Logo"><br> The National Center for Supercomputing Applications</A><br> <a href="http://www.uiuc.edu/">University of Illinois - at Urbana-Champaign</a><br> - <br> + at Urbana-Champaign</a> -<!-- -<address><a href="mailto:koziol@ncsa.uiuc.edu">Quincey Koziol</a></address> -<address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address> ---> +<p> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <!-- hhmts start --> Last modified: 16 Sept 1998 <!-- hhmts end --> +</font> + </body> </html> |
