File: bumpy_atomic_array.hpp

package info (click to toggle)
r-bioc-alabaster.base 1.6.1%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,652 kB
  • sloc: cpp: 11,377; sh: 29; makefile: 2
file content (55 lines) | stat: -rw-r--r-- 1,744 bytes parent folder | download | duplicates (2)
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
#ifndef TAKANE_BUMPY_ATOMIC_ARRAY_HPP
#define TAKANE_BUMPY_ATOMIC_ARRAY_HPP

#include "H5Cpp.h"

#include <filesystem>
#include <stdexcept>
#include <string>

#include "utils_public.hpp"
#include "utils_bumpy_array.hpp"

/**
 * @file bumpy_atomic_array.hpp
 * @brief Validation for bumpy atomic matrices.
 */

namespace takane {

namespace bumpy_atomic_array {

/**
 * @param path Path to the directory containing the bumpy atomic array.
 * @param metadata Metadata for the object, typically read from its `OBJECT` file.
 * @param options Validation options.
 */
inline void validate(const std::filesystem::path& path, const ObjectMetadata& metadata, Options& options) {
    internal_bumpy_array::validate_directory<false>(path, "bumpy_atomic_array", "atomic_vector", metadata, options);
}

/**
 * @param path Path to a directory containing an bumpy atomic array.
 * @param metadata Metadata for the object, typically read from its `OBJECT` file.
 * @param options Validation options.
 * @return The height (i.e., first dimension extent) of the array.
 */
inline size_t height(const std::filesystem::path& path, const ObjectMetadata& metadata, Options& options) {
    return internal_bumpy_array::height(path, "bumpy_atomic_array", metadata, options);
}

/**
 * @param path Path to a directory containing an bumpy atomic array.
 * @param metadata Metadata for the object, typically read from its `OBJECT` file.
 * @param options Validation options.
 * @return Vector containing the dimensions of the array.
 */
inline std::vector<size_t> dimensions(const std::filesystem::path& path, const ObjectMetadata& metadata, Options& options) {
    return internal_bumpy_array::dimensions(path, "bumpy_atomic_array", metadata, options);
}

}

}

#endif