HighFive::SliceTraits< Derivate > Class Template Reference

#include <H5Slice_traits.hpp>

Public Member Functions
template<typename T >
void	read (T &array) const
template<typename T >
void	read (T *array) const
Selection	select (const ElementSet &elements) const
Selection	select (const std::vector< size_t > &columns) const
Selection	select (const std::vector< size_t > &offset, const std::vector< size_t > &count, const std::vector< size_t > &stride=std::vector< size_t >()) const
template<typename T >
void	write (const T &buffer)
template<typename T >
void	write (const T *buffer)

Private Types
typedef Derivate	derivate_type

Detailed Description

template<typename Derivate>
class HighFive::SliceTraits< Derivate >

Definition at line 26 of file H5Slice_traits.hpp.

Member Typedef Documentation

derivate_type

template<typename Derivate >

typedef Derivate HighFive::SliceTraits< Derivate >::derivate_type

private

Definition at line 106 of file H5Slice_traits.hpp.

Member Function Documentation

read() [1/2]

template<typename Derivate >

template<typename T >

void HighFive::SliceTraits< Derivate >::read ( T &  array ) const

inline

Read the entire dataset into a buffer An exception is raised is if the numbers of dimension of the buffer and of the dataset are different

The array type can be a N-pointer or a N-vector. For plain pointers not dimensionality checking will be performed, it is the user's responsibility to ensure that the right amount of space has been allocated.

Definition at line 149 of file H5Slice_traits_misc.hpp.

read() [2/2]

template<typename Derivate >

template<typename T >

void HighFive::SliceTraits< Derivate >::read ( T *  array ) const

inline

Read the entire dataset into a raw buffer

No dimensionality checks will be performed, it is the user's responsibility to ensure that the right amount of space has been allocated.

Definition at line 189 of file H5Slice_traits_misc.hpp.

select() [1/3]

template<typename Derivate >

Selection HighFive::SliceTraits< Derivate >::select ( const ElementSet &  elements ) const

inline

select a region in the current Slice/Dataset out of a list of elements

Definition at line 121 of file H5Slice_traits_misc.hpp.

select() [2/3]

template<typename Derivate >

Selection HighFive::SliceTraits< Derivate >::select ( const std::vector< size_t > &  columns ) const

inline

select a set of columns in the last dimension of this dataset. The column indices must be smaller than the dimension size.

Definition at line 92 of file H5Slice_traits_misc.hpp.

select() [3/3]

template<typename Derivate >

Selection HighFive::SliceTraits< Derivate >::select ( const std::vector< size_t > &  offset, const std::vector< size_t > &  count, const std::vector< size_t > &  stride = std::vector<size_t>()  ) const

inline

select a region in the current Slice/Dataset of 'count' points at 'offset' separated by 'stride'. If strides are not provided they will default to 1 in all dimensions. vector offset and count have to be from the same dimension

Definition at line 66 of file H5Slice_traits_misc.hpp.

write() [1/2]

template<typename Derivate >

template<typename T >

void HighFive::SliceTraits< Derivate >::write ( const T &  buffer )

inline

Write the integrality N-dimension buffer to this dataset An exception is raised is if the numbers of dimension of the buffer and of the dataset are different

The array type can be a N-pointer or a N-vector ( e.g int** integer two dimensional array )

Definition at line 210 of file H5Slice_traits_misc.hpp.

write() [2/2]

template<typename Derivate >

template<typename T >

void HighFive::SliceTraits< Derivate >::write ( const T *  buffer )

inline

Write from a raw buffer into this dataset

No dimensionality checks will be performed, it is the user's responsibility to ensure that the buffer holds the right amount of elements. For n-dimensional matrices the buffer layout follows H5 default conventions.

Definition at line 245 of file H5Slice_traits_misc.hpp.

---

The documentation for this class was generated from the following files:

• H5Slice_traits.hpp
• H5Slice_traits_misc.hpp