mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-02-11 16:01:00 +08:00
cd3b105997
Intro
======
H5.intro.html
Major rewrite to Groups section. New Example 7 (groups).
Added TOC and requisite links.
Numbered sections.
Labelled figures and centered those that were not.
Fixed table formatting.
===========
User Guide
===========
H5.user.html
Linked in Chunking.html.
Linked in References.html.
Linked in DDL.html.
Chunking.html
Minor edits.
DDL.html
References.html
New documents.
Datatypes.html
Added "R Reference" to base name description and
"H5T_STD_ROBJ -- Reference to an entire object
in a file" to list of datatype names.
Files.html
H5Fflush
Added scope parameter.
Groups.html
Removed references to "current working group."
Removed H5Gpush, H5Gpop, and H5Gset functions.
Removed note that H5Glink and H5Gunlink were not implemented.
=================
Reference Manual
=================
RM_*.html and Tools.html
Updated Reference Manual internal cross-linking (the link
banner at the top and bottom of each page).
Changed
Returns SUCCEED (0) if successful;
otherwise FAIL (-1).
to read
Returns a non-negative value if successful;
otherwise returns a negative value.
and several derived changes where circumstances differred
only slightly.
Minor copy edits throughout.
RM_H5.html
Corrected H5open "Purpose" statement.
RM_H5A.html
Changed H5Aget_name return type to hssize_t.
RM_H5F.html
H5Fflush
Added scope parameter.
Added H5Freopen.
RM_H5Front.html
Reordered listing of interfaces to alphabetical order (H5,
H5A, H5D, ...)
Added H5I, H5R, and H5RA.
RM_H5G.html
H5Gopen
Edited "Description."
H5Gget_objinfo
Added named datatype to list of valid values for loc_id.
RM_H5I.html Identifier Interface
New section.
RM_H5P.html
Added H5Pset_fill_value and H5Pget_fill_value.
Several minor copy edits.
RM_H5R.html Reference Interface
New section.
H5RA.html
Essentially a new section. It was in the tree previously,
but it did not actually have content.
RM_H5S.html
Changed H5Sget_select_npoints return type to hssize_t.
Tools.html
Updated h5dump documentation.
136 lines
4.3 KiB
HTML
136 lines
4.3 KiB
HTML
<html>
|
|
<head><title>
|
|
HDF5/H5Z Draft API Specification
|
|
</title></head>
|
|
|
|
<body>
|
|
|
|
<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_H5I.html">H5I</a>
|
|
<a href="RM_H5P.html">H5P</a>
|
|
<a href="RM_H5R.html">H5R</a>
|
|
<a href="RM_H5RA.html">H5RA</a>
|
|
<a href="RM_H5S.html">H5S</a>
|
|
<a href="RM_H5T.html">H5T</a>
|
|
H5Z
|
|
<a href="Tools.html">Tools</a>
|
|
<!--
|
|
<a href="Glossary.html">Glossary</a>
|
|
-->
|
|
</center>
|
|
<hr>
|
|
|
|
<center>
|
|
<h1>H5Z: Compression Interface</h1>
|
|
</center>
|
|
|
|
<h2>Compression API Functions</h2>
|
|
|
|
This function enable the user to configure a new compression
|
|
method for the local environment.
|
|
|
|
<table border=0>
|
|
<tr><td valign=top>
|
|
<ul>
|
|
<li><a href="#Compression-Register">H5Zregister</a>
|
|
</ul>
|
|
</td><td> </td><td valign=top>
|
|
<ul>
|
|
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p>
|
|
HDF5 supports compression of raw data by compression methods
|
|
built into the library or defined by an application.
|
|
A compression method is associated with a dataset when the dataset is
|
|
created and is applied independently to each storage chunk of the dataset.
|
|
The dataset must use the <code>H5D_CHUNKED</code> storage layout.
|
|
<p>
|
|
The HDF5 library does not support compression for contiguous datasets
|
|
because of the difficulty of implementing random access for partial I/O.
|
|
Compact dataset compression is not supported because it would not produce
|
|
significant results.
|
|
<p>
|
|
See <a href="Compression.html"><cite>Compression</cite></a> in the
|
|
<cite>HDF5 User's Guide</cite> for further information.
|
|
|
|
<hr>
|
|
<dl>
|
|
<dt><strong>Name:</strong> <a name="Compression-Register">H5Zregister</a>
|
|
<dt><strong>Signature:</strong>
|
|
<dd><em>herr_t</em> <code>H5Zregister</code>(<em>H5Z_method_t</em> <code>method</code>,
|
|
<em>const char *</em><code>name</code>,
|
|
<em>H5Z_func_t</em><code>cfunc</code>,
|
|
<em>H5Z_func_t</em> <code>ufunc</code>
|
|
)
|
|
<dt><strong>Purpose:</strong>
|
|
<dd> Registers new compression and uncompression functions for a
|
|
method specified by a method number.
|
|
<dt><strong>Description:</strong>
|
|
<dd><code>H5Zregister</code> registers new compression and uncompression
|
|
functions for a method specified by a method number, <code>method</code>.
|
|
<code>name</code> is used for debugging and may be the null pointer.
|
|
Either or both of <code>cfunc</code> (the compression function) and
|
|
<code>ufunc</code> (the uncompression method) may be null pointers.
|
|
<p>
|
|
The statistics associated with a method number are not reset
|
|
by this function; they accumulate over the life of the library.
|
|
<dt><strong>Parameters:</strong>
|
|
<dl>
|
|
<dt><em>H5Z_method_t</em> <code>method</code>
|
|
<dd>Number specifying compression method.
|
|
<dt><em>const char *</em><code>name</code>
|
|
<dd>Name associated with the method number.
|
|
<dt><em>H5Z_func_t</em> <code>cfunc</code>
|
|
<dd>Compression method.
|
|
<dt><em>H5Z_func_t</em> <code>ufunc</code>
|
|
<dd>Uncompression method.
|
|
</dl>
|
|
<dt><strong>Returns:</strong>
|
|
<dd>Returns a non-negative value if successful;
|
|
otherwise returns a negative value.
|
|
</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_H5I.html">H5I</a>
|
|
<a href="RM_H5P.html">H5P</a>
|
|
<a href="RM_H5R.html">H5R</a>
|
|
<a href="RM_H5RA.html">H5RA</a>
|
|
<a href="RM_H5S.html">H5S</a>
|
|
<a href="RM_H5T.html">H5T</a>
|
|
H5Z
|
|
<a href="Tools.html">Tools</a>
|
|
<!--
|
|
<a href="Glossary.html">Glossary</a>
|
|
-->
|
|
</center>
|
|
<hr>
|
|
|
|
<address>
|
|
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
|
|
|
|
<br>
|
|
Last modified: 27 October 1998
|
|
|
|
</body>
|
|
</html>
|