diff options
| author | Frank Baker <fbaker@hdfgroup.org> | 1999-12-13 20:39:48 (GMT) |
|---|---|---|
| committer | Frank Baker <fbaker@hdfgroup.org> | 1999-12-13 20:39:48 (GMT) |
| commit | 658fdbfb981b60eb42a6be70b5e2baf9f01989cd (patch) | |
| tree | 5da339df5c8e5186fb760c16fcee5bbc0fbbffe3 /doc | |
| parent | ca73fde3ba444896894a56dda3dc9f79d06a7bcd (diff) | |
| download | hdf5-658fdbfb981b60eb42a6be70b5e2baf9f01989cd.zip hdf5-658fdbfb981b60eb42a6be70b5e2baf9f01989cd.tar.gz hdf5-658fdbfb981b60eb42a6be70b5e2baf9f01989cd.tar.bz2 | |
[svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree.
(except Datatypes.html, H5.format.html, ddl.html)
This version of HDF5 Ref Manual includes FORTRAN API references.
Diffstat (limited to 'doc')
33 files changed, 5814 insertions, 1575 deletions
diff --git a/doc/html/Attributes.html b/doc/html/Attributes.html index 7672d0d..e73419f 100644 --- a/doc/html/Attributes.html +++ b/doc/html/Attributes.html @@ -1,7 +1,7 @@ <html> <head> - <title>Attributes</title> + <title>Attribute Interface (H5A)</title> </head> <body bgcolor="#FFFFFF"> @@ -20,47 +20,31 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> Attributes <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -217,7 +201,7 @@ And in this document, the or resource leaks will develop. This function returns a datatype ID for success or negative for failure. <br><br> - <dt><code>size_t H5Aget_name (hid_t <em>attr_id</em>, + <dt><code>ssize_t H5Aget_name (hid_t <em>attr_id</em>, size_t <em>buf_size</em>, char *<em>buf</em>)</code> <dd>This function retrieves the name of an attribute for an attribute ID. Up to <em>buf_size</em> characters are stored in <em>buf</em> followed by a @@ -247,47 +231,31 @@ And in this document, the </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> Attributes <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -296,9 +264,9 @@ And in this document, the <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> +</address> -<br> -Last modified: 30 October 1998 +Last modified: 14 October 1999 </body> </html> diff --git a/doc/html/Caching.html b/doc/html/Caching.html index c35cc65..3b9e53c 100644 --- a/doc/html/Caching.html +++ b/doc/html/Caching.html @@ -20,54 +20,40 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> Caching - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> + <h1>Data Caching</h1> + + <h2>1. Meta Data Caching</h2> <p>The HDF5 library caches two types of data: meta data and raw data. The meta data cache holds file objects like the file @@ -79,7 +65,7 @@ And in this document, the are handled by preempting the older object in favor of the new one. - <h1>Raw Data Chunk Caching</h1> + <h2>2. Raw Data Chunk Caching</h2> <p>Raw data chunks are cached because I/O requests at the application level typically don't map well to chunks at the @@ -112,7 +98,7 @@ And in this document, the a diagonal accross the dataset where each request overlaps the previous request would benefit from a small <em>w0</em>. - <h1>The API</h1> + <h2>3. Data Caching Operations</h2> <p>The cache parameters for both caches are part of a file access property list and are set and queried with this pair of @@ -148,69 +134,46 @@ And in this document, the </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> Caching - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> ---> -<!-- Created: Tue May 26 15:20:14 EDT 1998 --> -<!-- hhmts start --> -<!-- -Last modified: Tue May 26 15:38:27 EDT 1998 ---> -<!-- hhmts end --> <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 30 October 1998 +<!-- Created: Tue May 26 15:20:14 EDT 1998 --> +<!-- hhmts start --> +Last modified: 14 October 1999 +<!-- hhmts end --> </body> </html> diff --git a/doc/html/Chunking.html b/doc/html/Chunking.html index f98196f..5018a2d 100644 --- a/doc/html/Chunking.html +++ b/doc/html/Chunking.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> <head> - <title>Dataset Chunking Issues</title> + <title>Dataset Chunking</title> </head> <body bgcolor="#FFFFFF"> @@ -20,47 +20,31 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> Chunking + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -257,69 +241,46 @@ And in this document, the </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> Chunking + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> ---> -<!-- Created: Tue Oct 20 12:38:40 EDT 1998 --> -<!-- hhmts start --> -<!-- -Last modified: Fri Oct 23 10:30:52 EDT 1998 ---> -<!-- hhmts end --> <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> +</address> -<br> -Last modified: 30 October 1998 +<!-- Created: Tue Oct 20 12:38:40 EDT 1998 --> +<!-- hhmts start --> +Last modified: 14 October 1999 +<!-- hhmts end --> </body> diff --git a/doc/html/Copyright.html b/doc/html/Copyright.html index f295867..b22c16c 100644 --- a/doc/html/Copyright.html +++ b/doc/html/Copyright.html @@ -1,31 +1,35 @@ <html> -<head><title> -HDF5 Copyright Notice -</title></head> +<html> + <head> + <title> + HDF5 Copyright Notice + </title> + </head> + + <body bgcolor="#FFFFFF"> -<body> <hr> <h3>Copyright Notice and Statement for <br> -NCSA Hierarchical Data Format (HDF) Software Library and Utilities</h3> +NCSA HDF5 (Hierarchical Data Format 5) Software Library and Utilities</h3> <hr> <p> -NCSA Hierarchical Data Format (HDF) Software Library and Utilities +NCSA HDF5 (Hierarchical Data Format 5) Software Library and Utilities <br> -Copyright 1998 the Board of Trustees of the University of Illinois +Copyright 1998, 1999 by the Board of Trustees of the University of Illinois <br> <strong>All rights reserved.</strong> <p> Contributors: National Center for Supercomputing Applications (NCSA) at -the University of Illinois, Lawrence Livermore Nat'l Laboratory (LLNL), -Sandia National Laboratories (SNL), Los Alamos National Laboratory (LANL), -Jean-loup Gailly and Mark Adler (gzip library) +the University of Illinois at Urbana-Champaign (UIUC), Lawrence Livermore +National Laboratory (LLNL), Sandia National Laboratories (SNL), Los Alamos +National Laboratory (LANL), Jean-loup Gailly and Mark Adler (gzip library). <p> Redistribution and use in source and binary forms, with or without @@ -35,10 +39,10 @@ provided that the following conditions are met: <ol> <li>Redistributions of source code must retain the above copyright notice, -this list of conditions and the following disclaimer. +this list of conditions, and the following disclaimer. <li>Redistributions in binary form must reproduce the above copyright -notice, this list of conditions and the following disclaimer in the +notice, this list of conditions, and the following disclaimer in the documentation and/or materials provided with the distribution. <li>In addition, redistributions of modified forms of the source or binary @@ -46,9 +50,9 @@ code must carry prominent notices stating that the original code was changed and the date of the change. <li>All publications or advertising materials mentioning features or use of -this software must acknowledge that it was developed by the National Center -for Supercomputing Applications at the University of Illinois, and credit -the Contributors. +this software are asked, but not required, to acknowledge that it was +developed by the National Center for Supercomputing Applications at the +University of Illinois at Urbana-Champaign and to credit the contributors. <li>Neither the name of the University nor the names of the Contributors may be used to endorse or promote products derived from this software without @@ -69,7 +73,7 @@ the possibility of such damage. <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 8 September 1998 +Last modified: 13 October 1999 </body> </html> diff --git a/doc/html/Datasets.html b/doc/html/Datasets.html index 0e64468..16218cc 100644 --- a/doc/html/Datasets.html +++ b/doc/html/Datasets.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> <head> - <title>The Dataset Interface (H5D)</title> + <title>Dataset Interface (H5D)</title> </head> <body bgcolor="#FFFFFF"> @@ -19,47 +19,31 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> Datasets - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -83,7 +67,7 @@ And in this document, the <dt>Constant Meta Data <dd>Meta data that is created when the dataset is created and exists unchanged for the life of the dataset. For instance, - the data type of stored array elements is defined when the + the datatype of stored array elements is defined when the dataset is created and cannot be subsequently changed. <dt>Persistent Meta Data @@ -96,7 +80,7 @@ And in this document, the <dd>Meta data that exists to describe how raw data is organized in the application's memory space. For instance, the data type of elements in an application array might not be the same - as the data type of those elements as stored in the HDF5 file. + as the datatype of those elements as stored in the HDF5 file. <dt>Transport Meta Data <dd>Meta data that is used only during the transfer of raw data @@ -107,7 +91,7 @@ And in this document, the <p>Each of these classes of meta data is handled differently by the library although the same API might be used to create them. - For instance, the data type exists as constant meta data and as + For instance, the datatype exists as constant meta data and as memory meta data; the same API (the <code>H5T</code> API) is used to manipulate both pieces of meta data but they're handled by the dataset API (the <code>H5D</code> API) in different @@ -137,7 +121,7 @@ And in this document, the <br><br> <dl> - <dt><code>H5D_COMPACT</code> + <dt><code>H5D_COMPACT</code> <i><b>(Not yet implemented.)</b></i> <dd>The raw data is presumably small and can be stored directly in the object header. Such data is non-extendible, non-compressible, non-sparse, and cannot @@ -145,7 +129,7 @@ And in this document, the arbitrary but are enforced because of the small size of the raw data. Storing data in this format eliminates the disk seek/read request normally necessary to read raw - data. <b>This layout is not implemented yet.</b> + data. <br><br> <dt><code>H5D_CONTIGUOUS</code> @@ -299,7 +283,8 @@ H5Pset_chunk (plist, 2, size); continues for <em>size</em> bytes. The space represented by this segment is adjacent to the space already represented by the external file list. The last segment in a file list may have the size - <code>H5F_UNLIMITED</em>. + <code>H5F_UNLIMITED</code>, in which case the external file may be + of unlimited size and no more files can be added to the external files list. <br><br> <dt><code>int H5Pget_external_count (hid_t <em>plist</em>)</code> @@ -397,28 +382,28 @@ H5Pset_external (plist, "scan3.data", 0, 16); through some other library. - <h2>5. Data Type</h2> + <h2>5. Datatype</h2> - <p>Raw data has a constant data type which describes the data type - of the raw data stored in the file, and a memory data type that - describes the data type stored in application memory. Both data + <p>Raw data has a constant datatype which describes the datatype + of the raw data stored in the file, and a memory datatype that + describes the datatype stored in application memory. Both data types are manipulated with the <a href="Datatypes.html"><code>H5T</code></a> API. - <p>The constant file data type is associated with the dataset when + <p>The constant file datatype is associated with the dataset when the dataset is created in a manner described below. Once assigned, the constant datatype can never be changed. - <p>The memory data type is specified when data is transferred + <p>The memory datatype is specified when data is transferred to/from application memory. In the name of data sharability, - the memory data type must be specified, but can be the same - type identifier as the constant data type. + the memory datatype must be specified, but can be the same + type identifier as the constant datatype. <p>During dataset I/O operations, the library translates the raw - data from the constant data type to the memory data type or vice - versa. Structured data types include member offsets to allow + data from the constant datatype to the memory datatype or vice + versa. Structured datatypes include member offsets to allow reordering of struct members and/or selection of a subset of - members and array data types include index permutation + members and array datatypes include index permutation information to allow things like transpose operations (<b>the prototype does not support array reordering</b>) Permutations are relative to some extrinsic descritpion of the dataset. @@ -452,7 +437,7 @@ H5Pset_external (plist, "scan3.data", 0, 16); <p>Each dataset has a set of constant and persistent properties which describe the layout method, pre-compression - transformation, compression method, data type, external storage, + transformation, compression method, datatype, external storage, and data space. The constant properties are set as described above in a dataset creation property list whose identifier is passed to <code>H5Dcreate()</code>. @@ -462,8 +447,8 @@ H5Pset_external (plist, "scan3.data", 0, 16); *<em>name</em>, hid_t <em>type_id</em>, hid_t <em>space_id</em>, hid_t <em>create_plist_id</em>)</code> <dd>A dataset is created by calling <code>H5Dcreate</code> with - a file identifier, a dataset name, a data type, a data space, - and constant properties. The data type and data space are the + a file identifier, a dataset name, a datatype, a data space, + and constant properties. The datatype and data space are the type and space of the dataset as it will exist in the file, which may be different than in application memory. The <em>create_plist_id</em> is a <code>H5P_DATASET_CREATE</code> @@ -511,7 +496,7 @@ H5Pset_external (plist, "scan3.data", 0, 16); <dl> <dt><code>hid_t H5Dget_type (hid_t <em>dataset_id</em>)</code> <dd>Returns an identifier for a copy of the dataset permanent - data type or negative for failure. + datatype or negative for failure. <dt><code>hid_t H5Dget_space (hid_t <em>dataset_id</em>)</code> <dd>Returns an identifier for a copy of the dataset permanent @@ -534,7 +519,7 @@ H5Pset_external (plist, "scan3.data", 0, 16); <p>A dataset also has memory properties which describe memory within the application, and transfer properties that control various aspects of the I/O operations. The memory can have a - data type different than the permanent file data type (different + datatype different than the permanent file datatype (different number types, different struct member offsets, different array element orderings) and can also be a different size (memory is a subset of the permanent dataset elements, or vice versa). The @@ -555,7 +540,7 @@ H5Pset_external (plist, "scan3.data", 0, 16); <dt><code>size_t H5Pget_buffer (hid_t <em>xfer_plist</em>, void **<em>tconv_buf</em>, void **<em>bkg_buf</em>)</code> <dd>Sets or retrieves the maximum size in bytes of the temporary - buffer used for data type conversion in the I/O pipeline. An + buffer used for datatype conversion in the I/O pipeline. An application-defined buffer can also be supplied as the <em>tconv_buf</em> argument, otherwise a buffer will be allocated and freed on demand by the library. A second @@ -593,7 +578,7 @@ H5Pset_external (plist, "scan3.data", 0, 16); a dataset transfer property list so that strip mining does not occur. It takes an (optional) dataset transfer property list, a dataset, a data space that describes - what data points are being transfered, and a data type + what data points are being transfered, and a datatype for the data points in memory. It returns a (new) dataset transfer property list with the temporary buffer size set to an appropriate value. The return @@ -604,7 +589,7 @@ H5Pset_external (plist, "scan3.data", 0, 16); 2 disable_strip_mining (hid_t xfer_plist, hid_t dataset, 3 hid_t space, hid_t mem_type) 4 { - 5 hid_t file_type; /* File data type */ + 5 hid_t file_type; /* File datatype */ 6 size_t type_size; /* Sizeof larger type */ 7 size_t size; /* Temp buffer size */ 8 hid_t xfer_plist; /* Return value */ @@ -643,10 +628,10 @@ H5Pset_external (plist, "scan3.data", 0, 16); <h2>11. Raw Data I/O</h2> <p>All raw data I/O is accomplished through these functions which - take a dataset handle, a memory data type, a memory data space, + take a dataset handle, a memory datatype, a memory data space, a file data space, transfer properties, and an application - memory buffer. They translate data between the memory data type - and space and the file data type and space. The data spaces can + memory buffer. They translate data between the memory datatype + and space and the file datatype and space. The data spaces can be used to describe partial I/O operations. <dl> @@ -655,7 +640,7 @@ H5Pset_external (plist, "scan3.data", 0, 16); <em>file_space_id</em>, hid_t <em>xfer_plist_id</em>, void *<em>buf</em>/*out*/)</code> <dd>Reads raw data from the specified dataset into <em>buf</em> - converting from file data type and space to memory data type + converting from file datatype and space to memory datatype and space. <br><br> @@ -664,8 +649,8 @@ H5Pset_external (plist, "scan3.data", 0, 16); <em>file_space_id</em>, hid_t <em>xfer_plist_id</em>, const void *<em>buf</em>)</code> <dd>Writes raw data from an application buffer <em>buf</em> to - the specified dataset converting from memory data type and - space to file data type and space. + the specified dataset converting from memory datatype and + space to file datatype and space. </dl> @@ -673,7 +658,7 @@ H5Pset_external (plist, "scan3.data", 0, 16); supplied. However, it can be the same identifier as was used to create the dataset or as was returned by <code>H5Dget_type()</code>; the library will not implicitly - derive memory data types from constant data types. + derive memory datatypes from constant datatypes. <p>For complete reads of the dataset one may supply <code>H5S_ALL</code> as the argument for the file data space. @@ -735,7 +720,7 @@ H5Pset_external (plist, "scan3.data", 0, 16); 29 H5Pset_compression (properties, H5D_COMPRESS_LZ77); 30 31 /* -32 * Create a new dataset within the file. The data type +32 * Create a new dataset within the file. The datatype 33 * and data space describe the data on disk, which may 34 * be different than the format used in the application's 35 * memory. @@ -744,7 +729,7 @@ H5Pset_external (plist, "scan3.data", 0, 16); 38 data_space, properties); 39 40 /* -41 * Write the array to the file. The data type and data +41 * Write the array to the file. The datatype and data 42 * space describe the format of the data in the `dd' 43 * buffer. The raw data is translated to the format 44 * required on disk defined above. We use default raw @@ -865,7 +850,7 @@ H5Pset_external (plist, "scan3.data", 0, 16); 8 dataset = H5Dopen (file, "dataset"); 9 10 /* -11 * Describe the memory data type, a struct with a single +11 * Describe the memory datatype, a struct with a single 12 * "delta" member. 13 */ 14 type = H5Tcreate (H5T_COMPOUND, sizeof(double)); @@ -903,69 +888,46 @@ H5Pset_external (plist, "scan3.data", 0, 16); </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> Datasets - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> ---> -<!-- Created: Tue Dec 2 09:17:09 EST 1997 --> -<!-- hhmts start --> -<!-- -Last modified: Wed May 13 18:57:47 EDT 1998 ---> -<!-- hhmts end --> <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 30 October 1998 +<!-- Created: Tue Dec 2 09:17:09 EST 1997 --> +<!-- hhmts start --> +Last modified: 14 October 1999 +<!-- hhmts end --> </body> </html> diff --git a/doc/html/Dataspaces.html b/doc/html/Dataspaces.html index 46eec9c..0df6770 100644 --- a/doc/html/Dataspaces.html +++ b/doc/html/Dataspaces.html @@ -1,7 +1,7 @@ <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> - <TITLE>The Data Space Interface (H5S)</TITLE> + <TITLE>Dataspace Interface (H5S)</TITLE> </HEAD> <body bgcolor="#FFFFFF"> @@ -19,47 +19,31 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> Dataspaces <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -311,6 +295,8 @@ Releases resources associated with a dataspace. Subsequent use of the dataspace identifier after this call is undefined. </DD> +<!-- NOT YET IMPLEMENTED (R1.2 -- 9908) + <DT> <TT>H5S_class_t H5Sextent_class (hid_t <I>space</I>)</TT></DT> @@ -319,6 +305,9 @@ Query a dataspace to determine the current class of a dataspace. The value which is returned is one of: H5S_SCALAR, H5S_SIMPLE on success or H5S_NO_CLASS on failure. </DD> + +--> + </DL> @@ -557,7 +546,7 @@ may execute slower. </DD> <DT> -<TT>hbool_t H5Sselect_valid (hid_t <I>space</I>)</TT></DT> +<TT>htri_t H5Sselect_valid (hid_t <I>space</I>)</TT></DT> <DD> This function verifies that the selection for a dataspace is within the extent @@ -656,73 +645,46 @@ is returned. </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> Dataspaces <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> - -<ADDRESS> -<A HREF="mailto:koziol@ncsa.uiuc.edu">Quincey Koziol</A></ADDRESS> - -<BR> ---> -<!-- Created: Thu Dec 4 14:57:32 EST 1997 --><!-- hhmts start --> -<!-- -Last modified: Thu May 28 15:12:04 EST 1998 ---> -<!-- hhmts end --> <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> +</address> -<br> -Last modified: 26 April 1999 +<!-- Created: Thu Dec 4 14:57:32 EST 1997 --> +<!-- hhmts start --> +Last modified: 14 October 1999 +<!-- hhmts end --> </BODY> </HTML> diff --git a/doc/html/Debugging.html b/doc/html/Debugging.html index 34ad4e7..0fe6841 100644 --- a/doc/html/Debugging.html +++ b/doc/html/Debugging.html @@ -20,47 +20,31 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> Debugging <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -100,7 +84,7 @@ And in this document, the <br><br> <dt><b>Timings and Statistics</b> <dd>The library can be configured to accumulate certain - statistics about things like cache performance, data type + statistics about things like cache performance, datatype conversion, data space conversion, and data filters. The code is included on a per-package basis and enabled at runtime by an environment variable. @@ -262,7 +246,7 @@ IOT Trap, core dumped. <tr> <td align=center>t</td> <td align=center>Yes</td> - <td>Data types</td> + <td>Datatypes</td> </tr> <tr> <td align=center>v</td> @@ -297,7 +281,7 @@ IOT Trap, core dumped. </tr> <tr valign=top> <td><code>all -t -s</code></td> - <td>Debugging output for all packages except data types + <td>Debugging output for all packages except datatypes and data spaces will appear on the standard error stream.</td> </tr> @@ -476,69 +460,46 @@ H5E.c:336: warning: trace info was not inserted </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> Debugging <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> ---> -<!-- Created: Wed Jun 17 12:29:12 EDT 1998 --> -<!-- hhmts start --> -<!-- -Last modified: Thu Aug 20 10:43:42 PDT 1998 ---> -<!-- hhmts end --> <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 30 October 1998 +<!-- Created: Wed Jun 17 12:29:12 EDT 1998 --> +<!-- hhmts start --> +Last modified: 14 October 1999 +<!-- hhmts end --> </body> </html> diff --git a/doc/html/Environment.html b/doc/html/Environment.html index 3e2141d..d168ab8 100644 --- a/doc/html/Environment.html +++ b/doc/html/Environment.html @@ -1,8 +1,8 @@ <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> -<<<<<<< Environment.html + <head> -<title>HDF5 Library Environment Variables and Configuration Parameters</title> +<title>Environment Variables and Configuration Parameters</title> </head> <body bgcolor="#FFFFFF"> @@ -21,47 +21,31 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> Environment <a href="ddl.html">DDL</a> + <br> <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> @@ -129,155 +113,42 @@ will display the current list of parameters and their effects. </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> Environment <a href="ddl.html">DDL</a> + <br> <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> - </head> - - <body> - - <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: - - <center> - <table width="90%"> - <tr> - <th>Variable</th> - <th>Description</th> - </tr> - - <tr valign=top> - <td><code>HDF5_DEBUG</code></td> - <td>Defines a list of debugging switches documented in the - <a href="Debugging.html">Debugging</a> section of the - <cite>HDF5 User's Guide</cite>.</td> - </tr> - - <tr valign=top> - <td><code>HDF5_NOCLEANUP</code></td> - <td>If set then programs in the test directories do not - remove temporary files. The default is for each test to - remove the files before exit if the test succeeds but to - leave the files if the test fails.</td> - </tr> - - <tr valign=top> - <td><code>HDF5_PREFIX</code></td> - <td>The value of this variable is prepended to all temporary - file names created by the test programs and separated from - the base name of the file by a slash. The default is no - prefix.</td> - </tr> - - <tr valign=top> - <td><ode>HDF5_DRIVER</code></td> - <td>This variable should hold the name of a low-level HDF5 - file driver such as <code>sec2</code>, <code>stdio</code>, - <code>core</code>, <code>split</code>, or - <code>family</code>. The family driver also takes an - optional real-valued family member size in MB which - defaults to 1. If this variable is not set or empty then - the library-defined default file driver is used (which can - be set at configuration time with the H5F_LOW_DFLT cpp - constant, usually <code>sec2</code>).</td> - </tr> - - <tr valign=top> - <td><code>HDF5_MPI_OPT_TYPES</code></td> - <td>When set to <code>1</code>, parallel HDF5 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.</td> - </tr> - - <tr valign=top> - <td><code>HDF5_MPI_1_METAWRITE</code></td> - <td>When set to <code>1</code>, parallel HDF5 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.</td> - </tr> - - </table> - </center> - - - <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> -<address> -<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> -</address> - -Last modified: 25 November 1998 +Last modified: 14 October 1999 </body> </html> diff --git a/doc/html/Errors.html b/doc/html/Errors.html index 8085b40..c5c4573 100644 --- a/doc/html/Errors.html +++ b/doc/html/Errors.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> <head> - <title>The Error Handling Interface (H5E)</title> + <title>Error Handling Interface (H5E)</title> </head> <body bgcolor="#FFFFFF"> @@ -20,47 +20,31 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> Error Handling + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -80,6 +64,8 @@ And in this document, the next API function which is called (with a few exceptions) resets the stack. + <h2>2. Error Handling Operations</h2> + <p>In normal circumstances, an error causes the stack to be printed on the standard error stream. The first item, number "#000" is produced by the API function itself and is usually @@ -93,14 +79,14 @@ And in this document, the <tr> <td> <p>If an application calls <code>H5Tclose</code> on a - predefined data type then the following message is + predefined datatype then the following message is printed on the standard error stream. This is a simple error that has only one component, the API function; other errors may have many components. <p><code><pre> HDF5-DIAG: Error detected in thread 0. Back trace follows. - #000: H5T.c line 462 in H5Tclose(): predefined data type + #000: H5T.c line 462 in H5Tclose(): predefined datatype major(01): Function argument minor(05): Bad value </code></pre> @@ -248,7 +234,7 @@ H5Eset_auto (my_hdf5_error_handler, NULL); sequence number beginning at zero (regardless of <em>direction</em>), a pointer to an error description record, and the <em>client_data</em> pointer. If <em>direction</em> - is <code>H5E_WALK_UPWARD</em> then traversal begins at the + is <code>H5E_WALK_UPWARD</code> then traversal begins at the inner-most function that detected the error and concludes with the API function. The opposite order is <code>H5E_WALK_DOWNWARD</code>. @@ -345,69 +331,46 @@ H5Ewalk_cb(int n, H5E_error_t *err_desc, void *client_data) </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> Error Handling + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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:hdf5dev@ncsa.uiuc.edu">Robb Matzke</a></address> ---> -<!-- Created: Fri Feb 27 23:42:52 EST 1998 --> -<!-- hhmts start --> -<!-- -Last modified: Wed Mar 4 10:06:17 EST 1998 ---> -<!-- hhmts end --> <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 30 October 1998 +<!-- Created: Fri Feb 27 23:42:52 EST 1998 --> +<!-- hhmts start --> +Last modified: 14 October 1999 +<!-- hhmts end --> </body> </html> diff --git a/doc/html/Files.html b/doc/html/Files.html index d371697..1765f2d 100644 --- a/doc/html/Files.html +++ b/doc/html/Files.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> <head> - <title>HDF5 Files</title> + <title>File Interface (H5F)</title> </head> <body bgcolor="#FFFFFF"> @@ -19,47 +19,31 @@ </td> <td valign=top align=right> And in this document, the - <a href="H5.user.html">HDF5 User's Guide</a>: - Files + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + Files <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -522,7 +506,7 @@ And in this document, the returns a negative value. On successful return, <em>access_properties</em> will point to a copy of the member access property list which should be closed by calling - <code>H5Pclose()</em> when the application is finished with + <code>H5Pclose()</code> when the application is finished with it. If <em>memb_size</em> is non-null then it will contain the logical size in bytes of each family member. In the future, additional arguments may be added to this function to @@ -573,7 +557,7 @@ And in this document, the returns a negative value. On successful return, <em>meta_properties</em> and <em>raw_properties</em> will point to copies of the meta and raw access property lists - which should be closed by calling <code>H5Pclose()</em> when + which should be closed by calling <code>H5Pclose()</code> when the application is finished with them, but if the meta and/or raw file has no property list then a negative value is returned for that property list handle. Also, if @@ -602,70 +586,46 @@ And in this document, the </td> <td valign=top align=right> And in this document, the - <a href="H5.user.html">HDF5 User's Guide</a>: - Files + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + Files <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> - <address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address> ---> -<!-- Created: Tue Jan 27 09:11:27 EST 1998 --> -<!-- hhmts start --> -<!-- -Last modified: Tue Sep 8 14:43:31 EDT 1998 ---> -<!-- hhmts end --> <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 30 October 1998 +<!-- Created: Tue Jan 27 09:11:27 EST 1998 --> +<!-- hhmts start --> +Last modified: 14 October 1999 +<!-- hhmts end --> </body> </html> diff --git a/doc/html/Filters.html b/doc/html/Filters.html index c2a1961..a7b3ddf 100644 --- a/doc/html/Filters.html +++ b/doc/html/Filters.html @@ -20,47 +20,31 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> Filters + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -535,67 +519,46 @@ H5Z: filter statistics accumulated over life of library: </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> Filters + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> ---> -<!-- Created: Fri Apr 17 13:39:35 EDT 1998 --> -<!-- hhmts start --> -Last modified: Mon Jan 18 13:32:14 EST 1999 -<!-- hhmts end --> <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 30 October 1998 +<!-- Created: Fri Apr 17 13:39:35 EDT 1998 --> +<!-- hhmts start --> +Last modified: 14 October 1999 +<!-- hhmts end --> </body> </html> diff --git a/doc/html/Glossary.html b/doc/html/Glossary.html index 1a9d9c8..204d081 100644 --- a/doc/html/Glossary.html +++ b/doc/html/Glossary.html @@ -6,18 +6,19 @@ HDF5 Glossary <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> -<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_H5P.html">H5P</a> -<a href="RM_H5S.html">H5S</a> -<a href="RM_H5T.html">H5T</a> -<a href="RM_H5Z.html">H5Z</a> -Glossary +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="index.html">Other HDF5 documents and links</a> <br> + <a href="H5.intro.html">Introduction to HDF5</a> +</td> +<td valign=top align=right> + +</td> +<td valign=top align=right> + <a href="H5.user.html">HDF5 User Guide</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> +</td></tr> +</table> </center> <hr> @@ -25,77 +26,512 @@ Glossary <h1>HDF5 Glossary</h1> </center> -<i>(<b>Under construction!</b> - This is the bare beginning of a Glossary to accompany the HDF5 - documentation; it is by no means complete.)</i> +<center> +<table width=90% border=0> +<tr><td valign=top align=left width=33%> +<dl> + <dt><a href="#Glossary-AtomicDType">atomic datatype</a> + <dt><a href="#Glossary-Attribute">attribute</a> +<!--<dt><a href="#Glossary-BasicDType">basic datatype</a>--> + <dt><a href="#Glossary-LayoutChunked">chunked layout</a> + <dt><a href="#Glossary-Chunking">chunking</a> +<!--<dt><a href="#Glossary-ComplexDType">complex datatype</a>--> + <dt><a href="#Glossary-CompoundDType">compound datatype</a> +<!--<dt>compound element--> + <dt><a href="#Glossary-LayoutContig">contiguous layout</a> +<!--<dt>conversion function--> + <dt><a href="#Glossary-Dataset">dataset</a> + <dt><a href="#Glossary-Dataspace">dataspace</a> +<!--<dl>--> +<!-- <dt>dimensions--> +<!-- <dt>selection--> +<!--</dl>--> + <dt><a href="#Glossary-Datatype">datatype</a> + <dl> + <dt><a href="#Glossary-AtomicDType">atomic</a> +<!-- <dt><a href="#Glossary-BasicDType">basic</a>--> +<!-- <dt><a href="#Glossary-ComplexDType">complex</a>--> + <dt><a href="#Glossary-CompoundDType">compound</a> +<!-- <dt>conversion function--> +<!-- <dt><a href="#Glossary-DiskIO">disk I/O</a>--> + <dt><a href="#Glossary-DTypeEnum">enumeration</a> + <dt><a href="#Glossary-DTypeNamed">named</a> + <dt><a href="#Glossary-DTypeOpaque">opaque</a> +<!-- <dt>transient--> + <dt><a href="#Glossary-DTypeVLen">variable-length</a> + </dl> +<!--<dt>DDL--> +<!--<dt>dimensions--> +<!--<dt><a href="#Glossary-DiskIO">disk I/O datatype</a>--> +<!--<dt>element--> + <dt><a href="#Glossary-DTypeEnum">enumeration datatype</a> + <dt><a href="#Glossary-File">file</a> + <dl> +<!-- <dt>compound element--> +<!-- <dt>element--> + <dt><a href="#Glossary-Group">group</a> + <dt><a href="#Glossary-Path">path</a> + <dt><a href="#Glossary-RootGroup">root group</a> + <dt><a href="#Glossary-SuperBlock">super block</a> + </dl> +</dl> +</td> +<td valign=top align=left width=34%> +<dl> + <dt><a href="#Glossary-FileAccessMode">file access mode</a> + <dt><a href="#Glossary-Group">group</a> + <dl> +<!-- <dt>element--> + <dt><a href="#Glossary-GroupMember">member</a> + <dt><a href="#Glossary-RootGroup">root group</a> + </dl> + <dt><a href="#Glossary-LinkHard">hard link</a> +<!--<dt>HDF5--> + <dt><a href="#Glossary-Hyperslab">hyperslab</a> + <dt><a href="#Glossary-Identifier">identifier</a> + <dt><a href="#Glossary-Link">link</a> + <dl> + <dt><a href="#Glossary-LinkHard">hard</a> + <dt><a href="#Glossary-LinkSoft">soft</a> +<!-- <dt><a href="#Glossary-LinkSoftName">soft link name</a>--> +<!-- <dt>target--> + </dl> + <dt><a href="#Glossary-GroupMember">member</a> + <dt><a href="#Glossary-Name">name</a> + <dt><a href="#Glossary-DTypeNamed">named datatype</a> + <dt><a href="#Glossary-DTypeOpaque">opaque datatype</a> + <dt><a href="#Glossary-Path">path</a> +<!--<dt>parallel I/O--> + <dt><a href="#Glossary-PList">property list</a> + <dl> + <dt><a href="#Glossary-PListDataTransfer">data transfer</a> + <dt><a href="#Glossary-PListDSetAccess">dataset access</a> + <dt><a href="#Glossary-PListDSetCreate">dataset creation</a> + <dt><a href="#Glossary-PListFileAccess">file access</a> + <dt><a href="#Glossary-PListFileCreate">file creation</a> + </dl> +</dl> +</td> +<td valign=top align=left width=33%> +<dl> + <dt><a href="#Glossary-RootGroup">root group</a> + <dt><a href="#Glossary-Selection">selection</a> + <dl> + <dt><a href="#Glossary-Hyperslab">hyperslab</a> +<!-- <dt>point--> + </dl> + <dt><a href="#Glossary-Serialization">serialization</a> + <dt><a href="#Glossary-LinkSoft">soft link</a> +<!--<dt><a href="#Glossary-LinkSoftName">soft link name</a>--> + <dt><a href="#Glossary-StorageLayout">storage layout</a> + <dl> + <dt><a href="#Glossary-LayoutChunked">chunked</a> + <dt><a href="#Glossary-Chunking">chunking</a> + <dt><a href="#Glossary-LayoutContig">contiguous</a> + </dl> + <dt><a href="#Glossary-SuperBlock">super block</a> +<!--<dt>target--> +<!--<dt>threadsafe--> +<!--<dt>transient datatype--> + <dt><a href="#Glossary-DTypeVLen">variable-length datatype</a> +</dl> +</td></tr> +</table> +</center> -<ul> - <li><a href="#Glossary-Basic">basic data types</a> - <li><a href="#Glossary-Complex">complex data types</a> - <li>data types -<ul> - <li><a href="#Glossary-Basic">basic data types</a> - <li><a href="#Glossary-Complex">complex data types</a> - <li><a href="#Glossary-DiskIO">disk I/O data types</a> -</ul> - <li><a href="#Glossary-DiskIO">disk I/O data types</a> -</ul> +<hr> -<hr> +<DL> -<a name="Glossary-Basic">basic data types:</a> -<ul> - <li><em>(Some data types may change substantially en route to - Release 1.0.)</em> - <li>char - 8-bit character (only for ASCII information) - <li>int8 - 8-bit signed integer - <li>uint8 - 8-bit unsigned integer - <li>int16 - 16-bit signed integer - <li>uint16 - 16-bit unsigned integer - <li>int32 - 32-bit signed integer - <li>uint32 - 32-bit unsigned integer - <li>intn - "native" signed integer - <li>uintn - "native" unsigned integer - <li>int64 - 64-bit signed integer (new) - <li>uint64 - 64-bit unsigned integer (new) - <li>float32 - 32-bit IEEE float - <li>float64 - 64-bit IEEE float -</ul> +<dt><strong><a name="Glossary-AtomicDType">atomic datatype</a></strong> + <dd>A datatype which cannot be decomposed into smaller units at the + API level. +<P> -<a name="Glossary-Complex">Complex data types:</a> -<ul> - <li><em>(Some data types may change substantially en route to - Release 1.0.)</em> - <li>hid_t - 32-bit unsigned integer used as ID for memory objects - <li>hoid_t - 32-bit unsigned integer (currently) used as ID for disk-based - objects - <li>hbool_t - boolean to indicate true/false/error codes from functions - <li>herr_t - 32-bit integer to indicate succeed/fail codes from functions -</ul> +<DT><a name="Glossary-Attribute"><B>attribute</B></a> +<DD>A small dataset that can be used to describe the nature and/or + the intended usage of the object it is attached to. +<P> + +<!-- +<dt><strong><a name="Glossary-Basic">basic datatypes</a></strong> + <ul> + <li>char - 8-bit character (only for ASCII information) + <li>int8 - 8-bit signed integer + <li>uint8 - 8-bit unsigned integer + <li>int16 - 16-bit signed integer + <li>uint16 - 16-bit unsigned integer + <li>int32 - 32-bit signed integer + <li>uint32 - 32-bit unsigned integer + <li>intn - "native" signed integer + <li>uintn - "native" unsigned integer + <li>int64 - 64-bit signed integer (new) + <li>uint64 - 64-bit unsigned integer (new) + <li>float32 - 32-bit IEEE float + <li>float64 - 64-bit IEEE float + </ul> +<P> +--> -<a name="Glossary-DiskIO">disk I/O data types:</a> +<dt><strong><a name="Glossary-LayoutChunked">chunked layout</a></strong> +<dd>The storage layout of a chunked dataset. +<P> + +<dt><strong><a name="Glossary-Chunking">chunking</a></strong> +<dd>A storage layout where a dataset is partitioned into fixed-size + multi-dimensional chunks. Chunking tends to improve performance + and facilitates dataset extensibility. +<P> + +<dt><strong><a name="Glossary-CompoundDType">compound datatype</a></strong> +<dd>A collection of one or more atomic types or small arrays of such types. + Similar to a struct in C or a common block in Fortran. +<P> + +<!-- +<dt><strong><a name="Glossary-ComplexDType">complex datatype</a></strong> +<dd>A collection of one or more atomic types or small arrays of such types. + <ul> + <li>hid_t - 32-bit unsigned integer used as ID for memory objects + <li>hoid_t - 32-bit unsigned integer (currently) used as ID for + disk-based objects + <li>hbool_t - boolean to indicate true/false/error codes from functions + <li>herr_t - 32-bit integer to indicate succeed/fail codes from + functions + </ul> +<P> +--> + +<dt><strong><a name="Glossary-LayoutContig">contiguous layout</a></strong> +<dd>The storage layout of a dataset that is not chunked, so that the entire + data portion of the dataset is stored in a single contiguous block. +<P> + +<DT><B><a name="Glossary-PListDataTransfer">data transfer property list</B></a> +<DD>The data transfer property list is used to control various aspects + of the I/O, such as caching hints or collective I/O information. +<P> + +<DT><B><a name="Glossary-Dataset">dataset</B></a> +<DD>A multi-dimensional array of data elements, together with + supporting metadata. +<P> + +<DT><B><a name="Glossary-PListDSetAccess">dataset access property list</B></a> +<DD>A property list containing information on how a dataset is to be accessed. +<P> + +<DT><B><a name="Glossary-PListDSetCreate">dataset creation property list</B></a> +<DD>A property list containing information on how + raw data is organized on disk and how the raw data is compressed. +<!-- + The dataset API partitions these terms by layout, compression, + and external storage: + <UL> + <B> Layout:</B> + <UL> + <LI>H5D_COMPACT: Data is small and can be stored in object header (not + implemented yet). This eliminates disk seek/read requests. + <LI>H5D_CONTIGUOUS: (<B>default</B>) The data is large, non-extendible, + non-compressible, non-sparse, and can be stored externally. + <LI>H5D_CHUNKED: The data is large and can be extended in any dimension. + It is partitioned into chunks so each chunk is the same logical size. + </UL> + <B>Compression:</B> (gzip compression)<BR> + <B>External Storage Properties:</B> The data must be contiguous to be + stored externally. It allows you to store + the data in one or more non-HDF5 files. + </UL> +--> +<P> + +<DT><B><a name="Glossary-Dataspace">dataspace</B></a> +<DD>An object that describes the dimensionality of the data array. + A dataspace is either a regular N-dimensional array of data points, + called a simple dataspace, or a more general collection of data points + organized in another manner, called a complex dataspace. +<P> + +<DT><B><a name="Glossary-Datatype">datatype</B></a> +<DD>An object that describes the storage format of the individual data + points of a data set. + There are two categories of datatypes: atomic and compound datatypes. + An atomic type is a type which cannot be decomposed into smaller + units at the API level. A compound datatype is a collection of one or + more atomic types or small arrays of such types. +<P> + +<!-- +<DT><B>DDL</B> +<DD>A detailed description of the HDF5 format and objects, written in a + Data Description Language using Backus-Naur Form. +<P> +--> + +<!-- +<dt><strong><a name="Glossary-DiskIO">disk I/O datatypes</a></strong> <ul> - <li><em>(Some data types may change substantially en route to - Release 1.0.)</em> <li>hoff_t - (64-bit?) offset on disk in bytes <li>hlen_t - (64-bit?) length on disk in bytes </ul> +<P> +--> + +<dt><strong><a name="Glossary-DTypeEnum">enumeration datatype</a></strong> +<dd>A one-to-one mapping between a set of symbols and a set of + integer values, and an order is imposed on the symbols by their + integer values. The symbols are passed between the application + and library as character strings and all the values for a + particular enumeration datatype are of the same integer type, + which is not necessarily a native type. +<P> + +<DT><B><a name="Glossary-File">file</B></a> +<DD>A container for storing grouped collections of + multi-dimensional arrays containing scientific data. +<P> + +<DT><B><a name="Glossary-FileAccessMode">file access mode</B></a> +<DD>Determines whether an existing file will be overwritten, + opened for read-only access, or opened for read/write access. + All newly created files are opened for both reading and + writing. +<!-- + Possible values are: + <PRE> + H5F_ACC_RDWR: Allow read and write access to file. + H5F_ACC_RDONLY: Allow read-only access to file. + H5F_ACC_TRUNC: Truncate file, if it already exists, erasing all data + previously stored in the file. + H5F_ACC_EXCL: Fail if file already exists. + H5F_ACC_DEBUG: Print debug information. + H5P_DEFAULT: Apply default file access and creation properties. + </PRE> +--> +<P> + +<DT><B><a name="Glossary-PListFileAccess">file access property list</B></a> +<DD>File access property lists are used to control different methods + of performing I/O on files: +<!-- + <UL> + <B>Unbuffered I/O:</B> Local permanent files can be accessed with the + functions described in Section 2 of the Posix manual, namely open(), + lseek(), read(), write(), and close(). <BR> + <B>Buffered I/O:</B> Local permanent files can be accessed with the + functions declared in the stdio.h header file, namely fopen(), + fseek(), fread(), fwrite(), and fclose().<BR> + <B>Memory I/O:</B> Local temporary files can be created and accessed + directly from memory without ever creating permanent storage. + The library uses malloc() and free() to create storage space for the + file<BR> + <B>Parallel Files using MPI I/O:</B> This driver allows parallel access + to a file through the MPI I/O library. The parameters which can be + modified are the MPI communicator, the info object, and the access mode. + The communicator and info object are saved and then passed to + MPI_File_open() during file creation or open. The access_mode + controls the kind of parallel access the application intends.<BR> + <B>Data Alignment:</B> Sometimes file access is faster if certain things + are aligned on file blocks. This can be controlled by setting alignment + properties of a file access property list with the H5Pset_alignment() + function. + </UL> +--> +<P> + +<DT><B><a name="Glossary-PListFileCreate">file creation property list</B></a> +<DD>The property list used to control file metadata. +<!-- + The parameters that can be modified are: + <UL> + <B>User-Block Size:</B> The "user-block" is a fixed length block + of data located at the beginning of the file which is ignored + by the HDF5 library and may be used to store any data information + found to be useful to applications. + <BR> + <B>Offset and Length Sizes:</B> The number of bytes used to store the + offset and length of objects in the HDF5 file can be controlled + with this parameter. + <BR> + <b>Symbol Table Parameters:</b> The size of symbol table B-trees can + be controlled by setting the 1/2 rank and 1/2 node size + parameters of the B-tree. + <BR> + <B>Indexed Storage Parameters:</B> The size of indexed storage + B-trees can be controlled by setting the 1/2 rank and 1/2 node + size parameters of the B-tree. + </UL> +--> +<P> + +<DT><B><a name="Glossary-Group">group</B></a> +<DD>A structure containing zero or more HDF5 objects, + together with supporting metadata. + The two primary HDF5 objects are datasets and groups. +<P> + +<dt><strong><a name="Glossary-LinkHard">hard link</a></strong> +<dd>A direct association between a name and the object where both exist + in a single HDF5 address space. +<P> + +<!-- +<DT><B>HDF5</B> +<DD>HDF5 is an abbreviation for Hierarchical Data Format Version 5. + This file format is intended to make it easy to write and read + scientific data + <P> + <UL> + <LI>by including the information needed to understand the data + within the file + <P> + <LI>by providing a library of C, FORTRAN, and other language + programs that reduce the work required to provide efficient + writing and reading - even with parallel IO + </UL> +<P> +--> + +<DT><B><a name="Glossary-Hyperslab">hyperslab</B></a> +<DD>A portion of a dataset. A hyperslab selection can be a + logically contiguous collection of points in a dataspace or + a regular pattern of points or blocks in a dataspace. +<P> + +<dt><strong><a name="Glossary-Identifier">identifier</a></strong> +<dd>A unique entity provided by the HDF5 library and used to access + an HDF5 object, such as a file, goup, dataset, datatype, etc. +<P> + +<dt><strong><a name="Glossary-Link">link</a></strong> +<dd>An association between a name and the object in an HDF5 file group. +<P> + +<dt><strong><a name="Glossary-GroupMember">member</a></strong> +<dd>A group or dataset that is in another dataset, <i>dataset A</i>, + is a member of <i>dataset A</i>. +<P> + +<DT><B><a name="Glossary-Name">name</B></a> +<DD>A slash-separated list of components that uniquely identifies an + element of an HDF5 file. A name begins that begins with a slash + is an absolute name which is accessed beginning with the root group + of the file; all other names are relative names and the associated + objects are accessed beginning with the current or specified group. +<P> + +<dt><strong><a name="Glossary-DTypeNamed">named datatype</a></strong> +<dd>A datatype that is named and stored in a file. Naming is permanent; + a datatype cannot be changed after being named. +<P> + +<dt><strong><a name="Glossary-DTypeOpaque">opaque datatype</a></strong> +<dd>A mechanism for describing data which cannot be otherwise described + by HDF5. The only properties associated with opaque types are a + size in bytes and an ASCII tag. +<P> + +<!-- +<DT><B>parallel I/O HDF5</B> +<DD>The parallel I/O version of HDF5 supports parallel file access using + MPI (Message Passing Interface). +<P> +--> + +<dt><strong><a name="Glossary-Path">path</a></strong> +<dd>The slash-separated list of components that forms the name + uniquely identifying an element of an HDF5 file. +<P> + +<dt><strong><a name="Glossary-PList">property list</a></strong> +<dd>A collection of name/value pairs that can be passed to other + HDF5 functions to control features that are typically unimportant + or whose default values are usually used. +<P> + +<dt><strong><a name="Glossary-RootGroup">root group</a></strong> +<dd>The group that is the entry point to the group graph in an HDF5 file. + Every HDF5 file has exactly one root group. +<P> + +<dt><strong><a name="Glossary-Selection">selection</a></strong> +<dd>A subset of a dataset or a dataspace, up to the entire dataset or + dataspace. +<P> + +<dt><strong><a name="Glossary-Serialization">serialization</a></strong> +<dd>The flattening of an <em>N</em>-dimensional data object into a + 1-dimensional object so that, for example, the data object can be + transmitted over the network as a 1-dimensional bitstream. +<P> + +<dt><strong><a name="Glossary-LinkSoft">soft link</a></strong> +<dd>An indirect association between a name and an object in an + HDF5 file group. +<P> + +<dt><strong><a name="Glossary-StorageLayout">storage layout</a></strong> +<dd>The manner in which a dataset is stored, either contiguous or + chunked, in the HDF5 file. +<P> + +<DT><B><a name="Glossary-SuperBlock">super block</B></a> +<DD>A block of data containing the information required to portably access + HDF5 files on multiple platforms, followed by information about the groups + and datasets in the file. + The super block contains information about the size of offsets, + lengths of objects, the number of entries in group tables, + and additional version information for the file. +<P> + +<!-- +<DT><B>threadsafe</B> +<DD>A "thread-safe" version of HDF-5 (TSHDF5) is one that can be called + from any thread of a multi-threaded program. Any calls to HDF + can be made in any order, and each individual HDF call will perform + correctly. A calling program does not have to explicitly lock the HDF + library in order to do I/O. Applications programmers may assume that + the TSHDF5 guarantees the following: + <UL> + <LI>the HDF-5 library does not create or destroy threads. + <LI>the HDF-5 library uses modest amounts of per-thread + private memory. + <LI>the HDF-5 library only locks/unlocks it's own locks (no locks + are passed in or returned from HDF), and the internal locking + is guaranteed to be deadlock free. + </UL> + <P> + These properties mean that the TSHDF5 library will not interfere + with an application's use of threads. A TSHDF5 library is the same + library as regular HDF-5 library, with additional code to synchronize + access to the HDF-5 library's internal data structures. +<P> +--> + +<dt><strong><a name="Glossary-DTypeVLen">variable-length datatype</a></strong> +<dd>A sequence of an existing datatype (atomic, variable-length (VL), + or compound) which are not fixed in length from one dataset location + to another. +<P> + +</DL> <hr> <center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> -<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_H5P.html">H5P</a> -<a href="RM_H5S.html">H5S</a> -<a href="RM_H5T.html">H5T</a> -<a href="RM_H5Z.html">H5Z</a> -Glossary +<table border=0 width=98%> +<tr><td valign=top align=left> + <a href="index.html">Other HDF5 documents and links</a> <br> + <a href="H5.intro.html">Introduction to HDF5</a> +</td> +<td valign=top align=right> + +</td> +<td valign=top align=right> + <a href="H5.user.html">HDF5 User Guide</a> <br> + <a href="RM_H5Front.html">HDF5 Reference Manual</a> +</td></tr> +</table> </center> <hr> @@ -103,7 +539,7 @@ Glossary <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 18 October 1999 </body> </html> diff --git a/doc/html/Groups.html b/doc/html/Groups.html index ed09929..8aac8a7 100644 --- a/doc/html/Groups.html +++ b/doc/html/Groups.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> <head> - <title>Groups</title> + <title>Group Interface (H5G)</title> </head> <body bgcolor="#FFFFFF"> @@ -20,47 +20,31 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> Groups - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -332,69 +316,46 @@ And in this document, the </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> Groups - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> ---> -<!-- Created: Tue Jan 27 09:11:27 EST 1998 --> -<!-- hhmts start --> -<!-- -Last modified: Wed Jul 22 14:24:34 EDT 1998 ---> -<!-- hhmts end --> <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 30 October 1998 +<!-- Created: Tue Jan 27 09:11:27 EST 1998 --> +<!-- hhmts start --> +Last modified: 14 October 1999 +<!-- hhmts end --> </body> </html> diff --git a/doc/html/H5.intro.html b/doc/html/H5.intro.html index 6c32ad7..1b9806d 100644 --- a/doc/html/H5.intro.html +++ b/doc/html/H5.intro.html @@ -7,14 +7,6 @@ <BODY LINK="#0000ff" VLINK="#800080" bgcolor="#FFFFFF"> -<!-- - SOURCE FILE FOR THIS DOCUMENT - ../src/H5intro.doc -- Microsoft Word - ------------------------------------------- - This HTML file is derived from that source. - Edit ONLY the source document. ---> - <hr> <center> @@ -36,7 +28,7 @@ Introduction to HDF5 <br> <a name="Intro-Intro"> -<h1 ALIGN="CENTER">Introduction to HDF5 Release 1.0</h1></a> +<h1 ALIGN="CENTER">Introduction to HDF5 Release 1.2</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 <A HREF="index.html">the HDF5 documentation</FONT></a><FONT FACE="Times">. Available documents include the following: @@ -47,7 +39,9 @@ Introduction to HDF5 <br> <FONT FACE="Times"><P>Code examples are available in the source code tree when you install HDF5. <UL> -</FONT><LI>The directory<FONT FACE="Courier" SIZE=2> hdf5/examples</FONT> contains the examples used in this document. +</FONT><LI>The directories <code>hdf5/examples</code> and +<code>hdf5/doc/html/Tutor/examples/</code> contain the examples +used in this document. <LI>The directory<FONT FACE="Courier" SIZE=2> hdf5/test</FONT> contains the development tests used by the HDF5 developers. Since these codes are intended to fully exercise the system, they provide more diverse and sophisticated examples of what HDF5 can do.</UL> <a name="Intro-TOC"> @@ -56,27 +50,30 @@ Introduction to HDF5 <br> <table border=0 width=90%> <tr><th colspan=3>Table of Contents</th></tr></a> <tr><td valign=top align=left width=42%> - <a href="#Intro-Intro">Introduction to HDF5 Release 1.0</a><p> + + <a href="#Intro-Intro">Introduction to HDF5 Release 1.2</a><p> <a href="#Intro-WhatIs">1. What Is HDF5?</a><br> <font size=-1> -    <a href="#Intro-Why">Why HDF5?</a><br> -    <a href="#Intro-Limits">Limitations of the - Current Release</a><br> -    <a href="#Intro-Changes">Changes in the +   <a href="#Intro-Why">Why HDF5?</a><br> +   <a href="#Intro-Limits">Limitations of the Current Release</a><br> +   <a href="#Intro-Changes">Changes in the + Current Release</a><p> </font> - <a href="#Intro-FileOrg">2. HDF5 File Organization and Data Model</a><br> + <a href="#Intro-FileOrg">2. HDF5 File Organization and</a></br> + <font size=-1>   </font><a href="#Intro-FileOrg">Data Model</a><br> <font size=-1> -    <a href="#Intro-OGroups">HDF5 Groups</a><br> -    <a href="#Intro-ODatasets">HDF5 Datasets</a><br> -    <a href="#Intro-OAttributes">HDF5 Attributes</a><br> +   <a href="#Intro-OGroups">HDF5 Groups</a><br> +   <a href="#Intro-ODatasets">HDF5 Datasets</a><br> +   <a href="#Intro-OAttributes">HDF5 Attributes</a><br> +   <a href="#Intro-FileTech">The File as Written to Media</a><p> </font> <a href="#Intro-APIs">3. The HDF5 API</a><br> <font size=-1> -    <a href="#Intro-NameConv">Naming +   <a href="#Intro-NameConv">Naming Conventions</a><br> -    <a href="#Intro-Include">Include Files</a><br> -    <a href="#Intro-ProgModels">Programming +   <a href="#Intro-Include">Include Files</a><br> +   <a href="#Intro-ProgModels">Programming Models</a><br>     <A href="#Intro-PMCreateFile">Creating an HDF5 file</A><br> @@ -88,13 +85,6 @@ Introduction to HDF5 <br>     <A href="#Intro-PMGetInfo">Getting information about a dataset</A><br> - -</td><td width=6%> </td><td valign=top align=left width=42%> - - <a href="#Intro-APIs">3. The HDF5 API</a> <i>(continued)</i><br> - <font size=-1> -    <a href="#Intro-ProgModels">Programming - Models</a> <i>(continued)</i><br>     <A href="#Intro-PMRdWrPortion">Reading/writing a portion of a dataset</A><br> @@ -105,14 +95,31 @@ Introduction to HDF5 <br> points</A><br>     <A href="#Intro-PMCreateCompound">Creating compound - datatypes</A><br> + datatypes</A> + +</td><td width=6%> </td><td valign=top align=left width=42%> + + <a href="#Intro-APIs">3. The HDF5 API</a> <i>(continued)</i><br> + <font size=-1> +   <a href="#Intro-ProgModels">Programming + Models</a> <i>(continued)</i><br>     - <A href="#Intro-PMCreateExtendible">Creating/writing - extendible datasets</A><br> + <A href="#Intro-PMCreateExtendible">Creating/writing extendible and</a> <br> +     +     + <A href="#Intro-PMCreateExtendible">chunked datasets</A><br>     <A href="#Intro-PMWorkGroups">Working with groups</A><br>     <A href="#Intro-PMWorkAttributes">Working with attributes</A><br> +     + <A href="#Intro-PMWorkRefObjects">Working with references to + objects</A><br> +     + <A href="#Intro-PMWorkRefRegions">Working with references to dataset</a> <br> +     +     + <A href="#Intro-PMWorkRefRegions">regions</A><p> </font> <a href="#Intro-Examples">4. Example Codes</a><br> <font size=-1> @@ -126,8 +133,10 @@ Introduction to HDF5 <br>     <A href="#Compound">4. Working with compound datatypes</A><br>     - <A href="#CreateExtendWrite">5. Creating and writing an - extendible dataset</A><br> + <A href="#CreateExtendWrite">5. Creating and writing an extendible</a> <br> +     +     + <A href="#CreateExtendWrite">dataset</A><br>     <A href="#ReadExtended">6. Reading data</A><br>     @@ -135,6 +144,23 @@ Introduction to HDF5 <br>     <A href="#ReadWriteAttributes">8. Writing and reading attributes</A><br> +     + <a href="#CreateWriteRefObj">9. Creating and writing references</a><br> +     +     + <a href="#CreateWriteRefObj">to objects</a><br> +     + <a href="#ReadRefObj">10. Reading references to objects</a><br> +     + <a href="#CreateWriteRefReg">11. Creating and writing references</a><br> +     +     + <a href="#CreateWriteRefReg">to dataset regions</a><br> +     + <a href="#ReadRefReg">12. Reading references to dataset</a><br> +     +     + <a href="#ReadRefReg">regions</a> </font> </td></tr> </table> @@ -143,11 +169,19 @@ Introduction to HDF5 <br> <hr> <H2><A NAME="Intro-WhatIs">1. What Is HDF5?</A></H2> -<FONT FACE="Times"><P>HDF5 is a new, experimental version of HDF that is designed to address some of the limitations of the current version of HDF (HDF4.x) and to address current and anticipated requirements of modern systems and applications. -<P>We urge you to look at this new version of HDF and give us feedback on what you like or do not like about it, and what features you would like to see added to it. +<FONT FACE="Times"><P>HDF5 is a completely new Hierarchical Data Format +product consisting of a data format specification and a +supporting library implementation. HDF5 is designed to address some +of the limitations of the older HDF product and to address current and +anticipated requirements of modern systems and applications. +<sup><a href="#H4H5footnote">1</a></sup> +<P>We urge you to look at HDF5, the format and the library, and give us +feedback on what you like or do not like about it, and what features +you would like to see added to it. <a name="Intro-Why"> <P><B>Why HDF5?</B></a> -The development of HDF5 is motivated by a number of limitations in the current HDF format, as well as limitations in the library. Some of these limitations are: +The development of HDF5 is motivated by a number of limitations in the +older HDF format and library. Some of these limitations are: <UL> </FONT><LI>A single file cannot store more than 20,000 complex objects, and a single file cannot be larger than 2 gigabytes. @@ -161,27 +195,45 @@ The development of HDF5 is motivated by a number of limitations in the current H <LI>A simpler, more comprehensive data model that includes only two basic structures: a multidimensional array of record structures, and a grouping structure. <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> +<font size=-1> +<a name="H4H5footnote">1.</a> +Note that HDF and HDF5 are two different products. +HDF is a data format first developed in the 1980s and currently +in Release 4.<i>x</i> (HDF Release 4.<i>x</i>). +HDF5 is a new data format first released in <i>Beta</i> in 1998 and +designed to better meet the ever-increasing demands of scientific computing +and to take better advantage of the ever-increasing capabilities of +computing systems. +HDF5 is currently in Release 1.<i>x</i> (HDF5 Release 1.<i>x</i>). +</font> + <H3><A NAME="Intro-Limits">Limitations of the Current Release</A></H3> <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>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 Beta) can be found in the file <CODE>hdf5/RELEASE </CODE>in the code installation. Important changes include: +<P>A detailed list of changes in HDF5 since the last release, +HDF5 Release 1.0, can be found in the file <CODE>hdf5/RELEASE</CODE> +in the source code installation. At a higher level, those changes include: <UL> -<li>An object reference has been implemented. -<li>Union selection (unions of hyperslabs) has been implemented. -<li>Fill values have been implemented. +<li>Support for bitfield, opaque, enumeration, and variable-length datatypes +<li>Support for object and dataset region pointers +<li>Improved parallel performance and support for additional parallel platforms +<li>Improved and expanded documentation +<li>Enhancements to the <code>h5ls</code> and <code>h5dump</code> tools + and a new HDF5 to HDF4 conversion tool, <code>h5toh4</code> +<li>Over 30 new API functions </UL> +<P>The changes as HDF5 has evolved from the first Alpha release +to the present are summarized in the file <CODE>hdf5/HISTORY</CODE> +in the source code installation. + <p align=right><font size=-1><a href="#Intro-TOC">(Return to TOC)</a></font> <hr> <H2><A NAME="Intro-FileOrg">2. HDF5 File Organization and Data Model</A></H2> @@ -231,12 +283,12 @@ Atomic datatypes can also be system-specific, or <I><CODE>NATIVE</CODE></I>, and <LI>Strings.</UL> <p> -<em><code>NATIVE</code> datatypes.</em> Although it is possible to describe nearly any kind of atomic data type, most applications will use predefined datatypes that are supported by their compiler. In HDF5 these are called <i>native</i> datatypes. <CODE>NATIVE</CODE> datatypes are C-like datatypes that are generally supported by the hardware of the machine on which the library was compiled. In order to be portable, applications should almost always use the <CODE>NATIVE </CODE>designation to describe data values in memory. +<em><code>NATIVE</code> datatypes.</em> Although it is possible to describe nearly any kind of atomic datatype, most applications will use predefined datatypes that are supported by their compiler. In HDF5 these are called <i>native</i> datatypes. <CODE>NATIVE</CODE> datatypes are C-like datatypes that are generally supported by the hardware of the machine on which the library was compiled. In order to be portable, applications should almost always use the <CODE>NATIVE </CODE>designation to describe data values in memory. <P>The <CODE>NATIVE</CODE> architecture has base names which do not follow the same rules as the others. Instead, native type names are similar to the C type names. The following figure shows several examples. <p> <center> -<b>Examples of Native Data Types and Corresponding C Types</b><br> +<b>Examples of Native Datatypes and Corresponding C Types</b><br> <TABLE BORDER CELLSPACING=1 CELLPADDING=7 WIDTH=462> <TR><TD WIDTH="49%" VALIGN="TOP"> <B><P ALIGN="CENTER">Example</B></TD> @@ -336,7 +388,7 @@ Atomic datatypes can also be system-specific, or <I><CODE>NATIVE</CODE></I>, and <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. +<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 datatype 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 <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.) @@ -363,10 +415,87 @@ See <A HREF="Datatypes.html"><I>Datatypes</I></A></font><FONT FACE="Times"> in t 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. +<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 datatype. <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 <A HREF="Attributes.html"><I>Attributes</I></A></font><FONT FACE="Times"> in the<I> HDF User’s Guide</I> for further information. +</FONT> + +<H3><A NAME="Intro-FileTech">The File as Written to Media</A></H3> + + <p>For those who are interested, this section takes a look at + the low-level elements of the file as the file is written to disk + (or other storage media) and the relation of those low-level + elements to the higher level elements with which users typically + are more familiar. The HDF5 API generally exposes only the + high-level elements to the user; the low-level elements are + often hidden. + The rest of this <cite>Introduction</cite> does not assume + an understanding of this material. + + <P>The format of an HDF5 file on disk encompasses several + key ideas of the HDF4 and AIO file formats as well as + addressing some shortcomings therein. The new format is + more self-describing than the HDF4 format and is more + uniformly applied to data objects in the file. + + <table align=left width=100> + <tr><td align=center> + <hr> + <img src="FF-IH_FileGroup.gif" alt="HDF5 Groups" hspace=15 vspace=15> + </td><td> </td></tr><tr><td align=center> + <strong>Figure 1:</strong> Relationships among the + HDF5 root group, other groups, and objects + <hr> + </td><td> </td></tr> + </table> + + + <P>An HDF5 file appears to the user as a directed graph. + The nodes of this graph are the higher-level HDF5 objects + that are exposed by the HDF5 APIs: + + <ul> + <li>Groups + <li>Datasets + <li>Datatypes + <li>Dataspaces + </ul> + + <P>At the lowest level, as information is actually written to the disk, + an HDF5 file is made up of the following objects: + <ul> + <li>A boot block + <li>B-tree nodes (containing either symbol nodes or raw data chunks) + <li>Object headers + + <table align=right width=95> + <tr><td> </td><td align=center> + <hr> + <img src="FF-IH_FileObject.gif" alt="HDF5 Objects" hspace=15 vspace=15> + </td></tr><tr><td> </td><td align=center> + <strong>Figure 2:</strong> HDF5 objects -- datasets, datatypes, or dataspaces + <hr> + </td></tr> + </table> + + <li>Collections + <li>Local heaps + <li>Free space + </ul> + + The HDF5 library uses these lower-level objects to represent the + higher-level objects that are then presented to the user or + to applications through the APIs. + For instance, a group is an object header that contains a message that + points to a local heap and to a B-tree which points to symbol nodes. + A dataset is an object header that contains messages that describe + datatype, space, layout, filters, external files, fill value, etc + with the layout message pointing to either a raw data chunk or to a + B-tree that points to raw data chunks. + + <P>See the <A HREF="H5.format.html"><cite>HDF5 File Format + Specification</cite></A><FONT FACE="Times"> for further information. <p align=right><font size=-1><a href="#Intro-TOC">(Return to TOC)</a></font> <hr> @@ -381,7 +510,7 @@ Example: <CODE>H5Fopen</CODE>, which opens an HDF5 file. <B><LI>H5G</B>: <B>G</B>roup functions, for creating and operating on groups of objects. <BR> Example: <CODE>H5Gset</CODE><FONT FACE="Courier">,</FONT>which sets the working group to the specified group. <B><LI>H5T: </B>Data<B>T</B>ype functions, for creating and operating on simple and compound datatypes to be used as the elements in data arrays.<B><BR> -</B>Example: <CODE>H5Tcopy</CODE><FONT FACE="Courier">,</FONT>which creates a copy of an existing data type. +</B>Example: <CODE>H5Tcopy</CODE><FONT FACE="Courier">,</FONT>which creates a copy of an existing datatype. <B><LI>H5S: </B>Data<B>S</B>pace functions, which create and manipulate the dataspace in which the elements of a data array are stored.<BR> Example: <CODE>H5Screate_simple</CODE>, which creates simple dataspaces. <B><LI>H5D: D</B>ataset functions, which manipulate the data within datasets and determine how the data is to be stored in the file. <BR> @@ -419,7 +548,7 @@ Example: <CODE>H5Iget_type</CODE>, which retrieves the type of an object.</UL> <LI>Work with attributes. </UL> -<H4><A NAME="Intro-PMCreateFile">How to create an HDF5 file</A></H4> +<h3><A NAME="Intro-PMCreateFile">How to create an HDF5 file</A></h3> <P>This programming model shows how to create a file and also how to close the file. <OL> @@ -441,7 +570,7 @@ status = H5Fclose(file); </PRE> </CODE><DL> <DT> </DT> </DL> -<H4><A NAME="Intro-PMComponents">How to create and initialize the essential components of a dataset for writing to a file</A></H4> +<h3><A NAME="Intro-PMComponents">How to create and initialize the essential components of a dataset for writing to a file</A></h3> <P>Recall that datatypes and dimensionality (dataspace) are independent objects, which are created separately from any dataset that they might be attached to. Because of this the creation of a dataset requires, at a minimum, separate definitions of datatype, dimensionality, and dataset. Hence, to create a dataset the following steps need to be taken: <ol> <FONT FACE="Times"><LI VALUE=1>Create and initialize a dataspace for the dataset to be written. @@ -472,12 +601,12 @@ status = H5Tset_order(datatype, H5T_ORDER_LE); * 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> +</CODE><h3><A NAME="Intro-PMDiscard">How to discard objects when they are no longer needed</A></h3> <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. </FONT><CODE><P>H5Tclose(datatype); <P>H5Dclose(dataset); <P>H5Sclose(dataspace); -</CODE><H4><A NAME="Intro-PMWriteNew">How to write a dataset to a new file</A></H4> +</CODE><h3><A NAME="Intro-PMWriteNew">How to write a dataset to a new file</A></h3> <FONT FACE="Times"><P>Having defined the datatype, dataset, and dataspace parameters, you write out the data with a call to </FONT><CODE>H5Dwrite</CODE><FONT FACE="Courier">. </FONT><CODE><PRE>/* * Write the data to the dataset using default transfer @@ -488,7 +617,7 @@ status = H5Dwrite(dataset, H5T_NATIVE_INT, H5S_ALL, H5S_ALL, </CODE><FONT FACE="Times"><P>The third and fourth parameters of </FONT><CODE>H5Dwrite</CODE><FONT FACE="Times"> in the example describe the dataspaces in memory and in the file, respectively. They are set to the value </FONT><CODE>H5S_ALL</CODE><FONT FACE="Times"> to indicate that an entire dataset is to be written. In a later section we look at how we would access a portion of a dataset. </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><h3><A NAME="Intro-PMGetInfo">Getting information about a dataset</A></h3> <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 @@ -508,7 +637,7 @@ dataspace = H5Dget_space(dataset); /* dataspace identifier */ 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> +</CODE><h3><A NAME="Intro-PMRdWrPortion">Reading and writing a portion of a dataset</A></h3> <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> @@ -1746,7 +1875,7 @@ the previous selection example. -</FONT><H4><A NAME="Intro-PMCreateCompound">Creating compound datatypes</A></H4> +</FONT><h3><A NAME="Intro-PMCreateCompound">Creating compound datatypes</A></h3> <B><P>Properties of compound datatypes. </B>A compound datatype is similar to a struct in C or a common block in Fortran. It is a collection of one or more atomic types or small arrays of such types. To create and use of a compound datatype you need to refer to various <i>properties</i> of the data compound datatype: <UL> @@ -1755,17 +1884,17 @@ the previous selection example. <LI>It consists of zero or more <i>members</i> (defined in any order) with unique names and which occupy non-overlapping regions within the datum. <LI>Each member has its own <i>datatype</i>. <LI>Each member is referenced by an <i>index number</i> between zero and N-1, where N is the number of members in the compound datatype. -<LI>Each member has a <i>name</i> which is unique among its siblings in a compound data type. +<LI>Each member has a <i>name</i> which is unique among its siblings in a compound datatype. <LI>Each member has a fixed <i>byte offset</i>, which is the first byte (smallest byte address) of that member in a compound datatype. <LI>Each member can be a small array of up to four dimensions.</UL> -<FONT FACE="Times"><P>Properties of members of a compound data type are defined when the member is added to the compound type and cannot be subsequently modified. -<B><P>Defining compound datatypes. </B>Compound datatypes must be built out of other datatypes. First, one creates an empty compound data type and specifies its total size. Then members are added to the compound data type in any order. -<I><P>Member names. </I>Each member must have a descriptive name, which is the key used to uniquely identify the member within the compound data type. A member name in an HDF5 data type does not necessarily have to be the same as the name of the corresponding member in the C struct in memory, although this is often the case. Nor does one need to define all members of the C struct in the HDF5 compound data type (or vice versa). +<FONT FACE="Times"><P>Properties of members of a compound datatype are defined when the member is added to the compound type and cannot be subsequently modified. +<B><P>Defining compound datatypes. </B>Compound datatypes must be built out of other datatypes. First, one creates an empty compound datatype and specifies its total size. Then members are added to the compound datatype in any order. +<I><P>Member names. </I>Each member must have a descriptive name, which is the key used to uniquely identify the member within the compound datatype. A member name in an HDF5 datatype does not necessarily have to be the same as the name of the corresponding member in the C struct in memory, although this is often the case. Nor does one need to define all members of the C struct in the HDF5 compound datatype (or vice versa). <I><P>Offsets. </I>Usually a C struct will be defined to hold a data point in memory, and the offsets of the members in memory will be the offsets of the struct members from the beginning of an instance of the struct. The library defines the macro to compute the offset of a member within a struct: </FONT><CODE><br> HOFFSET(s,m)<FONT SIZE=5> </FONT></CODE> <br><FONT FACE="Times">This macro computes the offset of member </FONT><FONT FACE="Courier"><EM>m</EM> </FONT><FONT FACE="Times">within a struct variable <EM>s</EM>. -<P>Here is an example in which a compound data type is created to describe complex numbers whose type is defined by the </FONT><CODE>complex_t</CODE><FONT FACE="Times" SIZE=2> </FONT><FONT FACE="Times">struct. +<P>Here is an example in which a compound datatype is created to describe complex numbers whose type is defined by the </FONT><CODE>complex_t</CODE><FONT FACE="Times" SIZE=2> </FONT><FONT FACE="Times">struct. </FONT><CODE><PRE>typedef struct { double re; /*real part */ double im; /*imaginary part */ @@ -1777,8 +1906,8 @@ H5Tinsert (complex_id, "real", HOFFSET(tmp,re), H5T_NATIVE_DOUBLE); H5Tinsert (complex_id, "imaginary", HOFFSET(tmp,im), H5T_NATIVE_DOUBLE);</PRE> -</CODE><P><A HREF="#Compound">Example 4</A><FONT FACE="Times"> shows how to create a compound data type, write an array that has the compound data type to the file, and read back subsets of the members. -</FONT><H4><A NAME="Intro-PMCreateExtendible">Creating and writing extendible datasets</A></H4> +</CODE><P><A HREF="#Compound">Example 4</A><FONT FACE="Times"> shows how to create a compound datatype, write an array that has the compound datatype to the file, and read back subsets of the members. +</FONT><h3><A NAME="Intro-PMCreateExtendible">Creating and writing extendible and chunked datasets</A></h3> <FONT FACE="Times"><P>An <I>extendible</I> dataset is one whose dimensions can grow. In HDF5, it is possible to define a dataset to have certain initial dimensions, then later to increase the size of any of the initial dimensions. <P>For example, you can create and store the following 3x3 HDF5 dataset: </FONT><PRE> 1 1 1 @@ -1854,7 +1983,7 @@ status = H5Dextend (dataset, size);</PRE> <FONT FACE="Courier" SIZE=2><P> </FONT><P><A HREF="#CreateExtendWrite">Example 5</A> shows how to create a 3x3 extendible dataset, write the dataset, extend the dataset to 10x3, write the dataset again, extend it again to 10x5, write the dataset again. <P><A HREF="#ReadExtended">Example 6</A> shows how to read the data written by Example 5. -<H4><A NAME="Intro-PMWorkGroups">Working with groups in a file</A></H4> +<h3><A NAME="Intro-PMWorkGroups">Working with groups in a file</A></h3> <P>Groups provide a mechanism for organizing meaningful and extendible sets of datasets within an HDF5 file. The H5G API contains routines for working with groups. <B><P>Creating a group. </B>To create a group, use <CODE>H5Gcreate</CODE>. For example, the following code @@ -1979,7 +2108,7 @@ 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> +<h3><A NAME="Intro-PMWorkAttributes">Working with attributes</A></h3> <P>Think of an attribute as a small datasets that is attached to a normal dataset or group. The H5A API contains routines for working with attributes. Since attributes share many of the characteristics of datasets, the programming model for working with attributes is analogous in many ways to the model for working with datasets. The primary differences are that an attribute must be attached to a dataset or a group, and subsetting operations cannot be performed on attributes. <B><P>To create an attribute </B>belonging to a particular dataset or group<B>, </B>first create a dataspace for the attribute with the call to <CODE>H5Screate</CODE>, then create the attribute using <CODE>H5Acreate</CODE>. For example, the following code creates an attribute called <CODE> Integer_attribute </CODE>that is a member of a dataset whose identifier is <CODE>dataset</CODE>. The attribute identifier is <CODE>attr2</CODE>.<CODE> H5Awrite</CODE> then sets the value of the attribute of that of the integer variable <CODE>point</code>. <code>H5Aclose</code> <FONT FACE="Times">then releases the attribute identifier. </CODE> @@ -2021,7 +2150,7 @@ ret = H5Aread(attr, H5T_NATIVE_INT, &point_out); printf("The value of the attribute \"Integer attribute\" is %d \n", point_out); ret = H5Aclose(attr); </pre> -</FONT><B><P>Reading an attribute whose characteristics are not known. </B>It may be necessary to query a<FONT FACE="Times"> file to obtain information about an attribute, namely its name, data type, rank and dimensions. The following code opens an attribute by its index value using </FONT><CODE>H5Aopen_index</CODE><FONT FACE="Times">, then reads in information about its datatype. +</FONT><B><P>Reading an attribute whose characteristics are not known. </B>It may be necessary to query a<FONT FACE="Times"> file to obtain information about an attribute, namely its name, datatype, rank and dimensions. The following code opens an attribute by its index value using </FONT><CODE>H5Aopen_index</CODE><FONT FACE="Times">, then reads in information about its datatype. </FONT> <pre> /* @@ -2034,14 +2163,893 @@ ret = H5Aread(attr, atype, string_out); printf("The value of the attribute with the index 2 is %s \n", string_out); </pre> <code> -</CODE><P>In practice, if the characteristics of attributes are not know, the code involved in accessing and processing the attribute can be quite complex. For this reason, HDF5 includes a function called <CODE>H5Aiterate</CODE>, which applies a user-supplied function to each of a set of attributes. The user-supplied function can contain the code that interprets, accesses and processes each attribute. +</CODE><P>In practice, if the characteristics of attributes are not known, +the code involved in accessing and processing the attribute can be quite +complex. For this reason, HDF5 includes a function called +<CODE>H5Aiterate</CODE>, which applies a user-supplied function to each +of a set of attributes. The user-supplied function can contain the code +that interprets, accesses and processes each attribute. <p> <a href="#ReadWriteAttributes">Example 8</a> <A NAME="_Toc429885323">illustrates the use of the <code>H5Aiterate</code> function, as well as the other attribute examples described above.</A> +<h3><A NAME="Intro-PMWorkRefObjects">Working with references to objects</A></h3> + +In HDF5, objects (i.e. groups, datasets, and named datatypes) are usually +accessed by name. This access method was discussed in previous sections. +There is another way to access stored objects -- by reference. +<P> +An object reference is based on the relative file address of the object header +in the file and is constant for the life of the object. Once a reference to +an object is created and stored in a dataset in the file, it can be used +to dereference the object it points to. References are handy for creating +a file index or for grouping related objects by storing references to them in +one dataset. +<P> + +<h5>Creating and Storing References to Objects</h5> +The following steps are involved in creating and storing file references +to objects: +<OL> +<LI> Create the objects or open them if they already exist in the file. +<LI> Create a dataset to store the objects' references. +<LI> Create and store references to the objects in a buffer. +<LI> Write a buffer with the references to the dataset. +</OL> + + +<h5> Programming Example</h5> +<b>Description:</b> +The example below [also <a href="#CreateWriteRefObj">Example 9</a>] +creates a group and two datasets and a named datatype in the group. +References to these four objects are stored in the dataset in the +root group. + +<PRE> + +#include <hdf5.h> + +#define FILE1 "trefer1.h5" + +/* 1-D dataset with fixed dimensions */ +#define SPACE1_NAME "Space1" +#define SPACE1_RANK 1 +#define SPACE1_DIM1 4 + +/* 2-D dataset with fixed dimensions */ +#define SPACE2_NAME "Space2" +#define SPACE2_RANK 2 +#define SPACE2_DIM1 10 +#define SPACE2_DIM2 10 + +int +main(void) { + hid_t fid1; /* HDF5 File IDs */ + hid_t dataset; /* Dataset ID */ + hid_t group; /* Group ID */ + hid_t sid1; /* Dataspace ID */ + hid_t tid1; /* Datatype ID */ + hsize_t dims1[] = {SPACE1_DIM1}; + hobj_ref_t *wbuf; /* buffer to write to disk */ + int *tu32; /* Temporary pointer to int data */ + int i; /* counting variables */ + const char *write_comment="Foo!"; /* Comments for group */ + herr_t ret; /* Generic return value */ + +/* Compound datatype */ +typedef struct s1_t { + unsigned int a; + unsigned int b; + float c; +} s1_t; + + /* Allocate write buffers */ + wbuf=(hobj_ref_t *)malloc(sizeof(hobj_ref_t)*SPACE1_DIM1); + tu32=malloc(sizeof(int)*SPACE1_DIM1); + + /* Create file */ + fid1 = H5Fcreate(FILE1, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT); + + /* Create dataspace for datasets */ + sid1 = H5Screate_simple(SPACE1_RANK, dims1, NULL); + + /* Create a group */ + group=H5Gcreate(fid1,"Group1",-1); + + /* Set group's comment */ + ret=H5Gset_comment(group,".",write_comment); + + /* Create a dataset (inside Group1) */ + dataset=H5Dcreate(group,"Dataset1",H5T_STD_U32LE,sid1,H5P_DEFAULT); + + for(i=0; i < SPACE1_DIM1; i++) + tu32[i] = i*3; + + /* Write selection to disk */ + ret=H5Dwrite(dataset,H5T_NATIVE_INT,H5S_ALL,H5S_ALL,H5P_DEFAULT,tu32); + + /* Close Dataset */ + ret = H5Dclose(dataset); + + /* Create another dataset (inside Group1) */ + dataset=H5Dcreate(group,"Dataset2",H5T_NATIVE_UCHAR,sid1,H5P_DEFAULT); + + /* Close Dataset */ + ret = H5Dclose(dataset); + + /* Create a datatype to refer to */ + tid1 = H5Tcreate (H5T_COMPOUND, sizeof(s1_t)); + + /* Insert fields */ + ret=H5Tinsert (tid1, "a", HOFFSET(s1_t,a), H5T_NATIVE_INT); + + ret=H5Tinsert (tid1, "b", HOFFSET(s1_t,b), H5T_NATIVE_INT); + + ret=H5Tinsert (tid1, "c", HOFFSET(s1_t,c), H5T_NATIVE_FLOAT); + + /* Save datatype for later */ + ret=H5Tcommit (group, "Datatype1", tid1); + + /* Close datatype */ + ret = H5Tclose(tid1); + + /* Close group */ + ret = H5Gclose(group); + + /* Create a dataset to store references */ + dataset=H5Dcreate(fid1,"Dataset3",H5T_STD_REF_OBJ,sid1,H5P_DEFAULT); + + /* Create reference to dataset */ + ret = H5Rcreate(&wbuf[0],fid1,"/Group1/Dataset1",H5R_OBJECT,-1); + + /* Create reference to dataset */ + ret = H5Rcreate(&wbuf[1],fid1,"/Group1/Dataset2",H5R_OBJECT,-1); + + /* Create reference to group */ + ret = H5Rcreate(&wbuf[2],fid1,"/Group1",H5R_OBJECT,-1); + + /* Create reference to named datatype */ + ret = H5Rcreate(&wbuf[3],fid1,"/Group1/Datatype1",H5R_OBJECT,-1); + + /* Write selection to disk */ + ret=H5Dwrite(dataset,H5T_STD_REF_OBJ,H5S_ALL,H5S_ALL,H5P_DEFAULT,wbuf); + + /* Close disk dataspace */ + ret = H5Sclose(sid1); + + /* Close Dataset */ + ret = H5Dclose(dataset); + + /* Close file */ + ret = H5Fclose(fid1); + free(wbuf); + free(tu32); + return 0; +} + +</PRE> + + +<b>Remarks:</b> + +<UL> +<LI> The following code, +<PRE> + dataset = H5Dcreate ( fid1,"Dataset3",H5T_STD_REF_OBJ,sid1,H5P_DEFAULT ); +</PRE> + creates a dataset to store references. Notice that the + <code>H5T_SDT_REF_OBJ</code> datatype is used to specify that + references to objects will be stored. + The datatype <code>H5T_STD_REF_DSETREG</code> is used to store the + dataset region references and is be discussed later. +<LI>The next few calls to the <code>H5Rcreate</code> function create + references to the objects and store them in the buffer <I>wbuf</I>. + The signature of the <code>H5Rcreate</code> function is: +<PRE> + herr_t H5Rcreate ( void* buf, hid_t loc_id, const char *name, + H5R_type_t ref_type, hid_t space_id ) +</PRE> +<UL> + <LI> The first argument specifies the buffer to store the reference. + <LI> The second and third arguments specify the name of the referenced + object. In the example, the file identifier <I>fid1</I> and + absolute name of the dataset <code>/Group1/Dataset1</code> + identify the dataset. One could also use the group identifier + of group <code>Group1</code> and the relative name of the dataset + <code>Dataset1</code> to create the same reference. + <LI> The fourth argument specifies the type of the reference. + The example uses references to the objects (<code>H5R_OBJECT</code>). + Another type of reference, reference to the dataset region + (<code>H5R_DATASET_REGION</code>), is discussed later. + <LI> The fifth argument specifies the space identifier. When references + to the objects are created, it should be set to <code>-1</code>. +</UL> +<LI>The <code>H5Dwrite</code> function writes a dataset with the + references to the file. Notice that the <code>H5T_SDT_REF_OBJ</code> + datatype is used to describe the dataset's memory datatype. +</UL> + +<b>File Contents:</b> +The contents of the <code>trefer1.h5</code> file created by this example +are as follows: +<PRE> + +HDF5 "trefer1.h5" { +GROUP "/" { + DATASET "Dataset3" { + DATATYPE { H5T_REFERENCE } + DATASPACE { SIMPLE ( 4 ) / ( 4 ) } + DATA { + DATASET 0:1696, DATASET 0:2152, GROUP 0:1320, DATATYPE 0:2268 + } + } + GROUP "Group1" { + DATASET "Dataset1" { + DATATYPE { H5T_STD_U32LE } + DATASPACE { SIMPLE ( 4 ) / ( 4 ) } + DATA { + 0, 3, 6, 9 + } + } + DATASET "Dataset2" { + DATATYPE { H5T_STD_U8LE } + DATASPACE { SIMPLE ( 4 ) / ( 4 ) } + DATA { + 0, 0, 0, 0 + } + } + DATATYPE "Datatype1" { + H5T_STD_I32BE "a"; + H5T_STD_I32BE "b"; + H5T_IEEE_F32BE "c"; + } + } +} +} + +</PRE> +Notice how the data in dataset <code>Dataset3</code> is described. +The two numbers with the colon in between represent a unique identifier +of the object. These numbers are constant for the life of the object. + + +<h5>Reading References and Accessing Objects Using References</h5> + +The following steps are involved: +<OL> +<LI> Open the dataset with the references and read them. + The <code>H5T_STD_REF_OBJ</code> datatype must be used to + describe the memory datatype. +<LI> Use the read reference to obtain the identifier of the object the + reference points to. +<LI> Open the dereferenced object and perform the desired operations. +<LI> Close all objects when the task is complete. +</OL> + +<h5>Programming Example</h5> + +<b>Description:</b> +The following example [also <a href="#ReadRefObj">Example 10</a>] +below opens and reads dataset <code>Dataset3</code> from +the file created previously. Then the program dereferences the references +to dataset <code>Dataset1</code>, the group and the named datatype, +and opens those objects. +The program reads and displays the dataset's data, the group's comment, and +the number of members of the compound datatype. + + +<PRE> + +#include <stdlib.h> +#include <hdf5.h> + +#define FILE1 "trefer1.h5" + +/* dataset with fixed dimensions */ +#define SPACE1_NAME "Space1" +#define SPACE1_RANK 1 +#define SPACE1_DIM1 4 + +int +main(void) +{ + hid_t fid1; /* HDF5 File IDs */ + hid_t dataset, /* Dataset ID */ + dset2; /* Dereferenced dataset ID */ + hid_t group; /* Group ID */ + hid_t sid1; /* Dataspace ID */ + hid_t tid1; /* Datatype ID */ + hobj_ref_t *rbuf; /* buffer to read from disk */ + int *tu32; /* temp. buffer read from disk */ + int i; /* counting variables */ + char read_comment[10]; + herr_t ret; /* Generic return value */ + + /* Allocate read buffers */ + rbuf = malloc(sizeof(hobj_ref_t)*SPACE1_DIM1); + tu32 = malloc(sizeof(int)*SPACE1_DIM1); + + /* Open the file */ + fid1 = H5Fopen(FILE1, H5F_ACC_RDWR, H5P_DEFAULT); + + /* Open the dataset */ + dataset=H5Dopen(fid1,"/Dataset3"); + + /* Read selection from disk */ + ret=H5Dread(dataset,H5T_STD_REF_OBJ,H5S_ALL,H5S_ALL,H5P_DEFAULT,rbuf); + + /* Open dataset object */ + dset2 = H5Rdereference(dataset,H5R_OBJECT,&rbuf[0]); + + /* Check information in referenced dataset */ + sid1 = H5Dget_space(dset2); + + ret=H5Sget_simple_extent_npoints(sid1); + + /* Read from disk */ + ret=H5Dread(dset2,H5T_NATIVE_INT,H5S_ALL,H5S_ALL,H5P_DEFAULT,tu32); + printf("Dataset data : \n"); + for (i=0; i < SPACE1_DIM1 ; i++) printf (" %d ", tu32[i]); + printf("\n"); + printf("\n"); + + /* Close dereferenced Dataset */ + ret = H5Dclose(dset2); + + /* Open group object */ + group = H5Rdereference(dataset,H5R_OBJECT,&rbuf[2]); + + /* Get group's comment */ + ret=H5Gget_comment(group,".",10,read_comment); + printf("Group comment is %s \n", read_comment); + printf(" \n"); + /* Close group */ + ret = H5Gclose(group); + + /* Open datatype object */ + tid1 = H5Rdereference(dataset,H5R_OBJECT,&rbuf[3]); + + /* Verify correct datatype */ + { + H5T_class_t tclass; + + tclass= H5Tget_class(tid1); + if ((tclass == H5T_COMPOUND)) + printf ("Number of compound datatype members is %d \n", H5Tget_nmembers(tid1)); + printf(" \n"); + } + + /* Close datatype */ + ret = H5Tclose(tid1); + + /* Close Dataset */ + ret = H5Dclose(dataset); + + /* Close file */ + ret = H5Fclose(fid1); + + /* Free memory buffers */ + free(rbuf); + free(tu32); + return 0; +} + +</PRE> + +The output of this program is as follows: + +<PRE> + +Dataset data : + 0 3 6 9 + +Group comment is Foo! + +Number of compound datatype members is 3 +</PRE> + + +<b>Remarks:</b> + +<UL> +<LI> The <code>H5Dread</code> function was used to read dataset + <code>Dataset3</code> containing the references to the objects. + The <code>H5T_STD_REF_OBJ</code> memory datatype was + used to read references to memory. +<LI> <code>H5Rdereference</code> obtains the object's identifier. + The signature of this function is: +<PRE> + hid_t H5Rdereference (hid_t datatset, H5R_type_t ref_type, void *ref) +</PRE> + <UL> + <LI> The first argument is an identifier of the dataset with the + references. + <LI> The second argument specifies the reference type. + <code>H5R_OBJECT</code> was used to specify a reference to an + object. Another type, used to specifiy a reference to a dataset + region and discussed later, is <code>H5R_DATASET_REGION</code>. + <LI> The third argument is a buffer to store the reference to be read. + <LI> The function returns an identifier of the object the reference + points to. In this simplified situation, the type that was + stored in the dataset is known. When the type of the object is + unknown, <code>H5Rget_object_type</code> should be used to + identify the type of object the reference points to. + </UL> +</UL> + + + +<h3><A NAME="Intro-PMWorkRefRegions">Working with references to dataset regions</A></h3> + +A dataset region reference points to the dataset selection by storing the +relative file address of the dataset header and the global heap offset of +the referenced selection. The selection referenced is located by retrieving +the coordinates of the areas in the selection from the global heap. This +internal mechanism of storing and retrieving dataset selections is transparent +to the user. A reference to the dataset selection (region) is constant for +the life of the dataset. + +<H5>Creating and Storing References to Dataset Regions</H5> +The following steps are involved in creating and storing references to +the dataset regions: +<OL> + +<LI> Create a dataset to store the dataset regions (selections). +<P> +<LI> Create selections in the dataset(s). Dataset(s) should already exist + in the file. +<P> +<LI> Create references to the selections and store them in a buffer. +<P> +<LI> Write references to the dataset regions in the file. +<P> +<LI> Close all objects. +</OL> + +<H5> Programming Example</H5> +<B>Description:</B> +The example below [also <a href="#CreateWriteRefReg">Example 11</a>] +creates a dataset in the file. Then it creates a dataset to store +references to the dataset regions (selections). +The first selection is a 6 x 6 hyperslab. +The second selection is a point selection in the same dataset. +References to both selections are created and stored in the buffer, +and then written to the dataset in the file. + +<PRE> + +#include <stdlib.h> +#include <hdf5.h> + +#define FILE2 "trefer2.h5" +#define SPACE1_NAME "Space1" +#define SPACE1_RANK 1 +#define SPACE1_DIM1 4 + +/* Dataset with fixed dimensions */ +#define SPACE2_NAME "Space2" +#define SPACE2_RANK 2 +#define SPACE2_DIM1 10 +#define SPACE2_DIM2 10 + +/* Element selection information */ +#define POINT1_NPOINTS 10 + +int +main(void) +{ + hid_t fid1; /* HDF5 File IDs */ + hid_t dset1, /* Dataset ID */ + dset2; /* Dereferenced dataset ID */ + hid_t sid1, /* Dataspace ID #1 */ + sid2; /* Dataspace ID #2 */ + hsize_t dims1[] = {SPACE1_DIM1}, + dims2[] = {SPACE2_DIM1, SPACE2_DIM2}; + hssize_t start[SPACE2_RANK]; /* Starting location of hyperslab */ + hsize_t stride[SPACE2_RANK]; /* Stride of hyperslab */ + hsize_t count[SPACE2_RANK]; /* Element count of hyperslab */ + hsize_t block[SPACE2_RANK]; /* Block size of hyperslab */ + hssize_t coord1[POINT1_NPOINTS][SPACE2_RANK]; + /* Coordinates for point selection */ + hdset_reg_ref_t *wbuf; /* buffer to write to disk */ + int *dwbuf; /* Buffer for writing numeric data to disk */ + int i; /* counting variables */ + herr_t ret; /* Generic return value */ + + + /* Allocate write & read buffers */ + wbuf=calloc(sizeof(hdset_reg_ref_t), SPACE1_DIM1); + dwbuf=malloc(sizeof(int)*SPACE2_DIM1*SPACE2_DIM2); + + /* Create file */ + fid1 = H5Fcreate(FILE2, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT); + + /* Create dataspace for datasets */ + sid2 = H5Screate_simple(SPACE2_RANK, dims2, NULL); + + /* Create a dataset */ + dset2=H5Dcreate(fid1,"Dataset2",H5T_STD_U8LE,sid2,H5P_DEFAULT); + + for(i=0; i < SPACE2_DIM1*SPACE2_DIM2; i++) + dwbuf[i]=i*3; + + /* Write selection to disk */ + ret=H5Dwrite(dset2,H5T_NATIVE_INT,H5S_ALL,H5S_ALL,H5P_DEFAULT,dwbuf); + + /* Close Dataset */ + ret = H5Dclose(dset2); + + /* Create dataspace for the reference dataset */ + sid1 = H5Screate_simple(SPACE1_RANK, dims1, NULL); + + /* Create a dataset */ + dset1=H5Dcreate(fid1,"Dataset1",H5T_STD_REF_DSETREG,sid1,H5P_DEFAULT); + + /* Create references */ + + /* Select 6x6 hyperslab for first reference */ + start[0]=2; start[1]=2; + stride[0]=1; stride[1]=1; + count[0]=6; count[1]=6; + block[0]=1; block[1]=1; + ret = H5Sselect_hyperslab(sid2,H5S_SELECT_SET,start,stride,count,block); + + /* Store first dataset region */ + ret = H5Rcreate(&wbuf[0],fid1,"/Dataset2",H5R_DATASET_REGION,sid2); + + /* Select sequence of ten points for second reference */ + coord1[0][0]=6; coord1[0][1]=9; + coord1[1][0]=2; coord1[1][1]=2; + coord1[2][0]=8; coord1[2][1]=4; + coord1[3][0]=1; coord1[3][1]=6; + coord1[4][0]=2; coord1[4][1]=8; + coord1[5][0]=3; coord1[5][1]=2; + coord1[6][0]=0; coord1[6][1]=4; + coord1[7][0]=9; coord1[7][1]=0; + coord1[8][0]=7; coord1[8][1]=1; + coord1[9][0]=3; coord1[9][1]=3; + ret = H5Sselect_elements(sid2,H5S_SELECT_SET,POINT1_NPOINTS,(const hssize_t **)coord1); + + /* Store second dataset region */ + ret = H5Rcreate(&wbuf[1],fid1,"/Dataset2",H5R_DATASET_REGION,sid2); + + /* Write selection to disk */ + ret=H5Dwrite(dset1,H5T_STD_REF_DSETREG,H5S_ALL,H5S_ALL,H5P_DEFAULT,wbuf); + + /* Close all objects */ + ret = H5Sclose(sid1); + ret = H5Dclose(dset1); + ret = H5Sclose(sid2); + + /* Close file */ + ret = H5Fclose(fid1); + + free(wbuf); + free(dwbuf); + return 0; +} + +</PRE> + + +<b>Remarks:</b> +<UL> +<LI> The code, +<PRE> + dset1=H5Dcreate(fid1,"Dataset1",H5T_STD_REF_DSETREG,sid1,H5P_DEFAULT); +</PRE> + creates a dataset to store references to the dataset(s) regions (selections). + Notice that the <code>H5T_STD_REF_DSETREG</code> datatype is used. + +<LI> This program uses hyperslab and point selections. The dataspace + handle <I>sid2</I> is used for the calls to <code>H5Sselect_hyperslab</code> + and <code>H5Sselect_elements</code>. The handle was created when dataset + <code><b>Dataset2</b></code> was created and it describes the dataset's + dataspace. It was not closed when the dataset was closed to decrease + the number of function calls used in the example. + In a real application program, one should open the dataset and determine + its dataspace using the <code>H5Dget_space</code> function. +<LI> <code>H5Rcreate</code> is used to create a dataset region reference + and store it in a buffer. The signature of the function is: +<PRE> + herr_t H5Rcreate(void *buf, hid_t loc_id, const char *name, + H5R_type_t ref_type, hid_t space_id) +</PRE> +<UL> + <LI> The first argument specifies the buffer to store the reference. + <LI> The second and third arguments specify the name of the referenced + dataset. In the example, the file identifier <I>fid1</I> and the + absolute name of the dataset <code><b>/Dataset2</b></code> were + used to identify the dataset. The reference to the region of this + dataset is stored in the buffer <I>buf</I>. + + <LI> The fourth argument specifies the type of the reference. Since + the example creates references to the dataset regions, the + <code>H5R_DATASET_REGION</code> datatype is used. + <LI> The fifth argument is a dataspace identifier of the referenced + dataset. +</UL> +</UL> + +<b>File Contents:</b> +The contents of the file <code>trefer2.h5</code> created by this program +are as follows: + +<PRE> +HDF5 "trefer2.h5" { +GROUP "/" { + DATASET "Dataset1" { + DATATYPE { H5T_REFERENCE } + DATASPACE { SIMPLE ( 4 ) / ( 4 ) } + DATA { + DATASET 0:744 {(2,2)-(7,7)}, DATASET 0:744 {(6,9), (2,2), (8,4), (1,6), + (2,8), (3,2), (0,4), (9,0), (7,1), (3,3)}, NULL, NULL + } + } + DATASET "Dataset2" { + DATATYPE { H5T_STD_U8LE } + DATASPACE { SIMPLE ( 10, 10 ) / ( 10, 10 ) } + DATA { + 0, 3, 6, 9, 12, 15, 18, 21, 24, 27, + 30, 33, 36, 39, 42, 45, 48, 51, 54, 57, + 60, 63, 66, 69, 72, 75, 78, 81, 84, 87, + 90, 93, 96, 99, 102, 105, 108, 111, 114, 117, + 120, 123, 126, 129, 132, 135, 138, 141, 144, 147, + 150, 153, 156, 159, 162, 165, 168, 171, 174, 177, + 180, 183, 186, 189, 192, 195, 198, 201, 204, 207, + 210, 213, 216, 219, 222, 225, 228, 231, 234, 237, + 240, 243, 246, 249, 252, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, 255, 255, 255, 255 + } + } +} +} +</PRE> +Notice how raw data of the dataset with the dataset regions is displayed. +Each element of the raw data consists of a reference to the dataset +(<code>DATASET number1:number2</code>) and its selected region. +If the selection is a hyperslab, the corner coordinates of the hyperslab +are displayed. +For the point selection, the coordinates of each point are displayed. +Since only two selections were stored, the third and fourth elements of the +dataset <code>Dataset1</code> are set to <code>NULL</code>. +This was done by the buffer inizialization in the program. + +<H5>Reading references to dataset regions</H5> + +The following steps are involved in reading references to dataset +regions and referenced dataset regions (selections). +<OL> +<LI> Open and read the dataset containing references to the dataset regions. + The datatype <code>H5T_STD_REF_DSETREG</code> must be used during + read operation. +<LI>Use <code>H5Rdereference</code> to obtain the dataset identifier + from the read dataset region reference. + <PRE> <B>OR</B> + </PRE> + Use <code>H5Rget_region</code> to obtain the dataspace identifier for + the dataset containing the selection from the read dataset region reference. +<LI> With the dataspace identifier, the H5S interface functions, + <code>H5Sget_select_</code>*, can be used to obtain information + about the selection. +<LI> Close all objects when they are no longer needed. +</OL> + +<H5>Programming Example</H5> + +<b>Description:</b> +The following example [also <a href="#ReadRefReg">Example 12</a>] +reads a dataset containing dataset region references. +It reads data from the dereferenced dataset and displays the number of +elements and raw data. Then it reads two selections: +a hyperslab selection and a point selection. The program queries a +number of points in the hyperslab and the coordinates and displays them. +Then it queries a number of selected points and their coordinates and +displays the information. + +<PRE> + +#include <stdlib.h> +#include <hdf5.h> + +#define FILE2 "trefer2.h5" +#define NPOINTS 10 + +/* 1-D dataset with fixed dimensions */ +#define SPACE1_NAME "Space1" +#define SPACE1_RANK 1 +#define SPACE1_DIM1 4 + +/* 2-D dataset with fixed dimensions */ +#define SPACE2_NAME "Space2" +#define SPACE2_RANK 2 +#define SPACE2_DIM1 10 +#define SPACE2_DIM2 10 + +int +main(void) +{ + hid_t fid1; /* HDF5 File IDs */ + hid_t dset1, /* Dataset ID */ + dset2; /* Dereferenced dataset ID */ + hid_t sid1, /* Dataspace ID #1 */ + sid2; /* Dataspace ID #2 */ + hsize_t * coords; /* Coordinate buffer */ + hsize_t low[SPACE2_RANK]; /* Selection bounds */ + hsize_t high[SPACE2_RANK]; /* Selection bounds */ + hdset_reg_ref_t *rbuf; /* buffer to to read disk */ + int *drbuf; /* Buffer for reading numeric data from disk */ + int i, j; /* counting variables */ + herr_t ret; /* Generic return value */ + + /* Output message about test being performed */ + + /* Allocate write & read buffers */ + rbuf=malloc(sizeof(hdset_reg_ref_t)*SPACE1_DIM1); + drbuf=calloc(sizeof(int),SPACE2_DIM1*SPACE2_DIM2); + + /* Open the file */ + fid1 = H5Fopen(FILE2, H5F_ACC_RDWR, H5P_DEFAULT); + + /* Open the dataset */ + dset1=H5Dopen(fid1,"/Dataset1"); + + /* Read selection from disk */ + ret=H5Dread(dset1,H5T_STD_REF_DSETREG,H5S_ALL,H5S_ALL,H5P_DEFAULT,rbuf); + + /* Try to open objects */ + dset2 = H5Rdereference(dset1,H5R_DATASET_REGION,&rbuf[0]); + + /* Check information in referenced dataset */ + sid1 = H5Dget_space(dset2); + + ret=H5Sget_simple_extent_npoints(sid1); + printf(" Number of elements in the dataset is : %d\n",ret); + + /* Read from disk */ + ret=H5Dread(dset2,H5T_NATIVE_INT,H5S_ALL,H5S_ALL,H5P_DEFAULT,drbuf); + + for(i=0; i < SPACE2_DIM1; i++) { + for (j=0; j < SPACE2_DIM2; j++) printf (" %d ", drbuf[i*SPACE2_DIM2+j]); + printf("\n"); } + + /* Get the hyperslab selection */ + sid2=H5Rget_region(dset1,H5R_DATASET_REGION,&rbuf[0]); + + /* Verify correct hyperslab selected */ + ret = H5Sget_select_npoints(sid2); + printf(" Number of elements in the hyperslab is : %d \n", ret); + ret = H5Sget_select_hyper_nblocks(sid2); + coords=malloc(ret*SPACE2_RANK*sizeof(hsize_t)*2); /* allocate space for the hyperslab blocks */ + ret = H5Sget_select_hyper_blocklist(sid2,0,ret,coords); + printf(" Hyperslab coordinates are : \n"); + printf (" ( %lu , %lu ) ( %lu , %lu ) \n", \ +(unsigned long)coords[0],(unsigned long)coords[1],(unsigned long)coords[2],(unsigned long)coords[3]); + free(coords); + ret = H5Sget_select_bounds(sid2,low,high); + + /* Close region space */ + ret = H5Sclose(sid2); + + /* Get the element selection */ + sid2=H5Rget_region(dset1,H5R_DATASET_REGION,&rbuf[1]); + + /* Verify correct elements selected */ + ret = H5Sget_select_elem_npoints(sid2); + printf(" Number of selected elements is : %d\n", ret); + + /* Allocate space for the element points */ + coords= malloc(ret*SPACE2_RANK*sizeof(hsize_t)); + ret = H5Sget_select_elem_pointlist(sid2,0,ret,coords); + printf(" Coordinates of selected elements are : \n"); + for (i=0; i < 2*NPOINTS; i=i+2) + printf(" ( %lu , %lu ) \n", (unsigned long)coords[i],(unsigned long)coords[i+1]); + + free(coords); + ret = H5Sget_select_bounds(sid2,low,high); + + /* Close region space */ + ret = H5Sclose(sid2); + + /* Close first space */ + ret = H5Sclose(sid1); + + /* Close dereferenced Dataset */ + ret = H5Dclose(dset2); + + /* Close Dataset */ + ret = H5Dclose(dset1); + + /* Close file */ + ret = H5Fclose(fid1); + + /* Free memory buffers */ + free(rbuf); + free(drbuf); + return 0; +} + +</PRE> + +<p> +The output of this program is : +<PRE> + + Number of elements in the dataset is : 100 + 0 3 6 9 12 15 18 21 24 27 + 30 33 36 39 42 45 48 51 54 57 + 60 63 66 69 72 75 78 81 84 87 + 90 93 96 99 102 105 108 111 114 117 + 120 123 126 129 132 135 138 141 144 147 + 150 153 156 159 162 165 168 171 174 177 + 180 183 186 189 192 195 198 201 204 207 + 210 213 216 219 222 225 228 231 234 237 + 240 243 246 249 252 255 255 255 255 255 + 255 255 255 255 255 255 255 255 255 255 + Number of elements in the hyperslab is : 36 + Hyperslab coordinates are : + ( 2 , 2 ) ( 7 , 7 ) + Number of selected elements is : 10 + Coordinates of selected elements are : + ( 6 , 9 ) + ( 2 , 2 ) + ( 8 , 4 ) + ( 1 , 6 ) + ( 2 , 8 ) + ( 3 , 2 ) + ( 0 , 4 ) + ( 9 , 0 ) + ( 7 , 1 ) + ( 3 , 3 ) + +</PRE> + +<b>Remarks:</b> +<UL> +<LI> The dataset with the region references was read by <code>H5Dread</code> + with the <code>H5T_STD_REF_DSETREG</code> datatype specified. +<LI> The read reference can be used to obtain the dataset identifier + with the following call: +<PRE> + dset2 = H5Rdereference (dset1,H5R_DATASET_REGION,&rbuf[0]); +</PRE> + or to obtain spacial information (dataspace and selection) with the call + to <code>H5Rget_region</code>: +<PRE> + sid2=H5Rget_region(dset1,H5R_DATASET_REGION,&rbuf[0]); +</PRE> + The reference to the dataset region has information for both the dataset + itself and its selection. In both functions: +<UL> + <LI> The first parameter is an identifier of the dataset with the + region references. + <LI> The second parameter specifies the type of reference stored. + In this example, a reference to the dataset region is stored. + <LI> The third parameter is a buffer containing the reference of the + specified type. +</UL> +<LI> This example introduces several <code>H5Sget_select</code>* + functions used to obtain information about selections: + +<UL> + <code>H5Sget_select_npoints:</code> returns the number of elements in + the hyperslab<BR> + <code>H5Sget_select_hyper_nblocks:</code> returns the number of blocks + in the hyperslab<BR> + <code>H5Sget_select_blocklist:</code> returns the "lower left" and + "upper right" coordinates of the blocks in the hyperslab selection<BR> + <code>H5Sget_select_bounds:</code> returns the coordinates of the + "minimal" block containing a hyperslab selection<BR> + <code>H5Sget_select_elem_npoints:</code> returns the number of points + in the element selection<BR> + <code>H5Sget_select_elem_points:</code> returns the coordinates of + the element selection +</UL> +</UL> <p align=right><font size=-1><a href="#Intro-TOC">(Return to TOC)</a></font> <hr> + <H2><A NAME="Intro-Examples">4. Example Codes</A></H2> @@ -2167,7 +3175,7 @@ main (void) hid_t file, dataset; /* handles */ hid_t datatype, dataspace; hid_t memspace; - H5T_class_t class; /* data type class */ + H5T_class_t class; /* datatype class */ H5T_order_t order; /* data order */ size_t size; /* * size of the data element @@ -2501,12 +3509,12 @@ int main (void) <H4><A NAME="Compound"><A NAME="_Toc429885327"></A>Example 4. Working with compound datatypes.</A></H4> -<P>This example shows how to create a compound data type, write an array which has the compound data type to the file, and read back subsets of fields. +<P>This example shows how to create a compound datatype, write an array which has the compound datatype to the file, and read back subsets of fields. <PRE> <!-- Insert Example 4, h5_compound.c, here. --> /* - * This example shows how to create a compound data type, - * write an array which has the compound data type to the file, + * This example shows how to create a compound datatype, + * write an array which has the compound datatype to the file, * and read back fields' subsets. */ @@ -2568,7 +3576,7 @@ main(void) file = H5Fcreate(FILE, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT); /* - * Create the memory data type. + * Create the memory datatype. */ s1_tid = H5Tcreate (H5T_COMPOUND, sizeof(s1_t)); H5Tinsert(s1_tid, "a_name", HOFFSET(s1_t, a), H5T_NATIVE_INT); @@ -2601,7 +3609,7 @@ main(void) dataset = H5Dopen(file, DATASETNAME); /* - * Create a data type for s2 + * Create a datatype for s2 */ s2_tid = H5Tcreate(H5T_COMPOUND, sizeof(s2_t)); @@ -2628,7 +3636,7 @@ main(void) printf("\n"); /* - * Create a data type for s3. + * Create a datatype for s3. */ s3_tid = H5Tcreate(H5T_COMPOUND, sizeof(float)); @@ -3470,6 +4478,503 @@ attr_info(hid_t loc_id, const char *name, void *opdata) </pre> +<H4><A NAME="CreateWriteRefObj">Example 9</A>. Creating and storing references to objects.</A></H4> +This example creates a group and two datasets and a named datatype +in the group. References to these four objects are stored in the dataset +in the root group. + +<PRE> + +#include <hdf5.h> + +#define FILE1 "trefer1.h5" + +/* 1-D dataset with fixed dimensions */ +#define SPACE1_NAME "Space1" +#define SPACE1_RANK 1 +#define SPACE1_DIM1 4 + +/* 2-D dataset with fixed dimensions */ +#define SPACE2_NAME "Space2" +#define SPACE2_RANK 2 +#define SPACE2_DIM1 10 +#define SPACE2_DIM2 10 + +int +main(void) { + hid_t fid1; /* HDF5 File IDs */ + hid_t dataset; /* Dataset ID */ + hid_t group; /* Group ID */ + hid_t sid1; /* Dataspace ID */ + hid_t tid1; /* Datatype ID */ + hsize_t dims1[] = {SPACE1_DIM1}; + hobj_ref_t *wbuf; /* buffer to write to disk */ + int *tu32; /* Temporary pointer to int data */ + int i; /* counting variables */ + const char *write_comment="Foo!"; /* Comments for group */ + herr_t ret; /* Generic return value */ + +/* Compound datatype */ +typedef struct s1_t { + unsigned int a; + unsigned int b; + float c; +} s1_t; + + /* Allocate write buffers */ + wbuf=(hobj_ref_t *)malloc(sizeof(hobj_ref_t)*SPACE1_DIM1); + tu32=malloc(sizeof(int)*SPACE1_DIM1); + + /* Create file */ + fid1 = H5Fcreate(FILE1, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT); + + /* Create dataspace for datasets */ + sid1 = H5Screate_simple(SPACE1_RANK, dims1, NULL); + + /* Create a group */ + group=H5Gcreate(fid1,"Group1",-1); + + /* Set group's comment */ + ret=H5Gset_comment(group,".",write_comment); + + /* Create a dataset (inside Group1) */ + dataset=H5Dcreate(group,"Dataset1",H5T_STD_U32LE,sid1,H5P_DEFAULT); + + for(i=0; i < SPACE1_DIM1; i++) + tu32[i] = i*3; + + /* Write selection to disk */ + ret=H5Dwrite(dataset,H5T_NATIVE_INT,H5S_ALL,H5S_ALL,H5P_DEFAULT,tu32); + + /* Close Dataset */ + ret = H5Dclose(dataset); + + /* Create another dataset (inside Group1) */ + dataset=H5Dcreate(group,"Dataset2",H5T_NATIVE_UCHAR,sid1,H5P_DEFAULT); + + /* Close Dataset */ + ret = H5Dclose(dataset); + + /* Create a datatype to refer to */ + tid1 = H5Tcreate (H5T_COMPOUND, sizeof(s1_t)); + + /* Insert fields */ + ret=H5Tinsert (tid1, "a", HOFFSET(s1_t,a), H5T_NATIVE_INT); + + ret=H5Tinsert (tid1, "b", HOFFSET(s1_t,b), H5T_NATIVE_INT); + + ret=H5Tinsert (tid1, "c", HOFFSET(s1_t,c), H5T_NATIVE_FLOAT); + + /* Save datatype for later */ + ret=H5Tcommit (group, "Datatype1", tid1); + + /* Close datatype */ + ret = H5Tclose(tid1); + + /* Close group */ + ret = H5Gclose(group); + + /* Create a dataset to store references */ + dataset=H5Dcreate(fid1,"Dataset3",H5T_STD_REF_OBJ,sid1,H5P_DEFAULT); + + /* Create reference to dataset */ + ret = H5Rcreate(&wbuf[0],fid1,"/Group1/Dataset1",H5R_OBJECT,-1); + + /* Create reference to dataset */ + ret = H5Rcreate(&wbuf[1],fid1,"/Group1/Dataset2",H5R_OBJECT,-1); + + /* Create reference to group */ + ret = H5Rcreate(&wbuf[2],fid1,"/Group1",H5R_OBJECT,-1); + + /* Create reference to named datatype */ + ret = H5Rcreate(&wbuf[3],fid1,"/Group1/Datatype1",H5R_OBJECT,-1); + + /* Write selection to disk */ + ret=H5Dwrite(dataset,H5T_STD_REF_OBJ,H5S_ALL,H5S_ALL,H5P_DEFAULT,wbuf); + + /* Close disk dataspace */ + ret = H5Sclose(sid1); + + /* Close Dataset */ + ret = H5Dclose(dataset); + + /* Close file */ + ret = H5Fclose(fid1); + free(wbuf); + free(tu32); + return 0; +} + +</PRE> + + + +<H4><A NAME="ReadRefObj">Example 10</A>. Reading references to objects.</A></H4> +This example opens and reads dataset <code>Dataset3</code> from +the file created in Example 9. Then the program dereferences the references +to dataset <code>Dataset1</code>, the group and the named datatype, +and opens those objects. +The program reads and displays the dataset's data, the group's comment, and +the number of members of the compound datatype. + + +<PRE> + +#include <stdlib.h> +#include <hdf5.h> + +#define FILE1 "trefer1.h5" + +/* dataset with fixed dimensions */ +#define SPACE1_NAME "Space1" +#define SPACE1_RANK 1 +#define SPACE1_DIM1 4 + +int +main(void) +{ + hid_t fid1; /* HDF5 File IDs */ + hid_t dataset, /* Dataset ID */ + dset2; /* Dereferenced dataset ID */ + hid_t group; /* Group ID */ + hid_t sid1; /* Dataspace ID */ + hid_t tid1; /* Datatype ID */ + hobj_ref_t *rbuf; /* buffer to read from disk */ + int *tu32; /* temp. buffer read from disk */ + int i; /* counting variables */ + char read_comment[10]; + herr_t ret; /* Generic return value */ + + /* Allocate read buffers */ + rbuf = malloc(sizeof(hobj_ref_t)*SPACE1_DIM1); + tu32 = malloc(sizeof(int)*SPACE1_DIM1); + + /* Open the file */ + fid1 = H5Fopen(FILE1, H5F_ACC_RDWR, H5P_DEFAULT); + + /* Open the dataset */ + dataset=H5Dopen(fid1,"/Dataset3"); + + /* Read selection from disk */ + ret=H5Dread(dataset,H5T_STD_REF_OBJ,H5S_ALL,H5S_ALL,H5P_DEFAULT,rbuf); + + /* Open dataset object */ + dset2 = H5Rdereference(dataset,H5R_OBJECT,&rbuf[0]); + + /* Check information in referenced dataset */ + sid1 = H5Dget_space(dset2); + + ret=H5Sget_simple_extent_npoints(sid1); + + /* Read from disk */ + ret=H5Dread(dset2,H5T_NATIVE_INT,H5S_ALL,H5S_ALL,H5P_DEFAULT,tu32); + printf("Dataset data : \n"); + for (i=0; i < SPACE1_DIM1 ; i++) printf (" %d ", tu32[i]); + printf("\n"); + printf("\n"); + + /* Close dereferenced Dataset */ + ret = H5Dclose(dset2); + + /* Open group object */ + group = H5Rdereference(dataset,H5R_OBJECT,&rbuf[2]); + + /* Get group's comment */ + ret=H5Gget_comment(group,".",10,read_comment); + printf("Group comment is %s \n", read_comment); + printf(" \n"); + /* Close group */ + ret = H5Gclose(group); + + /* Open datatype object */ + tid1 = H5Rdereference(dataset,H5R_OBJECT,&rbuf[3]); + + /* Verify correct datatype */ + { + H5T_class_t tclass; + + tclass= H5Tget_class(tid1); + if ((tclass == H5T_COMPOUND)) + printf ("Number of compound datatype members is %d \n", H5Tget_nmembers(tid1)); + printf(" \n"); + } + + /* Close datatype */ + ret = H5Tclose(tid1); + + /* Close Dataset */ + ret = H5Dclose(dataset); + + /* Close file */ + ret = H5Fclose(fid1); + + /* Free memory buffers */ + free(rbuf); + free(tu32); + return 0; +} + +</PRE> + + +<H4><A NAME="CreateWriteRefReg">Example 11</A>. Creating and writing a reference to a region.</A></H4> + +This example creates a dataset in the file. Then it creates a dataset +to store references to the dataset regions (selections). +The first selection is a 6 x 6 hyperslab. +The second selection is a point selection in the same dataset. +References to both selections are created and stored in the buffer, +and then written to the dataset in the file. + +<pre> +#include <stdlib.h> +#include <hdf5.h> + +#define FILE2 "trefer2.h5" +#define SPACE1_NAME "Space1" +#define SPACE1_RANK 1 +#define SPACE1_DIM1 4 + +/* Dataset with fixed dimensions */ +#define SPACE2_NAME "Space2" +#define SPACE2_RANK 2 +#define SPACE2_DIM1 10 +#define SPACE2_DIM2 10 + +/* Element selection information */ +#define POINT1_NPOINTS 10 + +int +main(void) +{ + hid_t fid1; /* HDF5 File IDs */ + hid_t dset1, /* Dataset ID */ + dset2; /* Dereferenced dataset ID */ + hid_t sid1, /* Dataspace ID #1 */ + sid2; /* Dataspace ID #2 */ + hsize_t dims1[] = {SPACE1_DIM1}, + dims2[] = {SPACE2_DIM1, SPACE2_DIM2}; + hssize_t start[SPACE2_RANK]; /* Starting location of hyperslab */ + hsize_t stride[SPACE2_RANK]; /* Stride of hyperslab */ + hsize_t count[SPACE2_RANK]; /* Element count of hyperslab */ + hsize_t block[SPACE2_RANK]; /* Block size of hyperslab */ + hssize_t coord1[POINT1_NPOINTS][SPACE2_RANK]; + /* Coordinates for point selection */ + hdset_reg_ref_t *wbuf; /* buffer to write to disk */ + int *dwbuf; /* Buffer for writing numeric data to disk */ + int i; /* counting variables */ + herr_t ret; /* Generic return value */ + + + /* Allocate write & read buffers */ + wbuf=calloc(sizeof(hdset_reg_ref_t), SPACE1_DIM1); + dwbuf=malloc(sizeof(int)*SPACE2_DIM1*SPACE2_DIM2); + + /* Create file */ + fid1 = H5Fcreate(FILE2, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT); + + /* Create dataspace for datasets */ + sid2 = H5Screate_simple(SPACE2_RANK, dims2, NULL); + + /* Create a dataset */ + dset2=H5Dcreate(fid1,"Dataset2",H5T_STD_U8LE,sid2,H5P_DEFAULT); + + for(i=0; i < SPACE2_DIM1*SPACE2_DIM2; i++) + dwbuf[i]=i*3; + + /* Write selection to disk */ + ret=H5Dwrite(dset2,H5T_NATIVE_INT,H5S_ALL,H5S_ALL,H5P_DEFAULT,dwbuf); + + /* Close Dataset */ + ret = H5Dclose(dset2); + + /* Create dataspace for the reference dataset */ + sid1 = H5Screate_simple(SPACE1_RANK, dims1, NULL); + + /* Create a dataset */ + dset1=H5Dcreate(fid1,"Dataset1",H5T_STD_REF_DSETREG,sid1,H5P_DEFAULT); + + /* Create references */ + + /* Select 6x6 hyperslab for first reference */ + start[0]=2; start[1]=2; + stride[0]=1; stride[1]=1; + count[0]=6; count[1]=6; + block[0]=1; block[1]=1; + ret = H5Sselect_hyperslab(sid2,H5S_SELECT_SET,start,stride,count,block); + + /* Store first dataset region */ + ret = H5Rcreate(&wbuf[0],fid1,"/Dataset2",H5R_DATASET_REGION,sid2); + + /* Select sequence of ten points for second reference */ + coord1[0][0]=6; coord1[0][1]=9; + coord1[1][0]=2; coord1[1][1]=2; + coord1[2][0]=8; coord1[2][1]=4; + coord1[3][0]=1; coord1[3][1]=6; + coord1[4][0]=2; coord1[4][1]=8; + coord1[5][0]=3; coord1[5][1]=2; + coord1[6][0]=0; coord1[6][1]=4; + coord1[7][0]=9; coord1[7][1]=0; + coord1[8][0]=7; coord1[8][1]=1; + coord1[9][0]=3; coord1[9][1]=3; + ret = H5Sselect_elements(sid2,H5S_SELECT_SET,POINT1_NPOINTS,(const hssize_t **)coord1); + + /* Store second dataset region */ + ret = H5Rcreate(&wbuf[1],fid1,"/Dataset2",H5R_DATASET_REGION,sid2); + + /* Write selection to disk */ + ret=H5Dwrite(dset1,H5T_STD_REF_DSETREG,H5S_ALL,H5S_ALL,H5P_DEFAULT,wbuf); + + /* Close all objects */ + ret = H5Sclose(sid1); + ret = H5Dclose(dset1); + ret = H5Sclose(sid2); + + /* Close file */ + ret = H5Fclose(fid1); + + free(wbuf); + free(dwbuf); + return 0; +} + +</pre> + + +<H4><A NAME="ReadRefReg">Example 12</A>. Reading a reference to a region.</A></H4> + +This example reads a dataset containing dataset region references. +It reads data from the dereferenced dataset and displays the number of +elements and raw data. Then it reads two selections: +a hyperslab selection and a point selection. The program queries a +number of points in the hyperslab and the coordinates and displays them. +Then it queries a number of selected points and their coordinates and +displays the information. + +<PRE> + +#include <stdlib.h> +#include <hdf5.h> + +#define FILE2 "trefer2.h5" +#define NPOINTS 10 + +/* 1-D dataset with fixed dimensions */ +#define SPACE1_NAME "Space1" +#define SPACE1_RANK 1 +#define SPACE1_DIM1 4 + +/* 2-D dataset with fixed dimensions */ +#define SPACE2_NAME "Space2" +#define SPACE2_RANK 2 +#define SPACE2_DIM1 10 +#define SPACE2_DIM2 10 + +int +main(void) +{ + hid_t fid1; /* HDF5 File IDs */ + hid_t dset1, /* Dataset ID */ + dset2; /* Dereferenced dataset ID */ + hid_t sid1, /* Dataspace ID #1 */ + sid2; /* Dataspace ID #2 */ + hsize_t * coords; /* Coordinate buffer */ + hsize_t low[SPACE2_RANK]; /* Selection bounds */ + hsize_t high[SPACE2_RANK]; /* Selection bounds */ + hdset_reg_ref_t *rbuf; /* buffer to to read disk */ + int *drbuf; /* Buffer for reading numeric data from disk */ + int i, j; /* counting variables */ + herr_t ret; /* Generic return value */ + + /* Output message about test being performed */ + + /* Allocate write & read buffers */ + rbuf=malloc(sizeof(hdset_reg_ref_t)*SPACE1_DIM1); + drbuf=calloc(sizeof(int),SPACE2_DIM1*SPACE2_DIM2); + + /* Open the file */ + fid1 = H5Fopen(FILE2, H5F_ACC_RDWR, H5P_DEFAULT); + + /* Open the dataset */ + dset1=H5Dopen(fid1,"/Dataset1"); + + /* Read selection from disk */ + ret=H5Dread(dset1,H5T_STD_REF_DSETREG,H5S_ALL,H5S_ALL,H5P_DEFAULT,rbuf); + + /* Try to open objects */ + dset2 = H5Rdereference(dset1,H5R_DATASET_REGION,&rbuf[0]); + + /* Check information in referenced dataset */ + sid1 = H5Dget_space(dset2); + + ret=H5Sget_simple_extent_npoints(sid1); + printf(" Number of elements in the dataset is : %d\n",ret); + + /* Read from disk */ + ret=H5Dread(dset2,H5T_NATIVE_INT,H5S_ALL,H5S_ALL,H5P_DEFAULT,drbuf); + + for(i=0; i < SPACE2_DIM1; i++) { + for (j=0; j < SPACE2_DIM2; j++) printf (" %d ", drbuf[i*SPACE2_DIM2+j]); + printf("\n"); } + + /* Get the hyperslab selection */ + sid2=H5Rget_region(dset1,H5R_DATASET_REGION,&rbuf[0]); + + /* Verify correct hyperslab selected */ + ret = H5Sget_select_npoints(sid2); + printf(" Number of elements in the hyperslab is : %d \n", ret); + ret = H5Sget_select_hyper_nblocks(sid2); + coords=malloc(ret*SPACE2_RANK*sizeof(hsize_t)*2); /* allocate space for the hyperslab blocks */ + ret = H5Sget_select_hyper_blocklist(sid2,0,ret,coords); + printf(" Hyperslab coordinates are : \n"); + printf (" ( %lu , %lu ) ( %lu , %lu ) \n", \ +(unsigned long)coords[0],(unsigned long)coords[1],(unsigned long)coords[2],(unsigned long)coords[3]); + free(coords); + ret = H5Sget_select_bounds(sid2,low,high); + + /* Close region space */ + ret = H5Sclose(sid2); + + /* Get the element selection */ + sid2=H5Rget_region(dset1,H5R_DATASET_REGION,&rbuf[1]); + + /* Verify correct elements selected */ + ret = H5Sget_select_elem_npoints(sid2); + printf(" Number of selected elements is : %d\n", ret); + + /* Allocate space for the element points */ + coords= malloc(ret*SPACE2_RANK*sizeof(hsize_t)); + ret = H5Sget_select_elem_pointlist(sid2,0,ret,coords); + printf(" Coordinates of selected elements are : \n"); + for (i=0; i < 2*NPOINTS; i=i+2) + printf(" ( %lu , %lu ) \n", (unsigned long)coords[i],(unsigned long)coords[i+1]); + + free(coords); + ret = H5Sget_select_bounds(sid2,low,high); + + /* Close region space */ + ret = H5Sclose(sid2); + + /* Close first space */ + ret = H5Sclose(sid1); + + /* Close dereferenced Dataset */ + ret = H5Dclose(dset2); + + /* Close Dataset */ + ret = H5Dclose(dset1); + + /* Close file */ + ret = H5Fclose(fid1); + + /* Free memory buffers */ + free(rbuf); + free(drbuf); + return 0; +} + +</PRE> + <P> @@ -3500,7 +5005,7 @@ Introduction to HDF5 <br> <tr><td align=left valign=top> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 30 October 1998 +Last modified: 16 October 1999 </td><td align=right valign=top> <a href="Copyright.html">Copyright</a> diff --git a/doc/html/H5.user.PrintGen.html b/doc/html/H5.user.PrintGen.html index be1a537..ca7d5e2 100644 --- a/doc/html/H5.user.PrintGen.html +++ b/doc/html/H5.user.PrintGen.html @@ -55,9 +55,7 @@ with a single print command as follows: </td><td></td><td valign=top>A guide to the <strong>H5D</strong> interface. </td></tr> - <tr><td valign=top><a href="Datatypes.html" target="PrintWin">Data Types</a> and - <br> - <a href="DatatypesEnum.html" target="PrintWin">Enumeration Data Types</a> + <tr><td valign=top><a href="Datatypes.html" target="PrintWin">Datatypes</a> </td><td></td><td valign=top>A guide to the <strong>H5T</strong> interface. </td></tr> @@ -90,6 +88,10 @@ with a single print command as follows: </td><td></td><td valign=top>A guide to the <strong>H5Z</strong> interface. </td></tr> + <tr><td valign=top><a href="Palettes.html" target="PrintWin">Palettes</a> + </td><td></td><td valign=top>A guide to the use of palettes + in HDF5. + </td></tr> <tr><td valign=top><a href="Caching.html" target="PrintWin">Caching</a> </td><td></td><td valign=top>A guide for meta and raw data caching. </td></tr> @@ -97,6 +99,10 @@ with a single print command as follows: </td><td></td><td valign=top>A guide to the issues and pitfalls of dataset chunking. </td></tr> + <tr><td valign=top><a href="MountingFiles.html" target="PrintWin">Mounting Files</a> + </td><td></td><td valign=top>A guide to mounting files containing + external HDF5 datasets. + </td></tr> <tr><td valign=top><a href="Debugging.html" target="PrintWin">Debugging</a> </td><td></td><td valign=top>A guide to debugging HDF5 API calls. </td></tr> @@ -127,7 +133,7 @@ with a single print command as follows: <tr><td align=left valign=top> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 1 June 1999 +Last modified: 22 July 1999 </table> diff --git a/doc/html/H5.user.PrintTpg.html b/doc/html/H5.user.PrintTpg.html index 1b018e0..c8b9536 100644 --- a/doc/html/H5.user.PrintTpg.html +++ b/doc/html/H5.user.PrintTpg.html @@ -15,7 +15,7 @@ <center> <font size=7> -A User's Guide for HDF5 +HDF5 User's Guide </font> <br><br><br> @@ -24,9 +24,9 @@ A User's Guide for HDF5 <br><br><br> <font size=6> -Release 1.0 +Release 1.2 <br> -January 1999 +October 1999 </font> <br><br><br><br> @@ -51,21 +51,25 @@ University of Illinois at Urbana-Champaign (UIUC) <strong>A Note to the Reader:</strong> The primary HDF5 user documents are the online HTML documents distributed with the HDF5 code and binaries and found on the HDF5 website. -Several users have expressed a desire for documents in an alternative format: +These PDF and PostScript versions are generated from the HTML to provide +the following capabilites: <ul> -<li>Some have requested a version that can be reasonably printed in a +<li>To provide a version that can be reasonably printed in a single print operation. -<li>Others have requested an easily searchable version. +<li>To provide an easily searchable version. </ul> -This PDF file has been created expressly to meet these needs. -<p> -The reader will note that each section of this document looks very much -as the corresponding HTML page would look in a web browser. That is not -accidental as the HTML version remains the HDF5 development team's primary -documentation vehicle. +In this package, you will find four PDF and PostScript documents: +<ul> +<li><cite>Introduction to HDF5</cite> +<li><cite>A User's Guide for HDF5</cite> +<li><cite>HDF5 Reference Manual</cite> +<li>All three of the above documents concatenated into a single file +</ul> +Note that these versions were created in response to user feedback; +the HDF Group is eager to hear from you so as to improve the delivered +product. </blockquote> - <br><br> <hr> diff --git a/doc/html/H5.user.html b/doc/html/H5.user.html index f15e164..f6970be 100644 --- a/doc/html/H5.user.html +++ b/doc/html/H5.user.html @@ -21,51 +21,8 @@ </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> @@ -88,7 +45,7 @@ And in this document, the </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> + <tr><td valign=top><a href="Datatypes.html">Datatypes</a> </td><td></td><td valign=top>A guide to the <strong>H5T</strong> interface. </td></tr> @@ -121,6 +78,10 @@ And in this document, the </td><td></td><td valign=top>A guide to the <strong>H5Z</strong> interface. </td></tr> + <tr><td valign=top><a href="Palettes.html">Palettes</a> + </td><td></td><td valign=top>A guide to the use of palettes + in HDF5. + </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> @@ -128,6 +89,14 @@ And in this document, the </td><td></td><td valign=top>A guide to the issues and pitfalls of dataset chunking. </td></tr> + <tr><td valign=top><a href="MountingFiles.html">Mounting Files</a> + </td><td></td><td valign=top>A guide to mounting files containing + external HDF5 datasets. + </td></tr> + <tr><td valign=top><a href="Performance.html">Performance</a> + </td><td></td><td valign=top>A guide to performance issues and + analysis tools. + </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> @@ -136,7 +105,7 @@ And in this document, the <br> <a href="Environment.html">Configuration Parameters</a> </td><td></td><td valign=top>A list of HDF5 environment variables - and <br> configuration parameters. + and configuration <br> 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. @@ -190,67 +159,13 @@ And in this document, the </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> - <address><a href="mailto:koziol@ncsa.uiuc.edu">Quincey Koziol</a></address> - <address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address> ---> -<!-- hhmts start --> -<!-- -Last modified: Wed Aug 19 15:29:11 PDT 1998 ---> -<!-- hhmts end --> <hr> <address> @@ -258,7 +173,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: 30 October 1998 +Last modified: 22 July 1999 </td><td align=right valign=top> <a href="Copyright.html">Copyright</a> diff --git a/doc/html/Makefile.in b/doc/html/Makefile.in index cfb7b14..c04597c 100644 --- a/doc/html/Makefile.in +++ b/doc/html/Makefile.in @@ -7,33 +7,45 @@ top_srcdir=@top_srcdir@ top_builddir=../.. srcdir=@srcdir@ +VPATH=.:@srcdir@ @COMMENCE@ # Subdirectories in build-order (not including `examples') SUBDIRS=Tutor DOCDIR=$(docdir)/hdf5 +TRACE=perl $(top_srcdir)/bin/trace + +# Add `-I.' to the C preprocessor flags. +CPPFLAGS=-I. -I@srcdir@ @CPPFLAGS@ + +# Temporary files +MOSTLYCLEAN= + # Public doc files (to be installed)... -PUB_DOCS=Attributes.html Big.html Caching.html Chunking.html Chunk_f1.gif \ +PUB_DOCS= Attributes.html Big.html Caching.html Chunking.html Chunk_f1.gif \ Chunk_f2.gif Chunk_f3.gif Chunk_f4.gif Chunk_f5.gif Chunk_f6.gif \ Coding.html Copyright.html Datasets.html Dataspaces.html \ Datatypes.html ddl.html Debugging.html EnumMap.gif Environment.html \ - Errors.html Files.html Filters.html Glossary.html Groups.html \ - H5.api_map.html H5.format.html H5.intro.html H5.sample_code.html \ - H5.user.html H5.user.PrintGen.html H5.user.PrintTpg.html IH_map1.gif \ - IH_map2.gif IH_map3.gif IH_map4.gif IH_mapFoot.gif IH_mapHead.gif \ - IOPipe.html NCSAfooterlogo.gif Properties.html Ragged.html \ - References.html RM_H5.html RM_H5A.html RM_H5D.html RM_H5E.html \ - RM_H5F.html RM_H5Front.html RM_H5G.html RM_H5I.html RM_H5P.html \ - RM_H5R.html RM_H5RA.html RM_H5S.html RM_H5T.html RM_H5Z.html \ - Tools.html Version.html chunk1.gif compat.html dataset_p1.gif \ - dataset_p1.obj extern1.gif extern2.gif group_p1.gif group_p2.gif \ - group_p3.gif h5s.examples hdf2.jpg ph5design.html ph5example.c \ - ph5implement.txt pipe1.gif pipe2.gif pipe3.gif pipe4.gif pipe5.gif \ - index.html version.gif + Errors.html FF-IH_FileGroup.gif FF-IH_FileObject.gif Files.html \ + Filters.html FF-IH_FileGroup.gif FF-IH_FileObject.gif Glossary.html \ + Groups.html H5.api_map.html H5.format.html H5.intro.html \ + H5.sample_code.html H5.user.html H5.user.PrintGen.html \ + H5.user.PrintTpg.html IH_map1.gif IH_map2.gif IH_map3.gif IH_map4.gif \ + IH_mapFoot.gif IH_mapHead.gif IOPipe.html MountingFiles.html \ + NCSAfooterlogo.gif PaletteExample1.gif Palettes.fm.anc.gif \ + Palettes.html Performance.html Properties.html Ragged.html + References.html RM_H5.html \ + RM_H5A.html RM_H5D.html RM_H5E.html RM_H5F.html RM_H5Front.html \ + RM_H5G.html RM_H5I.html RM_H5P.html RM_H5R.html RM_H5RA.html \ + RM_H5S.html RM_H5T.html RM_H5Z.html Tools.html Version.html chunk1.gif \ + compat.html dataset_p1.gif dataset_p1.obj extern1.gif extern2.gif \ + group_p1.gif group_p2.gif group_p3.gif h5s.examples hdf2.jpg \ + ph5design.html ph5example.c ph5implement.txt pipe1.gif pipe2.gif \ + pipe3.gif pipe4.gif pipe5.gif index.html version.gif # Other doc files (not to be installed)... -PRIVATE_DOCS=Chunk_f1.obj Chunk_f2.obj Chunk_f6.obj CodeReview.html \ +PRIVATE_DOCS= Chunk_f1.obj Chunk_f2.obj Chunk_f6.obj CodeReview.html \ ExternalFiles.html MemoryManagement.html ObjectHeader.txt chunk1.obj \ extern1.obj extern2.obj group_p1.obj group_p2.obj group_p3.obj \ pipe1.obj pipe2.obj pipe3.obj pipe4.obj pipe5.obj heap.txt move.html \ diff --git a/doc/html/Properties.html b/doc/html/Properties.html index 174affc..e84fc6a 100644 --- a/doc/html/Properties.html +++ b/doc/html/Properties.html @@ -20,47 +20,31 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> Property Lists <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -146,70 +130,46 @@ And in this document, the </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> Property Lists <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> - <address><a href="mailto:koziol@ncsa.uiuc.edu">Quincey Koziol</a></address> ---> -<!-- Created: Tue Feb 10 17:06:58 PST 1998 --> -<!-- hhmts start --> -<!-- -Last modified: Tue Feb 10 17:26:41 PST 1998 ---> -<!-- hhmts end --> <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 30 October 1998 +<!-- Created: Tue Feb 10 17:06:58 PST 1998 --> +<!-- hhmts start --> +Last modified: 14 October 1999 +<!-- hhmts end --> </body> </html> diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index 27c96a3..6457994 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -162,11 +162,11 @@ and it users. <dt><strong>Parameters:</strong> <dl> <dt><em>unsigned *</em><code>majnum</code> - <dd>The major version of the library. + <dd>OUT: The major version of the library. <dt><em>unsigned *</em><code>minnum</code> - <dd>The minor version of the library. + <dd>OUT: The minor version of the library. <dt><em>unsigned *</em><code>relnum</code> - <dd>The release number of the library. + <dd>OUT: The release number of the library. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; @@ -187,22 +187,24 @@ and it users. <dt><strong>Description:</strong> <dd><code>H5check_version</code> verifies that the arguments match the version numbers compiled into the library. This function is intended - to be called from user to verify that the versions of header files - compiled into the application match the version of the HDF5 library. + to be called by the user to verify that the version of the header files + compiled into the application match the version of the HDF5 library being used. <p> Due to the risks of data corruption or segmentation faults, <code>H5check_version</code> causes the application to abort if the version numbers do not match. + <p> + If the version numbers of the library do not match + the version numbers in the header files being checked, the library calls the + standard C function <code>abort()</code>. <dt><strong>Parameters:</strong> <dl> - <dt><em>unsigned *</em><code>majnum</code> - <dd>The major version of the library. - <dt><em>unsigned *</em><code>minnum</code> - <dd>The minor version of the library. - <dt><em>unsigned *</em><code>relnum</code> - <dd>The release number of the library. - <dt><em>unsigned *</em><code>patnum</code> - <dd>The patch number of the library. + <dt><em>unsigned </em><code>majnum</code> + <dd>IN: The major version of the library. + <dt><em>unsigned </em><code>minnum</code> + <dd>IN: The minor version of the library. + <dt><em>unsigned </em><code>relnum</code> + <dd>IN: The release number of the library. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. diff --git a/doc/html/RM_H5A.html b/doc/html/RM_H5A.html index 0417752..e452644 100644 --- a/doc/html/RM_H5A.html +++ b/doc/html/RM_H5A.html @@ -51,6 +51,9 @@ H5A These functions create and manipulate attributes and information about attributes. +<p> +<strong>The C Interfaces:</strong> + <table border=0> <tr><td valign=top> <ul> @@ -77,6 +80,47 @@ and information about attributes. </table> <p> +<strong>The FORTRAN90 Interfaces:</strong> + +<br> +<font size=-1> +<i>In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. The links below go to the C function +descriptions, which serve as general descriptions for both. A button, +under <strong>Non-C API(s)</strong> at the end of the C function description, +opens an external browser window displaying the FORTRAN90-specific +information. You will probably want to adjust the size and location of +this external window so that both browser windows are visible and to +facilitate moving easily between them.</i> +</font> + +<table border=0> +<tr><td valign=top> +<ul> + <li><a href="#Annot-Create">h5acreate_f</a> + <li><a href="#Annot-Write">h5awrite_f</a> + <li><a href="#Annot-Read">h5aread_f</a> + <li><a href="#Annot-Close">h5aclose_f</a> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#Annot-GetName">h5aget_name_f</a> + <li><a href="#Annot-OpenName">h5aopen_name_f</a> + <li><a href="#Annot-OpenIdx">h5aopen_idx_f</a> + <li><a href="#Annot-GetSpace">h5aget_space_f</a> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#Annot-GetType">h5aget_type_f</a> + <li><a href="#Annot-NumAttrs">h5aget_num_attrs_f</a> + <!--<li><a href="#Annot-Iterate">h5aiterate_f</a>--> + <li><a href="#Annot-Delete">h5adelete_f</a> +</ul> +</td></tr> +</table> + + +<p> The Attribute interface, H5A, is primarily designed to easily allow small datasets to be attached to primary datasets as metadata information. Additional goals for the H5A interface include keeping storage requirement @@ -140,6 +184,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns an attribute identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5acreate_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -172,6 +223,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns attribute identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aopen_name_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -205,6 +263,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns attribute identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aopen_idx_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -243,6 +308,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5awrite_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -276,11 +348,18 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><em>hid_t</em> <code>mem_type_id</code> <dd>IN: Identifier of the attribute datatype (in memory). <dt><em>void *</em><code>buf</code> - <dd>IN: Buffer for data to be read. + <dd>OUT: Buffer for data to be read. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aread_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -304,6 +383,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns attribute dataspace identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aget_space_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -333,6 +419,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns a datatype identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aget_type_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -340,7 +433,7 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dl> <dt><strong>Name:</strong> <a name="Annot-GetName">H5Aget_name</a> <dt><strong>Signature:</strong> - <dd><em>hssize_t</em> <code>H5Aget_name</code>(<em>hid_t</em> <code>attr_id</code>, + <dd><em>ssize_t</em> <code>H5Aget_name</code>(<em>hid_t</em> <code>attr_id</code>, <em>size_t</em> <code>buf_size</code>, <em>char *</em><code>buf</code> ) @@ -367,6 +460,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dd>Returns the length of the attribute's name, which may be longer than <code>buf_size</code>, if successful. Otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aget_name_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -390,6 +490,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns the number of attributes if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aget_num_attrs_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -454,6 +561,14 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dd>If successful, returns the return value of the last operator if it was non-zero, or zero if all attributes were processed. Otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aiterate_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -484,6 +599,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5adelete_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -507,6 +629,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5a_FORTRAN.html#h5aclose_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -550,7 +679,7 @@ H5A <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 30 October 1998 +Last modified: 20 October 1999 </body> </html> diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index 849ec8d..63753c3 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -51,24 +51,76 @@ H5D These functions create and manipulate dataset objects, and set and retrieve their constant or persistent properties. +<p> +<strong>The C Interfaces:</strong> + <table border=0> <tr><td valign=top> <ul> <li><a href="#Dataset-Create">H5Dcreate</a> <li><a href="#Dataset-Open">H5Dopen</a> + <li><a href="#Dataset-Close">H5Dclose</a> <li><a href="#Dataset-GetSpace">H5Dget_space</a> + <li><a href="#Dataset-GetType">H5Dget_type</a> </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Dataset-GetType">H5Dget_type</a> <li><a href="#Dataset-GetCreatePlist">H5Dget_create_plist</a> - <li><a href="#Dataset-Read">H5Dread</a> + <li><a href="#Dataset-GetStorageSize">H5Dget_storage_size</a> + <li><a href="#Dataset-GetVLBuf">H5Dget_vlen_buf_size</a> + <li><a href="#Dataset-VLReclaim">H5Dvlen_reclaim</a> </ul> </td><td> </td><td valign=top> <ul> + <li><a href="#Dataset-Read">H5Dread</a> <li><a href="#Dataset-Write">H5Dwrite</a> + <li><a href="#Dataset-Iterate">H5Diterate</a> +<!-- + <li><a href="#Dataset-Debug">H5Ddebug</a> +--> <li><a href="#Dataset-Extend">H5Dextend</a> - <li><a href="#Dataset-Close">H5Dclose</a> +</ul> +</td></tr> +</table> + +<p> +<strong>The FORTRAN90 Interfaces:</strong> + +<br> +<font size=-1> +<i>In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. The links below go to the C function +descriptions, which serve as general descriptions for both. A button, +under <strong>Non-C API(s)</strong> at the end of the C function description, +opens an external browser window displaying the FORTRAN90-specific +information. You will probably want to adjust the size and location of +this external window so that both browser windows are visible and to +facilitate moving easily between them.</i> +</font> + +<table border=0> +<tr><td valign=top> +<ul> + <li><a href="#Dataset-Create">h5dcreate_f</a> + <li><a href="#Dataset-Open">h5dopen_f</a> + <li><a href="#Dataset-Close">h5dclose_f</a> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#Dataset-GetSpace">h5dget_space_f</a> + <li><a href="#Dataset-GetType">h5dget_type_f</a> + <li><a href="#Dataset-GetCreatePlist">h5dget_create_plist_f</a> +<!--<li><a href="#Dataset-GetStorageSize">h5dget_storage_size_f</a> --> +<!--<li><a href="#Dataset-GetVLBuf">h5dget_vlen_buf_size_f</a> --> +<!--<li><a href="#Dataset-VLReclaim">h5dvlen_reclaim_f</a> --> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#Dataset-Read">h5dread_f</a> + <li><a href="#Dataset-Write">h5dwrite_f</a> +<!--<li><a href="#Dataset-Iterate">h5diterate_f</a> --> +<!--<li><a href="#Dataset-Debug">h5ddebug_f</a> --> + <li><a href="#Dataset-Extend">h5dextend_f</a> </ul> </td></tr> </table> @@ -121,6 +173,13 @@ and set and retrieve their constant or persistent properties. <dt><strong>Returns:</strong> <dd>Returns a dataset identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5dcreate_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -148,6 +207,13 @@ and set and retrieve their constant or persistent properties. <dt><strong>Returns:</strong> <dd>Returns a dataset identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5dopen_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -172,6 +238,13 @@ and set and retrieve their constant or persistent properties. <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5dget_space_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -200,6 +273,13 @@ and set and retrieve their constant or persistent properties. <dt><strong>Returns:</strong> <dd>Returns a datatype identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5dget_type_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -225,6 +305,146 @@ and set and retrieve their constant or persistent properties. <dt><strong>Returns:</strong> <dd>Returns a dataset creation property list identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5dget_create_plist_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataset-GetStorageSize">H5Dget_storage_size</a> +<dt><strong>Signature:</strong> + <dd><em>hsize_t </em><code>H5Dget_storage_size</code>(<em>hid_t </em><code>dataset_id</code> + ) +<dt><strong>Purpose:</strong> + <dd>Returns the amount of storage required for a dataset. +<dt><strong>Description:</strong> + <dd><code>H5Dget_storage_size</code> returns the amount of storage + that is required for the specified dataset, <code>dataset_id</code>. + For chunked datasets, this is the number of allocated chunks times + the chunk size. + The return value may be zero if no data has been stored. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>dataset_id</code> + <dd>Identifier of the dataset to query. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns the amount of storage space allocated for the dataset, + not counting meta data; + otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5dget_storage_size" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataset-GetVLBuf">H5Dget_vlen_buf_size</a> + <i><b>(Not yet implemented.)</b></i> +<dt><strong>Signature:</strong> + <dd><em>herr_t </em><code>H5Dget_vlen_buf_size</code>(<em>hid_t </em><code>dataset_id</code>, + <em>hid_t</em> <code>type_id</code>, + <em>hid_t</em> <code>space_id</code>, + <em>hsize_t</em> *<code>size</code> + ) +<dt><strong>Purpose:</strong> + <dd>Determines the number of bytes required to store VL data. +<dt><strong>Description:</strong> + <dd><code>H5Dget_vlen_buf_size</code> determines the number of bytes + required to store the VL data from the dataset, using the + <code>space_id</code> for the selection in the dataset on + disk and the <code>type_id</code> for the memory representation + of the VL data in memory. + <p> + <code>*size</code> is returned with the number of bytes are + required to store the VL data in memory. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>dataset_id</code> + <dd>Identifier of the dataset to query. + <dt><em>hid_t</em> <code>type_id</code> + <dd>Identifier of the datatype. + <dt><em>hid_t</em> <code>space_id</code> + <dd>Identifier of the dataspace. + <dt><em>hsize_t</em> *<code>size</code> + <dd>The size in bytes of the buffer required to store the VL data. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns non-negative value if successful; + otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5dget_vlen_buf_size_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataset-VLReclaim">H5Dvlen_reclaim</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t </em><code>H5Dvlen_reclaim</code>(<em>hid_t </em><code>type_id</code> + <em>hid_t</em> <code>space_id</code>, + <em>hid_t</em> <code>plist_id</code>, + <em>void</em> *<code>buf</code> + ) +<dt><strong>Purpose:</strong> + <dd>Reclaims VL datatype memory buffers. +<dt><strong>Description:</strong> + <dd><code>H5Dvlen_reclaim</code> reclaims memory buffers created to + store VL datatypes. + <p> + The <code>type_id</code> must be the datatype stored in the buffer. + The <code>space_id</code> describes the selection for the memory buffer + to free the VL datatypes within. + The <code>plist_id</code> is the dataset transfer property list which + was used for the I/O transfer to create the buffer. + And <code>buf</code> is the pointer to the buffer to be reclaimed. + <p> + The VL structures (<code>hvl_t</code>) in the user's buffer are + modified to zero out the VL information after the memory has been reclaimed. + <p> + If nested VL datatypes were used to create the buffer, + this routine frees them <em>from the bottom up</em>, releasing all + the memory without creating memory leaks. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>type_id</code> + <dd>Identifier of the datatype. + <dt><em>hid_t</em> <code>space_id</code> + <dd>Identifier of the dataspace. + <dt><em>hid_t</em> <code>plist_id</code> + <dd>Identifier of the property list used to create the buffer. + <dt><em>void</em> *<code>buf</code> + <dd>Pointer to the buffer to be reclaimed. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns non-negative value if successful; + otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5dvlen_reclaim_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -293,6 +513,13 @@ and set and retrieve their constant or persistent properties. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5dread_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -363,6 +590,13 @@ and set and retrieve their constant or persistent properties. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5dwrite_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -391,6 +625,13 @@ and set and retrieve their constant or persistent properties. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5dextend_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -401,7 +642,7 @@ and set and retrieve their constant or persistent properties. <dd><em>hid_t </em><code>H5Dclose</code>(<em>hid_t </em><code>dataset_id</code> ) <dt><strong>Purpose:</strong> - <dd> + <dd>Closes the specified dataset. <dt><strong>Description:</strong> <dd><code>H5Dclose</code> ends access to a dataset specified by <code>dataset_id</code> and releases resources used by it. @@ -415,9 +656,74 @@ and set and retrieve their constant or persistent properties. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5dclose_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataset-Iterate">H5Diterate</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t </em><code>H5Diterate</code>( + <em>void *</em><code>buf</code>, + <em>hid_t </em><code>type_id</code>, + <em>hid_t </em><code>space_id</code>, + <em>H5D_operator_t </em><code>operator</code>, + <em>void *</em><code>operator_data</code> + ) +<dt><strong>Purpose:</strong> + <dd>Iterates over all selected elements in a dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Diterate</code> iterates over all the elements selected + in a memory buffer. The callback function is called once for each + element selected in the dataspace. + <p> + The selection in the dataspace is modified so that any elements + already iterated over are removed from the selection if the + iteration is interrupted (by the <code>H5D_operator_t</code> + function returning non-zero) before the iteration is complete; + the iteration may then be re-started by the user where it left off. + +<dt><strong>Parameters:</strong> + <dl> + <dt><em>void *</em><code>buf</code> + <dd>IN/OUT: Pointer to the buffer in memory containing the + elements to iterate over. + <dt><em>hid_t </em><code>type_id</code> + <dd>IN: Datatype identifier for the elements stored in + <code>buf</code>. + <dt><em>hid_t </em><code>space_id</code> + <dd>IN: Dataspace identifier for <code>buf</code>. + Also contains the selection to iterate over. + <dt><em>H5D_operator_t </em><code>operator</code> + <dd>IN: Function pointer to the routine to be called + for each element in <code>buf</code> iterated over. + <dt><em>void *</em><code>operator_data</code> + <dd>IN/OUT: Pointer to any user-defined data associated + with the operation. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns the return value of the last operator if it was non-zero, + or zero if all elements have been processed. + Otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5d_FORTRAN.html#h5diterate_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> + <hr> <center> <table border=0 width=98%> @@ -458,7 +764,7 @@ H5D <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 30 October 1998 +Last modified: 20 October 1999 </body> </html> diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index 7384532..b4f3044 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -52,20 +52,23 @@ These functions are designed to provide file-level access to HDF5 files. Further manipulation of objects inside a file is performed through one of APIs documented below. +<p> +<strong>The C Interfaces:</strong> + <table border=0> <tr><td valign=top> <ul> - <li><a href="#File-Open">H5Fopen</a> <li><a href="#File-Create">H5Fcreate</a> - <li><a href="#File-IsHDF5">H5Fis_hdf5</a> + <li><a href="#File-Open">H5Fopen</a> + <li><a href="#File-Reopen">H5Freopen</a> + <li><a href="#File-Close">H5Fclose</a> </ul> </td><td> </td><td valign=top> <ul> <li><a href="#File-Flush">H5Fflush</a> - <li><a href="#File-Close">H5Fclose</a> + <li><a href="#File-IsHDF5">H5Fis_hdf5</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> <ul> @@ -75,6 +78,47 @@ documented below. </td></tr> </table> +<p> +<strong>The FORTRAN90 Interfaces:</strong> + +<br> +<font size=-1> +<i>In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. The links below go to the C function +descriptions, which serve as general descriptions for both. A button, +under <strong>Non-C API(s)</strong> at the end of the C function description, +opens an external browser window displaying the FORTRAN90-specific +information. You will probably want to adjust the size and location of +this external window so that both browser windows are visible and to +facilitate moving easily between them.</i> +</font> + +<table border=0> +<tr><td valign=top> +<ul> + <li><a href="#File-Create">h5fcreate_f</a> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#File-Open">h5fopen_f</a> +<!--<li><a href="#File-Reopen">h5freopen_f</a> --> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#File-Close">h5fclose_f</a> +<!--<li><a href="#File-Flush">h5fflush_f</a> --> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#File-IsHDF5">h5fis_hdf5_f</a> +<!--<li><a href="#File-Mount">h5fmount_f</a> --> +<!--<li><a href="#File-Unmount">h5funmount_f</a> --> +<!--<li><a href="#File-GetCreatePlist">h5fget_create_plist_f</a> --> +<!--<li><a href="#File-GetAccessPlist">h5fget_access_plist_f</a> --> +</ul> +</td></tr> +</table> + <hr> <dl> @@ -115,14 +159,36 @@ documented below. <dt><em>const char *</em><code>name</code> <dd>Name of the file to access. <dt><em>unsigned</em> <code>flags</code> - <dd>File access flags. See the <code>H5Fcreate</code> - parameters list for a list of possible values. + <dd>File access flags. Allowable values include: + <ul><dl> + <dt>H5F_ACC_RDWR + <dd>Allow read and write access to file. + <dt>H5F_ACC_RDONLY + <dd>Allow read-only access to file. + <dt>H5F_ACC_DEBUG + <dd>Print debug information. + (Used only by HDF5 library developers. + Do not use this flag in applications.) + </dl></ul> + <code>H5F_ACC_RDWR</code> and <code>H5F_ACC_RDONLY</code> + are mutually exclusive; use exactly one. <dt><em>hid_t</em> <code>access_id</code> <dd>Identifier for the file access properties list. + If parallel file access is desired, this is a collective + call according to the communicator stored in the + <code>access_id</code>. + Use <code>H5P_DEFAULT</code> for default file access properties. </dl> <dt><strong>Returns:</strong> <dd>Returns a file identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5f_FORTRAN.html#h5fopen_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -158,12 +224,8 @@ documented below. <dt><em>const char *</em><code>name</code> <dd>Name of the file to access. <dt><em>uintn</em> <code>flags</code> - <dd>File access flags. Possible values include: + <dd>File access flags. Allowable values include: <ul><dl> - <dt>H5F_ACC_RDWR - <dd>Allow read and write access to file. - <dt>H5F_ACC_RDONLY - <dd>Allow read-only access to file. <dt>H5F_ACC_TRUNC <dd>Truncate file, if it already exists, erasing all data previously stored in the file. @@ -171,22 +233,32 @@ documented below. <dd>Fail if file already exists. <dt>H5F_ACC_DEBUG <dd>Print debug information. - <dt>H5P_DEFAULT - <dd>Apply default file access and creation properties. + (Used only by HDF5 library developers. + Do not use this flag in applications.) </dl></ul> + <code>H5F_ACC_TRUNC</code> and <code>H5F_ACC_EXCL</code> + are mutually exclusive; use exactly one. <dt><em>hid_t</em> <code>create_id</code> <dd>File creation property list identifier, used when modifying default file meta-data. + Use <code>H5P_DEFAULT</code> for default file creation properties. <dt><em>hid_t</em> <code>access_id</code> <dd>File access property list identifier. If parallel file access is desired, this is a collective call according to the communicator stored in the <code>access_id</code>. - Use <code>0</code> for default access properties. + Use <code>H5P_DEFAULT</code> for default file access properties. </dl> <dt><strong>Returns:</strong> <dd>Returns a file identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5f_FORTRAN.html#h5fcreate_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -222,7 +294,7 @@ documented below. </center> <dt><strong>Parameters:</strong> <dl> - <dt><em>const char *</em><code>object_id</code> + <dt><em>hid_t </em><code>object_id</code> <dd>Identifier of object used to identify the file. <dt><em>H5F_scope_t</em> <code>scope</code> <dd>Specifies the scope of the flushing action. @@ -230,6 +302,14 @@ documented below. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5f_FORTRAN.html#h5fflush_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -237,7 +317,7 @@ documented below. <dl> <dt><strong>Name:</strong> <a name="File-IsHDF5">H5Fis_hdf5</a> <dt><strong>Signature:</strong> - <dd><em>hbool_t </em><code>H5Fis_hdf5</code>(<em>const char *</em><code>name</code> + <dd><em>htri_t </em><code>H5Fis_hdf5</code>(<em>const char *</em><code>name</code> ) <dt><strong>Purpose:</strong> <dd>Determines whether a file is in the HDF5 format. @@ -250,8 +330,16 @@ documented below. <dd>File name to check format. </dl> <dt><strong>Returns:</strong> - <dd>Returns <code>TRUE</code> or <code>FALSE</code> if successful. + <dd>When successful, returns a positive value, for <code>TRUE</code>, + or <code>0</code> (zero), for <code>FALSE</code>. Otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5f_FORTRAN.html#h5fis_hdf5_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -284,6 +372,14 @@ documented below. <dt><strong>Returns:</strong> <dd>Returns a file creation property list identifier if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5f_FORTRAN.html#h5fget_create_plist_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -313,6 +409,14 @@ documented below. <dt><strong>Returns:</strong> <dd>Returns a file access property list identifier if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5f_FORTRAN.html#h5fget_access_plist_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -337,6 +441,13 @@ documented below. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5f_FORTRAN.html#h5fclose_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -357,8 +468,8 @@ documented below. <code>loc_id</code> and <code>name</code> using the mount properties <code>plist_id</code>. <p> - Note that <code>loc_id</code> identifies a file or group. - <code>name</code> then specifies a group relative to <code>loc_id</code>. + Note that <code>loc_id</code> is either a file or group identifier + and <code>name</code> is relative to <code>loc_id</code>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> @@ -376,6 +487,14 @@ documented below. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5f_FORTRAN.html#h5fmount_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -394,23 +513,34 @@ documented below. from the file mounted there. This function does not close either file. <p> - The mount point can either be the group in the + The mount point can be either 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. + <p> + Note that <code>loc_id</code> is either a file or group identifier + and <code>name</code> is relative to <code>loc_id</code>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> <dd>The file or group 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. + <dd>The name of the mount point. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5f_FORTRAN.html#h5funmount_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -423,7 +553,7 @@ documented below. <dt><strong>Purpose:</strong> <dd>Reopens an HDF5 file. <dt><strong>Description:</strong> - <dd><code>H5Freopen</code> reopens an HDF5 file. The new + <code>H5Freopen</code> reopens an HDF5 file. The new file identifier which is returned points to the same file as the specified file idetifier, <code>file_id</code>. Both identifiers share caches and other information. @@ -438,6 +568,14 @@ documented below. <dt><strong>Returns:</strong> <dd>Returns a new file identifier if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5f_FORTRAN.html#h5freopen_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -481,7 +619,7 @@ H5F <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 30 October 1998 +Last modified: 20 October 1999 </body> </html> diff --git a/doc/html/RM_H5Front.html b/doc/html/RM_H5Front.html index c9741a9..a26b151 100644 --- a/doc/html/RM_H5Front.html +++ b/doc/html/RM_H5Front.html @@ -49,6 +49,28 @@ HDF5 Reference Manual The HDF5 library provides several interfaces, each of which provides the tools required to meet specific aspects of the HDF5 data-handling requirements. +<p> +<i><strong>A note regarding the prototype FORTRAN90 APIs:</strong><br> +This version of the </i>HDF5 Reference Manual<i> includes a description +of a partial FORTRAN90 <strong>prototype</strong> API to HDF5. +Prototype Fortran subroutines exist in the H5A, H5D, H5F, H5G, H5P, H5S, and H5T +interfaces and are described on those pages. +<p> +In general, each Fortran subroutine performs exactly the same task +as the corresponding C function. The links at the top of each reference manual +section go to the C function descriptions, which serve as general descriptions +for both the C and Fortran APIs. A button, +under <strong>Non-C API(s)</strong> at the end of the C function description, +opens an external browser window displaying the Fortran-specific +information. You will probably want to adjust the size and location of +this external window so that both browser windows are visible and to +facilitate moving easily between them. +<p> +See <a href="README_Fortran90.html" target="FortranWin">README_Fortran90.html</a>, +a copy of the README file in the Fortran prototype source code directory, +for more detailed notes regarding the prototype API. </i> +<p> + <center> <table border=0> @@ -104,7 +126,7 @@ tools required to meet specific aspects of the HDF5 data-handling requirements. </table> </center> - +<br><br> <hr> <center> diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index 469b26d..818cef8 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -50,6 +50,8 @@ H5G The Group interface functions create and manipulate groups of objects in an HDF5 file. +<p> +<strong>The C Interfaces:</strong> <table border=0> <tr><td valign=top> @@ -76,6 +78,48 @@ of objects in an HDF5 file. </table> <p> +<strong>The FORTRAN90 Interfaces:</strong> + +<br> +<font size=-1> +<i>In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. The links below go to the C function +descriptions, which serve as general descriptions for both. A button, +under <strong>Non-C API(s)</strong> at the end of the C function description, +opens an external browser window displaying the FORTRAN90-specific +information. You will probably want to adjust the size and location of +this external window so that both browser windows are visible and to +facilitate moving easily between them.</i> +</font> + +<table border=0> +<tr><td valign=top> +<ul> + <li><a href="#Group-Create">h5gcreate_f</a> + <li><a href="#Group-Open">h5gopen_f</a> + <li><a href="#Group-Close">h5gclose_f</a> +<!--<li><a href="#Group-Link">h5glink_f</a> + --> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#Group-Unlink">h5gunlink_f</a> + <li><a href="#Group-Iterate">h5gget_obj_info_idx_f</a> + <li><a href="#Group-Iterate">h5gn_members_f</a> + <li><a href="#Group-Move">h5gmove_f</a> +</ul> +</td><td> </td><td valign=top> +<ul> +<!--<li><a href="#Group-GetObjinfo">h5gget_objinfo_f</a> + --> + <li><a href="#Group-GetLinkval">h5gget_linkval_f</a> + <li><a href="#Group-SetComment">h5gset_comment_f</a> + <li><a href="#Group-GetComment">h5gget_comment_f</a> +</ul> +</td></tr> +</table> + +<p> A group associates names with objects and provides a mechanism for mapping a name to an object. Since all objects appear in at least one group (with the possible exception of the root object) @@ -126,7 +170,7 @@ create or access function. then a default size is chosen. <p> The return value is a group identifier for the open group. - This group identifier should be closed by calling + This group identifier should be closed by calling <code>H5Gclose()</code> when it is no longer needed. <dt><strong>Parameters:</strong> <dl> @@ -146,9 +190,20 @@ create or access function. <dt><strong>Returns:</strong> <dd>Returns a valid group identifier for the open group if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> +<!-- + <dd><a href="fortran/h5g_FORTRAN.html#h5gcreate_f" target="FortWin" onClick="window.open("fortran/h5g_FORTRAN.html#h5gcreate_f","FortWin","toolbar=0,location=0,directories=0,status=0,menubar=0,scrollbars=yes,resizable=1,width=500,height=250,titlebar=yes")"><img src="Graphics/FORTRAN.gif"></a> +--> + <dd><a href="fortran/h5g_FORTRAN.html#h5gcreate_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> + <hr> <dl> <dt><strong>Name:</strong> <a name="Group-Open">H5Gopen</a> @@ -178,6 +233,16 @@ create or access function. <dt><strong>Returns:</strong> <dd>Returns a valid group identifier if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> +<!-- + <dd><a href="fortran/h5g_FORTRAN.html#h5gopen_f" target="FortWin" onClick="window.open("fortran/h5g_FORTRAN.html#h5gopen_f","FortWin&nquot;,"toolbar=0,location=0,directories=0,status=0,menubar=0,scrollbars=yes,resizable=1,width=500,height=250,titlebar=yes")"><img src="Graphics/FORTRAN.gif"></a> +--> + <dd><a href="fortran/h5g_FORTRAN.html#h5gopen_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -202,6 +267,16 @@ create or access function. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> +<!-- + <dd><a href="fortran/h5g_FORTRAN.html#h5gclose_f" target="FortWin" onClick="window.open("fortran/h5g_FORTRAN.html#h5gclose_f","FortWin&nquot;,"toolbar=0,location=0,directories=0,status=0,menubar=0,scrollbars=yes,resizable=1,width=500,height=250,titlebar=yes")"><img src="Graphics/FORTRAN.gif"></a> +--> + <dd><a href="fortran/h5g_FORTRAN.html#h5gclose_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -251,6 +326,16 @@ create or access function. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> +<!-- + <dd><a href="fortran/h5g_FORTRAN.html#h5glink_f" target="FortWin" onClick="window.open("fortran/h5g_FORTRAN.html#h5glink_f","FortWin&nquot;,"toolbar=0,location=0,directories=0,status=0,menubar=0,scrollbars=yes,resizable=1,width=500,height=250,titlebar=yes")"><img src="Graphics/FORTRAN.gif"></a> +--> + <dd><a href="fortran/h5g_FORTRAN.html#h5glink_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -285,6 +370,13 @@ create or access function. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5g_FORTRAN.html#h5gunlink_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -355,6 +447,35 @@ create or access function. <dd>Returns the return value of the last operator if it was non-zero, or zero if all group members were processed. Otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd>There is no direct FORTRAN couterpart for the C function + <code>H5Giterate</code>. + Instead, that functionality is provided by two FORTRAN functions: + <center> + <table width=80%> + <tr valign=top align=left> + <td> + <a href="fortran/h5g_FORTRAN.html#h5gn_members_f" + target="FortranWin"><code>h5gn_members_f</code></a>. + </td><td> </td><td> + <strong>Purpose:</strong> + Returns the number of group members. + </tr><tr valign=top align=left> + <td> + <a href="fortran/h5g_FORTRAN.html#h5gget_obj_info_idx_f" + target="FortranWin"><code>h5gget_obj_info_idx_f</code></a> + </td><td> </td><td> + <strong>Purpose:</strong> + Returns name and type of the group member identified by its index. + </td> + </table> + </center> + <dd><a href="fortran/h5g_FORTRAN.html#h5gn_members_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -387,6 +508,13 @@ create or access function. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5g_FORTRAN.html#h5gmove_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -422,7 +550,7 @@ create or access function. unsigned long fileno[2]; unsigned long objno[2]; unsigned nlink; - H5G_type_t type; + int type; time_t mtime; size_t linklen; } H5G_stat_t @@ -467,6 +595,13 @@ create or access function. <dd> Returns a non-negative value if successful, with the fields of <code>statbuf</code> (if non-null) initialized. Otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5g_FORTRAN.html#h5gget_objinfo_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -515,6 +650,13 @@ create or access function. <dd>Returns a non-negative value, with the link value in <code>value</code>, if successful. Otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5g_FORTRAN.html#h5gget_linkval_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -558,6 +700,13 @@ create or access function. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5g_FORTRAN.html#h5gset_comment_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -600,6 +749,13 @@ create or access function. counting the null terminator, if successful; the value returned may be larger than <code>bufsize</code>. Otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5g_FORTRAN.html#h5gget_comment_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -643,7 +799,7 @@ H5G <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 26 April 1999 +Last modified: 20 October 1999 </body> </html> diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index f327114..c1170b8 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -50,7 +50,10 @@ H5P These functions manipulate property list objects to allow objects which require many different parameters to be easily manipulated. -<dir> + +<p> +<strong>The C Interfaces:</strong> + <table border=0> <tr><td valign=top> @@ -74,11 +77,12 @@ many different parameters to be easily manipulated. <li><a href="#Property-SetIstoreK">H5Pset_istore_k</a> <li><a href="#Property-GetIstoreK">H5Pget_istore_k</a> </ul> -<br> -<br> -|| <i>Available only in the -<br> -parallel HDF5 library.</i> + + <p><i>Variable-length Datatype Properties</i> + <ul> + <li><a href="#Property-SetVLMemManager">H5Pset_vlen_mem_manager</a> + <li><a href="#Property-GetVLMemManager">H5Pget_vlen_mem_manager</a> + </ul> </td><td> </td><td valign=top> @@ -101,8 +105,16 @@ parallel HDF5 library.</i> <li><a href="#Property-GetCache">H5Pget_cache</a> <li><a href="#Property-SetSplit">H5Pset_split</a> <li><a href="#Property-GetSplit">H5Pget_split</a> + <li><a href="#Property-SetGCReferences">H5Pset_gc_references</a> + <li><a href="#Property-GetGCReferences">H5Pget_gc_references</a> </ul> +<br> +<br> +<br> +|| <i>Available only in the +parallel HDF5 library.</i> + </td><td> </td><td valign=top> <i>Dataset Creation Properties</i> @@ -133,6 +145,10 @@ parallel HDF5 library.</i> <li><a href="#Property-GetBuffer">H5Pget_buffer</a> <li><a href="#Property-SetPreserve">H5Pset_preserve</a> <li><a href="#Property-GetPreserve">H5Pget_preserve</a> + <li><a href="#Property-SetHyperCache">H5Pset_hyper_cache</a> + <li><a href="#Property-GetHyperCache">H5Pget_hyper_cache</a> + <li><a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a> + <li><a href="#Property-GetBTreeRatios">H5Pget_btree_ratios</a> <li><a href="#Property-SetXfer">H5Pset_xfer</a> || <li><a href="#Property-GetXfer">H5Pget_xfer</a> || </ul> @@ -147,8 +163,118 @@ parallel HDF5 library.</i> --> </table> -</dir +<p> +<strong>The FORTRAN90 Interfaces:</strong> + +<br> +<font size=-1> +<i>In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. The links below go to the C function +descriptions, which serve as general descriptions for both. A button, +under <strong>Non-C API(s)</strong> at the end of the C function description, +opens an external browser window displaying the FORTRAN90-specific +information. You will probably want to adjust the size and location of +this external window so that both browser windows are visible and to +facilitate moving easily between them.</i> +</font> + +<table border=0> +<tr><td valign=top> + + <i>General Property List Operations</i> + <ul> + <li><a href="#Property-Create">h5pcreate_f</a> + <li><a href="#Property-GetClass">h5pget_class_f</a> + <li><a href="#Property-Copy">h5pcopy_f</a> + <li><a href="#Property-Close">h5pclose_f</a> + </ul> + +<!--<p><i>File Creation Properties</i> --> +<!--<ul> --> +<!--<li><a href="#Property-GetVersion">h5pget_version_f</a> --> +<!--<li><a href="#Property-SetUserblock">h5pset_userblock_f</a> --> +<!--<li><a href="#Property-GetUserblock">h5pget_userblock_f</a> --> +<!--<li><a href="#Property-SetSizes">h5pset_sizes_f</a> --> +<!--<li><a href="#Property-GetSizes">h5pget_sizes_f</a> --> +<!--<li><a href="#Property-SetSymK">h5pset_sym_k_f</a> --> +<!--<li><a href="#Property-GetSymK">h5pget_sym_k_f</a> --> +<!--<li><a href="#Property-SetIstoreK">h5pset_istore_k_f</a> --> +<!--<li><a href="#Property-GetIstoreK">h5pget_istore_k_f</a> --> +<!--</ul> --> + +<!--<p><i>Variable-length Datatype Properties</i> --> +<!--<ul> --> +<!--<li><a href="#Property-SetVLMemManager">h5pset_vlen_mem_manager_f</a> --> +<!--<li><a href="#Property-GetVLMemManager">h5pget_vlen_mem_manager_f</a> --> +<!--</ul> --> + +</td><td> </td><td valign=top> + +<!-- DELETE THIS LINE AND NEXT IF ANY APIs IN THIS SECTION COME INTO USE --> + + +<!--<i>File Access Properties</i> --> +<!--<ul> --> +<!--<li><a href="#Property-GetDriver">h5pget_driver_f</a> --> +<!--<li><a href="#Property-SetStdio">h5pset_stdio_f</a> --> +<!--<li><a href="#Property-GetStdio">h5pget_stdio_f</a> --> +<!--<li><a href="#Property-SetSec2">h5pset_sec2_f</a> --> +<!--<li><a href="#Property-GetSec2">h5pget_sec2_f</a> --> +<!--<li><a href="#Property-SetAlignment">h5pset_alignment_f</a> --> +<!--<li><a href="#Property-GetAlignment">h5pget_alignment_f</a> --> +<!--<li><a href="#Property-SetCore">h5pset_core_f</a> --> +<!--<li><a href="#Property-GetCore">h5pget_core_f</a> --> +<!--<li><a href="#Property-SetMPI">h5pset_mpi_f</a> || --> +<!--<li><a href="#Property-GetMPI">h5pget_mpi_f</a> || --> +<!--<li><a href="#Property-SetFamily">h5pset_family_f</a> --> +<!--<li><a href="#Property-GetFamily">h5pget_family_f</a> --> +<!--<li><a href="#Property-SetCache">h5pset_cache_f</a> --> +<!--<li><a href="#Property-GetCache">h5pget_cache_f</a> --> +<!--<li><a href="#Property-SetSplit">h5pset_split_f</a> --> +<!--<li><a href="#Property-GetSplit">h5pget_split_f</a> --> +<!--<li><a href="#Property-SetGCReferences">h5pset_gc_references_f</a> --> +<!--<li><a href="#Property-GetGCReferences">h5pget_gc_references_f</a> --> +<!--</ul> --> + +</td><td> </td><td valign=top> + + <i>Dataset Creation Properties</i> + <ul> +<!--<li><a href="#Property-SetLayout">h5pset_layout_f</a> --> +<!--<li><a href="#Property-GetLayout">h5pget_layout_f</a> --> + <li><a href="#Property-SetChunk">h5pset_chunk_f</a> + <li><a href="#Property-GetChunk">h5pget_chunk_f</a> + <li><a href="#Property-SetDeflate">h5pset_deflate_f</a> +<!--<li><a href="#Property-GetDeflate">h5pget_deflate_f</a> --> +<!--<li><a href="#Property-SetCompression">h5pset_compression_f</a> --> +<!--<li><a href="#Property-GetCompression">h5pget_compression_f</a> --> + <li><a href="#Property-SetFillValue">h5pset_fill_value_f</a> + <li><a href="#Property-GetFillValue">h5pget_fill_value_f</a> +<!--<li><a href="#Property-SetFilter">h5pset_filter_f</a> --> +<!--<li><a href="#Property-GetNFilters">h5pget_nfilters_f</a> --> +<!--<li><a href="#Property-GetFilter">h5pget_filter_f</a> --> +<!--<li><a href="#Property-SetExternal">h5pset_external_f</a> --> +<!--<li><a href="#Property-GetExternalCount">h5pget_external_count_f</a> --> +<!--<li><a href="#Property-GetExternal">h5pget_external_f</a> --> + </ul> + +<!--<p><i>Dataset Memory and Transfer Properties</i> --> +<!--<ul> --> +<!--<li><a href="#Property-SetBuffer">h5pset_buffer_f</a> --> +<!--<li><a href="#Property-GetBuffer">h5pget_buffer_f</a> --> +<!--<li><a href="#Property-SetPreserve">h5pset_preserve_f</a> --> +<!--<li><a href="#Property-GetPreserve">h5pget_preserve_f</a> --> +<!--<li><a href="#Property-SetHyperCache">h5pset_hyper_cache_f</a> --> +<!--<li><a href="#Property-GetHyperCache">h5pget_hyper_cache_f</a> --> +<!--<li><a href="#Property-SetBTreeRatios">h5pset_btree_ratios_f</a> --> +<!--<li><a href="#Property-GetBTreeRatios">h5pget_btree_ratios_f</a> --> +<!--<li><a href="#Property-SetXfer">h5pset_xfer_f</a> || --> +<!--<li><a href="#Property-GetXfer">h5pget_xfer_f</a> || --> +<!--</ul> --> + +</td></tr> +</table> <hr> <dl> @@ -197,6 +323,13 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a property list identifier (<code>plist</code>) if successful; otherwise Fail (-1). + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pcreate_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> <hr> @@ -220,6 +353,13 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pclose_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -244,6 +384,13 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a property list class if successful. Otherwise returns H5P_NO_CLASS (-1). + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pget_class_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -268,6 +415,13 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a property list identifier if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pcopy_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -304,6 +458,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -331,6 +493,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -356,6 +526,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -389,6 +567,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -418,6 +604,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -459,6 +653,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -490,6 +692,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if the file access property list is set to the MPI. Otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -528,6 +738,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -555,6 +773,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -598,6 +824,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -632,6 +866,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -666,6 +908,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -695,6 +945,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -713,7 +971,7 @@ parallel HDF5 library.</i> This function is only valid for dataset creation property lists. Valid parameters for <code>layout</code> are: <ul><dl> - <dt>H5D_COMPACT + <dt>H5D_COMPACT <i><b>(Not yet implemented.)</b></i> <dd>Store raw data and object header contiguously in file. This should only be used for very small amounts of raw data (suggested less than 1KB). @@ -735,6 +993,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -750,7 +1016,7 @@ parallel HDF5 library.</i> a dataset. This function is only valid for dataset creation property lists. Valid types for <code>layout</code> are: <ul> <dl> - <dt>H5D_COMPACT + <dt>H5D_COMPACT <i><b>(Not yet implemented.)</b></i> <dd>Raw data and object header stored contiguously in file. <dt>H5D_CONTIGUOUS <dd>Raw data stored separately from object header in one @@ -768,6 +1034,14 @@ parallel HDF5 library.</i> <dd>Returns the layout type of a a dataset creation property list if successful. Otherwise returns H5D_LAYOUT_ERROR (-1). + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -802,6 +1076,13 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pset_chunk_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -834,6 +1115,13 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns chunk dimensionality successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pget_chunk_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -874,6 +1162,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -905,6 +1201,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -925,10 +1229,16 @@ parallel HDF5 library.</i> <p> If a dataset is split across multiple files then the files should be defined in order. The total size of the dataset is - the sum of the SIZE arguments for all the external files. If + the sum of the <code>size</code> arguments for all the external files. If the total size is larger than the size of a dataset then the dataset can be extended (provided the data space also allows the extending). + <p> + The <code>size</code> argument specifies number of bytes reserved + for data in the external file. + If <code>size</code> is set to <code>H5F_UNLIMITED</code>, the + external file can be of unlimited size and no more files can be added to + the external files list. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> @@ -944,6 +1254,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -966,6 +1284,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns the number of external files if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1015,6 +1341,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> <hr> @@ -1059,6 +1393,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pset_fill_value_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> <hr> @@ -1094,6 +1436,13 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pget_fill_value_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1169,6 +1518,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1205,6 +1562,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns the number of filters in the pipeline if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1279,6 +1644,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1). + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1309,6 +1682,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a low-level driver identifier if successful. Otherwise returns H5F_LOW_ERROR (-1). + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1332,6 +1713,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1357,6 +1746,14 @@ parallel HDF5 library.</i> <dd>Returns a non-negative value if the file access property list is set to the stdio driver. Otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1381,6 +1778,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1406,6 +1811,14 @@ parallel HDF5 library.</i> <dd>Returns a non-negative value if the file access property list is set to the sec2 driver. Otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1437,12 +1850,20 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> <hr> <dl> - <dt><strong>Name:</strong> <a name="Property-GetCore"></a> + <dt><strong>Name:</strong> <a name="Property-GetCore">H5Pget_core</a> <dt><strong>Signature:</strong> <dd><em>herr_t</em> <code>H5Pget_core</code>(<em>hid_t</em> <code>plist</code>, <em>size_t</em> <code>*increment</code> @@ -1468,6 +1889,14 @@ parallel HDF5 library.</i> <dd>Returns a non-negative value if the file access property list is set to the core driver. Otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1513,6 +1942,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1557,8 +1994,8 @@ parallel HDF5 library.</i> <dt><em>size_t</em> <code>meta_ext_size</code> <dd>IN: Number of characters of the meta file extension to be copied to the <code>meta_ext</code> buffer. - <dt><em>OUT</em> <code>*meta_ext</code> - <dd>IN: Meta file extension. + <dt><em>char</em> <code>*meta_ext</code> + <dd>OUT: Meta file extension. <dt><em>hid_t</em> <code>*meta_properties</code> <dd>OUT: Pointer to a copy of the meta file access property list. <dt><em>size_t</em> <code>raw_ext_size</code> @@ -1573,51 +2010,94 @@ parallel HDF5 library.</i> <dd>Returns a non-negative value if the file access property list is set to the split driver. Otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> <hr> <dl> - <dt><strong>Name:</strong> <a name="Property-SetFamily">H5Pset_family</a> + <dt><strong>Name:</strong> <a name="Property-SetGCReferences">H5Pset_gc_references</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5Pset_family</code>(<em>hid_t</em> <code>plist</code>, - <em>hsize_t</em> <code>memb_size</code>, - <em>hid_t</em> <code>memb_plist</code> + <dd><em>herr_t</em> <code>H5Pset_split</code>(<em>hid_t</em> <code>plist</code>, + <em>unsigned</em> <code>gc_ref</code> ) <dt><strong>Purpose:</strong> - <dd>Sets the file access properties list to the <em>family</em> - driver. + <dd>Sets garbage collecting references flag. <dt><strong>Description:</strong> - <dd><i>Original version. Edited version below.</i> - <dd><code>H5Pset_family</code> sets the file access properties - to use the <em>family</em> - driver; any previously defined driver properties are erased - from the property list. Each member of the file family will - use <em>member_properties</em> as its file access property - list. The <em>memb_size</em> argument gives the logical size - in bytes of each family member but the actual size could be - smaller depending on whether the file contains holes. The - member size is only used when creating a new file or - truncating an existing file; otherwise the member size comes - from the size of the first member of the family being - opened. Note: if the size of the <code>off_t</code> type is - four bytes then the maximum family member size is usually - 2^31-1 because the byte at offset 2,147,483,647 is generally - inaccessible. Additional parameters may be added to this - function in the future. + <dd><code>H5Pset_gc_references</code> sets the flag for + garbage collecting references for the file. + <p> + Dataset region references and other reference types use space + in an HDF5 file's global heap. If garbage collection is on + and the user passes in an uninitialized value in a reference structure, + the heap might get corrupted. When garbage collection is off, however, + and the user re-uses a reference, the previous heap block will be + orphaned and not returned to the free heap space. + <p> + When garbage collection is on, the user must initialize the + reference structures to 0 or risk heap corruption. + <p> + The default value for garbage collecting references is off. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of the file access property list. - <dt><em>hsize_t</em> <code>memb_size</code> - <dd>IN: Logical size, in bytes, of each family member. - <dt><em>hid_t</em> <code>memb_plist</code> - <dd>IN: Identifier of the file access property list - for each member of the family. + <dd>IN: File access property list identifier. + <dt><em>unsigned</em> <code>gc_ref</code> + <dd>IN: </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-GetGCReferences">H5Pget_gc_references</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pget_split</code>(<em>hid_t</em> <code>plist</code>, + <em>unsigned</em> *<code>gc_ref</code> + ) + <dt><strong>Purpose:</strong> + <dd>Returns garbage collecting references setting. + <dt><strong>Description:</strong> + <dd><code>H5Pget_gc_references</code> returns the current setting + for the garbage collection references property from + the specified file access property list. + The garbage collection references property is set + by <a href="#Property-SetGCReferences">H5Pset_gc_references</a>. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist</code> + <dd>IN: File access property list identifier. + <dt><em>unsigned</em> <code>gc_ref</code> + <dd>OUT: + </dl> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1633,7 +2113,6 @@ parallel HDF5 library.</i> <dd>Sets the file access properties list to the <code>family</code> driver. <dt><strong>Description:</strong> - <dd><i>Edited version. Original version above.</i> <dd><code>H5Pset_family</code> sets the file access properties to use the <code>family</code> driver; any previously defined driver properties are erased from the property list. @@ -1672,6 +2151,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1711,6 +2198,14 @@ parallel HDF5 library.</i> <dd>Returns a non-negative value if the file access property list is set to the family driver. Otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1759,6 +2254,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1793,6 +2296,193 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-SetHyperCache">H5Pset_hyper_cache</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pset_hyper_cache</code>(<em>hid_t</em> <code>plist</code>, + <em>unsigned</em> <code>cache</code>, + <em>unsigned</em> <code>limit</code> + ) + <dt><strong>Purpose:</strong> + <dd>Indicates whether to cache hyperslab blocks during I/O. + <dt><strong>Description:</strong> + <dd>Given a dataset transfer property list, <code>H5Pset_hyper_cache</code> + indicates whether to cache hyperslab blocks during I/O, + a process which can significantly increase I/O speeds. + <p> + The parameter <code>limit</code> sets the maximum size of the + hyperslab block to cache. If a block is smaller than that limit, + it may still not be cached if no memory is available. + Setting the limit to <code>0</code> (zero) indicates no limitation on the size of + block to attempt to cache. + <p> + The default is to cache blocks with no limit on block size + for serial I/O and to not cache blocks for parallel I/O. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist</code> + <dd>IN: Dataset transfer property list identifier. + <dt><em>unsigned</em> <code>cache</code> + <dd>IN: + <dt><em>unsigned</em> <code>limit</code> + <dd>IN: Maximum size of the hyperslab block to cache. + <code>0</code> (zero) indicates no limit. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-GetHyperCache">H5Pget_hyper_cache</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pget_hyper_cache</code>(<em>hid_t</em> <code>plist</code>, + <em>unsigned</em> <code>cache</code>, + <em>unsigned</em> <code>limit</code> + ) + <dt><strong>Purpose:</strong> + <dd>Returns information regarding the caching of hyperslab blocks during I/O. + <dt><strong>Description:</strong> + <dd>Given a dataset transfer property list, <code>H5Pget_hyper_cache</code> + returns instructions regarding the caching of hyperslab blocks during I/O. + These parameters are set with the <code>H5Pset_hyper_cache</code> function. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist</code> + <dd>IN: Dataset transfer property list identifier. + <dt><em>unsigned</em> <code>cache</code> + <dd>OUT: + <dt><em>unsigned</em> <code>limit</code> + <dd>OUT: Maximum size of the hyperslab block to cache. + <code>0</code> (zero) indicates no limit. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-SetBTreeRatios">H5Pset_btree_ratios</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pset_btree_ratios</code>(<em>hid_t</em> <code>plist</code>, + <em>double</em> <code>left</code>, + <em>double</em> <code>middle</code>, + <em>double</em> <code>right</code> + ) + <dt><strong>Purpose:</strong> + <dd>Sets B-tree split ratios for a dataset transfer property list. + <dt><strong>Description:</strong> + <dd><code>H5Pset_btree_ratios</code> sets the B-tree split ratios + for a dataset transfer property list. The split ratios determine + what percent of children go in the first node when a node splits. + <p> + The ratio <code>left</code> is used when the splitting node is + the left-most node at its level in the tree; + the ratio <code>right</code> is used when the splitting node is + the right-most node at its level; + and the ratio <code>middle</code> is used for all other cases. + <p> + A node which is the only node at its level in the tree uses + the ratio <code>right</code> when it splits. + <p> + All ratios are real numbers between 0 and 1, inclusive. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist</code> + <dd>IN: The dataset transfer property list identifier. + <dt><em>double</em> <code>left</code> + <dd>IN: The B-tree split ratio for left-most nodes. + <dt><em>double</em> <code>right</code> + <dd>IN: The B-tree split ratio for right-most nodes and lone nodes. + <dt><em>double</em> <code>middle</code> + <dd>IN: The B-tree split ratio for all other nodes. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-GetBTreeRatios">H5Pget_btree_ratios</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pget_btree_ratios</code>(<em>hid_t</em> <code>plist</code>, + <em>double</em> *<code>left</code>, + <em>double</em> *<code>middle</code>, + <em>double</em> *<code>right</code> + ) + <dt><strong>Purpose:</strong> + <dd>Gets B-tree split ratios for a dataset transfer property list. + <dt><strong>Description:</strong> + <dd><code>H5Pget_btree_ratios</code> returns the B-tree split ratios + for a dataset transfer property list. + <p> + The B-tree split ratios are returned through the non-<code>NULL</code> + arguments <code>left</code>, <code>middle</code>, and <code>right</code>, + as set by the <a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a> function. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist</code> + <dd>IN: The dataset transfer property list identifier. + <dt><em>double</em> <code>left</code> + <dd>OUT: The B-tree split ratio for left-most nodes. + <dt><em>double</em> <code>right</code> + <dd>OUT: The B-tree split ratio for right-most nodes and lone nodes. + <dt><em>double</em> <code>middle</code> + <dd>OUT: The B-tree split ratio for all other nodes. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1811,15 +2501,21 @@ parallel HDF5 library.</i> <dd> Given a dataset transfer property list, <code>H5Pset_buffer</code> sets the maximum size for the type conversion buffer and background buffer and - optionally supply pointers to application-allocated buffers. + optionally supplies pointers to application-allocated buffers. If the buffer size is smaller than the entire amount of data - being transferred between application and file, and a type - conversion buffer or background buffer is required then - strip mining will be used. However, certain restrictions - apply for the size of buffer which can be used for strip - mining. For instance, when strip mining a 100x200x300 - hyperslab of a simple data space the buffer must be large - enough to hold a 1x200x300 slab. + being transferred between the application and the file, and a type + conversion buffer or background buffer is required, then + strip mining will be used. + <p> + Note that there are minimum size requirements for the buffer. + Strip mining can only break the data up along the first dimension, + so the buffer must be large enough to accommodate a complete slice + that encompasses all of the remaining dimensions. + For example, when strip mining a 100x200x300 hyperslab + of a simple data space, the buffer must be large enough to + hold 1x200x300 data elements. + When strip mining a 100x200x300x150 hyperslab of a simple data space, + the buffer must be large enough to hold 1x200x300x150 data elements. <p> If <code>tconv</code> and/or <code>bkg</code> are null pointers, then buffers will be allocated and freed during the data transfer. @@ -1839,6 +2535,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1869,6 +2573,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns buffer size if successful; otherwise 0 on failure. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1901,6 +2613,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1922,6 +2642,14 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns TRUE or FALSE if successful; otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1975,6 +2703,11 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> </dl> --> @@ -2015,6 +2748,11 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns compression method if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> </dl> --> @@ -2032,7 +2770,7 @@ parallel HDF5 library.</i> <dt><strong>Description:</strong> <dd><code>H5Pset_deflate</code> sets the compression method for a dataset creation property list to <code>H5D_COMPRESS_DEFLATE</code> - and the compression level to <code>level<>/code>, which should + and the compression level to <code>level</code>, which should be a value from zero to nine, inclusive. Lower compression levels are faster but result in less compression. This is the same algorithm as used by the GNU gzip program. @@ -2046,6 +2784,13 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pset_deflate_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -2071,12 +2816,146 @@ parallel HDF5 library.</i> <dt><strong>Returns:</strong> <dd>Returns compression level, a value between 0 and 9, if successful. Otherwise returns a negative value. + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> </dl> --> <hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-SetVLMemManager">H5Pset_vlen_mem_manager</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pset_vlen_mem_manager</code>(<em>hid_t</em> <code>plist</code>, + <em>H5MM_allocate_t</em> <code>alloc</code>, + <em>void</em> *<code>alloc_info</code>, + <em>H5MM_free_t</em> <code>free</code>, + <em>void</em> *<code>free_info</code> + ) + <dt><strong>Purpose:</strong> + <dd>Sets the memory manager for variable-length datatype allocation in + <code>H5Dread</code> and <code>H5Dvlen_reclaim</code>. + <dt><strong>Description:</strong> + <dd><code>H5Pset_vlen_mem_manager</code> sets the memory manager for + variable-length datatype allocation in <code>H5Dread</code> + and free in <code>H5Dvlen_reclaim</code>. + <p> + The <code>alloc</code> and <code>free</code> parameters + identify the memory management routines to be used. + If the user has defined custom memory management routines, + <code>alloc</code> and/or <code>free</code> should be set to make + those routine calls (i.e., the name of the routine is used as + the value of the parameter); + if the user prefers to use the system's <code> malloc</code> + and/or <code>free</code>, the <code>alloc</code> and + <code>free</code> parameters, respectively, should be set to + <code> NULL</code> + <p> + The prototypes for these user-defined functions would appear as follows: + <br> + <em>typedef void</em> *(*<code>H5MM_allocate_t</code>)(<em>size_t</em> <code>size</code>, + <em>void</em> *<code>alloc_info</code>) ; + + <br> + <em>typedef void</em> (*<code>H5MM_free_t</code>)(<em>void</em> *<code>mem</code>, + <em>void</em> *<code>free_info</code>) ; + <br> + The <code>alloc_info</code> and <code>free_info</code> parameters + can be used to pass along any required information to + the user's memory management routines. + <p> + In summary, if the user has defined custom memory management + routines, the name(s) of the routines are passed in the + <code>alloc</code> and <code>free</code> parameters and the + custom routines' parameters are passed in the + <code>alloc_info</code> and <code>free_info</code> parameters. + If the user wishes to use the system <code> malloc</code> and + <code>free</code> functions, the <code>alloc</code> and/or + <code>free</code> parameters are set to <code> NULL</code> + and the <code>alloc_info</code> and <code>free_info</code> + parameters are ignored. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist</code> + <dd>IN: Identifier for the dataset transfer property list. + <dt><em>H5MM_allocate_t</em> <code>alloc</code> + <dd>IN: User's allocate routine, or <code> NULL</code> for system <code> malloc</code>. + <dt><em>void</em> *<code>alloc_info</code> + <dd>IN: Extra parameter for user's allocation routine. + Ignored if preceding parameter is <code> NULL</code>. + <dt><em>H5MM_free_t</em> <code>free</code> + <dd>IN: User's free routine, or <code> NULL</code> for system <code>free</code>. + <dt><em>void</em> *<code>free_info</code> + <dd>IN: Extra parameter for user's free routine. + Ignored if preceding parameter is <code> NULL</code>. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-GetVLMemManager">H5Pget_vlen_mem_manager</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pget_vlen_mem_manager</code>(<em>hid_t</em> <code>plist</code>, + <em>H5MM_allocate_t</em> *<code>alloc</code>, + <em>void</em> **<code>alloc_info</code>, + <em>H5MM_free_t</em> *<code>free</code>, + <em>void</em> **<code>free_info</code> + ) + <dt><strong>Purpose:</strong> + <dd>Gets the memory manager for variable-length datatype allocation in + <code>H5Dread</code> and <code>H5Treclaim_vlen</code>. + <dt><strong>Description:</strong> + <dd><code>H5Pget_vlen_mem_manager</code> is the companion function to + <code>H5Pset_vlen_mem_manager</code>, returning the parameters + set by that function. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist</code> + <dd>IN: Identifier for the dataset transfer property list. + <dt><em>H5MM_allocate_t</em> <code>alloc</code> + <dd>OUT: User's allocate routine, or <code> NULL</code> + for system <code> malloc</code>. + <dt><em>void</em> *<code>alloc_info</code> + <dd>OUT: Extra parameter for user's allocation routine. + Ignored if preceding parameter is <code> NULL</code>. + <dt><em>H5MM_free_t</em> <code>free</code> + <dd>OUT: User's free routine, or <code> NULL</code> for + system <code>free</code>. + <dt><em>void</em> *<code>free_info</code> + <dd>OUT: Extra parameter for user's free routine. + Ignored if preceding parameter is <code> NULL</code>. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> <center> <table border=0 width=98%> <tr><td valign=top align=left> @@ -2116,7 +2995,7 @@ H5P <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 30 October 1998 +Last modified: 20 October 1999 </body> </html> diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index d138670..a039d63 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -57,14 +57,16 @@ to specific objects and data regions in an HDF5 file. <tr><td valign=top width=33%> <ul> <li><a href="#Reference-Create">H5Rcreate</a> + <li><a href="#Reference-Dereference">H5Rdereference</a> </ul> </td><td valign=top width=33%> <ul> - <li><a href="#Reference-Dereference">H5Rdereference</a> + <li><a href="#Reference-GetRegion">H5Rget_region</a> + <li><a href="#Reference-GetObjectType">H5Rget_object_type</a> </ul> </td><td valign=top width=34%> <ul> - <li><a href="#Reference-GetRegion">H5Rget_region</a> + </ul> </td></tr> </table> @@ -129,10 +131,12 @@ to specific objects and data regions in an HDF5 file. opens that object and returns an identifier. <p> The parameter <code>ref_type</code> specifies the reference type - of <code>ref</code>. See - <a href="References.html#Reference-RefTypes">Reference Types</a> in - <a href="References.html"><i>References (H5R)</i></a> - for a list of valid reference types. + of <code>ref</code>. + <code>ref_type</code> may contain either of the following values: + <ul> + <li><code>H5R_OBJECT</code> (<code>0</code>) + <li><code>H5R_DATASET_REGION</code> (<code>1</code>) + </ul> <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset</code> @@ -151,9 +155,8 @@ to specific objects and data regions in an HDF5 file. <hr> <dl> <dt><strong>Name:</strong> <a name="Reference-GetRegion">H5Rget_region</a> - <i>(Not yet implemented.)</i> <dt><strong>Signature:</strong> - <dd><em>H5S_t</em> <code>H5Rget_region</code>(<em>H5D_t</em> <code>dataset</code>, + <dd><em>hid_t</em> <code>H5Rget_region</code>(<em>hid_t</em> <code>dataset</code>, <em>H5R_type_t</em> <code>ref_type</code>, <em>void *</em><code>ref</code> ) @@ -166,10 +169,11 @@ to specific objects and data regions in an HDF5 file. which is the region pointed to. <p> The parameter <code>ref_type</code> specifies the reference type - of <code>ref</code>. See - <a href="References.html#Reference-RefTypes">Reference Types</a> in - <a href="References.html"><i>References (H5R)</i></a> - for a list of valid reference types. + of <code>ref</code>. + <code>ref_type</code> may contain the following value: + <ul> + <li><code>H5R_DATASET_REGION</code> (<code>1</code>) + </ul> <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset</code>, @@ -186,6 +190,34 @@ to specific objects and data regions in an HDF5 file. <hr> +<dl> +<dt><strong>Name:</strong> <a name="Reference-GetObjectType">H5Rget_object_type</a> +<dt><strong>Signature:</strong> + <dd><em>int</em> <code>H5Rget_object_type</code>(<em>hid_t</em> <code>id</code>, + <em>void *</em><code>ref</code> + ) +<dt><strong>Purpose:</strong> + <dd>Retrieves the type of object that an object reference points to. +<dt><strong>Description:</strong> + <dd>Given a reference to an object <code>ref</code>, + <code>H5Rget_object_type</code> returns the + type of the object pointed to. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>id</code>, + <dd>IN: The dataset containing the reference object or + the location identifier of the object that the dataset + is located within. + <dt><em>void *</em><code>ref</code> + <dd>IN: Reference to query. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns an object type as defined in <code>H5Gpublic.h</code>; + otherwise returns <code>H5G_UNKNOWN</code>. +</dl> + + +<hr> <center> <table border=0 width=98%> <tr><td valign=top align=left> diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index c8f0e04..721822d 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -51,40 +51,95 @@ H5S These functions create and manipulate the dataspace in which to store the elements of a dataset. + +<p> +<strong>The C Interfaces:</strong> + <table border=0> <tr><td valign=top> -<ul> <li><a href="#Dataspace-Create">H5Screate</a> + <li><a href="#Dataspace-Copy">H5Scopy</a> + <li><a href="#Dataspace-Close">H5Sclose</a> <li><a href="#Dataspace-CreateSimple">H5Screate_simple</a> <li><a href="#Dataspace-IsSimple">H5Sis_simple</a> <li><a href="#Dataspace-OffsetSimple">H5Soffset_simple</a> - <li><a href="#Dataspace-Copy">H5Scopy</a> + <li><a href="#Dataspace-ExtentDims">H5Sget_simple_extent_dims</a> + <li><a href="#Dataspace-ExtentNdims">H5Sget_simple_extent_ndims</a> + +</td><td> </td><td valign=top> + <li><a href="#Dataspace-ExtentNpoints">H5Sget_simple_extent_npoints</a> + <li><a href="#Dataspace-ExtentType">H5Sget_simple_extent_type</a> +<!-- NOT YET IMPLEMENTED (R1.2 -- 9908) <li><a href="#Dataspace-ExtentClass">H5Sextent_class</a> +--> <li><a href="#Dataspace-ExtentCopy">H5Sextent_copy</a> -</ul> -</td><td> </td><td valign=top> -<ul> <li><a href="#Dataspace-SetExtentSimple">H5Sset_extent_simple</a> <li><a href="#Dataspace-SetExtentNone">H5Sset_extent_none</a> <li><a href="#Dataspace-SelectNpoints">H5Sget_select_npoints</a> - <li><a href="#Dataspace-ExtentDims">H5Sget_simple_extent_dims</a> - <li><a href="#Dataspace-ExtentNdims">H5Sget_simple_extent_ndims</a> - <li><a href="#Dataspace-ExtentNpoints">H5Sget_simple_extent_npoints</a> - <li><a href="#Dataspace-ExtentType">H5Sget_simple_extent_type</a> -</ul> + <li><a href="#Dataspace-SelectHyperNBlocks">H5Sget_select_hyper_nblocks</a> + <li><a href="#Dataspace-SelectHyperBlockList">H5Sget_select_hyper_blocklist</a> </td><td> </td><td valign=top> -<ul> + <li><a href="#Dataspace-SelectElemNPoints">H5Sget_select_elem_npoints</a> + <li><a href="#Dataspace-SelectElemPointList">H5Sget_select_elem_pointlist</a> + <li><a href="#Dataspace-SelectBounds">H5Sget_select_bounds</a> <li><a href="#Dataspace-SelectElements">H5Sselect_elements</a> <li><a href="#Dataspace-SelectAll">H5Sselect_all</a> <li><a href="#Dataspace-SelectNone">H5Sselect_none</a> <li><a href="#Dataspace-SelectValid">H5Sselect_valid</a> <li><a href="#Dataspace-SelectHyperslab">H5Sselect_hyperslab</a> - <li><a href="#Dataspace-Close">H5Sclose</a> -</ul> </td></tr> </table> <p> +<strong>The FORTRAN90 Interfaces:</strong> + +<br> +<font size=-1> +<i>In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. The links below go to the C function +descriptions, which serve as general descriptions for both. A button, +under <strong>Non-C API(s)</strong> at the end of the C function description, +opens an external browser window displaying the FORTRAN90-specific +information. You will probably want to adjust the size and location of +this external window so that both browser windows are visible and to +facilitate moving easily between them.</i> +</font> + +<table border=0> +<tr><td valign=top> + <li><a href="#Dataspace-Create">h5screate_f</a> + <li><a href="#Dataspace-Copy">h5scopy_f</a> + <li><a href="#Dataspace-Close">h5sclose_f</a> + <li><a href="#Dataspace-CreateSimple">h5screate_simple_f</a> + <li><a href="#Dataspace-IsSimple">h5sis_simple_f</a> + <li><a href="#Dataspace-OffsetSimple">h5soffset_simple_f</a> + <li><a href="#Dataspace-ExtentDims">h5sget_simple_extent_dims_f</a> +</td><td> </td><td valign=top> + <li><a href="#Dataspace-ExtentNdims">h5sget_simple_extent_ndims_f</a> + <li><a href="#Dataspace-ExtentNpoints">h5sget_simple_extent_npoints_f</a> + <li><a href="#Dataspace-ExtentType">h5sget_simple_extent_type_f</a> +<!-- NOT YET IMPLEMENTED (R1.2 -- 9908) + <li><a href="#Dataspace-ExtentClass">h5sextent_class_f</a> --> + <li><a href="#Dataspace-ExtentCopy">h5sextent_copy_f</a> + <li><a href="#Dataspace-SetExtentSimple">h5sset_extent_simple_f</a> + <li><a href="#Dataspace-SetExtentNone">h5sset_extent_none_f</a> + <li><a href="#Dataspace-SelectNpoints">h5sget_select_npoints_f</a> +<!--<li><a href="#Dataspace-SelectHyperNBlocks">h5sget_select_hyper_nblocks_f</a> --> +<!--<li><a href="#Dataspace-SelectHyperBlockList">h5sget_select_hyper_blocklist_f</a> --> +<!--<li><a href="#Dataspace-SelectElemNPoints">h5sget_select_elem_npoints_f</a> --> +<!--<li><a href="#Dataspace-SelectElemPointList">h5sget_select_elem_pointlist_f</a> --> +<!--<li><a href="#Dataspace-SelectBounds">h5sget_select_bounds_f</a> --> +</td><td> </td><td valign=top> + <li><a href="#Dataspace-SelectElements">h5sselect_elements_f</a> + <li><a href="#Dataspace-SelectAll">h5sselect_all_f</a> + <li><a href="#Dataspace-SelectNone">h5sselect_none_f</a> + <li><a href="#Dataspace-SelectValid">h5sselect_valid_f</a> + <li><a href="#Dataspace-SelectHyperslab">h5sselect_hyperslab_f</a> +</td></tr> +</table> + + +<p> The following H5S functions are included in the HDF5 specification, but have not yet been implemented. They are described in the <a href="Dataspaces.html">The Dataspace Interface (H5S)</a> section @@ -95,11 +150,10 @@ of the <cite>HDF5 User's Guide.</cite>. <li>H5Scommit <li>H5Sis_subspace <li>H5Slock - <li>H5Sopen </ul> </td><td> </td><td valign=top> <ul> - <li>H5Sselect_name + <li>H5Sopen <li>H5Sselect_op <li>H5Sselect_order </ul> @@ -134,6 +188,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5screate_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -173,6 +234,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5screate_simple_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -197,6 +265,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5scopy_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -205,7 +280,7 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Name:</strong> <a name="Dataspace-SelectElements">H5Sselect_elements</a> <dt><strong>Signature:</strong> <dd><em>herr_t</em> <code>H5Sselect_elements</code>(<em>hid_t </em><code>space_id</code>, - <em>dh5s_selopt_t</em> <code>op</code>, + <em>H5S_seloper_t</em> <code>op</code>, <em>const size_t</em> <code>num_elements</code>, <em>const hssize_t *</em><code>coord</code>[ ] ) @@ -248,7 +323,7 @@ of the <cite>HDF5 User's Guide.</cite>. <dl> <dt><em>hid_t</em> <code>space_id</code> <dd>Identifier of the dataspace. - <dt><em>dh5s_selopt_t</em> <code>op</code> + <dt><em>H5S_seloper_t</em> <code>op</code> <dd>operator specifying how the new selection is to be combined with the existing selection for the dataspace. <dt><em>const size_t</em> <code>num_elements</code> @@ -260,6 +335,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sselect_elements_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -287,6 +369,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sselect_all_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -309,6 +398,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sselect_none_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -316,7 +412,7 @@ of the <cite>HDF5 User's Guide.</cite>. <dl> <dt><strong>Name:</strong> <a name="Dataspace-SelectValid">H5Sselect_valid</a> <dt><strong>Signature:</strong> - <dd><em>hbool_t</em> <code>H5Sselect_valid</code>(<em>hid_t</em> <code>space_id</code>) + <dd><em>htri_t</em> <code>H5Sselect_valid</code>(<em>hid_t</em> <code>space_id</code>) <dt><strong>Purpose:</strong> <dd>Verifies that the selection is within the extent of the dataspace. <dt><strong>Description:</strong> @@ -330,10 +426,18 @@ of the <cite>HDF5 User's Guide.</cite>. selection is being reset. </dl> <dt><strong>Returns:</strong> - <dd>Returns <tt>TRUE</tt> if the selection is contained within - the extent and <tt>FALSE</tt> if it is not. - Returns returns a negative value on error conditions + <dd>Returns a positive value, for <code>TRUE</code>, + if the selection is contained within the extent + or <code>0</code> (zero), for <code>FALSE</code>, if it is not. + Returns a negative value on error conditions such as the selection or extent not being defined. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sselect_valid_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -356,6 +460,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns the number of elements in the dataspace if successful; otherwise returns 0. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sget_simple_extent_npoints_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -365,7 +476,7 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Signature:</strong> <dd><em>hssize_t</em> <code>H5Sget_select_npoints</code>(<em>hid_t</em> <code>space_id</code>) <dt><strong>Purpose:</strong> - <dd>Determines the number of elements in a dataspace. + <dd>Determines the number of elements in a dataspace selection. <dt><strong>Description:</strong> <dd><code>H5Sget_select_npoints</code> determines the number of elements in the current selection of a dataspace. @@ -377,6 +488,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns the number of elements in the selection if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sget_select_npoints_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -398,6 +516,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sget_simple_extent_ndims_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -427,6 +552,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sget_simple_extent_dims_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -453,6 +585,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns a dataspace class name if successful; otherwise H5S_NO_CLASS (-1). +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sget_simple_extent_type_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -497,6 +636,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sset_extent_simple_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -504,7 +650,7 @@ of the <cite>HDF5 User's Guide.</cite>. <dl> <dt><strong>Name:</strong> <a name="Dataspace-IsSimple">H5Sis_simple</a> <dt><strong>Signature:</strong> - <dd><em>hbool_t </em><code>H5Sis_simple</code>(<em>hid_t </em><code>space_id</code>) + <dd><em>htri_t </em><code>H5Sis_simple</code>(<em>hid_t </em><code>space_id</code>) <dt><strong>Purpose:</strong> <dd>Determines whether a dataspace is a simple dataspace. <dt><strong>Description:</strong> @@ -517,8 +663,16 @@ of the <cite>HDF5 User's Guide.</cite>. <dd>Identifier of the dataspace to query </dl> <dt><strong>Returns:</strong> - <dd>Returns TRUE or FALSE if Successful; - otherwise returns a negative value. + <dd>When successful, returns a positive value, for <code>TRUE</code>, + or <code>0</code> (zero), for <code>FALSE</code>. + Otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sis_simple_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -552,9 +706,18 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5soffset_simple_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> +<!-- NOT YET IMPLEMENTED (R1.2 -- 9908) + <hr> <dl> <dt><strong>Name:</strong> <a name="Dataspace-ExtentClass">H5Sextent_class</a> @@ -577,8 +740,15 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns a dataspace class name if successful; otherwise H5S_NO_CLASS (-1). +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sextent_class_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> </dl> +--> + <hr> <dl> @@ -605,6 +775,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sextent_copy_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -627,6 +804,13 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sset_extent_none_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -635,7 +819,7 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Name:</strong> <a name="Dataspace-SelectHyperslab">H5Sselect_hyperslab</a> <dt><strong>Signature:</strong> <dd><em>herr_t</em> <code>H5Sselect_hyperslab</code>(<em>hid_t</em> <code>space_id</code>, - <em>h5s_selopt_t</em><code>op</code>, + <em>H5S_seloper_t</em><code>op</code>, <em>const hssize_t *</em><code>start</code>, <em>const hsize_t *</em><code>stride</code> <em>const hsize_t *</em><code>count</code>, @@ -733,6 +917,247 @@ I/O is performed. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sselect_hyperslab_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SelectHyperNBlocks">H5Sget_select_hyper_nblocks</a> +<dt><strong>Signature:</strong> + <dd><em>hssize_t </em><code>H5Sget_select_hyper_nblocks</code>(<em>hid_t </em><code>space_id</code> + ) +<dt><strong>Purpose:</strong> + <dd>Get number of hyperslab blocks. +<dt><strong>Description:</strong> + <dd><code>H5Sget_select_hyper_nblocks</code> returns the + number of hyperslab blocks in the current dataspace selection. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>IN: Identifier of dataspace to query. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns the number of hyperslab blocks in + the current dataspace selection if successful. + Otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sget_select_hyper_nblocks_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SelectHyperBlockList">H5Sget_select_hyper_blocklist</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t </em><code>H5Sget_select_hyper_blocklist</code>(<em>hid_t </em><code>space_id</code>, + <em>hsize_t </em><code>startblock</code>, + <em>hsize_t </em><code>numblocks</code>, + <em>hsize_t *</em><code>buf</code> + ) +<dt><strong>Purpose:</strong> + <dd>Gets the list of hyperslab blocks currently selected. +<dt><strong>Description:</strong> + <dd><code>H5Sget_select_hyper_blocklist</code> returns a list of + the hyperslab blocks currently selected. Starting with the + <code>startblock</code>-th block in the list of blocks, + <code>numblocks</code> blocks are put into the user's buffer. + If the user's buffer fills up before <code>numblocks</code> + blocks are inserted, the buffer will contain only as many + blocks as fit. + <p> + The block coordinates have the same dimensionality (rank) + as the dataspace they are located within. The list of blocks + is formatted as follows: + <br> + <"start" coordinate>, immediately followed by + <br> + <"opposite" corner coordinate>, followed by + <br> + the next "start" and "opposite" coordinates, + <br> + etc. + <br> + until all of the selected blocks have been listed. + <p> + No guarantee is implied as the order in which blocks are listed. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>IN: Dataspace identifier of selection to query. + <dt><em>hsize_t </em><code>startblock</code> + <dd>IN: Hyperslab block to start with. + <dt><em>hsize_t </em><code>numblocks</code> + <dd>IN: Number of hyperslab blocks to get. + <dt><em>hsize_t *</em><code>buf</code> + <dd>OUT: List of hyperslab blocks selected. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sget_select_hyper_blocklist_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SelectElemNPoints">H5Sget_select_elem_npoints</a> +<dt><strong>Signature:</strong> + <dd><em>hssize_t </em><code>H5Sget_select_elem_npoints</code>(<em>hid_t </em><code>space_id</code> + ) +<dt><strong>Purpose:</strong> + <dd>Gets the number of element points in the current selection. +<dt><strong>Description:</strong> + <dd><code>H5Sget_select_elem_npoints</code> returns + the number of element points in the current dataspace selection. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>IN: Identifier of dataspace to query. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns the number of element points in the current dataspace selection if successful. + Otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sget_select_elem_npoints_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SelectElemPointList">H5Sget_select_elem_pointlist</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t </em><code>H5Sget_select_elem_pointlist</code>(<em>hid_t </em><code>space_id</code> + <em>hsize_t </em><code>startpoint</code>, + <em>hsize_t </em><code>numpoints</code>, + <em>hsize_t *</em><code>buf</code> + ) +<dt><strong>Purpose:</strong> + <dd>Gets the list of element points currently selected. +<dt><strong>Description:</strong> + <dd><code>H5Sget_select_elem_pointlist</code> returns the list of + element points in the current dataspace selection. Starting with + the <code>startpoint</code>-th point in the list of points, + <code>numpoints</code> points are put into the user's buffer. + If the user's buffer fills up before <code>numpoints</code> + points are inserted, the buffer will contain only as many + points as fit. + <p> + The element point coordinates have the same dimensionality (rank) + as the dataspace they are located within. The list of element points + is formatted as follows: + <br> + <coordinate>, followed by + <br> + the next coordinate, + <br> + etc. + <br> + until all of the selected element points have been listed. + <p> + The points are returned in the order they will be iterated through + when the selection is read/written from/to disk. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>IN: Dataspace identifier of selection to query. + <dt><em>hsize_t </em><code>startpoint</code> + <dd>IN: Element point to start with. + <dt><em>hsize_t </em><code>numpoints</code> + <dd>IN: Number of element points to get. + <dt><em>hsize_t *</em><code>buf</code> + <dd>OUT: List of element points selected. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sget_select_elem_pointlist_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SelectBounds">H5Sget_select_bounds</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t </em><code>H5Sget_select_bounds</code>(<em>hid_t </em><code>space_id</code> + <em>hsize_t *</em><code>start</code>, + <em>hsize_t *</em><code>end</code> + ) +<dt><strong>Purpose:</strong> + <dd>Gets the bounding box containing the current selection. +<dt><strong>Description:</strong> + <dd><code>H5Sget_select_bounds</code> retrieves the coordinates of + the bounding box containing the current selection and places + them into user-supplied buffers. + <p> + The <code>start</code> and <code>end</code> buffers must be large + enough to hold the dataspace rank number of coordinates. + <p> + The bounding box exactly contains the selection. + I.e., if a 2-dimensional element selection is currently + defined as containing the points (4,5), (6,8), and (10,7), + then the bounding box will be (4, 5), (10, 8). + <p> + The bounding box calculation includes the current offset of the + selection within the dataspace extent. + <p> + Calling this function on a <code>none</code> selection will + return <code>FAIL</code>. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>IN: Identifier of dataspace to query. + <dt><em>hsize_t *</em><code>start</code> + <dd>OUT: Starting coordinates of the bounding box. + <dt><em>hsize_t *</em><code>end</code> + <dd>OUT: Ending coordinates of the bounding box, + i.e., the coordinates of the diagonally opposite corner. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a negative value if successful; + otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sget_select_bounds_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -757,6 +1182,13 @@ I/O is performed. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5s_FORTRAN.html#h5sclose_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -800,7 +1232,7 @@ H5S <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 30 October 1998 +Last modified: 20 October 1999 </body> </html> diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 19c65ac..1ae41cd 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -51,6 +51,10 @@ H5T These functions create and manipulate the datatype which describes elements of a dataset. + +<p> +<strong>The C Interfaces:</strong> + <table border=0> <tr><td valign=top> <i>General Datatype Operations</i> @@ -63,10 +67,19 @@ of a dataset. <li><a href="#Datatype-Lock">H5Tlock</a> <li><a href="#Datatype-GetClass">H5Tget_class</a> <li><a href="#Datatype-GetSize">H5Tget_size</a> + <li><a href="#Datatype-GetSuper">H5Tget_super</a> <li><a href="#Datatype-Close">H5Tclose</a> <p> +<i>Conversion Functions</i> + <li><a href="#Datatype-Convert">H5Tconvert</a> + <li><a href="#Datatype-Find">H5Tfind</a> + <li><a href="#Datatype-SetOverflow">H5Tset_overflow</a> + <li><a href="#Datatype-GetOverflow">H5Tget_overflow</a> + <li><a href="#Datatype-Register">H5Tregister</a> + <li><a href="#Datatype-Unregister">H5Tunregister</a> </td><td> </td><td valign=top> -<i>Atomic Datatype</i> +<i>Atomic Datatype Properties</i> + <table><tr><td valign=top> <li><a href="#Datatype-SetSize">H5Tset_size</a> <li><a href="#Datatype-GetOrder">H5Tget_order</a> <li><a href="#Datatype-SetOrder">H5Tset_order</a> @@ -78,12 +91,11 @@ of a dataset. <li><a href="#Datatype-SetPad">H5Tset_pad</a> <li><a href="#Datatype-GetSign">H5Tget_sign</a> <li><a href="#Datatype-SetSign">H5Tset_sign</a> -</td><td valign=top> -<i>Properties</i> <li><a href="#Datatype-GetFields">H5Tget_fields</a> <li><a href="#Datatype-SetFields">H5Tset_fields</a> <li><a href="#Datatype-GetEbias">H5Tget_ebias</a> <li><a href="#Datatype-SetEbias">H5Tset_ebias</a> + </td><td valign=top> <li><a href="#Datatype-GetNorm">H5Tget_norm</a> <li><a href="#Datatype-SetNorm">H5Tset_norm</a> <li><a href="#Datatype-GetInpad">H5Tget_inpad</a> @@ -92,9 +104,12 @@ of a dataset. <li><a href="#Datatype-SetCset">H5Tset_cset</a> <li><a href="#Datatype-GetStrpad">H5Tget_strpad</a> <li><a href="#Datatype-SetStrpad">H5Tset_strpad</a> + </td></tr></table> <p> +<i>Variable-length Datatypes</i> + <li><a href="#Datatype-VLCreate">H5Tvlen_create</a> </td><td> </td><td valign=top> -<i>Properties of Compound Types</i> +<i>Compound Datatype Properties</i> <li><a href="#Datatype-GetNmembers">H5Tget_nmembers</a> <li><a href="#Datatype-GetMemberName">H5Tget_member_name</a> <li><a href="#Datatype-GetMemberOffset">H5Tget_member_offset</a> @@ -104,18 +119,117 @@ of a dataset. <li><a href="#Datatype-Pack">H5Tpack</a> <li><a href="#Datatype-InsertArray">H5Tinsert_array</a> <p> -<i>Conversion Functions</i> - <li><a href="#Datatype-Convert">H5Tconvert</a> - <li><a href="#Datatype-Find">H5Tfind</a> - <li><a href="#Datatype-SetOverflow">H5Tset_overflow</a> - <li><a href="#Datatype-GetOverflow">H5Tget_overflow</a> - <li><a href="#Datatype-RegisterHard">H5Tregister_hard</a> - <li><a href="#Datatype-RegisterSoft">H5Tregister_soft</a> - <li><a href="#Datatype-Unregister">H5Tunregister</a> +<i>Enumeration Datatypes</i> + <li><a href="#Datatype-EnumCreate">H5Tenum_create</a> + <li><a href="#Datatype-EnumInsert">H5Tenum_insert</a> + <li><a href="#Datatype-EnumNameOf">H5Tenum_nameof</a> + <li><a href="#Datatype-EnumValueOf">H5Tenum_valueof</a> + <li><a href="#Datatype-GetMemberValue">H5Tget_member_value</a> +<p> +<i>Opaque Datatypes</i> + <li><a href="#Datatype-SetTag">H5Tset_tag</a> + <li><a href="#Datatype-GetTag">H5Tget_tag</a> </td></tr> </table> <p> +<strong>The FORTRAN90 Interfaces:</strong> +<br> + +<font size=-1> +<i>In general, each FORTRAN90 subroutine performs exactly the same task +as the corresponding C function. The links below go to the C function +descriptions, which serve as general descriptions for both. A button, +under <strong>Non-C API(s)</strong> at the end of the C function description, +opens an external browser window displaying the FORTRAN90-specific +information. You will probably want to adjust the size and location of +this external window so that both browser windows are visible and to +facilitate moving easily between them.</i> +</font> + +<table border=0> +<tr><td valign=top> +<i>General Datatype Operations</i> +<!--<li><a href="#Datatype-Create">h5tcreate_f</a> --> + <li><a href="#Datatype-Open">h5topen_f</a> + <li><a href="#Datatype-Commit">h5tcommit_f</a> +<!--<li><a href="#Datatype-Committed">h5tcommitted_f</a> --> + <li><a href="#Datatype-Copy">h5tcopy_f</a> +<!--<li><a href="#Datatype-Equal">h5tequal_f</a> --> +<!--<li><a href="#Datatype-Lock">h5tlock_f</a> --> +</td><td valign=top> +<br> + <li><a href="#Datatype-GetClass">h5tget_class_f</a> + <li><a href="#Datatype-GetSize">h5tget_size_f</a> +<!--<li><a href="#Datatype-GetSuper">h5tget_super_f</a> --> + <li><a href="#Datatype-Close">h5tclose_f</a> +<!--<p> --> +<!--<i>Conversion Functions</i> --> +<!--<li><a href="#Datatype-Convert">h5tconvert_f</a> --> +<!--<li><a href="#Datatype-Find">h5tfind_f</a> --> +<!--<li><a href="#Datatype-SetOverflow">h5tset_overflow_f</a> --> +<!--<li><a href="#Datatype-GetOverflow">h5tget_overflow_f</a> --> +<!--<li><a href="#Datatype-Register">h5tregister_f</a> --> +<!--<li><a href="#Datatype-Unregister">h5tunregister_f</a> --> +</td><td> </td><td valign=top> +</td><td> </td><td valign=top> +</td><td> </td><td valign=top> +<i>Atomic Datatype Properties</i> +<!-- <table><tr><td valign=top> --> + <li><a href="#Datatype-SetSize">h5tset_size_f</a> + <li><a href="#Datatype-GetOrder">h5tget_order_f</a> + <li><a href="#Datatype-SetOrder">h5tset_order_f</a> +<!--<li><a href="#Datatype-GetPrecision">h5tget_precision_f</a> --> +<!--<li><a href="#Datatype-SetPrecision">h5tset_precision_f</a> --> +<!--<li><a href="#Datatype-GetOffset">h5tget_offset_f</a> --> +<!--<li><a href="#Datatype-SetOffset">h5tset_offset_f</a> --> +<!--<li><a href="#Datatype-GetPad">h5tget_pad_f</a> --> +<!--<li><a href="#Datatype-SetPad">h5tset_pad_f</a> --> +<!--<li><a href="#Datatype-GetSign">h5tget_sign_f</a> --> +<!--<li><a href="#Datatype-SetSign">h5tset_sign_f</a> --> +<!--<li><a href="#Datatype-GetFields">h5tget_fields_f</a> --> +<!--<li><a href="#Datatype-SetFields">h5tset_fields_f</a> --> +<!--<li><a href="#Datatype-GetEbias">h5tget_ebias_f</a> --> +<!--<li><a href="#Datatype-SetEbias">h5tset_ebias_f</a> --> +<!-- </td><td valign=top> --> +<!--<li><a href="#Datatype-GetNorm">h5tget_norm_f</a> --> +<!--<li><a href="#Datatype-SetNorm">h5tset_norm_f</a> --> +<!--<li><a href="#Datatype-GetInpad">h5tget_inpad_f</a> --> +<!--<li><a href="#Datatype-SetInpad">h5tset_inpad_f</a> --> +<!--<li><a href="#Datatype-GetCset">h5tget_cset_f</a> --> +<!--<li><a href="#Datatype-SetCset">h5tset_cset_f</a> --> +<!--<li><a href="#Datatype-GetStrpad">h5tget_strpad_f</a> --> +<!--<li><a href="#Datatype-SetStrpad">h5tset_strpad_f</a> --> +<!-- </td></tr></table> --> +<!--<p> --> +<!--<i>Variable-length Datatypes</i> --> +<!--<li><a href="#Datatype-VLCreate">h5tvlen_create_f</a> --> +<!--</td><td> </td><td valign=top> --> +<!--<i>Compound Datatype Properties</i> --> +<!--<li><a href="#Datatype-GetNmembers">h5tget_nmembers_f</a> --> +<!--<li><a href="#Datatype-GetMemberName">h5tget_member_name_f</a> --> +<!--<li><a href="#Datatype-GetMemberOffset">h5tget_member_offset_f</a> --> +<!--<li><a href="#Datatype-GetMemberDims">h5tget_member_dims_f</a> --> +<!--<li><a href="#Datatype-GetMemberType">h5tget_member_type_f</a> --> +<!--<li><a href="#Datatype-Insert">h5tinsert_f</a> --> +<!--<li><a href="#Datatype-Pack">h5tpack_f</a> --> +<!--<li><a href="#Datatype-InsertArray">h5tinsert_array_f</a> --> +<!--<p> --> +<!--<i>Enumeration Datatypes</i> --> +<!--<li><a href="#Datatype-EnumCreate">h5tenum_create_f</a> --> +<!--<li><a href="#Datatype-EnumInsert">h5tenum_insert_f</a> --> +<!--<li><a href="#Datatype-EnumNameOf">h5tenum_nameof_f</a> --> +<!--<li><a href="#Datatype-EnumValueOf">h5tenum_valueof_f</a> --> +<!--<li><a href="#Datatype-GetMemberValue">h5tget_member_value_f</a> --> +<!--<p> --> +<!--<i>Opaque Datatypes</i> --> +<!--<li><a href="#Datatype-SetTag">h5tset_tag_f</a> --> +<!--<li><a href="#Datatype-GetTag">h5tget_tag_f</a> --> +</td></tr> +</table> + + +<p> The Datatype interface, H5T, provides a mechanism to describe the storage format of individual data points of a data set and is hopefully designed in such a way as to allow new features to be @@ -162,13 +276,20 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>A file, group, or datatype identifier. + <dd>IN: A file or group identifier. <dt><em>const char *</em> <code>name</code> - <dd>A datatype name. + <dd>IN: A datatype name, defined within the file or group identified by <code>loc_id</code>. </dl> <dt><strong>Returns:</strong> <dd>Returns a named datatype identifier if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#h5topen_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -191,15 +312,22 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>A file or group identifier. + <dd>IN: A file or group identifier. <dt><em>const char *</em> <code>name</code> - <dd>A datatype name. + <dd>IN: A datatype name. <dt><em>hid_t</em> <code>type</code> - <dd>A datatype identifier. + <dd>IN: A datatype identifier. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#h5tcommit_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -207,7 +335,7 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl <dl> <dt><strong>Name:</strong> <a name="Datatype-Committed">H5Tcommitted</a> <dt><strong>Signature:</strong> - <dd><em>hbool_t</em><code>H5Tcommitted</code>(<em>hid_t</em> <code>type</code>) + <dd><em>htri_t</em><code>H5Tcommitted</code>(<em>hid_t</em> <code>type</code>) <dt><strong>Purpose:</strong> <dd>Determines whether a datatype is a named type or a transient type. <dt><strong>Description:</strong> @@ -220,12 +348,22 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl able to share the datatype with other datasets in the same file. <dt><strong>Parameters:</strong> <dl> - <dt>hid_t</em> <code>type</code> - <dd>Datatype identifier. + <dt><em>hid_t</em> <code>type</code> + <dd>IN: Datatype identifier. </dl> <dt><strong>Returns:</strong> - <dd>The successful return values are TRUE if committed, else FALSE. + <dd>When successful, returns a positive value, for <code>TRUE</code>, + if the datatype has been committed, or <code>0</code> (zero), + for <code>FALSE</code>, if the datatype has not been committed. Otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -250,31 +388,51 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl and the size of the array is </em><code>dim</code>. The new member's name, <code>name</code>, must be unique within the compound datatype. - The <code>offset</code> argument defines the start of the + The <code>offset</code> argument defines the byte offset of the start of the member in an instance of the compound datatype and <code>member_id</code> is the type identifier of the new member. The total member size should be relatively small. + <p> + The functionality of the <code>perm</code> parameter has + not yet been implemented. + Currently, <code>perm</code> is best set to <code>NULL</code>. + (When implemented, <code>perm</code> will specify the mapping + of dimensions within a struct. At that time, a + <code>NULL</code> value for <code>perm</code> will mean + no mappiing change is to take place. Thus, using a value + of <code>NULL</code> ensures that application behavior will + remain unchanged upon implementation of this functionality.) <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>parent_id</code> - <dd>Identifier of the parent compound datatype. + <dd>IN: Identifier of the parent compound datatype. <dt><em>const char *</em><code>name</code> - <dd>Name of new member. + <dd>IN: Name of new member. <dt><em>size_t</em> <code>offset</code> - <dd>Offset to start of new member within compound datatype. + <dd>IN: Offset to start of new member within compound datatype. <dt><em>int</em> <code>ndims</code> - <dd>Dimensionality of new member. + <dd>IN: Dimensionality of new member. + Valid values are <code>0</code> (zero) + through <code>4</code> (four). <dt><em>const size_t *</em><code>dim</code> - <dd>Size of new member array. + <dd>IN: Size of new member array. <dt><em>const int *</em><code>perm</code> - <dd>Pointer to buffer to store the permutation vector of + <dd>IN: Pointer to buffer to store the permutation vector of the field. <dt><em>hid_t</em> <code>member_id</code> - <dd>Identifier of the datatype of the new member. + <dd>IN: Identifier of the datatype of the new member. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -299,15 +457,23 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>src_id</code> - <dd>Identifier for the source datatype. + <dd>IN: Identifier for the source datatype. <dt><em>hid_t</em> <code>dst_id</code> - <dd>Identifier for the destination datatype. + <dd>IN: Identifier for the destination datatype. <dt><em>H5T_cdata_t **</em><code>pcdata</code> - <dd>Pointer to type conversion data. + <dd>IN: Pointer to type conversion data. </dl> <dt><strong>Returns:</strong> <dd>Returns a pointer to a suitable conversion function if successful. Otherwise returns NULL. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -353,6 +519,14 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -386,6 +560,14 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -412,6 +594,14 @@ H5Tget_overflow () <dd>Returns a pointer to an application-defined function if successful. Otherwise returns NULL; this can happen if no overflow handling function is registered. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -427,9 +617,16 @@ H5Tget_overflow () <dt><strong>Description:</strong> <dd><code>H5Tcreate</code> creates a new dataype of the specified class with the specified number of bytes. - Currently, only the <code>H5T_COMPOUND</code> datatype class is - supported with this function. Use <code>H5Tcopy</code> - to create integer or floating-point datatypes. + <p> + The following datatype classes are supported with this function: + <ul> + <li><code>H5T_COMPOUND</code> + <li><code>H5T_OPAQUE</code> + <li><code>H5T_ENUM</code> + </ul> + <p> + Use <code>H5Tcopy</code> to create integer or floating-point datatypes. + <p> The datatype identifier returned from this function should be released with <code>H5Tclose</code> or resource leaks will result. <dt><strong>Parameters:</strong> @@ -442,6 +639,54 @@ H5Tget_overflow () <dt><strong>Returns:</strong> <dd>Returns datatype identifier if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Datatype-VLCreate">H5Tvlen_create</a> +<dt><strong>Signature:</strong> + <dd><em>hid_t </em><code>H5Tvlen_create</code>(<em>hid_t </em><code>base_type_id</code> + ) +<dt><strong>Purpose:</strong> + <dd>Creates a new variable-length dataype. +<dt><strong>Description:</strong> + <dd><code>H5Tvlen_create</code> creates a new variable-length (VL) dataype. + <p> + The base datatype will be the datatype that the sequence is composed of, + characters for character strings, vertex coordinates for polygon lists, etc. + The base type specified for the VL datatype can be of any HDF5 datatype, + including another VL datatype, a compound datatype or an atomic datatype. + <p> + When necessary, use <code>H5Tget_super</code> to determine the base type + of the VL datatype. + <p> + The datatype identifier returned from this function should be + released with <code>H5Tclose</code> or resource leaks will result. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>base_type_id</code> + <dd>Base type of datatype to create. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns datatype identifier if successful; + otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -529,6 +774,13 @@ H5Tget_overflow () <dt><strong>Returns:</strong> <dd>Returns a datatype identifier if successful; otherwise returns a negative value +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#h5tcopy_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -536,7 +788,7 @@ H5Tget_overflow () <dl> <dt><strong>Name:</strong> <a name="Datatype-Equal">H5Tequal</a> <dt><strong>Signature:</strong> - <dd><em>hbool_t </em><code>H5Tequal</code>(<em>hid_t </em><code>type_id1</code>, + <dd><em>htri_t </em><code>H5Tequal</code>(<em>hid_t </em><code>type_id1</code>, <em>hid_t</em><code>type_id2</code> ) <dt><strong>Purpose:</strong> @@ -552,9 +804,18 @@ H5Tget_overflow () <dd>Identifier of datatype to compare. </dl> <dt><strong>Returns:</strong> - <dd>When successful, returns TRUE if the datatype identifiers - refer to the same datatype, else FALSE. + <dd>When successful, returns a positive value, for <code>TRUE</code>, + if the datatype identifiers refer to the same datatype, + or <code>0</code> (zero), for <code>FALSE</code>. Otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -581,6 +842,14 @@ H5Tget_overflow () <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -603,6 +872,8 @@ H5Tget_overflow () <li><code>H5T_BITFIELD</code> (<code>4</code>) <li><code>H5T_OPAQUE</code> (<code>5</code>) <li><code>H5T_COMPOUND</code> (<code>6</code>) + <li><code>H5T_ENUM</code> (<code>7</code>) + <li><code>H5T_REFERENCE</code> (<code>8</code>) </ul> <dt><strong>Parameters:</strong> <dl> @@ -612,6 +883,13 @@ H5Tget_overflow () <dt><strong>Returns:</strong> <dd>Returns datatype class identifier if successful; otherwise H5T_NO_CLASS (-1). +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#h5tget_class_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -633,6 +911,13 @@ H5Tget_overflow () <dt><strong>Returns:</strong> <dd>Returns the size of the datatype in bytes if successful; otherwise 0. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#h5tget_size_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -666,6 +951,45 @@ H5Tget_overflow () <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#h5tset_size_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Datatype-GetSuper">H5Tget_super</a> +<dt><strong>Signature:</strong> + <dd><em>hid_t</em> <code>H5Tget_super</code>(<em>hid_t</em> <code>type</code> + ) +<dt><strong>Purpose:</strong> + <dd>Returns the base datatype from which a datatype is derived. +<dt><strong>Description:</strong> + <dd><code>H5Tget_super</code> returns the base datatype from which the + datatype <code>type</code> is derived. + <P> + In the case of an enumeration type, the return value is an integer type. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>type</code> + <dd>Datatype identifier for the derived datatype. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns the datatype identifier for the base datatype if successful; + otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -698,6 +1022,13 @@ H5Tget_overflow () <dt><strong>Returns:</strong> <dd>Returns a byte order constant if successful; otherwise <code>H5T_ORDER_ERROR</code> (-1). +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#h5tget_order_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -731,6 +1062,13 @@ H5Tget_overflow () <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#h5tset_order_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -754,6 +1092,14 @@ H5Tget_overflow () <dt><strong>Returns:</strong> <dd>Returns the number of significant bits if successful; otherwise 0. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -788,6 +1134,14 @@ H5Tget_overflow () <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -855,6 +1209,14 @@ H5Tget_overflow () <dt><strong>Returns:</strong> <dd>Returns a positive offset value if successful; otherwise 0. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -932,6 +1294,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -970,6 +1340,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1005,6 +1383,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1033,6 +1419,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a valid sign type if successful; otherwise <code>H5T_SGN_ERROR</code> (-1). +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1063,6 +1457,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1100,6 +1502,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1139,6 +1549,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1160,6 +1578,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns the bias if successful; otherwise 0. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1184,6 +1610,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1214,6 +1648,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a valid normalization type if successful; otherwise <code>H5T_NORM_ERROR</code> (-1). +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1247,6 +1689,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1278,6 +1728,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a valid padding type if successful; otherwise <code>H5T_PAD_ERROR</code> (-1). +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1314,6 +1772,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1340,6 +1806,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a valid character set type if successful; otherwise <code>H5T_CSET_ERROR</code> (-1). +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1372,6 +1846,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1400,6 +1882,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a valid string padding type if successful; otherwise <code>H5T_STR_ERROR</code> (-1). +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1434,6 +1924,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1441,7 +1939,7 @@ zero. <dl> <dt><strong>Name:</strong> <a name="Datatype-GetNmembers">H5Tget_nmembers</a> <dt><strong>Signature:</strong> - <dd><em>intn </em><code>H5Tget_nmembers</code>(<em>hid_t </em><code>type_id</code> + <dd><em>int </em><code>H5Tget_nmembers</code>(<em>hid_t </em><code>type_id</code> ) <dt><strong>Purpose:</strong> <dd>Retrieves the number of fields in a compound datatype. @@ -1455,6 +1953,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns number of members datatype has if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1484,9 +1990,56 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a valid pointer if successful; otherwise NULL. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Datatype-GetMemberOffset">H5Tget_member_offset</a> +<dt><strong>Signature:</strong> + <dd><em>size_t</em> <code>H5Tget_member_offset</code>(<em>hid_t </em><code>type_id</code>, + <em>int</em> <code>memb_no</code> + ) +<dt><strong>Purpose:</strong> + <dd>Retrieves the offset of a field of a compound datatype. +<dt><strong>Description:</strong> + <dd><code>H5Tget_member_offset</code> retrieves the + byte offset of the beginning of a field within a + compound datatype with respect to the beginning + of the compound data type datum. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>type_id</code> + <dd>Identifier of datatype to query. + <dt><em>int</em> <code>memb_no</code> + <dd>Number of the field whose offset is requested. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns the byte offset of the field if successful; + otherwise returns <code>0</code> (zero). + Note that zero is a valid offset and that this function + will fail only if a call to <code>H5Tget_member_dims()</code> + fails with the same arguments. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> + <hr> <dl> <dt><strong>Name:</strong> <a name="Datatype-GetMemberDims">H5Tget_member_dims</a> @@ -1521,6 +2074,14 @@ zero. <dd>Returns the number of dimensions, a number from 0 to 4, if successful. Otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1547,6 +2108,14 @@ zero. <dd>Returns the identifier of a copy of the datatype of the field if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1556,7 +2125,7 @@ zero. <dt><strong>Signature:</strong> <dd><em>herr_t</em> <code>H5Tinsert</code>(<em>hid_t </em><code>type_id</code>, <em>const char *</em> <code>name</code>, - <em>off_t</em> <code>offset</code>, + <em>size_t</em> <code>offset</code>, <em>hid_t</em> <code>field_id</code> ) <dt><strong>Purpose:</strong> @@ -1569,16 +2138,15 @@ zero. in an instance of the compound datatype, and <code>field_id</code> is the datatype identifier of the new member. <P> - Note: All members of a compound datatype must be atomic; a - compound datatype cannot have a member which is a compound - datatype. + Note: Members of a compound datatype do not have to be atomic datatypes; + a compound datatype can have a member which is a compound datatype. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>type_id</code> <dd>Identifier of compound datatype to modify. <dt><em>const char *</em> <code>name</code> <dd>Name of the field to insert. - <dt><em>off_t</em> <code>offset</code> + <dt><em>size_t</em> <code>offset</code> <dd>Offset in memory structure of the field to insert. <dt><em>hid_t</em> <code>field_id</code> <dd>Datatype identifier of the field to insert. @@ -1586,6 +2154,14 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1608,43 +2184,71 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> <hr> <dl> -<dt><strong>Name:</strong> <a name="Datatype-RegisterHard">H5Tregister_hard</a> +<dt><strong>Name:</strong> <a name="Datatype-Register">H5Tregister</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5Tregister_hard</code>(<em>const char - *</em> <code>name</code>, <em>hid_t </em><code>src_id</code>, + <dd><em>herr_t</em> <code>H5Tregister</code>(<em>H5T_pers_t</em> <code>pers</code>, + <em>const char *</em> <code>name</code>, + <em>hid_t </em><code>src_id</code>, <em>hid_t</em> <code>dst_id</code>, <em>H5T_conv_t</em> <code>func</code> ) <dt><strong>Purpose:</strong> - <dd>Registers a hard conversion function. + <dd>Registers a conversion function. <dt><strong>Description:</strong> - <dd><code>H5Tregister_hard</code> registers a hard conversion function for a datatype - conversion path. The path is specified by the source and destination - datatypes <code>src_id</code> and <code>dst_id</code>. A conversion - path can only have one hard function, so <code>func</code> replaces any - previous hard function. + <dd><code>H5Tregister</code> registers a hard or soft conversion function + for a datatype conversion path. + <p> + The parameter <code>pers</code> indicates whether a conversion function + is <code>HARD</code> or <code>SOFT</code>. + <p> + A conversion path can have only one hard function. + When <code>pers</code> is <code>HARD</code>, <code>func</code> replaces + any previous hard function. + If <code>pers</code> is <code>HARD</code> and <code>func</code> + is the null pointer, then any hard function registered for this + path is removed. + <p> + When <code>pers</code> is <code>SOFT</code>, <code>H5Tregister</code> + adds the function to the end of the master soft list and replaces + the soft function in all applicable existing conversion paths. + Soft functions are used when determining which conversion function + is appropriate for this path. + <p> + The <code>name</code> is used only for debugging and should be a + short identifier for the function. <p> - If <code>func</code> is the null pointer then any hard function - registered for this path is removed from this path. The soft functions - are then used when determining which conversion function is appropriate - for this path. The <code>name</code> argument is used only - for debugging and should be a short identifier for the function. + The path is specified by the source and destination datatypes + <code>src_id</code> and <code>dst_id</code>. + For soft conversion functions, only the class of these types is important. <p> The type of the conversion function pointer is declared as: - <br> - <code>typedef</code> <em>herr_t </em>(<code>*H5T_conv_t</code>) (<em>hid_t </em><code>src_id</code>, + <dl> + <dd><code>typedef</code> <em>herr_t </em>(<code>*H5T_conv_t</code>) + (<em>hid_t </em><code>src_id</code>, <em>hid_t </em><code>dst_id</code>, <em>H5T_cdata_t *</em><code>cdata</code>, <em>size_t </em><code>nelmts</code>, <em>void *</em><code>buf</code>, - <em>void *</em><code>bkg)</code>; + <em>void *</em><code>bkg</code>); + </dl> <dt><strong>Parameters:</strong> <dl> + <dt><em>H5T_pers_t</em> <code>pers</code> + <dd><code>HARD</code> for hard conversion functions; + <code>SOFT</code> for soft conversion functions. <dt><em>const char *</em> <code>name</code> <dd>Name displayed in diagnostic output. <dt><em>hid_t</em> <code>src_id</code> @@ -1657,79 +2261,320 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> <hr> <dl> -<dt><strong>Name:</strong> <a name="Datatype-RegisterSoft">H5Tregister_soft</a> +<dt><strong>Name:</strong> <a name="Datatype-Unregister">H5Tunregister</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5Tregister_soft</code>(<em>const char - *</em> <code>name</code>, <em>H5T_class_t </em><code>src_cls</code>, - <em>H5T_class_t</em> <code>dst_cls</code>, - <em>H5T_conv_t</em> <code>func</code> + <dd><em>herr_t</em> <code>H5Tunregister</code>(<em>H5T_conv_t</em> <code>func</code> ) <dt><strong>Purpose:</strong> - <dd>Registers a soft conversion function. + <dd>Removes a conversion function from all conversion paths. <dt><strong>Description:</strong> - <dd><code>H5Tregister_soft</code> registers a soft conversion function by adding it to the - end of the master soft list and replacing the soft function in all - applicable existing conversion paths. The <code>name</code> - is used only for debugging and should be a short identifier - for the function. + <dd><code>H5Tunregister</code> removes a conversion function from all conversion paths. <P> - The type of the conversion function pointer is declared as: - <br> - <code>typedef</code> <em>herr_t </em>(<code>*H5T_conv_t</code>) (<em>hid_t </em><code>src_id</code>, - <em>hid_t </em><code>dst_id</code>, - <em>H5T_cdata_t *</em><code>cdata</code>, - <em>size_t </em><code>nelmts</code>, - <em>void *</em><code>buf</code>, - <em>void *</em><code>bkg)</code>; + The conversion function pointer type declaration is described in + <a href="#Datatype-Register">H5Tregister</a>. <dt><strong>Parameters:</strong> <dl> - <dt><em>const char *</em> <code>name</code> - <dd>Name displayed in diagnostic output. - <dt><em>H5T_class_t</em> <code>src_cls</code> - <dd>Identifier of source datatype class. - <dt><em>H5T_class_t</em> <code>dst_cls</code> - <dd>Identifier of destination datatype class. <dt><em>H5T_conv_t</em> <code>func</code> - <dd>Function to convert between source and destination datatypes. + <dd>Function to remove from conversion paths. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> <hr> <dl> -<dt><strong>Name:</strong> <a name="Datatype-Unregister">H5Tunregister</a> +<dt><strong>Name:</strong> <a name="Datatype-EnumCreate">H5Tenum_create</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5Tunregister</code>(<em>H5T_conv_t</em> <code>func</code> + <dd><em>hid_t</em> <code>H5Tenum_create</code>(<em>hid_t</em> <code>parent_id</code> ) <dt><strong>Purpose:</strong> - <dd>Removes a conversion function from all conversion paths. + <dd>Creates a new enumeration datatype. <dt><strong>Description:</strong> - <dd><code>H5Tunregister</code> removes a conversion function from all conversion paths. - <P> - The type of the conversion function pointer is declared as: - <br> - <code>typedef</code> <em>herr_t </em>(<code>*H5T_conv_t</code>) (<em>hid_t </em><code>src_id</code>, - <em>hid_t </em><code>dst_id</code>, - <em>H5T_cdata_t *</em><code>cdata</code>, - <em>size_t </em><code>nelmts</code>, - <em>void *</em><code>buf</code>, - <em>void *</em><code>bkg)</code>; + <dd><code>H5Tenum_create</code> creates a new enumeration datatype + based on the specified base datatype, <code>parent_id</code>, + which must be an integer type. <dt><strong>Parameters:</strong> <dl> - <dt><em>H5T_conv_t</em> <code>func</code> - <dd>Function to remove from conversion paths. + <dt><em>hid_t</em> <code>parent_id</code> + <dd>IN: Datatype identifier for the base datatype. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns the datatype identifier for the new enumeration datatype if successful; + otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Datatype-EnumInsert">H5Tenum_insert</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Tenum_insert</code>(<em>hid_t</em> <code>type</code>, + <em>const char</em> *<code>name</code>, + <em>void</em> *<code>value</code> + ) +<dt><strong>Purpose:</strong> + <dd>Inserts a new enumeration datatype member. +<dt><strong>Description:</strong> + <dd><code>H5Tenum_insert</code> inserts a + new enumeration datatype member into an enumeration datatype. + <p> + <code>type</code> is the enumeration datatype, + <code>name</code> is the name of the new member, and + <code>value</code> points to the value of the new member. + <p> + <code>name</code> and <code>value</code> must both + be unique within <code>type</code>. + <p> + <code>value</code> points to data which is of the + datatype defined when the enumeration datatype was created. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>type</code> + <dd>IN: Datatype identifier for the enumeration datatype. + <dt><em>const char</em> *<code>name</code> + <dd>IN: Name of the new member. + <dt><em>void</em> *<code>value</code> + <dd>IN: Pointer to the value of the new member. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Datatype-EnumNameOf">H5Tenum_nameof</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Tenum_nameof</code>(<em>hid_t</em> <code>type</code> + <em>void</em> *<code>value</code>, + <em>char</em> *<code>name</code>, + <em>size_t</em> <code>size</code> + ) +<dt><strong>Purpose:</strong> + <dd>Returns the symbol name corresponding to a specified member of an enumeration datatype. +<dt><strong>Description:</strong> + <dd><code>H5Tenum_nameof</code> finds the symbol name that + corresponds to the specified <code>value</code> + of the enumeration datatype <code>type</code>. + <p> + At most <code>size</code> characters of the symbol + name are copied into the <code>name</code> buffer. + If the entire symbol name and null terminator + do not fit in the <code>name</code> buffer, then as + many characters as possible are copied + (not null terminated) and the function fails. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>type</code> + <dd>IN: Enumeration datatype identifier. + <dt><em>void</em> *<code>value</code>, + <dd>IN: Value of the enumeration datatype. + <dt><em>char</em> *<code>name</code>, + <dd>OUT: Buffer for output of the symbol name. + <dt><em>size_t</em> <code>size</code> + <dd>IN: Anticipated size of the symbol name, in bytes (characters). + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful. + Otherwise returns a negative value + and, if <code>size</code> allows it, + the first character of <code>name</code> is + set to <code>NULL</code>. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Datatype-EnumValueOf">H5Tenum_valueof</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Tenum_valueof</code>(<em>hid_t</em> <code>type</code> + <em>char</em> *<code>name</code>, + <em>void</em> *<code>value</code> + ) +<dt><strong>Purpose:</strong> + <dd>Returns the value corresponding to a specified member of an enumeration datatype. +<dt><strong>Description:</strong> + <dd><code>H5Tenum_valueof</code> finds the value that + corresponds to the specified <code>name</code> + of the enumeration datatype <code>type</code>. + <p> + The <code>value</code> argument should be at least + as large as the value of <code>H5Tget_size(type)</code> + in order to hold the result. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>type</code> + <dd>IN: Enumeration datatype identifier. + <dt><em>const char</em> *<code>name</code>, + <dd>IN: Symbol name of the enumeration datatype. + <dt><em>void</em> *<code>value</code>, + <dd>OUT: Buffer for output of the value of the enumeration datatype. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Datatype-GetMemberValue">H5Tget_member_value</a> +<dt><strong>Signature:</strong> + <dd><em>hid_t</em> <code>H5Tget_member_value</code>(<em>hid_t</em> <code>type</code> + <em>int</em> <code>memb_no</code>, + <em>void</em> *<code>value</code> + ) +<dt><strong>Purpose:</strong> + <dd>Returns the value of an enumeration datatype member. +<dt><strong>Description:</strong> + <dd><code>H5Tget_member_value</code> returns the value of + the enumeration datatype member <code>memb_no</code>. + <p> + The member value is returned in a user-supplied buffer + pointed to by <code>value</code>. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>type</code> + <dd>IN: Datatype identifier for the enumeration datatype. + <dt><em>int</em> <code>memb_no</code>, + <dd>IN: Number of the enumeration datatype member. + <dt><em>void</em> *<code>value</code> + <dd>OUT: Pointer to a buffer for output of the + value of the enumeration datatype member. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Datatype-SetTag">H5Tset_tag</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Tset_tag</code>(<em>hid_t</em> <code>type_id</code> + <em>const char</em> *<code>tag</code> + ) +<dt><strong>Purpose:</strong> + <dd>Tags an opaque datatype. +<dt><strong>Description:</strong> + <dd><code>H5Tset_tag</code> tags an opaque datatype <code>type_id</code> + with a unique ASCII identifier <code>tag</code>. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>type_id</code> + <dd>IN: Datatype identifier for the opaque datatype to be tagged. + <dt><em>const char</em> *<code>tag</code> + <dd>IN: Unique ASCII string with which the opaque datatype is to be tagged. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Datatype-GetTag">H5Tget_tag</a> +<dt><strong>Signature:</strong> + <dd><em>char</em> *<code>H5Tget_tag</code>(<em>hid_t</em> <code>type_id</code> + ) +<dt><strong>Purpose:</strong> + <dd>Gets the tag associated with an opaque datatype. +<dt><strong>Description:</strong> + <dd><code>H5Tget_tag</code> returns the tag associated with + the opaque datatype <code>type_id</code>. + <P> + The tag is returned via a pointer to an + allocated string, which the caller must free. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>type_id</code> + <dd>Datatype identifier for the opaque datatype. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a pointer to an allocated string if successful; + otherwise returns <code>NULL</code>. +<!-- +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#xxx" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1753,6 +2598,13 @@ zero. <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. +<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5t_FORTRAN.html#h5tclose_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> </dl> @@ -1796,7 +2648,7 @@ H5T <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 30 October 1998 +Last modified: 20 October 1999 </body> </html> diff --git a/doc/html/Ragged.html b/doc/html/Ragged.html index 53d9f04..c8198fc 100644 --- a/doc/html/Ragged.html +++ b/doc/html/Ragged.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> <head> - <title>Ragged Arrays</title> + <title>Ragged Array Experimental Interface (H5RA)</title> </head> <body bgcolor="#FFFFFF"> @@ -20,47 +20,31 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> 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> @@ -97,7 +81,7 @@ Do not create any archives using this interface!</center> rows. The number of rows and the length of each row can be changed at any time (the current version does not support truncating an array by removing rows). All elements of the - ragged array have the same data type and, as with datasets, the + ragged array have the same datatype and, as with datasets, the data is type-converted between memory buffers and files. <p>The current implementation works best when most of the rows are @@ -138,7 +122,7 @@ Do not create any archives using this interface!</center> independently). The dataset creation property list <em>plist</em> defines the width of the <em>raw</em> dataset; a nominal row is considered to be the width of a chunk. The - <em>type</em> argument defines the data type which will be + <em>type</em> argument defines the datatype which will be stored in the file. A negative value is returned if the array cannot be created. @@ -172,7 +156,7 @@ Do not create any archives using this interface!</center> *<em>buf</em>[])</code> <dd>A set of ragged array rows beginning at <em>start_row</em> and continuing for <em>nrows</em> is written to the file, - converting the memory data type <em>type</em> to the file data + converting the memory datatype <em>type</em> to the file data type which was defined when the array was created. The number of elements to write from each row is specified in the <em>size</em> array and the data for each row is pointed to @@ -187,8 +171,8 @@ Do not create any archives using this interface!</center> *<em>buf</em>[])</code> <dd>A set of ragged array rows beginning at <em>start_row</em> and continuing for <em>nrows</em> is read from the file, - converting from the file data type which was defined when the - array was created to the memory data type <em>type</em>. The + converting from the file datatype which was defined when the + array was created to the memory datatype <em>type</em>. The number of elements to read from each row is specified in the <em>size</em> array and the buffers in which to place the results are pointed to by the <em>buf</em> array. On return, @@ -217,69 +201,46 @@ Do not create any archives using this interface!</center> </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - <a href="References.html">References</a> <br> + <a href="References.html">References</a> <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> 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> - <address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address> ---> -<!-- Created: Wed Aug 26 14:10:32 EDT 1998 --> -<!-- hhmts start --> -<!-- -Last modified: Fri Aug 28 14:27:19 EDT 1998 ---> -<!-- hhmts end --> <hr> <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 30 October 1998 +<!-- Created: Wed Aug 26 14:10:32 EDT 1998 --> +<!-- hhmts start --> +Last modified: 14 October 1999 +<!-- hhmts end --> </body> </html> diff --git a/doc/html/References.html b/doc/html/References.html index e985f8d..bb38f55 100644 --- a/doc/html/References.html +++ b/doc/html/References.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> <html> <head> -<title>References</title> +<title>Reference (H5R) and Identifier Interfaces (H5I)</title> </head> <body bgcolor="#FFFFFF"> @@ -20,47 +20,31 @@ </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - References <br> + References <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -206,7 +190,7 @@ The H5I function is also useful outside the context of references. <tr><td><code>H5I_GROUP</code></td> <td>Group objects</td></tr> <tr><td><code>H5I_DATATYPE</code></td> - <td>Data type objects</td></tr> + <td>Datatype objects</td></tr> <tr><td><code>H5I_DATASPACE</code></td> <td>Dataspace objects</td></tr> <tr><td><code>H5I_DATASET</code></td> @@ -219,7 +203,7 @@ The H5I function is also useful outside the context of references. This function was inspired by the need of users to figure out which type of object closing function (<code>H5Dclose</code>, <code>H5Gclose</code>, etc.) - to call after a call to <code>H5Ddereference</code>, + to call after a call to <code>H5Rdereference</code>, but it is also of general use. <p> </dl> @@ -494,7 +478,7 @@ Notes: <h2>Comments</h2> <pre> Reference types are atomic types and may be included as fields in compound - data types. + datatypes. There are (at least) three levels of reference strength: Weak - We allow the user to store any type of reference in an array @@ -502,14 +486,14 @@ Notes: could be a mix of Object, Dataset Region and Internal references) Medium - We force the user to stick with a particular type of reference within a dataset, but the datasets pointed to (with - Object and Dataset Region references) may be of any data type + Object and Dataset Region references) may be of any datatype or dataspace. Strong - We force the user to stick with a particular type of reference and Object and Dataset Region references must point to - datasets with the same data type. + datasets with the same datatype. Extra Strong - We force the user to stick with a particular type of reference and Object and Dataset Region references must point to - datasets with the same data type _and_ dataspace. + datasets with the same datatype <i>and</i> dataspace. The library is currently implemented with "medium" strength references. </pre> @@ -622,47 +606,31 @@ Notes: </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> + <a href="H5.user.html"><strong>HDF5 User's Guide:</strong></a> <br> + <a href="Files.html">Files</a> <a href="Datasets.html">Datasets</a> - <a href="Datatypes.html">Data Types</a> + <a href="Datatypes.html">Datatypes</a> <a href="Dataspaces.html">Dataspaces</a> <a href="Groups.html">Groups</a> - References <br> + References <a href="Attributes.html">Attributes</a> <a href="Properties.html">Property Lists</a> <a href="Errors.html">Error Handling</a> + <br> <a href="Filters.html">Filters</a> + <a href="Palettes.html">Palettes</a> <a href="Caching.html">Caching</a> - <br> <a href="Chunking.html">Chunking</a> + <a href="MountingFiles.html">Mounting Files</a> + <br> + <a href="Performance.html">Performance</a> <a href="Debugging.html">Debugging</a> <a href="Environment.html">Environment</a> <a href="ddl.html">DDL</a> + <br> <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> @@ -673,7 +641,7 @@ And in this document, the <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> </address> -Last modified: 30 October 1998 +Last modified: 14 October 1999 </body> </html> diff --git a/doc/html/Tools.html b/doc/html/Tools.html index 929cfcb..944ae87 100644 --- a/doc/html/Tools.html +++ b/doc/html/Tools.html @@ -176,7 +176,7 @@ These tools enable the user to examine HDF5 files interactively. <dt>- H5T_IEEE_F32BE, H5T_IEEE_F32LE, H5T_IEEE_F64BE, ... <li>string type <li>compound type - <dt>- named, unamed and transient compound type + <dt>- named, unnamed and transient compound type <dt>- integer, floating or string type member <li>reference type <dt>- object references diff --git a/doc/html/index.html b/doc/html/index.html index 0ad8191..1ed32ba 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -23,39 +23,64 @@ <CENTER> <table border=0 width=90%> -<tr><td rowspan=2 bgcolor="#BBFFFF" valign=top align=left width=25%> +<tr><td rowspan=4 bgcolor="#BBFFFF" valign=top align=left width=35%> <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> + <p> <!-- <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 + <p> + <dt><A HREF="http://hdf.ncsa.uiuc.edu/HDF5/HDF5_overview/index.html">HDF5 Overview</A> + <dd>HDF5 library and development effort (slide show) + <p> + <dt><A HREF="http://hdf.ncsa.uiuc.edu/HDF5/doc_dev_snapshot/index.html">HDF5 Doc Development</A> + <dd>Bugfixes for this release (if any); Snapshot of the next + <p> +<!-- + <dt><A HREF="http://hdf.ncsa.uiuc.edu/HDF5/doc_dev_snapshot/index.html">Printable + and Searchable Docs</A> + <dd>PDF and PS versions of selected HDF5 docs (*) +--> </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> +<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> +<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> +<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> +<dt><A HREF="H5.format.html">HDF5 File Format Specification</A> <dd>The complete specification of the HDF5 file format +<dt><A HREF="Glossary.html">HDF5 Glossary</A> * + <dd>A glossary of terms as they are used in HDF5 +</dl> +</td></tr><tr><td bgcolor="#FFFFFF"> +</td><td bgcolor="#BBFFFF" valign=top align=left> +<dl> +<dt><A HREF="Tutor/index.html">HDF5 Tutorial</a> * + <dd>A tutorial introduction the HDF5 +</dl> +</td></tr><tr><td bgcolor="#FFFFFF"> +</td><td bgcolor="#BBFFFF" valign=top align=left> +<dl> + <dt><A HREF="PSandPDF/index.html">Printable and Searchable Docs</A> + <dd>PDF and PS versions of selected HDF5 docs (*) </dl> </td></tr><tr><td bgcolor="#FFFFFF"> </td><td bgcolor="#BBFFFF" valign=top align=left> @@ -89,7 +114,7 @@ <p> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <!-- hhmts start --> -Last modified: 16 Sept 1998 +Last modified: 16 October 1999 <!-- hhmts end --> </font> |