Constant identity-matrix expression ( \( 1 \) on the diagonal, \( 0 \) elsewhere). More...

#include <Matrix.hpp>

Inheritance diagram for CDPL::Math::IdentityMatrix< T >:

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

typedef const T &	Reference
	Reference type (always a `const` reference — elements are immutable). 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 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 Matrix< T >	MatrixTemporaryType
	Concrete temporary matrix type used by expression-template machinery. More...

typedef Vector< T, std::vector< T > >	VectorTemporaryType
	Concrete temporary vector type used when assembling vectors from this matrix. More...

Public Types inherited from CDPL::Math::MatrixContainer< IdentityMatrix< T > >
typedef IdentityMatrix< T >	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
	IdentityMatrix ()
	Constructs an empty identity matrix. More...

	IdentityMatrix (SizeType m, SizeType n)
	Constructs an identity matrix of size \( m \times n \) (`1` on the diagonal, `0` elsewhere). More...

	IdentityMatrix (const IdentityMatrix &m)
	Constructs a copy of the identity matrix m. More...

ConstReference	operator() (SizeType i, SizeType j) const
	Returns a `const` reference to either `1` (if i equals j) or `0`. More...

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

SizeType	getSize1 () const
	Returns the logical number of rows. More...

SizeType	getSize2 () const
	Returns the logical number of columns. More...

SizeType	getMaxSize1 () const
	Returns the maximum representable row count. More...

SizeType	getMaxSize2 () const
	Returns the maximum representable column count. More...

IdentityMatrix &	operator= (const IdentityMatrix &m)
	Copy-assigns the dimensions from m. More...

void	swap (IdentityMatrix &m)
	Swaps the dimensions with m. More...

void	resize (SizeType m, SizeType n)
	Resizes the dimensions to \( m \times n \). More...

Public Member Functions inherited from CDPL::Math::MatrixContainer< IdentityMatrix< T > >
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...

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

Additional Inherited Members
Protected Member Functions inherited from CDPL::Math::MatrixContainer< IdentityMatrix< T > >
	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>
class CDPL::Math::IdentityMatrix< T >

Constant identity-matrix expression ( \( 1 \) on the diagonal, \( 0 \) elsewhere).

Template Parameters

T	The scalar value type.

Member Typedef Documentation

◆ ValueType

template<typename T >

typedef T CDPL::Math::IdentityMatrix< T >::ValueType

The scalar value type.

◆ Reference

template<typename T >

typedef const T& CDPL::Math::IdentityMatrix< T >::Reference

Reference type (always a const reference — elements are immutable).

◆ ConstReference

template<typename T >

typedef const T& CDPL::Math::IdentityMatrix< T >::ConstReference

Constant reference type to an element.

◆ SizeType

template<typename T >

typedef std::size_t CDPL::Math::IdentityMatrix< T >::SizeType

The unsigned size type.

◆ DifferenceType

template<typename T >

typedef std::ptrdiff_t CDPL::Math::IdentityMatrix< T >::DifferenceType

The signed difference type.

◆ ClosureType

template<typename T >

typedef MatrixReference<SelfType> CDPL::Math::IdentityMatrix< T >::ClosureType

Closure type used when this matrix appears inside another expression.

◆ ConstClosureType

template<typename T >

typedef const MatrixReference<const SelfType> CDPL::Math::IdentityMatrix< T >::ConstClosureType

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

◆ MatrixTemporaryType

template<typename T >

typedef Matrix<T> CDPL::Math::IdentityMatrix< T >::MatrixTemporaryType

Concrete temporary matrix type used by expression-template machinery.

◆ VectorTemporaryType

template<typename T >

typedef Vector<T, std::vector<T> > CDPL::Math::IdentityMatrix< T >::VectorTemporaryType

Concrete temporary vector type used when assembling vectors from this matrix.

Constructor & Destructor Documentation

◆ IdentityMatrix() [1/3]

template<typename T >

CDPL::Math::IdentityMatrix< T >::IdentityMatrix ( )

inline

Constructs an empty identity matrix.

◆ IdentityMatrix() [2/3]

template<typename T >

CDPL::Math::IdentityMatrix< T >::IdentityMatrix	(	SizeType	m,
		SizeType	n
	)

inline

Constructs an identity matrix of size \( m \times n \) (1 on the diagonal, 0 elsewhere).

Parameters

m	The number of rows.
n	The number of columns.

◆ IdentityMatrix() [3/3]

template<typename T >

CDPL::Math::IdentityMatrix< T >::IdentityMatrix ( const IdentityMatrix< T > & m )

inline

Constructs a copy of the identity matrix m.

Parameters

m	The identity matrix to copy.

Member Function Documentation

◆ operator()()

template<typename T >

ConstReference CDPL::Math::IdentityMatrix< T >::operator()	(	SizeType	i,
		SizeType	j
	)		const

inline

Returns a const reference to either 1 (if i equals j) or 0.

Parameters

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

Returns: A const reference to either 1 (on the diagonal) or 0 (off the diagonal).

Exceptions

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

◆ isEmpty()

template<typename T >

bool CDPL::Math::IdentityMatrix< T >::isEmpty ( ) const

inline

Tells whether the matrix is empty.

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

◆ getSize1()

template<typename T >

SizeType CDPL::Math::IdentityMatrix< T >::getSize1 ( ) const

inline

Returns the logical number of rows.

Returns: The number of rows.

◆ getSize2()

template<typename T >

SizeType CDPL::Math::IdentityMatrix< T >::getSize2 ( ) const

inline

Returns the logical number of columns.

Returns: The number of columns.

◆ getMaxSize1()

template<typename T >

SizeType CDPL::Math::IdentityMatrix< T >::getMaxSize1 ( ) const

inline

Returns the maximum representable row count.

Returns: The maximum number of rows.

◆ getMaxSize2()

template<typename T >

SizeType CDPL::Math::IdentityMatrix< T >::getMaxSize2 ( ) const

inline

Returns the maximum representable column count.

Returns: The maximum number of columns.

◆ operator=()

template<typename T >

IdentityMatrix& CDPL::Math::IdentityMatrix< T >::operator= ( const IdentityMatrix< T > & m )

inline

Copy-assigns the dimensions from m.

Parameters

m	The source identity matrix.

Returns: A reference to itself.

◆ swap()

template<typename T >

void CDPL::Math::IdentityMatrix< T >::swap ( IdentityMatrix< T > & m )

inline

Swaps the dimensions with m.

Parameters

m	The identity matrix to swap with.

◆ resize()

template<typename T >

void CDPL::Math::IdentityMatrix< T >::resize	(	SizeType	m,
		SizeType	n
	)

inline

Resizes the dimensions to \( m \times n \).

Parameters

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

Friends And Related Function Documentation

◆ swap

template<typename T >

void swap	(	IdentityMatrix< T > &	m1,
		IdentityMatrix< T > &	m2
	)

friend

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

Parameters

m1	The first identity matrix.
m2	The second identity matrix.

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

Matrix.hpp

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

template<typename T> class CDPL::Math::IdentityMatrix< T >

Member Typedef Documentation

◆ ValueType

◆ Reference

◆ ConstReference

◆ SizeType

◆ DifferenceType

◆ ClosureType

◆ ConstClosureType

◆ MatrixTemporaryType

◆ VectorTemporaryType

Constructor & Destructor Documentation

◆ IdentityMatrix() [1/3]

◆ IdentityMatrix() [2/3]

◆ IdentityMatrix() [3/3]

Member Function Documentation

◆ operator()()

◆ isEmpty()

◆ getSize1()

◆ getSize2()

◆ getMaxSize1()

◆ getMaxSize2()

◆ operator=()

◆ swap()

◆ resize()

Friends And Related Function Documentation

◆ swap

template<typename T>
class CDPL::Math::IdentityMatrix< T >