This is the base class for the other matrices types. More...

#include <MathUtilities.h>

Inheritance diagram for SNgeneric< T, tp_size >:

[legend]

Public Member Functions
virtual unsigned int	getSize () const final

virtual T &	at (const m_num, const m_num) final

virtual T	get (const m_num, const m_num) const final

virtual SNline< T, tp_size >	getSNline (m_num l) const

template<class V , unsigned int s>
void	subtract (const SNgeneric< V, s > &)

template<class V , unsigned int s>
void	subtract (const SNgaussian< V, s > &)

SNgaussian< T, tp_size >	getGaussian (const m_num c) const

template<class V , unsigned int s>
bool	isNumericallyEqual (const SNgeneric< V, s > &A, const double &epsilon) const

Private Member Functions
virtual T	_get (const m_num, const m_num) const =0

virtual T &	_at (const m_num, const m_num)=0

virtual void	checkRangeCorectness (const m_num &, const m_num &) const final

Detailed Description

template<class T, unsigned int tp_size>
class SNgeneric< T, tp_size >

This is the base class for the other matrices types.

A matrix can be

diagonal
upper/lower triangular
a gaussian transformation
symmetric
etc.

Each of these types have different implementations for storing the elements, perform equality tests (opertor==), multiplication (operator*) and so on.

What you need in your subclass :

override T _get
- _get(i,j) has to return the value of the element (i,j) of your matrix.
override T& _at
- _at(i,j) has to return a reference to the element (i,j) of your matrix.
- In consequence, _at(i,j) should throw 'SNchangeNotAllowedException' if the requested element cannot be modified. For example requesting the element (1,4) of a lower triangular matrix.
- _at is intended to populate the matrix.

As an example, on a lower diagonal matrix,

_get(1,3) returns 0 (by value)
_at(1,3) throws SNchangeNotAllowedException

Member Function Documentation

template<class T, unsigned int tp_size>

virtual T& SNgeneric< T, tp_size >::_at	(	const m_num	,
		const m_num
	)

privatepure virtual

Return by reference the requested element of the matrix

Implemented in SNmatrix< T, tp_size >, SNgaussian< T, tp_size >, SNlowerTriangular< T, tp_size >, SNmultiGaussian< T, tp_size >, SNpermutation< T, tp_size >, SNupperTriangular< T, tp_size >, and SNidentity< T, tp_size >.

template<class T, unsigned int tp_size>

virtual T SNgeneric< T, tp_size >::_get	(	const m_num	,
		const m_num
	)		const

privatepure virtual

Return by value the requested element of the matrix

Implemented in SNmatrix< T, tp_size >, SNgaussian< T, tp_size >, SNmultiGaussian< T, tp_size >, SNpermutation< T, tp_size >, SNlowerTriangular< T, tp_size >, SNupperTriangular< T, tp_size >, and SNidentity< T, tp_size >.