bumpy_data_frame_array.hpp File Reference

Validation for bumpy data frame matrices. More...

#include "H5Cpp.h"
#include <filesystem>
#include <stdexcept>
#include <string>
#include "utils_public.hpp"
#include "utils_bumpy_array.hpp"

Include dependency graph for bumpy_data_frame_array.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	takane
	takane validation functions.

Functions
void	takane::bumpy_data_frame_array::validate (const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)
size_t	takane::bumpy_data_frame_array::height (const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)
std::vector< size_t >	takane::bumpy_data_frame_array::dimensions (const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)

Detailed Description

Validation for bumpy data frame matrices.

Function Documentation

dimensions()

std::vector< size_t > takane::bumpy_data_frame_array::dimensions ( const std::filesystem::path & path, const ObjectMetadata & metadata, Options & options )

inline

Parameters

path	Path to a directory containing an bumpy data frame array.
metadata	Metadata for the object, typically read from its OBJECT file.
options	Validation options.

Returns

Vector containing the dimensions of the array.

height()

size_t takane::bumpy_data_frame_array::height ( const std::filesystem::path & path, const ObjectMetadata & metadata, Options & options )

inline

Parameters

path	Path to a directory containing an bumpy data frame array.
metadata	Metadata for the object, typically read from its OBJECT file.
options	Validation options.

Returns

The height (i.e., first dimension extent) of the array.

validate()

void takane::bumpy_data_frame_array::validate ( const std::filesystem::path & path, const ObjectMetadata & metadata, Options & options )

inline

Parameters

path	Path to the directory containing the bumpy data frame array.
metadata	Metadata for the object, typically read from its OBJECT file.
options	Validation options.