A multidimensional view onto an array. More...

#include <multi_array_view.hpp>

Public Types
using	value_type = T
	value type of the array

Public Member Functions
	multi_array_view (T *data_, std::vector< std::size_t > shape_)
	Constructs a new view for a given array using a given shape. More...

template<typename... Indices, typename Enabler = typename std::enable_if< detail::all_integral<Indices...>::value>::type>
const value_type &	operator() (Indices...indices) const
	Accesses a specified element. More...

template<typename... Indices, typename Enabler = typename std::enable_if< detail::all_integral<Indices...>::value>::type>
value_type &	operator() (Indices...indices)
	Accesses a specified element. More...

template<typename... Args, typename Enabler = typename std::enable_if< !detail::all_integral<Args...>::value>::type>
echelon::hdf5::array_slice< T >	operator() (Args...args)
	Slice the array. More...

const value_type *	data () const
	Direct access to the underlying array. More...

value_type *	data ()
	Direct access to the underlying array. More...

const std::vector< std::size_t > &	shape () const
	The shape of the array.

Detailed Description

template<typename T>
class echelon::multi_array_view< T >

A multidimensional view onto an array.

Template Parameters

T	the value type of the array

Constructor & Destructor Documentation

template<typename T >

echelon::multi_array_view< T >::multi_array_view	(	T *	data_,
		std::vector< std::size_t >	shape_
	)

inline

Constructs a new view for a given array using a given shape.

Precondition: Let $(s_1,...,s_{N})$ be the requested shape and let be the size of the underlying memory block, then $\prod_{i} s_{i} = s$ should hold.

Parameters

container_	the adapted container
shape_	the shape of the array

Member Function Documentation

template<typename T >

const value_type* echelon::multi_array_view< T >::data ( ) const

inline

Direct access to the underlying array.

Returns: a pointer to the underlying array.

template<typename T >

value_type* echelon::multi_array_view< T >::data ( )

inline

Direct access to the underlying array.

Returns: a pointer to the underlying array.

template<typename T >

template<typename... Indices, typename Enabler = typename std::enable_if< detail::all_integral<Indices...>::value>::type>

const value_type& echelon::multi_array_view< T >::operator() ( Indices... indices ) const

inline

Accesses a specified element.

Template Parameters

Indices Types of the indices. All indices should have integral type.

Precondition: Let $\left(s_1,...s_{rank}\right)$ be the shape of the array and let $\left(i_1,...i_{rank_2}\right)$ be the tuple of indices, then and $i_{i} < s_{i}$ for every $i \in \left\{ 0,...,rank-1 \right\}$ should hold.

Parameters

indices Indices of the requested element

Returns: the specified element

template<typename T >

template<typename... Indices, typename Enabler = typename std::enable_if< detail::all_integral<Indices...>::value>::type>

value_type& echelon::multi_array_view< T >::operator() ( Indices... indices )

inline

Accesses a specified element.

Template Parameters

Indices Types of the indices. All indices should have integral type.

Precondition: Let $\left(s_1,...s_{rank}\right)$ be the shape of the array and let $\left(i_1,...i_{rank_2}\right)$ be the tuple of indices, then and $i_{i} < s_{i}$ for every $i \in \left\{ 0,...,rank-1 \right\}$ should hold.

Parameters

indices Indices of the requested element

Returns: the specified element

template<typename T >

template<typename... Args, typename Enabler = typename std::enable_if< !detail::all_integral<Args...>::value>::type>

echelon::hdf5::array_slice<T> echelon::multi_array_view< T >::operator() ( Args... args )

inline

Slice the array.

Template Parameters

Args	types of the index range specifiers

Parameters

args	index range specifiers

Returns: the specified slice.

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

multi_array_view.hpp

Public Types

Public Member Functions

Detailed Description

template<typename T> class echelon::multi_array_view< T >

Constructor & Destructor Documentation

Member Function Documentation

template<typename T>
class echelon::multi_array_view< T >