echelon::hdf5 Namespace Reference

echelon.hdf5's core namespace More...

Classes
class	attribute
	A handle to an HDF5 attribute. More...
class	attribute_repository
	Attribute manager, which should be embedded into a parent object, which supports attributes. More...
class	broken_contract_exception
	Exception, which is thrown, if a require_*-type method can't fulfill the contract. More...
class	dataset
	A handle to an HDF5 dataset. More...
class	dataset_dimensions
	Accessor class for the dimensions of a dataset. More...
class	dataset_options
	Additional options for the dataset creation. More...
class	dimension
	Handle to a dataset dimension. More...
class	dimension_scale
	A handle to a dimension scale. More...
class	file
	A handle to an HDF5 file object. More...
class	group
	A handle to an HDF5 group object. More...
class	link
	A link (directed edge) between two HDF5 objects. More...
class	non_existing_member_exception
	Exception, which is thrown, if a requested object does not exist. More...
class	object
	Polymorphic handle to an HDF5 object. More...
class	object_reference
	A reference to an HDF5 object. More...
class	scalar_dataset
	A handle to an HDF5 scalar dataset. More...
class	slice
	A slice (rectangular portion) of an HDF5 dataset. More...
class	type
	A handle to an HDF5 type. More...
class	type_layout
	Description of a compound type's internal structure. More...
class	wrong_object_type_exception
	Exception, which is thrown, if the conversion of a polymorphic handle to a more specialized, but incompatible, handle fails. More...

Functions
template<typename C , typename... Args>
array_slice< typename container_trait< C >::value_type >	make_slice (C &&container, Args...args)
	Slice a container. More...
template<typename C >
auto	reshape (C &container, const std::vector< std::size_t > &new_shape) -> decltype(container.reshape(new_shape))
	Reshapes the container. More...
template<typename Base , typename Bound >
range_t< Base, Bound >	range (Base base, Bound bound, hsize_t stride=1)
	Constructs an index range. More...

Detailed Description

echelon.hdf5's core namespace

Function Documentation

template<typename C , typename... Args>

array_slice<typename container_trait<C>::value_type> echelon::hdf5::make_slice	(	C &&	container,
		Args...	args
	)

Slice a container.

Template Parameters

C	type of the container; must fulfill the Container requirements
Args	types of the index range specifiers

Parameters

container	the sliced container
args	index range specifiers

template<typename Base , typename Bound >

range_t<Base, Bound> echelon::hdf5::range ( Base  base, Bound  bound, hsize_t  stride = 1  )

inline

Constructs an index range.

Parameters

base	base index (or lower bound)
bound	upper bound
stride	difference between two consecutive indices

template<typename C >

auto echelon::hdf5::reshape ( C &  container, const std::vector< std::size_t > &  new_shape  ) -> decltype(container.reshape(new_shape))

inline

Initial value:

{
    return reshape(container, new_shape, adl_enabler{})

Reshapes the container.

Template Parameters

C	type of the container

Parameters

container	container, which should be reshaped
new_shape	new shape of the container