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
|
#ifndef RITSUKO_HDF5_GET_1D_LENGTH_HPP
#define RITSUKO_HDF5_GET_1D_LENGTH_HPP
#include "H5Cpp.h"
#include <stdexcept>
/**
* @file get_1d_length.hpp
* @brief Get the length of a 1-dimensional HDF5 dataset.
*/
namespace ritsuko {
namespace hdf5 {
/**
* Get the length of a 1-dimensional HDF5 dataset.
*
* @param space The data space of the dataset.
* @param allow_scalar Whether to allow scalars.
*
* @return Length of the dataset, i.e., the extent of its single dimension.
* If `allow_scalar = true`, zero is returned in the presence of a scalar dataset, otherwise an error is raised.
*/
inline hsize_t get_1d_length(const H5::DataSpace& space, bool allow_scalar) {
int ndims = space.getSimpleExtentNdims();
if (ndims == 0) {
if (!allow_scalar) {
throw std::runtime_error("expected a 1-dimensional dataset, got a scalar instead");
}
return 0;
}
if (ndims != 1) {
throw std::runtime_error("expected a 1-dimensional dataset, got " + std::to_string(ndims) + " dimensions instead");
}
hsize_t dims;
space.getSimpleExtentDims(&dims);
return dims;
}
/**
* Overload of `get_1d_length()` that accepts a dataset handle.
*
* @param handle Handle to a HDF5 dataset.
* @param allow_scalar Whether to allow scalars.
*
* @return Length of the dataset, i.e., the extent of its single dimension.
*/
inline hsize_t get_1d_length(const H5::DataSet& handle, bool allow_scalar) {
return get_1d_length(handle.getSpace(), allow_scalar);
}
/**
* Overload of `get_1d_length()` that accepts an attribute handle.
*
* @param handle Handle to a HDF5 attribute.
* @param allow_scalar Whether to allow scalars.
*
* @return Length of the attribute, i.e., the extent of its single dimension.
*/
inline hsize_t get_1d_length(const H5::Attribute& handle, bool allow_scalar) {
return get_1d_length(handle.getSpace(), allow_scalar);
}
/**
* @param space The data space of the dataset.
* @return Whether `space` represents a scalar dataset.
*/
inline bool is_scalar(const H5::DataSpace& space) {
return space.getSimpleExtentNdims() == 0;
}
/**
* Overload of `is_scalar()` that accepts a dataset handle.
* @param handle Handle to a HDF5 dataset.
* @return Whether `space` represents a scalar dataset.
*/
inline bool is_scalar(const H5::DataSet& handle) {
return is_scalar(handle.getSpace());
}
/**
* Overload of `is_scalar()` that accepts an attribute handle.
* @param handle Handle to a HDF5 attribute.
* @return Whether `space` represents a scalar dataset.
*/
inline bool is_scalar(const H5::Attribute& handle) {
return is_scalar(handle.getSpace());
}
}
}
#endif
|
