summaryrefslogtreecommitdiffstats
path: root/doc/html/fortran/h5s_FORTRAN.html
blob: 1d3c0febcd8a403c4b6735dee290981bbe8622d3 (plain)
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
<html>
<head><title>
FORTRAN Dataspace API -- h5s
</title></head>

<body bgcolor="#FFFFFF">



<center>
<h1>The FORTRAN 90 API to HDF5<br>h5s: Dataspaces</h1>
</center>


<dl>


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sclose_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sclose_f</strong>
<pre>

          SUBROUTINE h5sclose_f(space_id, hdferr)
     
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id  ! Dataspace identifier
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure

          END SUBROUTINE h5sclose_f
</pre>


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5scopy_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5scopy_f</strong>
<pre>

          SUBROUTINE h5scopy_f(space_id, new_space_id, hdferr) 

            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier 
            INTEGER(HID_T), INTENT(OUT) :: new_space_id 
                                               ! Identifier of dataspace's copy 
            INTEGER, INTENT(OUT) :: hdferr     ! Error code
                                               ! 0 on success and -1 on failure
 
          END SUBROUTINE h5scopy_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5screate_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5screate_f</strong>
<pre>

          SUBROUTINE h5screate_f(classtype, space_id, hdferr) 
            IMPLICIT NONE
            INTEGER, INTENT(IN) :: classtype     ! The type of the dataspace
                                                 ! to be created. Possible values
                                                 ! are: 
                                                 !  H5S_SCALAR_F 
                                                 !  H5S_SIMPLE_F 
            INTEGER(HID_T), INTENT(OUT) :: space_id ! Dataspace identifier 
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
 
          END SUBROUTINE h5screate_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5screate_simple_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5screate_simple_f</strong>
<pre>

          SUBROUTINE h5screate_simple_f(rank, dims, space_id, hdferr, maxdims) 
            IMPLICIT NONE
            INTEGER, INTENT(IN) :: rank     ! Number of dataspace dimensions 
            INTEGER(HSIZE_T), INTENT(IN) :: dims(*) ! Array with the dimension 
                                                    ! sizes 
            INTEGER(HID_T), INTENT(OUT) :: space_id ! Dataspace identifier 
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
            INTEGER(HSIZE_T), OPTIONAL, INTENT(IN) :: maxdims(*) 
                                                    ! Array with the maximum 
                                                    ! dimension sizes 
 
          END SUBROUTINE h5screate_simple_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sextent_copy_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sextent_copy_f</strong>
<pre>

          SUBROUTINE h5sextent_copy_f(dest_space_id, source_space_id, hdferr) 

            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: dest_space_id  ! Identifier of destination
                                                         ! dataspace
            INTEGER(HID_T), INTENT(IN) :: source_space_id ! Identifier of source 
                                                          ! dataspace
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
 
          END SUBROUTINE h5sextent_copy_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sget_select_npoints_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sget_select_npoints_f</strong>
<pre>

          SUBROUTINE h5sget_select_npoints_f(space_id, npoints, hdferr) 

            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id     ! Dataspace identifier 
            INTEGER(HSSIZE_T), INTENT(OUT) :: npoints  ! Number of elements in the
                                                       ! selection 
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
 
          END SUBROUTINE h5sget_select_npoints_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sget_simple_extent_dims_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sget_simple_extent_dims_f</strong>
<pre>

          SUBROUTINE h5sget_simple_extent_dims_f(space_id, dims, maxdims, hdferr) 

            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier 
            INTEGER(HSIZE_T), DIMENSION(*), INTENT(OUT) :: dims 
                                                   ! Array to store dimension sizes 
            INTEGER(HSIZE_T), DIMENSION(*), INTENT(OUT) :: maxdims 
                                                   ! Array to store max dimension 
                                                   ! sizes  
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
 
          END SUBROUTINE h5sget_simple_extent_dims_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sget_simple_extent_ndims_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sget_simple_extent_ndims_f</strong>
<pre>

          SUBROUTINE h5sget_simple_extent_ndims_f(space_id, rank, hdferr) 

            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id     ! Dataspace identifier 
            INTEGER, INTENT(OUT) :: rank               ! Number of dimensions 
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
 
          END SUBROUTINE h5sget_simple_extent_ndims_f
</pre>          



<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sget_simple_extent_npoints_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sget_simple_extent_npoints_f</strong>
<pre>

          SUBROUTINE h5sget_simple_extent_npoints_f(space_id, npoints, hdferr) 

            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id    ! Dataspace identifier 
            INTEGER(HSIZE_T), INTENT(OUT) :: npoints  ! Number of elements in 
                                                      ! dataspace
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
 
          END SUBROUTINE h5sget_simple_extent_npoints_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sget_simple_extent_type_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sget_simple_extent_type_f</strong>
<pre>

          SUBROUTINE h5sget_simple_extent_type_f(space_id, classtype, hdferr) 

            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier 
            INTEGER, INTENT(OUT) :: classtype      ! Class type , possible values
                                                   ! are: 
                                                   !  H5S_NO_CLASS_F 
                                                   !  H5S_SCALAR_F 
                                                   !  H5S_SIMPLE_F 
            INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                                  ! 0 on success and -1 on failure
 
          END SUBROUTINE h5sget_simple_extent_type_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sis_simple_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sis_simple_f</strong>
<pre>

          SUBROUTINE h5sis_simple_f(space_id, flag, hdferr) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id  ! Dataspace identifier 
            LOGICAL, INTENT(OUT) :: flag            ! Flag, idicates if dataspace
                                                    ! is simple or not ( TRUE or
                                                    ! FALSE)  
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
 
          END SUBROUTINE h5sis_simple_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5soffset_simple_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5soffset_simple_f</strong>
<pre>

          SUBROUTINE h5soffset_simple_f(space_id, offset, hdferr) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier 
            INTEGER(HSSIZE_T), DIMENSION(*), INTENT(IN) ::  offset
                                                 ! The offset at which to position
                                                 ! the selection  
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
 
          END SUBROUTINE h5soffset_simple_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sselect_all_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sselect_all_f</strong>
<pre>

          SUBROUTINE h5sselect_all_f(space_id, hdferr) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id  ! Dataspace identifier 
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
          END SUBROUTINE h5sselect_all_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sselect_elements_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sselect_elements_f</strong>
<pre>

          SUBROUTINE h5sselect_elements_f(space_id, operator, num_elements, &
                                          coord, hdferr) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier 
            INTEGER, INTENT(IN) :: op     ! Flag, valid values are:
                                          ! H5S_SELECT_SET_F 
                                          ! H5S_SELECT_OR_F 
            INTEGER, INTENT(IN) :: num_elements  ! Number of elements to be
                                                 ! selected
            INTEGER(HSSIZE_T), DIMENSION(*,*), INTENT(IN) :: coord 
                                          ! Array with the coordinates
                                          ! of the selected elements
                                          ! coord(num_elements, rank)
            INTEGER, INTENT(OUT) :: hdferr     ! Error code
                                               ! 0 on success and -1 on failure
 
          END SUBROUTINE h5sselect_elements_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sselect_hyperslab_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sselect_hyperslab_f</strong>
<pre>

          SUBROUTINE h5sselect_hyperslab_f(space_id, operator, start, count, &
                                           hdferr, stride, block) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier 
            INTEGER, INTENT(IN) :: op     ! Flag, valid values are:
                                          ! H5S_SELECT_SET_F
                                          ! H5S_SELECT_OR_F
                                          !  
            INTEGER(HSSIZE_T), DIMENSION(*), INTENT(IN) :: start
                                          ! Starting coordinates of the hyperslab 
            INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN) :: count 
                                          ! Number of blocks to select 
                                          ! from dataspace 
            INTEGER, INTENT(OUT) :: hdferr     ! Error code
                                               ! 0 on success and -1 on failure
            INTEGER(HSIZE_T), DIMENSION(*), OPTIONAL, INTENT(IN) :: stride
                                          ! Array of how many elements to move
                                          ! in each direction
            INTEGER(HSIZE_T), DIMENSION(*), OPTIONAL, INTENT(IN) :: block 
                                          ! Size of the element block 
 
          END SUBROUTINE h5sselect_hyperslab_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sselect_none_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sselect_none_f</strong>
<pre>

          SUBROUTINE h5sselect_none_f(space_id, hdferr) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id  ! Dataspace identifier 
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
          END SUBROUTINE h5sselect_none_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sselect_valid_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sselect_valid_f</strong>
<pre>

          SUBROUTINE h5sselect_valid_f(space_id, flag, hdferr) 
            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id  ! Dataspace identifier 
            LOGICAL, INTENT(OUT) :: flag            ! TRUE if the selection is
                                                    ! contained within the extent,
                                                    ! FALSE otherwise. 
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
          END SUBROUTINE h5sselect_valid_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sset_extent_none_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sset_extent_none_f</strong>
<pre>

          SUBROUTINE h5sset_extent_none_f(space_id, hdferr) 

            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id  ! Dataspace identifier 
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
 
          END SUBROUTINE h5sset_extent_none_f
</pre>          


<p>&nbsp;
<p>&nbsp;
<hr>
<p>&nbsp;
<a name="h5sset_extent_simple_f">
<p>&nbsp;
</a>


<dt><strong>FORTRAN interface:</strong> &nbsp <strong>h5sset_extent_simple_f</strong>
<pre>

          SUBROUTINE h5sset_extent_simple_f(space_id, rank, current_size, &
                                            maximum_size, hdferr) 

            IMPLICIT NONE
            INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier 
            INTEGER, INTENT(IN) :: rank            ! Dataspace rank 
            INTEGER(HSIZE_T), DIMENSION(rank), INTENT(IN) :: current_size 
                                                   ! Array with the new sizes
                                                   ! of dimensions 
            INTEGER(HSIZE_T), DIMENSION(rank), INTENT(IN) ::  
                                                   ! Array with the new maximum
                                                   ! sizes of dimensions 
            INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                                 ! 0 on success and -1 on failure
 
          END SUBROUTINE h5sset_extent_simple_f
</pre>          



</dl>

<p>&nbsp;
<p>&nbsp;
<hr>



<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> 
</address>

Last modified:  20 October 1999
<br>
Describes HDF5 Release 1.5, Unreleased Development Branch


</body>
</html>