Commit 90f1ab4
committed
[#282]:svarga:docs, decorate H5D public surface + clean group titles
Parallel of the H5A decoration sweep for the dataset (H5D*) family.
Most H5D files already had alias-first docstrings from the prior
sweep -- this turn focuses on the gaps (H5Dread, H5Dappend, H5Dsparse,
H5Dopen) and on shortening the @defgroup titles across the API so
the rendered Topics / Modules tree reads cleanly.
Unlike H5A, the H5D public surface does not use SFINAE on the parent
type -- every signature takes a concrete h5::fd_t / h5::ds_t -- so the
H5CPP_*_RET return-type macro pattern from H5A does not apply here.
The lowercase hid_t template-param rename does not apply either.
DOCSTRINGS
* H5Dread.hpp -- 8 overloads modernised from the older
chained-aliases format to the full template (one-liner @brief,
detailed description, \par_* parameter aliases, @throws,
@code example, \sa_h5cpp / \sa_hdf5, @sa cross-refs):
- read(ds, T* ptr, args...) -- low-level raw pointer
- read(fd, path, T* ptr, args...)
- read(file_path, path, T* ptr, args...)
- read(ds, T& ref, args...) -- primary by-reference path
- read(fd, path, T& ref, args...)
- read(file_path, path, T& ref, args...)
- T read(ds, args...) -- return-by-value primary
- T read(fd, path, args...)
- T read(file_path, path, args...)
Each docstring distinguishes its overload's role (primary vs
convenience) and points at sibling overloads through @sa.
* H5Dappend.hpp -- 4 public entry points decorated:
- append(pt, const T&) -- buffered element append
- append(pt, const T*) -- raw-chunk path
- flush(pt) -- explicit chunk flush
- reset(pt) -- dimension-tracker reset
Includes streaming-loop @code example showing the create / append
/ flush flow against an extendable chunked dataset.
* H5Dsparse.hpp -- both public entry points decorated:
- write<T, LOC>(parent, path, sparse_src)
- read<T, LOC>(parent, path)
Documents the CSC group layout, scipy / 10x / Loompy interop,
the uint32-on-disk index width limit, the sync() /
makeCompressed() preconditions, and the ColMajor static_assert.
Cross-references the Supported Linear Algebra Types page §
Sparse storage layout.
* H5Dopen.hpp -- single public entry point modernised:
- open(fd, path, dapl) -- with note on the high-throughput
pipeline tag auto-initialisation path.
GROUP TITLES (h5cpp/H5config.hpp)
* Renamed the @defgroup titles so the rendered group page titles
read as short noun phrases instead of the inline-signature form
the project used historically:
- io-create "template <T> ds_t create( ... );"
-> "HDF5 datasets -- create"
- io-read "h5::read<T>( ds | path [,offset]...)"
-> "HDF5 datasets -- read"
- io-write "herr_t h5::write<T>( ds | path, object<T>...)"
-> "HDF5 datasets -- write"
- io-append "h5::append<T>( pt , T object);"
-> "HDF5 packet table -- append"
- io-wrap "`handle` | `type_id` with RAII"
-> "RAII handles"
- file-io "`h5::open` | `h5::create` | `h5::mute` | `h5::unmute`"
-> "HDF5 files"
* Added @defgroup sparse-io ("HDF5 sparse datasets") so the
func_sparse_hdr alias actually produces a group page (was
previously a dangling reference). Mirrors the attribute-io
fix from the H5A sweep.
* The attribute-io title rename ("HDF5 attributes") landed in the
H5A commit and is unchanged here.
ALIAS VOCABULARY
* docs/links/h5cpp.txt + docs/aliases.md catalog -- added
\func_append_hdr (-> @InGroup io-append) alongside the existing
func_*_hdr family. Now used by the H5Dappend.hpp public surface.
VERIFICATION
* End-to-end compile + run on the H5D public surface: create<float>
with current_dims{10,10}, write a vector, read it back, append 32
samples through h5::pt_t with chunk{16}, flush. All operations
return 0, no diagnostic output.
* Doxygen build clean -- no warnings.log produced.1 parent 0504008 commit 90f1ab4
17 files changed
Lines changed: 770 additions & 506 deletions
File tree
- docs
- links
- reports/architecture
- doxy
- h5cpp
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
139 | 139 | | |
140 | 140 | | |
141 | 141 | | |
142 | | - | |
143 | | - | |
144 | | - | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
145 | 146 | | |
146 | | - | |
| 147 | + | |
147 | 148 | | |
148 | 149 | | |
149 | 150 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
82 | 82 | | |
83 | 83 | | |
84 | 84 | | |
85 | | - | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
86 | 92 | | |
87 | 93 | | |
88 | | - | |
| 94 | + | |
89 | 95 | | |
90 | 96 | | |
91 | | - | |
| 97 | + | |
92 | 98 | | |
93 | 99 | | |
| 100 | + | |
94 | 101 | | |
95 | | - | |
| 102 | + | |
96 | 103 | | |
97 | 104 | | |
Lines changed: 0 additions & 64 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
5 | | - | |
6 | | - | |
7 | | - | |
8 | | - | |
9 | | - | |
10 | | - | |
11 | | - | |
12 | | - | |
13 | | - | |
14 | 3 | | |
15 | 4 | | |
16 | 5 | | |
| |||
420 | 409 | | |
421 | 410 | | |
422 | 411 | | |
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 | | - | |
Lines changed: 0 additions & 45 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
5 | | - | |
6 | | - | |
7 | | - | |
8 | | - | |
9 | | - | |
10 | 3 | | |
11 | 4 | | |
12 | 5 | | |
| |||
238 | 231 | | |
239 | 232 | | |
240 | 233 | | |
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 | | - | |
Lines changed: 0 additions & 40 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
5 | | - | |
6 | | - | |
7 | | - | |
8 | | - | |
9 | 3 | | |
10 | 4 | | |
11 | 5 | | |
| |||
449 | 443 | | |
450 | 444 | | |
451 | 445 | | |
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 | | - | |
Lines changed: 0 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
5 | | - | |
6 | | - | |
7 | | - | |
8 | | - | |
9 | | - | |
10 | 3 | | |
11 | 4 | | |
12 | 5 | | |
| |||
0 commit comments