Value backed, read only tensor interface. More...

#include <lin/core/types/const_base.hpp>

Inheritance diagram for lin::internal::ConstBase< D >:

Public Types
typedef traits< D >	Traits
	Traits information for this type. More...

Public Types inherited from lin::internal::Stream< D >
typedef traits< D >	Traits
	Traits information for this type. More...

Public Member Functions
constexpr	ConstBase (ConstBase< D > const &)=default

constexpr	ConstBase (ConstBase< D > &&)=default

constexpr ConstBase< D > &	operator= (ConstBase< D > const &)=default

constexpr ConstBase< D > &	operator= (ConstBase< D > &&)=default

constexpr Traits::elem_t const *	data () const
	Retrives a constant pointer to the element backing array. More...

constexpr Traits::elem_t const &	operator() (size_t i, size_t j) const
	Provides read only access to tensor elements. More...

constexpr Traits::elem_t const &	operator() (size_t i)
	Provides read only access to tensor elements. More...

Public Member Functions inherited from lin::internal::Stream< D >
constexpr	Stream (Stream< D > const &)=default

constexpr	Stream (Stream< D > &&)=default

constexpr Stream< D > &	operator= (Stream< D > const &)=default

constexpr Stream< D > &	operator= (Stream< D > &&)=default

constexpr size_t	rows () const

constexpr size_t	cols () const

constexpr size_t	size () const

constexpr Traits::elem_t	operator() (size_t i, size_t j) const
	Provides read only access to tensor elements. More...

constexpr Traits::elem_t	operator() (size_t i) const
	Provides read only access to tensor elements. More...

constexpr Traits::elem_t	operator[] (size_t i) const
	Provides read only access to tensor elements. More...

constexpr Traits::eval_t	eval () const
	Forces evaluation of this stream to a value backed type. More...

Public Member Functions inherited from lin::internal::Dimensions< D >
constexpr	Dimensions (Dimensions< D > const &)=default

constexpr	Dimensions (Dimensions< D > &&)=default

constexpr Dimensions< D > &	operator= (Dimensions< D > const &)=default

constexpr Dimensions< D > &	operator= (Dimensions< D > &&)=default

constexpr size_t	rows () const

constexpr size_t	cols () const

constexpr void	resize (size_t r, size_t c)
	Resizes a tensor's dimensions. More...

Additional Inherited Members
Protected Member Functions inherited from lin::internal::Stream< D >
constexpr D &	derived ()

constexpr D const &	derived () const

Detailed Description

template<class D>
class lin::internal::ConstBase< D >

Value backed, read only tensor interface.

Template Parameters

D	Derived type.

This is the third of the three main entry points on the lin inheritance tree after internal::Mapping.

Here, direct tracking of runtime dimensions and the ability to resize is added. A getter to retrive a pointer to the element backing array is also included.

The main purpose is to provide an interface that supports value backed types - i.e. those directly storing tensor elements in a member array or and a pointer.

See also: internal::Stream; internal::Mapping; internal::Tensor

Member Typedef Documentation

template<class D>

typedef traits<D> lin::internal::ConstBase< D >::Traits

Traits information for this type.

See also: internal::traits

Member Function Documentation

template<class D>

constexpr Traits::elem_t const* lin::internal::ConstBase< D >::data ( ) const

inline

Retrives a constant pointer to the element backing array.

Returns: Constant pointer to the backing array.

The elements of the tensor are layed out in row major order in the backing array. They are stored contiguously in memory.

template<class D>

constexpr Traits::elem_t const& lin::internal::ConstBase< D >::operator()	(	size_t	i,
		size_t	j
	)		const

inline

Provides read only access to tensor elements.

Parameters

i	Row index.
j	Column index.

Returns: Value of the tensor element.

If the indices are out of bounds as defined by the tensor's current dimensions, lin assertion errors will be triggered.

template<class D>

constexpr Traits::elem_t const& lin::internal::ConstBase< D >::operator() ( size_t i )

inline

Provides read only access to tensor elements.

Parameters

i Index

Returns: Value of the tensor element.

Element access proceeds as if all the elements of the tensor stream were flattened into an array in row major order.

If the index is out of bounds as defined by the tensor's current size, lin lin assertion errors will be triggered.

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

include/lin/core/types/const_base.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class D> class lin::internal::ConstBase< D >

Member Typedef Documentation

Member Function Documentation

template<class D>
class lin::internal::ConstBase< D >