1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
|
<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> <br>
<a href="../H5.intro.html">Introduction to HDF5</a> <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> <br>
<a href="../RM_H5Front.html">HDF5 Reference Manual</a> <br>
<a href="../ADGuide.html">HDF5 Application Developer's Guide</a> <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.7.x (current release) versus Release 1.6</h2>
<dir>
<h3>Deleted Functions</h3>
The following functions are removed from HDF5 Release 1.7.x as the GASS
virtual file driver has been retired.
<dir>
<table border=0>
<tr valign="top" align="left"><td>
</td><td>
<pre>
<code>H5Pget_fapl_gass</code>
</pre>
</td><td>
</td><td>
<pre>
<code>H5Pset_fapl_gass</code>
</pre>
</td><td>
</td><td>
</td></tr>
</table>
</dir>
</dir>
<p>
<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> </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> </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>
</td><td>
<pre>
<code>H5Pset_hyper_cache</code>
<code>H5Pget_hyper_cache</code>
</pre>
</td><td>
</td><td>
<pre>
<code>H5Rget_object_type</code>
</pre>
</td><td>
</td><td>
<pre>
</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>
<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>
<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 </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.
</pre>
-->
</td><td>
</td><td>
<pre>
<!-- List deleted function(s) here. Remove forced spaces. -->
</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>
</td><td>
<pre>
<!-- List added function(s) here. Remove forced spaces. -->
</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.
</pre>
-->
</td><td>
</td><td>
<pre>
<!-- List deleted function(s) here. Remove forced spaces. -->
</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.
</pre>
-->
</td><td>
</td><td>
<pre>
<!-- List deleted function(s) here. Remove forced spaces. -->
</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>
</td><td>
<pre>
<!-- new deleted functions here. Remove forced spaces. -->
</pre>
</td><td>
</td><td>
<pre>
<!-- new deleted functions here. Remove forced spaces. -->
</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>
</td><td>
<pre>
H5Pset_core
H5Pset_family
H5Pset_mpi
H5Pset_sec2
H5Pset_split
H5Pset_stdio
H5Pset_xfer
</pre>
</td><td>
</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>
<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> <br>
<a href="../H5.intro.html">Introduction to HDF5</a> <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> <br>
<a href="../RM_H5Front.html">HDF5 Reference Manual</a> <br>
<a href="../ADGuide.html">HDF5 Application Developer's Guide</a> <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.7, the unreleased development branch; working toward HDF5 Release 1.8.0
</address><!-- #EndLibraryItem --><!-- Created: Spring 1999 -->
<!-- hhmts start -->
Last modified: 3 March 2005
<!-- hhmts end -->
</body>
</html>
|
