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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* 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 COPYING file, which can be found at the root of the source code *
* distribution tree, or in https://www.hdfgroup.org/licenses. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Programmer: Quincey Koziol
* Saturday, September 12, 2015
*
* Purpose: This file contains declarations which define macros for the
* H5S package. Including this header means that the source file
* is part of the H5S package.
*/
#ifndef H5Smodule_H
#define H5Smodule_H
/* Define the proper control macros for the generic FUNC_ENTER/LEAVE and error
* reporting macros.
*/
#define H5S_MODULE
#define H5_MY_PKG H5S
#define H5_MY_PKG_ERR H5E_DATASPACE
/**\defgroup H5S H5S
*
* Use the functions in this module to manage HDF5 dataspaces \Emph{and} selections.
*
* HDF5 dataspaces describe the \Emph{shape} of datasets in memory or in HDF5
* files. Dataspaces can be empty (#H5S_NULL), a singleton (#H5S_SCALAR), or
* a multi-dimensional, regular grid (#H5S_SIMPLE). Dataspaces can be re-shaped.
*
* Subsets of dataspaces can be "book-marked" or used to restrict I/O operations
* using \Emph{selections}. Furthermore, certain set operations are supported
* for selections.
*
* <table>
* <tr><th>Create</th><th>Read</th></tr>
* <tr valign="top">
* <td>
* \snippet{lineno} H5S_examples.c create
* </td>
* <td>
* \snippet{lineno} H5S_examples.c read
* </td>
* <tr><th>Update</th><th>Delete</th></tr>
* <tr valign="top">
* <td>
* \snippet{lineno} H5S_examples.c update
* </td>
* <td>
* \snippet{lineno} H5S_examples.c delete
* </td>
* </tr>
* </table>
*
*/
#endif /* H5Smodule_H */
|
