Variable-size matrix with fixed upper capacities M \( \times \) N stored in a stack-allocated array. More...

#include <Matrix.hpp>

Inheritance diagram for CDPL::Math::BoundedMatrix< T, M, N >:

Public Types
typedef T	ValueType
	The scalar value type. More...

typedef T &	Reference
	Mutable reference type to an element. More...

typedef const T &	ConstReference
	Constant reference type to an element. More...

typedef std::size_t	SizeType
	The unsigned size type. More...

typedef std::ptrdiff_t	DifferenceType
	The signed difference type. More...

typedef ValueType	ArrayType[M][N]
	The fixed-capacity 2D C-array type used for in-memory storage. More...

typedef T(*	ArrayPointer)[N]
	Pointer-to-row type for raw access to the element array. More...

typedef const T(*	ConstArrayPointer)[N]
	Constant pointer-to-row type for raw access to the element array. More...

typedef T *	Pointer
	Pointer type to a single element. More...

typedef const T *	ConstPointer
	Constant pointer type to a single element. More...

typedef MatrixReference< SelfType >	ClosureType
	Closure type used when this matrix appears inside another expression. More...

typedef const MatrixReference< const SelfType >	ConstClosureType
	Constant closure type used when this matrix appears inside another expression. More...

typedef SelfType	MatrixTemporaryType
	Concrete temporary matrix type used by expression-template machinery. More...

typedef BoundedVector< T, M *N >	VectorTemporaryType
	Concrete temporary vector type used when assembling vectors from this matrix (a bounded vector of capacity M * N). More...

typedef std::shared_ptr< SelfType >	SharedPointer
	A reference-counted smart pointer [SHPTR] for dynamically allocated `BoundedMatrix` instances. More...

typedef std::initializer_list< std::initializer_list< T > >	InitializerListType
	The initializer-list-of-rows type accepted by constructors and assignment. More...

Public Types inherited from CDPL::Math::MatrixContainer< BoundedMatrix< T, M, N > >
typedef BoundedMatrix< T, M, N >	ContainerType
	The derived matrix container type. More...

Public Types inherited from CDPL::Math::MatrixExpression< E >
typedef E	ExpressionType
	The derived matrix expression type. More...

Public Types inherited from CDPL::Math::Expression< E >
typedef E	ExpressionType
	The derived expression type (made available to expression-template machinery). More...

Public Member Functions
	BoundedMatrix ()
	Constructs an empty bounded matrix (zero rows, zero columns). More...

	BoundedMatrix (SizeType m, SizeType n)
	Constructs a bounded matrix of size \( m \times n \) with value-initialized elements. More...

	BoundedMatrix (SizeType m, SizeType n, const ValueType &v)
	Constructs a bounded matrix of size \( m \times n \) with every element initialized to v. More...

	BoundedMatrix (const BoundedMatrix &m)
	Constructs a copy of the bounded matrix m. More...

	BoundedMatrix (InitializerListType l)
	Constructs a bounded matrix from the initializer list of rows l. More...

template<typename E >
	BoundedMatrix (const MatrixExpression< E > &e)
	Constructs a bounded matrix from the matrix expression e. More...

Reference	operator() (SizeType i, SizeType j)
	Returns a mutable reference to the element at (i, j). More...

ConstReference	operator() (SizeType i, SizeType j) const
	Returns a `const` reference to the element at (i, j). More...

bool	isEmpty () const
	Tells whether the matrix is empty. More...

SizeType	getSize1 () const
	Returns the current row count. More...

SizeType	getSize2 () const
	Returns the current column count. More...

SizeType	getMaxSize1 () const
	Returns the compile-time maximum row count M. More...

SizeType	getMaxSize2 () const
	Returns the compile-time maximum column count N. More...

ArrayPointer	getData ()
	Returns a mutable pointer-to-row to the contiguous 2D element array. More...

ConstArrayPointer	getData () const
	Returns a `const` pointer-to-row to the contiguous 2D element array. More...

BoundedMatrix &	operator= (const BoundedMatrix &m)
	Copy-assigns the elements of m to this bounded matrix. More...

template<typename C >
BoundedMatrix &	operator= (const MatrixContainer< C > &c)
	Assigns the contents of the matrix container c to this bounded matrix (no alias check needed). More...

BoundedMatrix &	operator= (InitializerListType l)
	Assigns the rows in l to this bounded matrix (resizes to match, respecting the bounds). More...

template<typename E >
BoundedMatrix &	operator= (const MatrixExpression< E > &e)
	Assigns the matrix expression e to this bounded matrix (via a temporary to handle aliasing). More...

template<typename C >
BoundedMatrix &	operator+= (const MatrixContainer< C > &c)
	Adds the contents of the matrix container c element-wise to this bounded matrix (no alias check needed). More...

BoundedMatrix &	operator+= (InitializerListType l)
	Adds the rows in l element-wise to this bounded matrix. More...

template<typename E >
BoundedMatrix &	operator+= (const MatrixExpression< E > &e)
	Adds the matrix expression e element-wise to this bounded matrix (via a temporary to handle aliasing). More...

template<typename C >
BoundedMatrix &	operator-= (const MatrixContainer< C > &c)
	Subtracts the contents of the matrix container c element-wise from this bounded matrix (no alias check needed). More...

BoundedMatrix &	operator-= (InitializerListType l)
	Subtracts the rows in l element-wise from this bounded matrix. More...

template<typename E >
BoundedMatrix &	operator-= (const MatrixExpression< E > &e)
	Subtracts the matrix expression e element-wise from this bounded matrix (via a temporary to handle aliasing). More...

template<typename T1 >
std::enable_if< IsScalar< T1 >::value, BoundedMatrix >::type &	operator*= (const T1 &v)
	Multiplies every element by the scalar v. More...

template<typename T1 >
std::enable_if< IsScalar< T1 >::value, BoundedMatrix >::type &	operator/= (const T1 &v)
	Divides every element by the scalar v. More...

template<typename E >
BoundedMatrix &	assign (const MatrixExpression< E > &e)
	Resizes this matrix to match e and assigns its elements without intermediate temporary. More...

BoundedMatrix &	assign (InitializerListType l)
	Resizes this matrix to match l and assigns its elements. More...

template<typename E >
BoundedMatrix &	plusAssign (const MatrixExpression< E > &e)
	Adds the elements of the matrix expression e to this matrix without intermediate temporary. More...

BoundedMatrix &	plusAssign (InitializerListType l)
	Adds the rows in l element-wise to this matrix without intermediate temporary. More...

template<typename E >
BoundedMatrix &	minusAssign (const MatrixExpression< E > &e)
	Subtracts the elements of the matrix expression e from this matrix without intermediate temporary. More...

BoundedMatrix &	minusAssign (InitializerListType l)
	Subtracts the rows in l element-wise from this matrix without intermediate temporary. More...

void	swap (BoundedMatrix &m)
	Swaps the contents of this bounded matrix with those of m. More...

void	clear (const ValueType &v=ValueType())
	Sets every element of the matrix to the value v (dimensions unchanged). More...

void	resize (SizeType m, SizeType n)
	Resizes the matrix to \( m \times n \) elements (new elements are left value-uninitialized). More...

void	resize (SizeType m, SizeType n, const ValueType &v)
	Resizes the matrix to \( m \times n \) elements; newly added cells are set to v. More...

Public Member Functions inherited from CDPL::Math::MatrixContainer< BoundedMatrix< T, M, N > >
const ContainerType &	operator() () const
	Returns a `const` reference to the derived matrix container. More...

ContainerType &	operator() ()
	Returns a reference to the derived matrix container. More...

Public Member Functions inherited from CDPL::Math::MatrixExpression< E >
const ExpressionType &	operator() () const
	Returns a `const` reference to the derived matrix expression. More...

ExpressionType &	operator() ()
	Returns a reference to the derived matrix expression. More...

Static Public Attributes
static const SizeType	MaxSize1 = M
	The compile-time maximum number of rows M. More...

static const SizeType	MaxSize2 = N
	The compile-time maximum number of columns N. More...

Friends
void	swap (BoundedMatrix &m1, BoundedMatrix &m2)
	ADL-enabled free-function form of swap(). More...

Additional Inherited Members
Protected Member Functions inherited from CDPL::Math::MatrixContainer< BoundedMatrix< T, M, N > >
	MatrixContainer ()

	~MatrixContainer ()

Protected Member Functions inherited from CDPL::Math::MatrixExpression< E >
	MatrixExpression ()

	~MatrixExpression ()

Protected Member Functions inherited from CDPL::Math::Expression< E >
	Expression ()

	~Expression ()

Detailed Description

template<typename T, std::size_t M, std::size_t N>
class CDPL::Math::BoundedMatrix< T, M, N >

Variable-size matrix with fixed upper capacities M \( \times \) N stored in a stack-allocated array.

Template Parameters

T	The scalar value type.
M	The maximum number of rows.
N	The maximum number of columns.

Member Typedef Documentation

◆ ValueType

template<typename T , std::size_t M, std::size_t N>

typedef T CDPL::Math::BoundedMatrix< T, M, N >::ValueType

The scalar value type.

◆ Reference

template<typename T , std::size_t M, std::size_t N>

typedef T& CDPL::Math::BoundedMatrix< T, M, N >::Reference

Mutable reference type to an element.

◆ ConstReference

template<typename T , std::size_t M, std::size_t N>

typedef const T& CDPL::Math::BoundedMatrix< T, M, N >::ConstReference

Constant reference type to an element.

◆ SizeType

template<typename T , std::size_t M, std::size_t N>

typedef std::size_t CDPL::Math::BoundedMatrix< T, M, N >::SizeType

The unsigned size type.

◆ DifferenceType

template<typename T , std::size_t M, std::size_t N>

typedef std::ptrdiff_t CDPL::Math::BoundedMatrix< T, M, N >::DifferenceType

The signed difference type.

◆ ArrayType

template<typename T , std::size_t M, std::size_t N>

typedef ValueType CDPL::Math::BoundedMatrix< T, M, N >::ArrayType[M][N]

The fixed-capacity 2D C-array type used for in-memory storage.

◆ ArrayPointer

template<typename T , std::size_t M, std::size_t N>

typedef T(* CDPL::Math::BoundedMatrix< T, M, N >::ArrayPointer)[N]

Pointer-to-row type for raw access to the element array.

◆ ConstArrayPointer

template<typename T , std::size_t M, std::size_t N>

typedef const T(* CDPL::Math::BoundedMatrix< T, M, N >::ConstArrayPointer)[N]

Constant pointer-to-row type for raw access to the element array.

◆ Pointer

template<typename T , std::size_t M, std::size_t N>

typedef T* CDPL::Math::BoundedMatrix< T, M, N >::Pointer

Pointer type to a single element.

◆ ConstPointer

template<typename T , std::size_t M, std::size_t N>

typedef const T* CDPL::Math::BoundedMatrix< T, M, N >::ConstPointer

Constant pointer type to a single element.

◆ ClosureType

template<typename T , std::size_t M, std::size_t N>

typedef MatrixReference<SelfType> CDPL::Math::BoundedMatrix< T, M, N >::ClosureType

Closure type used when this matrix appears inside another expression.

◆ ConstClosureType

template<typename T , std::size_t M, std::size_t N>

typedef const MatrixReference<const SelfType> CDPL::Math::BoundedMatrix< T, M, N >::ConstClosureType

Constant closure type used when this matrix appears inside another expression.

◆ MatrixTemporaryType

template<typename T , std::size_t M, std::size_t N>

typedef SelfType CDPL::Math::BoundedMatrix< T, M, N >::MatrixTemporaryType

Concrete temporary matrix type used by expression-template machinery.

◆ VectorTemporaryType

template<typename T , std::size_t M, std::size_t N>

typedef BoundedVector<T, M * N> CDPL::Math::BoundedMatrix< T, M, N >::VectorTemporaryType

Concrete temporary vector type used when assembling vectors from this matrix (a bounded vector of capacity M * N).

◆ SharedPointer

template<typename T , std::size_t M, std::size_t N>

typedef std::shared_ptr<SelfType> CDPL::Math::BoundedMatrix< T, M, N >::SharedPointer

A reference-counted smart pointer [SHPTR] for dynamically allocated BoundedMatrix instances.

◆ InitializerListType

template<typename T , std::size_t M, std::size_t N>

typedef std::initializer_list<std::initializer_list<T> > CDPL::Math::BoundedMatrix< T, M, N >::InitializerListType

The initializer-list-of-rows type accepted by constructors and assignment.

Constructor & Destructor Documentation

◆ BoundedMatrix() [1/6]

template<typename T , std::size_t M, std::size_t N>

CDPL::Math::BoundedMatrix< T, M, N >::BoundedMatrix ( )

inline

Constructs an empty bounded matrix (zero rows, zero columns).

◆ BoundedMatrix() [2/6]

template<typename T , std::size_t M, std::size_t N>

CDPL::Math::BoundedMatrix< T, M, N >::BoundedMatrix	(	SizeType	m,
		SizeType	n
	)

inline

Constructs a bounded matrix of size \( m \times n \) with value-initialized elements.

Parameters

m	The initial row count.
n	The initial column count.

Exceptions

Base::SizeError if m exceeds the bound M or n exceeds N.

◆ BoundedMatrix() [3/6]

template<typename T , std::size_t M, std::size_t N>

CDPL::Math::BoundedMatrix< T, M, N >::BoundedMatrix	(	SizeType	m,
		SizeType	n,
		const ValueType &	v
	)

inline

Constructs a bounded matrix of size \( m \times n \) with every element initialized to v.

Parameters

m	The initial row count.
n	The initial column count.
v	The initial element value.

Exceptions

Base::SizeError if m exceeds the bound M or n exceeds N.

◆ BoundedMatrix() [4/6]

template<typename T , std::size_t M, std::size_t N>

CDPL::Math::BoundedMatrix< T, M, N >::BoundedMatrix ( const BoundedMatrix< T, M, N > & m )

inline

Constructs a copy of the bounded matrix m.

Parameters

m	The bounded matrix to copy.

◆ BoundedMatrix() [5/6]

template<typename T , std::size_t M, std::size_t N>

CDPL::Math::BoundedMatrix< T, M, N >::BoundedMatrix ( InitializerListType l )

inline

Constructs a bounded matrix from the initializer list of rows l.

Parameters

l	The initializer list of rows.

Exceptions

Base::SizeError if the dimensions of l exceed the bounds M, N.

◆ BoundedMatrix() [6/6]

template<typename T , std::size_t M, std::size_t N>

template<typename E >

CDPL::Math::BoundedMatrix< T, M, N >::BoundedMatrix ( const MatrixExpression< E > & e )

inline

Constructs a bounded matrix from the matrix expression e.

Template Parameters

E	The source matrix expression type.

Parameters

e	The source matrix expression.

Exceptions

Base::SizeError if the dimensions of e exceed the bounds M, N.

Member Function Documentation

◆ operator()() [1/2]

template<typename T , std::size_t M, std::size_t N>

Reference CDPL::Math::BoundedMatrix< T, M, N >::operator()	(	SizeType	i,
		SizeType	j
	)

inline

Returns a mutable reference to the element at (i, j).

Parameters

i	The zero-based row index.
j	The zero-based column index.

Returns: A mutable reference to the element.

Exceptions

Base::IndexError if either index is out of range.

◆ operator()() [2/2]

template<typename T , std::size_t M, std::size_t N>

ConstReference CDPL::Math::BoundedMatrix< T, M, N >::operator()	(	SizeType	i,
		SizeType	j
	)		const

inline

Returns a const reference to the element at (i, j).

Parameters

i	The zero-based row index.
j	The zero-based column index.

Returns: A const reference to the element.

Exceptions

Base::IndexError if either index is out of range.

◆ isEmpty()

template<typename T , std::size_t M, std::size_t N>

bool CDPL::Math::BoundedMatrix< T, M, N >::isEmpty ( ) const

inline

Tells whether the matrix is empty.

Returns: true if either dimension is zero, and false otherwise.

◆ getSize1()

template<typename T , std::size_t M, std::size_t N>

SizeType CDPL::Math::BoundedMatrix< T, M, N >::getSize1 ( ) const

inline

Returns the current row count.

Returns: The number of rows.

◆ getSize2()

template<typename T , std::size_t M, std::size_t N>

SizeType CDPL::Math::BoundedMatrix< T, M, N >::getSize2 ( ) const

inline

Returns the current column count.

Returns: The number of columns.

◆ getMaxSize1()

template<typename T , std::size_t M, std::size_t N>

SizeType CDPL::Math::BoundedMatrix< T, M, N >::getMaxSize1 ( ) const

inline

Returns the compile-time maximum row count M.

Returns: The maximum number of rows.

◆ getMaxSize2()

template<typename T , std::size_t M, std::size_t N>

SizeType CDPL::Math::BoundedMatrix< T, M, N >::getMaxSize2 ( ) const

inline

Returns the compile-time maximum column count N.

Returns: The maximum number of columns.

◆ getData() [1/2]

template<typename T , std::size_t M, std::size_t N>

ArrayPointer CDPL::Math::BoundedMatrix< T, M, N >::getData ( )

inline

Returns a mutable pointer-to-row to the contiguous 2D element array.

Returns: A mutable array pointer.

◆ getData() [2/2]

template<typename T , std::size_t M, std::size_t N>

ConstArrayPointer CDPL::Math::BoundedMatrix< T, M, N >::getData ( ) const

inline

Returns a const pointer-to-row to the contiguous 2D element array.

Returns: A const array pointer.

◆ operator=() [1/4]

template<typename T , std::size_t M, std::size_t N>

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::operator= ( const BoundedMatrix< T, M, N > & m )

inline

Copy-assigns the elements of m to this bounded matrix.

Parameters

m	The source bounded matrix.

Returns: A reference to itself.

◆ operator=() [2/4]

template<typename T , std::size_t M, std::size_t N>

template<typename C >

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::operator= ( const MatrixContainer< C > & c )

inline

Assigns the contents of the matrix container c to this bounded matrix (no alias check needed).

Template Parameters

C	The source matrix container type.

Parameters

c	The source matrix container.

Returns: A reference to itself.

◆ operator=() [3/4]

template<typename T , std::size_t M, std::size_t N>

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::operator= ( InitializerListType l )

inline

Assigns the rows in l to this bounded matrix (resizes to match, respecting the bounds).

Parameters

l	The initializer list of rows.

Returns: A reference to itself.

Exceptions

Base::SizeError if the dimensions of l exceed the bounds M, N.

◆ operator=() [4/4]

template<typename T , std::size_t M, std::size_t N>

template<typename E >

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::operator= ( const MatrixExpression< E > & e )

inline

Assigns the matrix expression e to this bounded matrix (via a temporary to handle aliasing).

Template Parameters

E	The source matrix expression type.

Parameters

e	The source matrix expression.

Returns: A reference to itself.

Exceptions

Base::SizeError if the dimensions of e exceed the bounds M, N.

◆ operator+=() [1/3]

template<typename T , std::size_t M, std::size_t N>

template<typename C >

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::operator+= ( const MatrixContainer< C > & c )

inline

Adds the contents of the matrix container c element-wise to this bounded matrix (no alias check needed).

Template Parameters

C	The source matrix container type.

Parameters

c	The source matrix container.

Returns: A reference to itself.

◆ operator+=() [2/3]

template<typename T , std::size_t M, std::size_t N>

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::operator+= ( InitializerListType l )

inline

Adds the rows in l element-wise to this bounded matrix.

Parameters

l	The initializer list of rows providing the addends.

Returns: A reference to itself.

◆ operator+=() [3/3]

template<typename T , std::size_t M, std::size_t N>

template<typename E >

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::operator+= ( const MatrixExpression< E > & e )

inline

Adds the matrix expression e element-wise to this bounded matrix (via a temporary to handle aliasing).

Template Parameters

E	The source matrix expression type.

Parameters

e	The source matrix expression.

Returns: A reference to itself.

◆ operator-=() [1/3]

template<typename T , std::size_t M, std::size_t N>

template<typename C >

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::operator-= ( const MatrixContainer< C > & c )

inline

Subtracts the contents of the matrix container c element-wise from this bounded matrix (no alias check needed).

Template Parameters

C	The source matrix container type.

Parameters

c	The source matrix container.

Returns: A reference to itself.

◆ operator-=() [2/3]

template<typename T , std::size_t M, std::size_t N>

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::operator-= ( InitializerListType l )

inline

Subtracts the rows in l element-wise from this bounded matrix.

Parameters

l	The initializer list of rows providing the subtrahends.

Returns: A reference to itself.

◆ operator-=() [3/3]

template<typename T , std::size_t M, std::size_t N>

template<typename E >

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::operator-= ( const MatrixExpression< E > & e )

inline

Subtracts the matrix expression e element-wise from this bounded matrix (via a temporary to handle aliasing).

Template Parameters

E	The source matrix expression type.

Parameters

e	The source matrix expression.

Returns: A reference to itself.

◆ operator*=()

template<typename T , std::size_t M, std::size_t N>

template<typename T1 >

std::enable_if<IsScalar<T1>::value, BoundedMatrix>::type& CDPL::Math::BoundedMatrix< T, M, N >::operator*= ( const T1 & v )

inline

Multiplies every element by the scalar v.

Template Parameters

T1	The scalar type.

Parameters

v	The scalar multiplier.

Returns: A reference to itself.

◆ operator/=()

template<typename T , std::size_t M, std::size_t N>

template<typename T1 >

std::enable_if<IsScalar<T1>::value, BoundedMatrix>::type& CDPL::Math::BoundedMatrix< T, M, N >::operator/= ( const T1 & v )

inline

Divides every element by the scalar v.

Template Parameters

T1	The scalar type.

Parameters

v	The scalar divisor.

Returns: A reference to itself.

◆ assign() [1/2]

template<typename T , std::size_t M, std::size_t N>

template<typename E >

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::assign ( const MatrixExpression< E > & e )

inline

Resizes this matrix to match e and assigns its elements without intermediate temporary.

Template Parameters

E	The source matrix expression type.

Parameters

e	The source matrix expression.

Returns: A reference to itself.

Exceptions

Base::SizeError if the dimensions of e exceed the bounds M, N.

◆ assign() [2/2]

template<typename T , std::size_t M, std::size_t N>

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::assign ( InitializerListType l )

inline

Resizes this matrix to match l and assigns its elements.

Parameters

l	The initializer list of rows providing the new elements.

Returns: A reference to itself.

Exceptions

Base::SizeError if the dimensions of l exceed the bounds M, N.

◆ plusAssign() [1/2]

template<typename T , std::size_t M, std::size_t N>

template<typename E >

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::plusAssign ( const MatrixExpression< E > & e )

inline

Adds the elements of the matrix expression e to this matrix without intermediate temporary.

Template Parameters

E	The source matrix expression type.

Parameters

e	The source matrix expression.

Returns: A reference to itself.

◆ plusAssign() [2/2]

template<typename T , std::size_t M, std::size_t N>

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::plusAssign ( InitializerListType l )

inline

Adds the rows in l element-wise to this matrix without intermediate temporary.

Parameters

l	The initializer list of rows providing the addends.

Returns: A reference to itself.

◆ minusAssign() [1/2]

template<typename T , std::size_t M, std::size_t N>

template<typename E >

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::minusAssign ( const MatrixExpression< E > & e )

inline

Subtracts the elements of the matrix expression e from this matrix without intermediate temporary.

Template Parameters

E	The source matrix expression type.

Parameters

e	The source matrix expression.

Returns: A reference to itself.

◆ minusAssign() [2/2]

template<typename T , std::size_t M, std::size_t N>

BoundedMatrix& CDPL::Math::BoundedMatrix< T, M, N >::minusAssign ( InitializerListType l )

inline

Subtracts the rows in l element-wise from this matrix without intermediate temporary.

Parameters

l	The initializer list of rows providing the subtrahends.

Returns: A reference to itself.

◆ swap()

template<typename T , std::size_t M, std::size_t N>

void CDPL::Math::BoundedMatrix< T, M, N >::swap ( BoundedMatrix< T, M, N > & m )

inline

Swaps the contents of this bounded matrix with those of m.

Parameters

m	The bounded matrix to swap with.

◆ clear()

template<typename T , std::size_t M, std::size_t N>

void CDPL::Math::BoundedMatrix< T, M, N >::clear ( const ValueType & v = ValueType() )

inline

Sets every element of the matrix to the value v (dimensions unchanged).

Parameters

v	The fill value.

◆ resize() [1/2]

template<typename T , std::size_t M, std::size_t N>

void CDPL::Math::BoundedMatrix< T, M, N >::resize	(	SizeType	m,
		SizeType	n
	)

inline

Resizes the matrix to \( m \times n \) elements (new elements are left value-uninitialized).

Parameters

m	The new row count.
n	The new column count.

Exceptions

Base::SizeError if m exceeds M or n exceeds N.

◆ resize() [2/2]

template<typename T , std::size_t M, std::size_t N>

void CDPL::Math::BoundedMatrix< T, M, N >::resize	(	SizeType	m,
		SizeType	n,
		const ValueType &	v
	)

inline

Resizes the matrix to \( m \times n \) elements; newly added cells are set to v.

Parameters

m	The new row count.
n	The new column count.
v	The fill value for newly added cells.

Exceptions

Base::SizeError if m exceeds M or n exceeds N.

Friends And Related Function Documentation

◆ swap

template<typename T , std::size_t M, std::size_t N>

void swap	(	BoundedMatrix< T, M, N > &	m1,
		BoundedMatrix< T, M, N > &	m2
	)

friend

ADL-enabled free-function form of swap().

Parameters

m1	The first bounded matrix.
m2	The second bounded matrix.

Member Data Documentation

◆ MaxSize1

template<typename T , std::size_t M, std::size_t N>

const BoundedMatrix< T, M, N >::SizeType CDPL::Math::BoundedMatrix< T, M, N >::MaxSize1 = M

static

The compile-time maximum number of rows M.

◆ MaxSize2

template<typename T , std::size_t M, std::size_t N>

const BoundedMatrix< T, M, N >::SizeType CDPL::Math::BoundedMatrix< T, M, N >::MaxSize2 = N

static

The compile-time maximum number of columns N.

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

Matrix.hpp

Public Types

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

template<typename T, std::size_t M, std::size_t N> class CDPL::Math::BoundedMatrix< T, M, N >

Member Typedef Documentation

◆ ValueType

◆ Reference

◆ ConstReference

◆ SizeType

◆ DifferenceType

◆ ArrayType

◆ ArrayPointer

◆ ConstArrayPointer

◆ Pointer

◆ ConstPointer

◆ ClosureType

◆ ConstClosureType

◆ MatrixTemporaryType

◆ VectorTemporaryType

◆ SharedPointer

◆ InitializerListType

Constructor & Destructor Documentation

◆ BoundedMatrix() [1/6]

◆ BoundedMatrix() [2/6]

◆ BoundedMatrix() [3/6]

◆ BoundedMatrix() [4/6]

◆ BoundedMatrix() [5/6]

◆ BoundedMatrix() [6/6]

Member Function Documentation

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ isEmpty()

◆ getSize1()

◆ getSize2()

◆ getMaxSize1()

◆ getMaxSize2()

◆ getData() [1/2]

◆ getData() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ operator+=() [1/3]

◆ operator+=() [2/3]

◆ operator+=() [3/3]

◆ operator-=() [1/3]

◆ operator-=() [2/3]

◆ operator-=() [3/3]

◆ operator*=()

◆ operator/=()

◆ assign() [1/2]

◆ assign() [2/2]

◆ plusAssign() [1/2]

◆ plusAssign() [2/2]

◆ minusAssign() [1/2]

◆ minusAssign() [2/2]

◆ swap()

◆ clear()

◆ resize() [1/2]

◆ resize() [2/2]

Friends And Related Function Documentation

◆ swap

Member Data Documentation

◆ MaxSize1

◆ MaxSize2

template<typename T, std::size_t M, std::size_t N>
class CDPL::Math::BoundedMatrix< T, M, N >