Namespace for all chihaya functions. More...

Classes
struct	ArrayDetails
	Details about an array. More...

struct	Options
	Validation options. More...

Enumerations
enum	ArrayType { BOOLEAN = 0 , INTEGER = 1 , FLOAT = 2 , STRING = 3 }

Functions
ArrayDetails	validate_binary_arithmetic (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_binary_comparison (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_binary_logic (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_combine (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_constant_array (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_custom_array (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_dense_array (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_dimnames (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_external_hdf5 (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_matrix_product (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_sparse_matrix (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_subset (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_subset_assignment (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_transpose (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_unary_arithmetic (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_unary_comparison (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_unary_logic (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_unary_math (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate_unary_special_check (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ArrayDetails	validate (const H5::Group &group, const ritsuko::Version &version, const Options &options)

ritsuko::Version	extract_version (const H5::Group &group)

ArrayDetails	validate (const H5::Group &group, const Options &options)

ArrayDetails	validate (const std::string &path, const std::string &name, const Options &options)

ArrayDetails	validate (const std::string &path, const std::string &name)

Detailed Description

Namespace for all chihaya functions.

Enumeration Type Documentation

◆ ArrayType

enum chihaya::ArrayType

Type of the array. Operations involving mixed types will generally result in promotion to the more advanced types, e.g., an INTEGER and FLOAT addition will result in promotion to FLOAT. Note that operations involving the same types are not guaranteed to preserve type, e.g., INTEGER division is assumed to produce a FLOAT.

Function Documentation

◆ extract_version()

ritsuko::Version chihaya::extract_version ( const H5::Group & group )

inline

The version is taken from the delayed_version attribute of the group. This should be a version string of the form <MAJOR>.<MINOR>. For back-compatibility purposes, the string "1.0.0" is also allowed, corresponding to version 1.0; and if delayed_version is missing, it defaults to 0.99.

Parameters

group HDF5 group corresponding to a delayed operation or array.

Returns: Version of the chihaya specification.

◆ validate() [1/4]

ArrayDetails chihaya::validate	(	const H5::Group &	group,
		const Options &	options )

inline

Overload of validate() that extracts the version from group via extract_version().

Parameters

group	HDF5 group representing a delayed operation or array.
options	Validation options, see `validate()` for details.

Returns: Details of the array after all delayed operations in group (and its children) have been applied.

◆ validate() [2/4]

ArrayDetails chihaya::validate	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Validate a HDF5 group representing a delayed oepration or array. For operations, this function will first search options.custom_operation_validate_registry for an available validation function. For arrays, this function will first search options.custom_array_validate_registry for an available validation function.

Parameters

group	HDF5 group representing a delayed operation or array.
version	Version of the chihaya specification.
options	Validation options, possibly containing custom validation functions.

Returns: Details of the array after all delayed operations in group (and its children) have been applied.

◆ validate() [3/4]

ArrayDetails chihaya::validate	(	const std::string &	path,
		const std::string &	name )

inline

Overload of validate() that accepts a file path and group name, and uses the default Options.

Parameters

path	Path to a HDF5 file.
name	Name of the HDF5 group inside the file representing a delayed operation or array.

Returns: Details of the array after all delayed operations have been applied.

◆ validate() [4/4]

ArrayDetails chihaya::validate	(	const std::string &	path,
		const std::string &	name,
		const Options &	options )

inline

Overload of validate() that accepts a file path and group name.

Parameters

path	Path to a HDF5 file.
name	Name of the HDF5 group inside the file representing a delayed operation or array.
options	Validation options, see `validate()` for details.

Returns: Details of the array after all delayed operations have been applied.

◆ validate_binary_arithmetic()

ArrayDetails chihaya::validate_binary_arithmetic	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a binary arithmetic operation.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the object after applying the arithmetic operation. Otherwise, if the validation failed, an error is raised.

◆ validate_binary_comparison()

ArrayDetails chihaya::validate_binary_comparison	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a binary comparison.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the object after applying the comparison operation. Otherwise, if the validation failed, an error is raised.

◆ validate_binary_logic()

ArrayDetails chihaya::validate_binary_logic	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a binary logical operation.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the object after applying the logical operation. Otherwise, if the validation failed, an error is raised.

◆ validate_combine()

ArrayDetails chihaya::validate_combine	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a combining operation.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the combined object. Otherwise, if the validation failed, an error is raised.

◆ validate_constant_array()

ArrayDetails chihaya::validate_constant_array	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a constant array.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the constant array. Otherwise, if the validation failed, an error is raised.

◆ validate_custom_array()

ArrayDetails chihaya::validate_custom_array	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a custom array.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the custom array. Otherwise, if the validation failed, an error is raised.

◆ validate_dense_array()

ArrayDetails chihaya::validate_dense_array	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a dense array.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the dense array. Otherwise, if the validation failed, an error is raised.

◆ validate_dimnames()

ArrayDetails chihaya::validate_dimnames	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a dimnames assignment operation.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the object after assigning dimnames. Otherwise, if the validation failed, an error is raised.

◆ validate_external_hdf5()

ArrayDetails chihaya::validate_external_hdf5	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing an external HDF5 array.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the external HDF5 array. Otherwise, if the validation failed, an error is raised.

◆ validate_matrix_product()

ArrayDetails chihaya::validate_matrix_product	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a matrix product.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the matrix product. Otherwise, if the validation failed, an error is raised.

◆ validate_sparse_matrix()

ArrayDetails chihaya::validate_sparse_matrix	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a sparse matrix.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the sparse matrix. Otherwise, if the validation failed, an error is raised.

◆ validate_subset()

ArrayDetails chihaya::validate_subset	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a subset operation.
version	Verison of the chihaya specification.
options	Validation options.

Returns: Details of the subsetted object. Otherwise, if the validation failed, an error is raised.

◆ validate_subset_assignment()

ArrayDetails chihaya::validate_subset_assignment	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a subset assignment.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the object after subset assignment. Otherwise, if the validation failed, an error is raised.

◆ validate_transpose()

ArrayDetails chihaya::validate_transpose	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing a transposition.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the transposed object. Otherwise, if the validation failed, an error is raised.

◆ validate_unary_arithmetic()

ArrayDetails chihaya::validate_unary_arithmetic	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing an unary arithmetic operation.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the object after applying the arithmetic operation. Otherwise, if the validation failed, an error is raised.

◆ validate_unary_comparison()

ArrayDetails chihaya::validate_unary_comparison	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing an unary comparison operation.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the object after applying the comparison operation. Otherwise, if the validation failed, an error is raised.

◆ validate_unary_logic()

ArrayDetails chihaya::validate_unary_logic	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing an unary logic operation.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the object after applying the logical operation. Otherwise, if the validation failed, an error is raised.

◆ validate_unary_math()

ArrayDetails chihaya::validate_unary_math	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing an unary math operation.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the object after applying the mathal operation. Otherwise, if the validation failed, an error is raised.

◆ validate_unary_special_check()

ArrayDetails chihaya::validate_unary_special_check	(	const H5::Group &	group,
		const ritsuko::Version &	version,
		const Options &	options )

inline

Parameters

group	HDF5 group representing an unary special check operation.
version	Version of the chihaya specification.
options	Validation options.

Returns: Details of the object after applying the special check. Otherwise, if the validation failed, an error is raised.

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ ArrayType

Function Documentation

◆ extract_version()

◆ validate() [1/4]

◆ validate() [2/4]

◆ validate() [3/4]

◆ validate() [4/4]

◆ validate_binary_arithmetic()

◆ validate_binary_comparison()

◆ validate_binary_logic()

◆ validate_combine()

◆ validate_constant_array()

◆ validate_custom_array()

◆ validate_dense_array()

◆ validate_dimnames()

◆ validate_external_hdf5()

◆ validate_matrix_product()

◆ validate_sparse_matrix()

◆ validate_subset()

◆ validate_subset_assignment()

◆ validate_transpose()

◆ validate_unary_arithmetic()

◆ validate_unary_comparison()

◆ validate_unary_logic()

◆ validate_unary_math()

◆ validate_unary_special_check()