hdf5/doc/html/ADGuide/Changes.html
Frank Baker 4146d79af1 [svn-r7159]
Purpose:
    Changed "HDF5 User's Guide" links (in navigation bars, primarily)
    to point to new user's guide, which will reside for a while yet on
    the HDF server.
    The old user's guide will still go out with the distribution under
    the label "HDF5 User's Guide, Release 1.4.5."

Platforms tested:
    IE 5
2003-07-03 14:40:03 -05:00

1056 lines
38 KiB
HTML
Executable File

<html>
<head>
<title>HDF5 Software Changes</title>
<!-- #BeginLibraryItem "/ed_libs/styles_Gen.lbi" -->
<!--
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
-->
<link href="../ed_styles/GenElect.css" rel="stylesheet" type="text/css">
<!-- #EndLibraryItem --></head>
<body bgcolor="#FFFFFF">
<!-- #BeginLibraryItem "/ed_libs/NavBar_ADevG.lbi" --><hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="../index.html">HDF5 documents and links</a>&nbsp;<br>
<a href="../H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/UG/index.html">HDF5 User's Guide</a>&nbsp;<br>
<a href="../RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;<br>
<a href="../ADGuide.html">HDF5 Application Developer's Guide</a>&nbsp;<br>
</td></tr>
</table>
</center>
<hr>
<!-- #EndLibraryItem --><center>
<h1>HDF5 Software Changes from Release to Release</h1>
</center>
<!-- Document API CHANGES ONLY in this file. -->
This document is intended to assist application developers who must keep
an application synchronized with the HDF5 library or related software.
<h2>Release 1.6.0 (current release) versus Release 1.4.5</h2>
<dir>
This section lists the API-level changes that have been made in the
transition from the HDF5 Release 1.4.<i>x</i> series to Release 1.6.0.
<h3>New Functions and Tools</h3>
<dl>
<dt>The following functions are new for Release 1.6.0 and are included in the
<a href="../RM_H5Front.html"><cite>HDF5 Reference Manual</cite></a>.
<dd>
<table border="0">
<tr>
<td align="left" valign="top"><code>H5Dget_offset</code></td>
<td align="left" valign="top"><em>hsize_t</em> <code>H5Dget_offset</code> (<em>hid_t </em><code>dset_id</code>)</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Dget_space_status</code></td>
<td align="left" valign="top"><em>hid_t</em> <code>H5Dget_space_status</code> (<em>hid_t</em>
<code>dset_id</code>, <em>H5D_space_status_t *</em><code>status</code>)
</td>
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Fget_obj_ids</code></td>
<td align="left" valign="top">
<em>int </em><code>H5Fget_obj_ids</code> (<em>hid_t</em> <code>file_id</code>,
<em>unsigned int</em> <code>types</code>,
<em>int</em> <code>max_objs</code>, <em>hid_t *</em><code>obj_id_list</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Fget_vfd_handle</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Fget_vfd_handle</code> (<em>hid_t</em> <code>file_id</code>,
<em>hid_t</em> <code>fapl_id</code>, <em>void *</em><code>file_handle</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Gget_num_objs</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Gget_num_objs</code> (<em>hid_t</em> <code>loc_id</code>,
<em>hsize_t* </em> <code>num_obj</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Gget_objname_by_idx</code></td>
<td align="left" valign="top">
<em>ssize_t</em> <code>H5Gget_objname_by_idx</code> (<em>hid_t</em> <code>group_id</code>,
<em>hsize_t</em> <code>idx</code>, <em>char *</em><code>name</code>,
<em>size_t*</em> <code>size</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Gget_objtype_by_idx</code></td>
<td align="left" valign="top">
<em>int</em> <code>H5Gget_objtype_by_idx</code> (<em>hid_t</em> <code>group_id</code>,
<em>hsize_t</em> <code>idx</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Iget_name</code></td>
<td align="left" valign="top">
<em>ssize_t</em> <code>H5Iget_name</code> (<em>hid_t</em> <code>obj_id</code>,
<em>char *</em><code>name</code>, <em>size_t</em> <code>size</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pall_filters_avail</code></td>
<td align="left" valign="top">
<em>htri_t</em> <code>H5Pall_filters_avail</code> (<em>hid_t</em> <code>dcpl_id</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pfill_value_defined</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Pfill_value_defined</code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5D_fill_value_t *</em><code>status</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_alloc_time</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Pget_alloc_time</code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5D_alloc_time_t *</em><code>alloc_time</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_edc_check</code></td>
<td align="left" valign="top">
<em>H5Z_EDC_t</em> <code>H5Pget_edc_check</code> (<em>hid_t</em>
<code>plist</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_family_offset</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pget_family_offset</code> (<em>hid_t</em> <code>fapl_id</code>,
<em>hsize_t *</em><code>offset</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_fapl_mpiposix</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pget_fapl_mpiposix</code> (<em>hid_t</em> <code>fapl_id</code>,
<em>MPI_Comm *</em><code>comm</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_fill_time</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Pget_fill_time</code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5D_fill_time_t *</em><code>fill_time</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_filter_by_id</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pget_filter_by_id</code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5Z_filter_t</em> <code>filter</code>, <em>unsigned int *</em><code>flags</code>,
<em>size_t *</em><code>cd_nelmts</code>, <em>unsigned int</em> <code>cd_values[]</code>,
<em>size_t</em> <code>namelen</code>, <em>char *</em><code>name[]</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_hyper_vector_size</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pget_hyper_vector_size</code> (<em>hid_t</em> <code>dxpl_id</code>,
<em>size_t *</em><code>vector_size</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pget_multi_type</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pget_multi_type</code> (<em>hid_t</em> <code>fapl_id</code>,
<em>H5FD_mem_t *</em><code>type</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pmodify_filter</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pmodify_filter</code> (<em>hid_t</em> <code>plist</code>,
<em>H5Z_filter_t</em> <code>filter</code>, <em>unsigned int</em> <code>flags</code>,
<em>size_t</em> <code>cd_nelmts</code>, <em>const unsigned int</em> <code>cd_values[]</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_alloc_time</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Pset_alloc_time</code> (<em>hid_t</em>
<code>plist_id</code>, <em>H5D_alloc_time_t</em> <code>alloc_time</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_edc_check</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_edc_check</code> (<em>hid_t</em>
<code>plist</code>, <em>H5Z_EDC_t</em> <code>check</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_family_offset</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_family_offset</code> (<em>hid_t</em> <code>fapl_id</code>,
<em>hsize_t</em> <code>offset</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_fapl_mpiposix</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_fapl_mpiposix</code> (<em>hid_t</em> <code>fapl_id</code>,
<em>MPI_Comm</em> <code>comm</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_fill_time</code></td>
<td align="left" valign="top">
<em>herr_t </em><code>H5Pset_fill_time</code> (<em>hid_t</em> <code>plist_id</code>,
<em>H5D_fill_time_t</em> <code>fill_time</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_filter</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_filter</code>
(<em>hid_t</em> <code>plist</code>, <em>H5Z_filter_t</em> <code>filter</code>,
<em>unsigned int</em> <code>flags</code>, <em>size_t</em> <code>cd_nelmts</code>,
<em>const unsigned int</em> <code>cd_values[])</code>
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_filter_callback</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_filter_callback</code> (<em>hid_t</em>
<code>plist</code>, <em>H5Z_filter_func_t</em> <code>func</code>,
<em>void *</em><code>op_data</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_fletcher32</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_fletcher32</code> (<em>hid_t</em>
<code>plist</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_hyper_vector_size</code>&nbsp;</td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_hyper_vector_size</code> (<em>hid_t</em> <code>dxpl_id</code>,
<em>size_t</em> <code>vector_size</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_multi_type</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_multi_type</code> (<em>hid_t</em> <code>fapl_id</code>,
<em>H5FD_mem_t</em> <code>type</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_shuffle</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_shuffle</code> (<em>hid_t</em> <code>plist_id</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Pset_szip</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Pset_szip</code> (<em>hid_t</em> <code>plist</code>,
<em>unsigned int</em> <code>options_mask</code>, <em>unsigned int</em>
<code>pixels_per_block</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Rget_object_type</code></td>
<td align="left" valign="top">
<em>int</em> <code>H5Rget_object_type</code> (<em>hid_t</em> <code>id</code>,
<em>void *</em><code>ref</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5set_free_list_limits</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5set_free_list_limits</code> (<em>int</em> <code>reg_global_lim</code>,
<em>int</em> <code>reg_list_lim</code>, <em>int</em> <code>arr_global_lim</code>,
<em>int</em> <code>arr_list_lim</code>, <em>int</em> <code>blk_global_lim</code>,
<em>int</em> <code>blk_list_lim</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Sget_select_type</code></td>
<td align="left" valign="top">
<em>H5S_sel_type</em> <code>H5Sget_select_type</code> (<em>hid_t</em> <code>space_id</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Tdetect_class</code></td>
<td align="left" valign="top">
<em>htri_t </em><code>H5Tdetect_class</code> (<em>hid_t</em> <code>dtype_id</code>,
<em>H5T_class_t</em> <code>dtype_class</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Tget_native_type</code></td>
<td align="left" valign="top">
<em>hid_t</em> <code>H5Tget_native_type</code> (<em>hid_t</em> <code>type_id</code>,
<em>H5T_direction_t</em> <code>direction</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Tis_variable_str</code></td>
<td align="left" valign="top">
<em>htri_t </em><code>H5Tis_variable_str</code> (<em>hid_t </em><code>dtype_id</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Zfilter_avail</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Zfilter_avail</code> (<em>H5Z_filter_t</em> <code>filter</code>)
</td>
</tr>
<tr>
<td align="left" valign="top"><code>H5Zunregister</code></td>
<td align="left" valign="top">
<em>herr_t</em> <code>H5Zunregister</code> (<em>H5Z_filter_t</em> <code>filter</code>)
</td>
</tr>
</table>
</dd>
<dd>&nbsp;</dd>
</dt>
<dt>The following tools are new for Release 1.5 and are included in the
<a href="../RM_H5Front.html"><cite>HDF5 Reference Manual</cite></a>.
<dd><code>h5diff</code>
<dd><code>h5import</code>
<dd><code>h5fc</code>
<dd><code>h5c++</code>
<dd><code>h5perf</code>
<dd><code>h5redeploy</code>
</dt>
</dl>
<h3>Deleted Functions</h3>
The following functions are deprecated in HDF5 Release 1.6.0.
A backward compatibility mode is provided in this release,
enabling these functions and other Release 1.4.x compatibility
features, but is available only when the HDF5 library is
configured with the flag <code>H5_WANT_H5_V1_4_COMPAT</code>.
The backward compatibility mode is not enabled in the
binaries distributed by NCSA.
<dir>
<table border=0>
<tr valign="top" align="left"><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<code>H5Pset_hyper_cache</code>
<code>H5Pget_hyper_cache</code>
</pre>
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<code>H5Rget_object_type</code>
</pre>
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>&nbsp;
</pre>
</td></tr>
</table>
</dir>
<p>
The above functions will eventually be removed from the HDF5
distribution and from the <cite>HDF5 Reference Manual</cite>.
<h3>Functions with Changed Syntax</h3>
The following functions have changed as noted.
<dir>
<dl>
<dt>C functions:
<dt><code>H5FDflush and VFL "flush" callbacks</code>
<dd>An extra parameter <code>closing</code> has been added to
these functions,
to allow the library to indicate that the file will be closed
following the call to "flush". Actions in the "flush" call
that are duplicated in the VFL "close" call may be omitted by
the VFL driver.
<dt>* <code>H5Gget_objtype_by_idx</code>
<dd>The function return type has changed from
<code><em>int</em></code> to
the enumerated type <code><em>H5G_obj_t</em></code>.
<dt>* <code>H5Pset(get)_buffer</code>
<dd>The <code>size</code> parameter for <code>H5Pset_buffer</code>
has changed from type <code><em>hsize_t</em></code> to
<code><em>size_t</em></code>.
<dd>The <code>H5Pget_buffer</code> return type has similarly
changed from <code><em>hsize_t</em></code> to
<code><em>size_t</em></code>.
<dt>* <code>H5Pset(get)_cache</code>
<dd>The <code>rdcc_nelmts</code> parameter has changed from type
<code><em>int</em></code> to
<code><em>size_t</em></code>.
<dt>* <code>H5Pset_fapl_log</code>
<dd>The <code>verbosity</code> parameter has been removed.
<dd>Two new parameters have been added:
<code>flags</code> of type <code><em>unsigned</em></code> and
<code>buf_size</code> of type <code><em>size_t</em></code>.
<dt>* <code>H5Pset(get)_fapl_mpiposix</code>
<dd>A <code>use_gpfs</code> parameter of type
<code><em>hbool_t</em></code> has been added.
<dt>* <code>H5Pset(get)_sieve_buf_size</code>
<dd>The <code>size</code> parameter has changed from type
<code><em>hsize_t</em></code> to
<code><em>size_t</em></code>.
<dt>* <code>H5Pset(get)_sym_k</code>
<dd>The <code>lk</code> parameter has changed from type
<code><em>int</em></code> to
<code><em>unsigned</em></code>.
<dt>* <code>H5Sget_select_bounds</code>
<dd>The <code>start</code> and <code>end</code> parameters have
changed from type <code><em>hsize_t *</em></code>
to <code><em>hssize_t *</em></code> to better match the
rest of the dataspace API.
<dt>* <code>H5Zregister</code>
<dd>This function is substantially revised in Release 1.6.0 with
a new <code>H5Z_class_t</code> struct and
new <i>set local</i> and <i>can apply</i> callback functions.
<dt>&nbsp;
<dt>Fortran90 functions:
<dt><code>h5pset(get)_fapl_core_f</code>
<dd>The <code>backing_store</code> parameter has changed from
<code><em>INTEGER</em></code> to <code><em>LOGICAL</em></code>
to better match the C API.
<dt><code>h5pset(get)_preserve_f</code>
<dd>The <code>flag</code> parameter has changed from
<code><em>INTEGER</em></code> to <code><em>LOGICAL</em></code>
to better match the C API.
</dl>
</dir>
<p>
Backward compatibility with the Release 1.4.x syntax is available
for the functions indicated above with a leading asterisk (*).
The backward compatibility features are available only when the
HDF5 library is configured with the flag
<code>H5_WANT_H5_V1_4_COMPAT</code>,
is not enabled in the binaries distributed by NCSA, and
will eventually be removed from the HDF5 distribution.
<h3>Constants with Changed Values</h3>
</dir>
<p>&nbsp;
<h2>Release 1.4.5 versus Release 1.4.4</h2>
<dir>
<h3>C Library</h3>
<dir>
<b>Added functions:</b>
<dir>
<table border=0>
<tr valign=top align=left><td>
<pre>
herr_t H5Pset_fapl_mpiposix(hid_t fapl_id, MPI_Comm comm);
herr_t H5Pget_fapl_mpiposix(hid_t fapl_id, MPI_Comm *comm/*out*/);
</pre>
</td></tr>
</table>
</dir>
<b>Changed functions:</b>
<dir>
The following functions have changed behavior.
<p>
<table border=0>
<tr valign=top align=left><td>
<code>H5Pset_fapl_mpio&nbsp;&nbsp;</code><br>
<code>H5Pget_fapl_mpio</code><br>
<code>H5Fcreate</code><br>
<code>H5Fopen</code><br>
<code>H5Fclose</code>
</td><td>
Previously, the Communicator and Info object arguments supplied
to <code>H5Pset_fapl_mpio</code> were stored in the property with
its handle values.
This meant changes to the communicator or the Info object
after calling <code>H5Pset_fapl_mpio</code> would affect the how
the property list functioned.
This was also the case when <code>H5Fopen/create</code> operated.
They just stored the handle value. This is not according to the
MPI-2 defined behavior of how Info objects should be handled.
(MPI-2 defines Info objects must be parsed when called.)<br>
<code>H5Pset_fapl_mpio</code> now stores a duplicate of each of
the communicator and Info object.<br>
<code>H5Pget_fapl_mpio</code> now returns a duplicate of its
stored communicator and Info object.
It is now the responsibility of the applications to free
those objects when done.<p>
<code>H5Fcreate</code> and <code>H5Fopen</code> also store
a duplicate of the communicator and Info
object supplied by the file access property List.
<code>H5Fclose</code> frees the duplicates.<p>
Advice to users: User applications should release the communicator and
Info object returned by <code>H5Pget_fapl_mpio</code> when they are
no longer needed.
</td></tr>
</table>
</dir>
<b>Removed functions:</b>
<dir>
<table border=0>
<tr valign=top align=left><td>
None
<!--
<pre>
List deleted function(s) here. Remove forced spaces. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
-->
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<!-- List deleted function(s) here. Remove forced spaces. -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
</td></tr>
</table>
</dir>
There were no other public API changes in the C library for this release.
</dir>
<h3>Fortran90 Library</h3>
<dir>
The following missing Fortran functions were added:
<br>
<br>
<code> h5get_libversion_f, h5check_version_f, h5garbage_collect_f, h5dont_atexit_f </code>
<br>
<code> h5tget_member_index_f, h5tvlen_create_f </code>
<br>
<code> h5dget_storage_size_f, h5dvlen_get_max_len_f , h5dwrite_vl_f, h5dread_vl_f</code>
<br>
<br>
Only <code>integer, real</code> and
<code>character</code> types are supported for VL datatypes.
</dir>
</dir>
<!-- Document API CHANGES ONLY in this file. -->
<h2>Release 1.4.4 versus Release 1.4.3</h2>
<dir>
<h3>C Library</h3>
<dir>
<b>Added functions:</b>
<dir>
<table border=0>
<tr valign=top align=left><td>
<pre>
H5Pget_small_data_block_size
H5Pset_small_data_block_size
H5Tget_member_index
</pre>
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<!-- List added function(s) here. Remove forced spaces. -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
</td></tr>
</table>
</dir>
<b>Changed functions:</b>
<dir>
<table border=0>
<tr valign=top align=left><td>
None
<!--
<pre>
List deleted function(s) here. Remove forced spaces. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
-->
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<!-- List deleted function(s) here. Remove forced spaces. -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
</td></tr>
</table>
</dir>
<b>Removed functions:</b>
<dir>
<table border=0>
<tr valign=top align=left><td>
None
<!--
<pre>
List deleted function(s) here. Remove forced spaces. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
-->
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<!-- List deleted function(s) here. Remove forced spaces. -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
</td></tr>
</table>
</dir>
There were no other public API changes in the C library for this release.
</dir>
<h3>Fortran90 Library</h3>
<dir>
<code>h5dwrite_f, h5dread_f, h5awrite_f, h5aread_f </code>were overloaded
with <code>dims</code> argument to be assumed size array of type <code>INTEGER(HSIZE_T).</code>
We recommend to use the subroutines with the new type. Module subroutines
that accept <code>dims</code> as <code>INTEGER</code> array of size <code>7</code> will be deprecated in the 1.6.0 release.
</dir>
</dir>
<h2>Release 1.4.3 versus Release 1.4.2</h2>
<dir>
<h3>C Library</h3>
<dir>
<b>Removed function:</b>
<dir>
<table border=0>
<tr valign=top align=left><td>
<pre>
H5Pset_fapl_dpss </pre>
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<!-- new deleted functions here. Remove forced spaces. -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
<!-- new deleted functions here. Remove forced spaces. -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</pre>
</td></tr>
</table>
</dir>
There were no other public API changes in the C library for this release.
</dir>
<h3>Fortran90 Library</h3>
<dir>
There were no changes to the public Fortran90 APIs for this release.
</dir>
</dir>
<h2>Release 1.4.2 versus Release 1.4.1</h2>
<dir>
<h3>C Library</h3>
The HDF5 Release 1.4.2 C library is a "Bugfix Release";
there are no API changes in the underlying HDF5 library.
<h3>Fortran90 Library</h3>
The following functions in the HDF5 Release 1.4.2 Fortran90 library
have an additional parameter, <code>dims</code>, that was not present
in Release 1.4.1:
<dir>
<pre>
<font color=red>h5aread_f</font>(attr_id, memtype_id, buf, dims, hdferr)
<font color=red>h5awrite_f</font>(attr_id, memtype_id, buf, dims, hdferr)
<font color=red>h5dread_f</font>(dset_id, mem_type_id, buf, dims, hdferr, mem_space_id, &
file_space_id, xfer_prp)
<font color=red>h5dwrite_f</font>(dset_id, mem_type_id, buf, dims, hdferr, mem_space_id, &
file_space_id, xfer_prp)
</pre>
</dir>
The <code>dims</code> parameter enables library portability
between the UNIX and Microsoft Windows platforms.
</dir>
<h2>Release 1.4.1 versus Release 1.4.0</h2>
<dir>
Release 1.4.1 is a "Tools Release"; there are no API changes in the
underlying HDF5 library.
</dir>
<h2>Release 1.4.0 versus Release 1.2.2</h2>
<dir>
Several functions were added to or removed from the HDF5 library
in the development of Release 1.4.0.
A few functions have been modified in minor ways.
<h3>New Functions</h3>
The following functions are new for Release 1.4.0 and are included in the
<a href="../RM_H5Front.html"><cite>HDF5 Reference Manual</cite></a>.
<dir>
<pre>
herr_t <font color=red>H5Dvlen_get_buf_size</font> (hid_t dataset_id, hid_t type_id,
hid_t space_id, hsize_t *size);
herr_t <font color=red>H5Epush</font> (const char *file, const char *func,
unsigned line, H5E_major_t maj, H5E_minor_t min,
const char *str);
hid_t <font color=red>H5Pget_driver</font> (hid_t plist_id);
void *<font color=red>H5Pget_driver_info</font> (hid_t plist_id);
herr_t <font color=red>H5Pget_dxpl_mpio</font> (hid_t dxpl_id,
H5FD_mpio_xfer_t *xfer_mode/*out*/);
herr_t <font color=red>H5Pget_dxpl_multi</font> (hid_t dxpl_id,
hid_t *memb_dxpl/*out*/);
herr_t <font color=red>H5Pget_fapl_core</font> (hid_t fapl_id, size_t *increment/*out*/,
hbool_t *backing_store/*out*/)
herr_t <font color=red>H5Pget_fapl_family</font> (hid_t fapl_id,
hsize_t *memb_size/*out*/, hid_t *memb_fapl_id/*out*/);
herr_t <font color=red>H5Pget_fapl_mpio</font> (hid_t fapl_id, MPI_Comm *comm/*out*/,
MPI_Info *info/*out*/);
herr_t <font color=red>H5Pget_fapl_multi</font> (hid_t fapl_id,
H5FD_mem_t *memb_map/*out*/, hid_t *memb_fapl/*out*/,
char **memb_name/*out*/, haddr_t *memb_addr/*out*/,
hbool_t *relax/*out*/);
herr_t <font color=red>H5Pget_fapl_stream</font> (hid_t fapl_id,
H5FD_stream_fapl_t *fapl /*out*/ );
herr_t <font color=red>H5Pget_meta_block_size</font> (hid_t fapl_id,
hsize_t *size/*out*/);
herr_t <font color=red>H5Pget_sieve_buf_size</font> (hid_t fapl_id,
hsize_t *size/*out*/);
herr_t <font color=red>H5Pset_driver</font> (hid_t plist_id, hid_t driver_id,
const void *driver_info);
herr_t <font color=red>H5Pset_dxpl_mpio</font> (hid_t dxpl_id,
H5FD_mpio_xfer_t xfer_mode);
herr_t <font color=red>H5Pset_dxpl_multi</font> (hid_t dxpl_id,
const hid_t *memb_dxpl);
herr_t <font color=red>H5Pset_fapl_core</font> (hid_t fapl_id, size_t increment,
hbool_t backing_store)
herr_t <font color=red>H5Pset_fapl_family</font> (hid_t fapl_id, hsize_t memb_size,
hid_t memb_fapl_id);
herr_t <font color=red>H5Pset_fapl_log</font> (hid_t fapl_id, char *logfile,
int verbosity);
herr_t <font color=red>H5Pset_fapl_mpio</font> (hid_t fapl_id, MPI_Comm comm,
MPI_Info info);
herr_t <font color=red>H5Pset_fapl_multi</font> (hid_t fapl_id,
const H5FD_mem_t *memb_map, const hid_t *memb_fapl,
const char **memb_name, const haddr_t *memb_addr,
hbool_t relax);
herr_t <font color=red>H5Pset_fapl_sec2</font> (hid_t fapl_id);
herr_t <font color=red>H5Pset_fapl_split</font> (hid_t fapl, const char *meta_ext,
hid_t meta_plist_id, const char *raw_ext,
hid_t raw_plist_id);
herr_t <font color=red>H5Pset_fapl_stdio</font> (hid_t fapl_id);
herr_t <font color=red>H5Pset_fapl_stream</font> (hid_t fapl_id,
H5FD_stream_fapl_t *fapl);
herr_t <font color=red>H5Pset_meta_block_size</font>(hid_t fapl_id, hsize_t size);
herr_t <font color=red>H5Pset_sieve_buf_size</font>(hid_t fapl_id, hsize_t size);
hid_t <font color=red>H5Tarray_create</font> (hid_t base, int rank, const hsize_t dims[],
const int perm[])
int <font color=red>H5Tget_array_dims</font> (hid_t adtype_id, hsize_t *dims[], int *perm[])
int <font color=red>H5Tget_array_ndims</font> (hid_t adtype_id)
</pre>
</dir>
<p>
The following functions are new for Release 1.4.0, but
are intended only for use in specialized environments.
These are also included in the
<a href="../RM_H5Front.html"><cite>HDF5 Reference Manual</cite></a>.
<dir>
<pre>
herr_t <font color=red>H5Pget_fapl_dpss</font> (hid_t fapl_id);
herr_t <font color=red>H5Pget_fapl_gass</font> (hid_t fapl_id, GASS_Info *info/*out*/);
herr_t <font color=red>H5Pget_fapl_srb</font> (hid_t fapl_id, SRB_Info *info);
herr_t <font color=red>H5Pset_fapl_dpss</font> (hid_t fapl_id);
herr_t <font color=red>H5Pset_fapl_gass</font> (hid_t fapl_id, GASS_Info info);
herr_t <font color=red>H5Pset_fapl_srb</font> (hid_t fapl_id, SRB_Info info);
</pre>
</dir>
<p>
The following functions are new for Release 1.4.0 but are intended
only for driver development work, not for general use.
They are listed in the
<a href="../TechNotes/VFLfunc.html"><cite>List of VFL Functions</cite></a>
document in the
<a href="../TechNotes.html"><cite>HDF5 Technical Notes</cite></a>.
They are described in detail only in the source code and
do not appear in the <cite>HDF5 Reference Manual</cite>.
<dir>
<pre>
haddr_t <font color=red>H5FDalloc</font> (H5FD_t *file, H5FD_mem_t type,
hsize_t size);
herr_t <font color=red>H5FDclose</font> (H5FD_t *file);
int <font color=red>H5FDcmp</font> (const H5FD_t *f1, const H5FD_t *f2);
herr_t <font color=red>H5FDflush</font> (H5FD_t *file);
herr_t <font color=red>H5FDfree</font> (H5FD_t *file, H5FD_mem_t type,
haddr_t addr, hsize_t size);
haddr_t <font color=red>H5FDget_eoa</font> (H5FD_t *file);
haddr_t <font color=red>H5FDget_eof</font> (H5FD_t *file);
H5FD_t *<font color=red>H5FDopen</font> (const char *name, unsigned flags,
hid_t fapl_id, haddr_t maxaddr);
int <font color=red>H5FDquery</font> (const H5FD_t *f, unsigned long *flags);
herr_t <font color=red>H5FDread</font> (H5FD_t *file, hid_t dxpl_id, haddr_t addr,
hsize_t size, void *buf/*out*/);
haddr_t <font color=red>H5FDrealloc</font> (H5FD_t *file, H5FD_mem_t type,
haddr_t addr, hsize_t old_size, hsize_t new_size);
hid_t <font color=red>H5FDregister</font> (const H5FD_class_t *cls);
herr_t <font color=red>H5FDset_eoa</font> (H5FD_t *file, haddr_t eof);
herr_t <font color=red>H5FDunregister</font> (hid_t driver_id);
herr_t <font color=red>H5FDwrite</font> (H5FD_t *file, H5FD_mem_t type,
hid_t dxpl_id, haddr_t addr, hsize_t size,
const void *buf);
</pre>
</dir>
<h3>Deleted Functions</h3>
The following functions have been removed from the HDF5 library
and from the <cite>HDF5 Reference Manual</cite>.
<dir>
<table>
<tr valign=top align=left><td>
<pre>
H5Pget_core
H5Pget_driver
H5Pget_family
H5Pget_mpi
H5Pget_sec2
H5Pget_split
H5Pget_stdio
H5Pget_xfer
</pre>
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
H5Pset_core
H5Pset_family
H5Pset_mpi
H5Pset_sec2
H5Pset_split
H5Pset_stdio
H5Pset_xfer
</pre>
</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</td><td>
<pre>
H5RAclose
H5RAcreate
H5RAopen
H5RAread
H5RAwrite
H5Tget_member_dims
H5Tinsert_array
</pre>
</td></tr>
</table>
</dir>
Note that the entire H5RA interface, an experimental interface for
ragged arrays, has been removed from the library.
<h3>Functions with Changed Syntax</h3>
The following functions have changed slightly.
<dir>
<dl>
<dt><code>H5Pget_buffer</code>
<dd>Return type has changed to <em>hsize_t</em>.
<dt><code>H5Pset_buffer</code>
<dd>The type of the <code>size</code> parameter has changed
to <em>hsize_t</em>.
<dt><code>H5Tconvert</code>
<dd>The type of the <code>nelmts</code> parameter has changed
to <em>hsize_t</em>.
</dl>
</dir>
<h3>Constants with Changed Values</h3>
The values of the constants <code>H5P_DEFAULT</code> and
<code>H5S_ALL</code> have been changed from <code>-2</code>
to <code>0</code>.
These default values had to be special-cased in situations where
they could be returned to distinguish them from error values.
</dir>
<p>&nbsp;
<h2>Migration from Release 1.2.2 to Release 1.4.<em>x</em></h2>
<dir>
<h3>H5Tinsert_array</h3>
The functionality of <code>H5Tinsert_array</code> has been replaced by
<code>H5Tarray_create</code>.
Here is an example of changing code from <code>H5Tinsert_array</code>
to <code>H5Tarray_create</code>.
<pre>
V1.2.2
{
struct tmp_struct {
int a;
float f[3];
double d[2][4];
};
size_t f_dims[1]={3};
size_t d_dims[2]={2,4};
hid_t compound_type;
compound_type=H5Tcreate(H5T_COMPOUND,sizeof(struct tmp_struct));
H5Tinsert(compound_type,"a",HOFFSET(struct tmp_struct,a),H5T_NATIVE_INT);
H5Tinsert_array(compound_type,"f",HOFFSET(struct tmp_struct,f),1,f_dims,NULL,H5T_NATIVE_FLOAT);
H5Tinsert_array(compound_type,"d",HOFFSET(struct tmp_struct,d),2,d_dims,NULL,H5T_NATIVE_DOUBLE);
}
V1.4.0
{
struct tmp_struct {
int a;
float f[3];
double d[2][4];
};
hsize_t f_dims[1]={3};
hsize_t d_dims[2]={2,4};
hid_t compound_type;
hid_t array_type;
compound_type=H5Tcreate(H5T_COMPOUND,sizeof(struct tmp_struct));
H5Tinsert(compound_type,"a",HOFFSET(struct tmp_struct,a),H5T_NATIVE_INT);
array_type=H5Tarray_create(H5T_NATIVE_FLOAT,1,f_dims,NULL);
H5Tinsert(compound_type,"f",HOFFSET(struct tmp_struct,f),array_type);
H5Tclose(array_type);
array_type=H5Tarray_create(H5T_NATIVE_DOUBLE,2,d_dims,NULL);
H5Tinsert(compound_type,"d",HOFFSET(struct tmp_struct,d),array_type);
H5Tclose(array_type);
}
</pre>
</dir>
<h2>This and Prior Releases: The RELEASE.txt and HISTORY.txt Files</h2>
<dir>
The HDF5 source code, as distributed to users and developers,
contains two files that will be of interest to readers of this
document. Both files are located at the top level of the
source code tree and are duplicated here for your reference:
<p>
<dl>
<dt><a href="RELEASE.txt" target="ExtWin">RELEASE.txt</a>
<dd>Technical notes regarding the release, including
new features and the changes since the last release,
notes regarding new or revised utilities,
notes regarding alternative language APIs (Fortran90, C++),
bugs fixed since the last release,
platforms on which the release has been tested, and
known problems.
This is the file commonly known as "the release notes."
<p>
<dt><a href="HISTORY.txt" target="ExtWin">HISTORY.txt</a>
<dd>A release-by-release history of the HDF5 library.
This file is a compiled set of the release notes
(i.e., the RELEASE.txt files) from prior releases.
<dl>
</dir>
<!-- #BeginLibraryItem "/ed_libs/NavBar_ADevG.lbi" --><hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="../index.html">HDF5 documents and links</a>&nbsp;<br>
<a href="../H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/UG/index.html">HDF5 User's Guide</a>&nbsp;<br>
<a href="../RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;<br>
<a href="../ADGuide.html">HDF5 Application Developer's Guide</a>&nbsp;<br>
</td></tr>
</table>
</center>
<hr>
<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Describes HDF5 Release 1.6.0, July 2003
</address><!-- #EndLibraryItem --><!-- Created: Spring 1999 -->
<!-- hhmts start -->
Last modified: 2 July 2003
<!-- hhmts end -->
</body>
</html>