User Manual, Developers Guide and API Documentation

wns::container::Matrix< T, N, R > Class Template Reference

This template class provides a simple N-dimensional "matrix".

#include <container/Matrix.hpp>

Inheritance diagram for wns::container::Matrix< T, N, R >:

Inheritance graph
[legend]
Collaboration diagram for wns::container::Matrix< T, N, R >:

Collaboration graph
[legend]

List of all members.

Public Types

typedef const HyperplaneTypeConstReference
 Constant reference to the next hyperplane (what is returned after [] has been applied once).
typedef Matrix< T, N-1, R > HyperplaneType
typedef SuperType::IndexType IndexType
 The type of indexes in the [] operator.
typedef HyperplaneTypeReference
 Reference to the next hyperplane (what is returned after [] has been applied once).
typedef
MultiAccessibleDefs::SizeType 
SizeType
 The type for sizes used in this class.
typedef SuperType::ValueType ValueType
 The type of the values that are accessed.

Public Member Functions

virtual SizeType dimSize (const SizeType &dim) const
 Get the size of a dimension.
virtual SizeType getSize (const SizeType &dim) const
virtual bool isEmpty () const
 Check if the Matrix is empty.
 Matrix (const SizeType sizes[N], const ValueType defaultValue=ValueType())
 Matrix ()
virtual bool operator!= (const Matrix &other) const
virtual bool operator== (const Matrix &other) const
virtual ConstReference operator[] (const IndexType &index) const
virtual Reference operator[] (const IndexType &index)
virtual ~Matrix ()

Private Types

typedef
MultiReadWriteAccessible< T, N,
R > 
SuperType

Private Attributes

std::vector< HyperplaneTypev


Detailed Description

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
class wns::container::Matrix< T, N, R >

Definition at line 43 of file Matrix.hpp.


Member Typedef Documentation

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
typedef const HyperplaneType& wns::container::Matrix< T, N, R >::ConstReference

Reimplemented from wns::container::MultiReadAccessible< T, N, R, I >.

Definition at line 54 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
typedef Matrix<T, N - 1, R> wns::container::Matrix< T, N, R >::HyperplaneType

Definition at line 52 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
typedef SuperType::IndexType wns::container::Matrix< T, N, R >::IndexType

Reimplemented from wns::container::MultiReadWriteAccessible< T, N, R >.

Definition at line 49 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
typedef HyperplaneType& wns::container::Matrix< T, N, R >::Reference

Reimplemented from wns::container::MultiWriteAccessible< T, N, I >.

Definition at line 53 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
typedef MultiAccessibleDefs::SizeType wns::container::Matrix< T, N, R >::SizeType

Reimplemented from wns::container::MultiReadWriteAccessible< T, N, R >.

Definition at line 50 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
typedef MultiReadWriteAccessible<T, N, R> wns::container::Matrix< T, N, R >::SuperType [private]

Definition at line 46 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
typedef SuperType::ValueType wns::container::Matrix< T, N, R >::ValueType

Reimplemented from wns::container::MultiReadWriteAccessible< T, N, R >.

Definition at line 48 of file Matrix.hpp.


Constructor & Destructor Documentation

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
wns::container::Matrix< T, N, R >::Matrix (  )  [inline]

Definition at line 56 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
wns::container::Matrix< T, N, R >::Matrix ( const SizeType  sizes[N],
const ValueType  defaultValue = ValueType() 
) [inline]

Definition at line 61 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
virtual wns::container::Matrix< T, N, R >::~Matrix (  )  [inline, virtual]

Definition at line 68 of file Matrix.hpp.


Member Function Documentation

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
virtual SizeType wns::container::Matrix< T, N, R >::dimSize ( const SizeType dim  )  const [inline, virtual]

Parameters:
dim (in) The dimension to get the size for.
Returns:
Size of dimension dim.

Implements wns::container::MultiReadWriteAccessible< T, N, R >.

Definition at line 114 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
virtual SizeType wns::container::Matrix< T, N, R >::getSize ( const SizeType dim  )  const [inline, virtual]

Definition at line 108 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
virtual bool wns::container::Matrix< T, N, R >::isEmpty (  )  const [inline, virtual]

Definition at line 135 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
virtual bool wns::container::Matrix< T, N, R >::operator!= ( const Matrix< T, N, R > &  other  )  const [inline, virtual]

Definition at line 101 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
virtual bool wns::container::Matrix< T, N, R >::operator== ( const Matrix< T, N, R > &  other  )  const [inline, virtual]

Definition at line 88 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
virtual ConstReference wns::container::Matrix< T, N, R >::operator[] ( const IndexType index  )  const [inline, virtual]

Definition at line 80 of file Matrix.hpp.

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
virtual Reference wns::container::Matrix< T, N, R >::operator[] ( const IndexType index  )  [inline, virtual]

Definition at line 72 of file Matrix.hpp.


Member Data Documentation

template<typename T, MultiAccessibleDefs::SizeType N, typename R = const T&>
std::vector<HyperplaneType> wns::container::Matrix< T, N, R >::v [private]

Definition at line 141 of file Matrix.hpp.


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

Generated on Sat May 26 03:32:52 2012 for openWNS by  doxygen 1.5.5