From 1e07dfa83dce27f92491876b9d27708edd283480 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Wed, 2 Jul 2003 15:05:15 -0500 Subject: [svn-r7137] Description: Add H5_WANT_H5_V1_4_COMPAT notes. Add or expand "Changed Syntax" and "Deleted Functions" sections. Edited to refer to Release 1.6.0 (instead of R 1.5 Developoment Branch). Bring in sections from R 1.4 branch covering changes from R 1.2.2 through 1.4.5. Platforms tested: IE 5 --- doc/html/ADGuide/Changes.html | 460 +++++++++++++++++++++++++++++++++++++----- 1 file changed, 409 insertions(+), 51 deletions(-) diff --git a/doc/html/ADGuide/Changes.html b/doc/html/ADGuide/Changes.html index 1e17d35..97c8ea6 100755 --- a/doc/html/ADGuide/Changes.html +++ b/doc/html/ADGuide/Changes.html @@ -29,28 +29,23 @@

HDF5 Software Changes from Release to Release

+ + This document is intended to assist application developers who must keep an application synchronized with the HDF5 library or related software. -

Development Release 1.5
(current development toward Production Release 1.6)

+

Release 1.6.0 (current release) versus Release 1.4.5

-This section lists the API-level changes that have been made during the -Release 1.5 development phase. (The development release number, 1.5, -will be used to describe this version until this the current development -cycle is completed, at which point it will be promoted to a production -release. The first production release of this code will be as Release 1.6.) +This section lists the API-level changes that have been made in the +transition from the HDF5 Release 1.4.x series to Release 1.6.0. -

-Note that changes at the subrelease level in the Release 1.4 production -branch, i.e., Releases 1.4.1, 1.4.2, ..., are summarized in the -Release 1.4.x versions of this document; they are not reported here.

New Functions and Tools

-
The following functions are new for Release 1.5 and are included in the +
The following functions are new for Release 1.6.0 and are included in the HDF5 Reference Manual.
@@ -348,81 +343,394 @@ Release 1.4.x versions of this document; they are not reported here.

Deleted Functions

- The following functions have been removed from the HDF5 library - and from the HDF5 Reference Manual. + 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 H5_WANT_H5_V1_4_COMPAT. + The backward compatibility mode is not enabled in the + binaries distributed by NCSA. +
        
-H5function1
-H5function2
+H5Pset_hyper_cache
+H5Pget_hyper_cache
       
-H5function3
-H5function4
+H5Rget_object_type
       
-H5function5
-H5function6
+ 
+

+ The above functions will eventually be removed from the HDF5 + distribution and from the HDF5 Reference Manual.

Functions with Changed Syntax

- The following functions have changed slightly. + The following functions have changed as noted.
+
C functions:
H5FDflush and VFL "flush" callbacks -
An extra parameter 'closing' has been added to these functions, +
An extra parameter closing 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. -
H5Sget_select_bounds -
The 'start' and 'end' parameters have changed from - 'hsize_t *' - to 'hssize_t *' to better match the rest of the dataspace API. +
* H5Gget_objtype_by_idx +
The function return type has changed from + int to + the enumerated type H5G_obj_t. +
* H5Pset(get)_buffer +
The size parameter for H5Pset_buffer + has changed from type hsize_t to + size_t. +
The H5Pget_buffer return type has similarly + changed from hsize_t to + size_t. +
* H5Pset(get)_cache +
The rdcc_nelmts parameter has changed from type + int to + size_t. +
* H5Pset_fapl_log +
The verbosity parameter has been removed. +
Two new parameters have been added: + flags of type unsigned and + buf_size of type size_t. +
* H5Pset(get)_fapl_mpiposix +
A use_gpfs parameter of type + hbool_t has been added. +
* H5Pset(get)_sieve_buf_size +
The size parameter has changed from type + hsize_t to + size_t. +
* H5Pset(get)_sym_k +
The lk parameter has changed from type + int to + unsigned. +
* H5Sget_select_bounds +
The start and end parameters have + changed from type hsize_t * + to hssize_t * to better match the + rest of the dataspace API. +
* H5Zregister +
This function is substantially revised in Release 1.6.0 with + a new H5Z_class_t struct and + new set local and can apply callback functions. +
  +
Fortran90 functions:
h5pset(get)_fapl_core_f -
The 'backing_store' parameter has changed from - INTEGER to LOGICAL to match better C API +
The backing_store parameter has changed from + INTEGER to LOGICAL + to better match the C API.
h5pset(get)_preserve_f -
The 'flag' parameter has changed from - INTEGER to LOGICAL to match better C API -
H5function -
Description of change +
The flag parameter has changed from + INTEGER to LOGICAL + to better match the C API.
+

+ 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 + H5_WANT_H5_V1_4_COMPAT, + is not enabled in the binaries distributed by NCSA, and + will eventually be removed from the HDF5 distribution. + +

Constants with Changed Values

  -

Release 1.4

+ + + + +

Release 1.4.5 versus Release 1.4.4

+

C Library

+ + + Added functions: + + + +
+
+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*/);
+
+
+ + + Changed functions: + + The following functions have changed behavior. +

+ + +
+ H5Pset_fapl_mpio  
+ H5Pget_fapl_mpio
+ H5Fcreate
+ H5Fopen
+ H5Fclose + 		+ Previously, the Communicator and Info object arguments supplied + to H5Pset_fapl_mpio were stored in the property with + its handle values. + This meant changes to the communicator or the Info object + after calling H5Pset_fapl_mpio would affect the how + the property list functioned. + This was also the case when H5Fopen/create 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.)
+ H5Pset_fapl_mpio now stores a duplicate of each of + the communicator and Info object.
+ H5Pget_fapl_mpio 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.

+ H5Fcreate and H5Fopen also store + a duplicate of the communicator and Info + object supplied by the file access property List. + H5Fclose frees the duplicates.

+ Advice to users: User applications should release the communicator and + Info object returned by H5Pget_fapl_mpio when they are + no longer needed. +

+

+ -Note: Changes at the subrelease level, i.e., 1.4.1, 1.4.2, ..., are -summarized in the Release 1.4.x version of this document; they are not -reported here. + + Removed functions: + + + +
+None + + +        + +
+          
+
+
+ + + There were no other public API changes in the C library for this release. + + +

Fortran90 Library

+ + + + The following missing Fortran functions were added: +
+
+ h5get_libversion_f, h5check_version_f, h5garbage_collect_f, h5dont_atexit_f +
+ h5tget_member_index_f, h5tvlen_create_f +
+ h5dget_storage_size_f, h5dvlen_get_max_len_f , h5dwrite_vl_f, h5dread_vl_f +
+
+ Only integer, real and + character types are supported for VL datatypes. + + + + + + + +

Release 1.4.4 versus Release 1.4.3

+ +

C Library

+ + + Added functions: + + + +
+
+H5Pget_small_data_block_size
+H5Pset_small_data_block_size
+H5Tget_member_index
+
+ 		+        + +
+          
+
+
+ + + Changed functions: + + + +
+None + + +        + +
+          
+
+
+ + + Removed functions: + + + +
+None + + +        + +
+          
+
+
+ + + There were no other public API changes in the C library for this release. + + +

Fortran90 Library

+ + + h5dwrite_f, h5dread_f, h5awrite_f, h5aread_f were overloaded + with dims argument to be assumed size array of type INTEGER(HSIZE_T). + We recommend to use the subroutines with the new type. Module subroutines + that accept dims as INTEGER array of size 7 will be deprecated in the 1.6.0 release. + + + + +

Release 1.4.3 versus Release 1.4.2

+ +

C Library

+ + + Removed function: + + + +
+
+H5Pset_fapl_dpss
+ 		+        + +
+          
+
+ 		+        + +
+          
+
+
+ + + There were no other public API changes in the C library for this release. + + +

Fortran90 Library

+ + + There were no changes to the public Fortran90 APIs for this release. + + + + +

Release 1.4.2 versus Release 1.4.1

+ +

C Library

+ The HDF5 Release 1.4.2 C library is a "Bugfix Release"; + there are no API changes in the underlying HDF5 library. + +

Fortran90 Library

+ The following functions in the HDF5 Release 1.4.2 Fortran90 library + have an additional parameter, dims, that was not present + in Release 1.4.1: + + +
+h5aread_f(attr_id, memtype_id,  buf, dims, hdferr)
+h5awrite_f(attr_id, memtype_id,  buf, dims, hdferr)
+h5dread_f(dset_id, mem_type_id, buf, dims, hdferr, mem_space_id, &
+           file_space_id, xfer_prp)
+h5dwrite_f(dset_id, mem_type_id, buf, dims, hdferr, mem_space_id, &
+           file_space_id, xfer_prp)
+
+ + + The dims parameter enables library portability + between the UNIX and Microsoft Windows platforms. + + + + +

Release 1.4.1 versus Release 1.4.0

+ + Release 1.4.1 is a "Tools Release"; there are no API changes in the + underlying HDF5 library. + + + +

Release 1.4.0 versus Release 1.2.2

+ + Several functions were added to or removed from the HDF5 library - in the development of Release 1.4. + in the development of Release 1.4.0. A few functions have been modified in minor ways.

New Functions

- The following functions are new for Release 1.4 and are included in the + The following functions are new for Release 1.4.0 and are included in the HDF5 Reference Manual. @@ -490,7 +798,7 @@ int H5Tget_array_ndims (hid_t adtype_id)

- The following functions are new for Release 1.4, but + 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 HDF5 Reference Manual. @@ -508,7 +816,7 @@ herr_t H5Pset_fapl_srb (hid_t fapl_id, SRB_Info info);

- The following functions are new for Release 1.4 but are intended + 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 List of VFL Functions @@ -588,7 +896,7 @@ H5Tinsert_array

- Note that the entire H5RA interface, an esperimental interface for + Note that the entire H5RA interface, an experimental interface for ragged arrays, has been removed from the library. @@ -617,37 +925,87 @@ H5Tinsert_array

  +

Migration from Release 1.2.2 to Release 1.4.x

+ + +

H5Tinsert_array

+ The functionality of H5Tinsert_array has been replaced by + H5Tarray_create. + Here is an example of changing code from H5Tinsert_array + to H5Tarray_create. +
+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);
+}
+
+
+ + -

This and Prior Releases: The RELEASE and HISTORY Files

+

This and Prior Releases: The RELEASE.txt and HISTORY.txt Files

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 (i.e., in .../hdf5/) and are - duplicated here for your reference: + source code tree and are duplicated here for your reference:

-
RELEASE +
RELEASE.txt
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 + platforms on which the release has been tested, and known problems. - This is the file commonly known among developers as - "the release notes." + This is the file commonly known as "the release notes."

-

HISTORY +
HISTORY.txt
A release-by-release history of the HDF5 library. This file is a compiled set of the release notes - (i.e., the RELEASE files) from prior releases. + (i.e., the RELEASE.txt files) from prior releases.
+ +
@@ -674,7 +1032,7 @@ Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 25 June 2003 +Last modified: 2 July 2003 -- cgit v0.12