mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-03-31 17:10:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

[svn-r680] H5.user.html

Browse Source 
A little editorial cleanup.
   Added link to Ragged.html, Ragged Arrays.
   Added link to Environment.html, Environmental Variables and
	Configuration Parameters.
   Added link to Copyright.html.

Ragged.html
   Added "Use at your own risk" notice.

Environment.html
   New file for environmental variables and configuration parameters.

Datatypes.html
   Added the following datatypes:
	H5T_NATIVE_HSIZE
	H5T_NATIVE_HSSIZE
	H5T_NATIVE_HERR
	H5T_NATIVE_HBOOL
   Section 8, "Data Conversions"
	Added named link tag to catch hyperlink from RM.
	Revised "Note:" to emphasize limited inate data-conversion capability.

Copyright.html
   New file.
   Copyright statement, linked into User's Guide and Reference Manual.

Glossary.html
   Unlinked for Beta.

General
   Changed email link at bottom of "user guide level documents"
	(as contrasted with "developer guide level documents"
	listed on the lower half of the User's Guide front page)
	to HDF Help Desk, hdfhelp@ncsa.uiuc.edu.
   Changed the following function names:
	From:                       To:
	H5version                   H5get_libversion
	H5vers_check                H5check_version
	H5Anum_attrs                H5Aget_num_attrs
	H5Fget_create_template()    H5Fget_create_plist()
	H5Fget_access_template()    H5Fget_access_plist()
	H5Gstat                     H5Gget_stat
	H5Sextent_npoints           H5Sget_simple_extent_npoints
	H5Sextent_ndims             H5Sget_simple_extent_ndims
	H5Sextent_dims              H5Sget_simple_extent_dims
	H5Sget_class                H5Sget_simple_extent_type
	H5Sselect_npoints           H5Sget_select_npoints
This commit is contained in:
Frank Baker 1998-09-09 17:48:37 -05:00
parent 2a7c272a69
commit dd99ecc1bc
14 changed files with 238 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/html/Attributes.html
View File

@ -165,13 +165,18 @@
This function returns the length of the attribute's name (which may be
longer than <em>buf_size</em>) on success or negative for failure.
<br><br>
<dt><code>int H5Anum_attrs (hid_t <em>loc_id</em>)</code>
<dt><code>int H5Aget_num_attrs (hid_t <em>loc_id</em>)</code>
<dd>This function returns the number of attributes attached to a dataset or
group, <em>loc_id</em>.
This function returns non-negative for success or negative for failure.
</dl>
<hr>
<address><a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Support</a></address>
<hr>
<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Last modified: 3 September 1998
</body>
</html>

12
doc/html/Caching.html
View File

@ -72,11 +72,23 @@
the pointer arguments may be null pointers.
</dl>
<!--
<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: 9 September 1998
</body>
</html>

12
doc/html/Datasets.html
View File

@ -829,11 +829,23 @@ H5Pset_external (plist, "scan3.data", 0, 16);
</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: 9 September 1998
</body>
</html>

26
doc/html/Dataspaces.html
View File

@ -298,7 +298,7 @@ failure.
</DD>
<DT>
<TT>hsize_t H5Sextent_npoints (hid_t <I>space</I>)</TT></DT>
<TT>hsize_t H5Sget_simple_extent_npoints (hid_t <I>space</I>)</TT></DT>
<DD>
This function determines the number of elements in a dataspace. For example, a
@ -308,7 +308,7 @@ Returns the number of elements in the dataspace, negative on failure.
</DD>
<DT>
<TT>int H5Sextent_ndims (hid_t <I>space</I>)</TT></DT>
<TT>int H5Sget_simple_extent_ndims (hid_t <I>space</I>)</TT></DT>
<DD>
This function determines the dimensionality (or rank) of a dataspace.
@ -316,7 +316,7 @@ Returns the number of dimensions in the dataspace, negative on failure.
</DD>
<DT>
<TT>herr_t H5Sextent_dims (hid_t <I>space</I>, hsize_t *<I>dims</I>,
<TT>herr_t H5Sget_simple_extent_dims (hid_t <I>space</I>, hsize_t *<I>dims</I>,
hsize_t *<I>max</I>)</TT></DT>
<DD>
@ -481,7 +481,7 @@ the selection or extent is not defined).
</DD>
<DT>
<TT>hsize_t H5Sselect_npoints (hid_t <I>space</I>)</TT></DT>
<TT>hsize_t H5Sget_select_npoints (hid_t <I>space</I>)</TT></DT>
<DD>
This function determines the number of elements in the current selection
@ -556,13 +556,27 @@ is returned.
</DL>
<HR>
<!--
<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&nbsp;<!-- hhmts end -->
<BR>
-->
<!-- Created: Thu Dec 4 14:57:32 EST 1997 --><!-- hhmts start -->Last
<!--
modified: Thu May 28 15:12:04 EST 1998&nbsp;
-->
<!-- hhmts end -->
<hr>
<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Last modified: 3 September 1998
</BODY>
</HTML>

47
doc/html/Datatypes.html
View File

@ -777,6 +777,22 @@
<td><code>H5T_NATIVE_LDOUBLE</code></td>
<td><code>long double</code></td>
</tr>
<tr>
<td><code>H5T_NATIVE_HSIZE</code></td>
<td><code>hsize_t</code></td>
</tr>
<tr>
<td><code>H5T_NATIVE_HSSIZE</code></td>
<td><code>hssize_t</code></td>
</tr>
<tr>
<td><code>H5T_NATIVE_HERR</code></td>
<td><code>herr_t</code></td>
</tr>
<tr>
<td><code>H5T_NATIVE_HBOOL</code></td>
<td><code>hbool_t</code></td>
</tr>
</table>
</center>
@ -1024,7 +1040,9 @@ hid_t dset4 = H5Dcreate (file, "dset4", t2, space, H5P_DEFAULT);
</table>
</center>
<a name="Datatypes-DataConversion">
<h2>8. Data Conversion</h2>
</a>
<p>The library is capable of converting data from one type to
another and does so automatically when reading or writing the
@ -1049,11 +1067,18 @@ hid_t dset4 = H5Dcreate (file, "dset4", t2, space, H5P_DEFAULT);
conversion functions than calling an application-defined
conversion function).
<p><b>Note:</b> The alpha version of the library does not contain
a full set of conversions. It can convert from one integer
format to another and one struct to another. It can also
perform byte swapping when the source and destination types are
otherwise the same.
<p><b>Note:</b> The HDF5 library contains a deliberately limited
set of conversion routines. It can convert from one integer
format to another, from one floating point format to another,
and from one struct to another. It can also perform byte
swapping when the source and destination types are otherwise
the same. The library does not contain any functions for
converting data between integer and floating point formats.
It is anticipated that some users will find it necessary to
develop float to integer or integer to float conversion functions
at the application level; if they wish, users are invited to
submit those functions to be considered for inclusion in future
versions of the library.
<p>A conversion path contains a source and destination data type
and each path contains a <em>hard</em> conversion function
@ -1383,12 +1408,24 @@ H5Tregister_soft ("cus2be", H5T_INTEGER, H5T_INTEGER, cray_ushort2be);
conversion path whether that conversion path was actually used
or not.
<!--
<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: Thu Dec 4 14:57:32 EST 1997 -->
<!-- hhmts start -->
<!--
Last modified: Tue Sep 8 14:43:32 EDT 1998
-->
<!-- hhmts end -->
<hr>
<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
</address>
Last modified: 9 September 1998
</body>
</html>

12
doc/html/Debugging.html
View File

@ -401,11 +401,23 @@ H5E.c:336: warning: trace info was not inserted
modified.
<!--
<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: 9 September 1998
</body>
</html>

12
doc/html/Errors.html
View File

@ -271,11 +271,23 @@ H5Ewalk_cb(int n, H5E_error_t *err_desc, void *client_data)
<!--
<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: 9 September 1998
</body>
</html>

12
doc/html/Files.html
View File

@ -527,12 +527,24 @@
</dl>
<!--
<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: 9 September 1998
</body>
</html>

12
doc/html/Filters.html
View File

@ -459,11 +459,23 @@ H5Z: filter statistics accumulated over life of library:
</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: Thu Aug 6 14:58:42 EDT 1998
-->
<!-- hhmts end -->
<hr>
<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
</address>
Last modified: 9 September 1998
</body>
</html>

12
doc/html/Groups.html
View File

@ -304,11 +304,23 @@
string is returned.
</dl>
<!--
<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: 9 September 1998
</body>
</html>

41
doc/html/H5.user.html
View File

@ -16,17 +16,17 @@
A guide to the H5F interface.
<li><a href="Datasets.html">Datasets</a> -
A guide to the H5D interface.
<li><a href="Datatypes.html">Data types</a> -
<li><a href="Datatypes.html">Data Types</a> -
A guide to the H5T interface.
<li><a href="Dataspaces.html">Data spaces</a> -
<li><a href="Dataspaces.html">Data Spaces</a> -
A guide to the H5S interface.
<li><a href="Groups.html">Groups</a> -
A guide to the H5G interface.
<li><a href="Attributes.html">Attributes</a> -
A guide to the H5A interface.
<li><a href="Properties.html">Property lists</a> -
<li><a href="Properties.html">Property Lists</a> -
A guide to the H5P interface.
<li><a href="Errors.html">Error handling</a> -
<li><a href="Errors.html">Error Handling</a> -
A guide to the H5E interface.
<li><a href="Filters.html">Filters</a> -
A guide to the H5Z interface.
@ -34,6 +34,12 @@
A guide for meta and raw data caching.
<li><a href="Debugging.html">Debugging</a> -
A guide to debugging HDF5 API calls.
<li><a href="Environment.html">Environment Variables and
Configuration Parameters</a> -
A list of HDF5 environment variables and configuration parameters.
<li><a href="Ragged.html">Ragged Arrays</a> -
A guide to the H5R interface.
&nbsp;&nbsp;<em><font color=red>(Experimental)</font></em>
</ul>
<p>The following documents form a loosely organized developer's guide to
@ -46,28 +52,45 @@
A description of HDF5 version numbers.
<li><a href="IOPipe.html">I/O Pipeline</a> -
A description of the raw data I/O pipeline.
<li><a href="ExternalFiles.html">Working with external files</a> -
<li><a href="ExternalFiles.html">Working with External Files</a> -
A guide to the use of multiple files with HDF5.
<li><a href="Big.html">Large Datasets</a> -
A guide to accessing large datasets on small computers.
<li><a href="MemoryManagement.html">Memory management</a> -
<li><a href="MemoryManagement.html">Memory Management</a> -
A white paper about memory management issues in HDF5.
<li><a href="Coding.html">Coding style</a> -
<li><a href="Coding.html">Coding Style</a> -
A white paper about coding style in the HDF5 library code.
<li><a href="compat.html">HDF4/HDF5 compatibility</a> -
<li><a href="compat.html">HDF4/HDF5 Compatibility</a> -
A white paper about compatibility issues between HDF4 and HDF5.
<li><a href="study.html">Chunking performance study</a> -
<li><a href="study.html">Chunking Performance Study</a> -
A white paper describing the HDF5 chunking performance.
</ul>
<!--
<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>
<table width=100% border=0>
<tr><td align=left valign=top>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Last modified: 9 September 1998
</td><td align=right valign=top>
<a href="Copyright.html">Copyright</a>&nbsp;&nbsp;
</td></tr>
</table>
</body>
</html>

12
doc/html/Properties.html
View File

@ -70,12 +70,24 @@
are defined above for <code>H5Pcreate()</code>.
</dl>
<!--
<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: 9 September 1998
</body>
</html>

25
doc/html/Ragged.html
View File

@ -7,6 +7,19 @@
<body>
<h1>Ragged Arrays</h1>
<table border=1>
<tr><th align=left>
<font color=red>
The H5R Interface is strictly experimental at this time;
the interface may change dramatically or support for ragged arrays
may be unavailable in future in releases. As a result, future releases
may be unable to retrieve data stored with this interface.
<p><center>Use these functions at your own risk!<br>
Do not create any archives using this interface!</center>
</font>
</th></tr>
</table>
<h2>1. Introduction</h2>
<p><b>Ragged arrays should be considered alpha quality. They were
@ -128,11 +141,23 @@
with <em>buf</em> containing the original input values.
</dl>
<!--
<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: 8 September 1998
</body>
</html>

18
doc/html/Version.html
View File

@ -94,7 +94,7 @@
include file and determine the version of the include files.
<br><br>
<dt><code>herr_t H5version (unsigned *<em>majnum</em>, unsigned
<dt><code>herr_t H5get_libversion (unsigned *<em>majnum</em>, unsigned
*<em>minnum</em>, unsigned *<em>relnum</em>)</code>
<dd>This function returns through its arguments the version
numbers for the library to which the application is linked.
@ -112,20 +112,32 @@
standard error stream and aborts with a core dump.
<br><br>
<dt><code>herr_t H5vers_check (unsigned <em>majnum</em>,
<dt><code>herr_t H5check_version (unsigned <em>majnum</em>,
unsigned <em>minnum</em>, unsigned <em>relnum</em>)</code>
<dd>This function is called by the <code>H5check()</code> macro
with the include file version constants. The function
compares its arguments to the result returned by
<code>H5version()</code> and if a mismatch is detected prints
<code>H5get_libversion()</code> and if a mismatch is detected prints
an error message on the standard error stream and aborts.
</dl>
<!--
<hr>
<address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address>
-->
<!-- Created: Wed Apr 22 11:24:40 EDT 1998 -->
<!-- hhmts start -->
<!--
Last modified: Mon Jul 20 11:42:20 EDT 1998
-->
<!-- hhmts end -->
<hr>
<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Last modified: 3 September 1998
</body>
</html>