DiagMatrix< T, M, N > Class Template Reference

A matrix with nonzero elements only along the main diagonal. More...

#include <geomc/linalg/mtxtypes/DiagMatrix.h>

Inheritance diagram for DiagMatrix< T, M, N >:

Public Types
typedef MtxColIterator< const DiagMatrix< T, M, N >, const elem_t >	const_col_iterator
	Read-only iterator over the elements of a column.
typedef MtxSubsetIterator< const DiagMatrix< T, M, N >, const elem_t >	const_iterator
	Read-only row-major iterator over matrix elements.
typedef const_iterator	const_region_iterator
	Read-only row-major iterator over the matrix elements in a rectangular region.
typedef MtxRowIterator< const DiagMatrix< T, M, N >, const elem_t >	const_row_iterator
	Read-only iterator over the elments of a row.
typedef T	elem_t
	Element type.
typedef DiagMatrix< T, M, N >	recurring_t
typedef detail::_ImplMtxReftype< DiagMatrix< T, M, N >, T >::reference	reference
typedef Storage< storage_token_t, _ImplStorageObjCount< DiagMatrix< T, M, N > >::count >	storagebuffer_t

Public Member Functions
	DiagMatrix (const T src[], index_t n)
	DiagMatrix (index_t nrows, index_t ncols)
const_iterator	begin () const
const_col_iterator	col (index_t i) const
index_t	cols () const
T &	diagonal (index_t i)
const T &	diagonal (index_t i) const
T *	diagonal_begin ()
const T *	diagonal_begin () const
T *	diagonal_end ()
const T *	diagonal_end () const
const_iterator	end () const
storagebuffer_t	get_storage_token_buffer () const
void	get_storage_tokens (storage_token_t *buf) const
T	operator() (index_t r, index_t c) const
derived_const_row_iterator	operator[] (index_t i) const
const_region_iterator	region_begin (const MatrixRegion &r) const
const_region_iterator	region_end (const MatrixRegion &r) const
const_row_iterator	row (index_t i) const
index_t	rows () const
void	set_identity ()
void	set_zero ()
constexpr index_t	storage_token_count () const

Static Public Attributes
static constexpr index_t	COLDIM
	Column dimension template parameter.
static constexpr index_t	ROWDIM
	Row dimension template parameter.

Detailed Description

template<typename T, index_t M, index_t N>
class geom::DiagMatrix< T, M, N >

A matrix with nonzero elements only along the main diagonal.

Template Parameters

T	Element type.
M	Row dimension.
N	Column dimension.

Storage for DiagMatrixes is O(n), and operations with diagonal matrices usually benefit from the O(n) algorithmic improvement associated with their lower dimension.

Constructor & Destructor Documentation

DiagMatrix() [1/2]

template<typename T, index_t M, index_t N>

DiagMatrix ( index_t nrows, index_t ncols )

inlineexplicit

Construct a new diagonal matrix.

Parameters

nrows	Number of rows (ignored / not required if statically sized).
ncols	Number of columns (ignored / not required if statically sized).

DiagMatrix() [2/2]

template<typename T, index_t M, index_t N>

DiagMatrix ( const T src[], index_t n )

inline

Construct a new n x n diagonal matrix, with diagonal elements copied from src.

Parameters

src	Array containing diagonal elements.
n	Number of elements in src. Ignored / not required if statically sized.

Member Function Documentation

begin()

const_iterator begin ( ) const

inlineinherited

Returns

A read-only random-access row major-ordered iterator over the elements of this matrix, pointing to the element at (0,0).

col()

const_col_iterator col ( index_t i ) const

inlineinherited

Parameters

i	Index of column (zero-indexed)

Returns

A const iterator over the elements of column i

diagonal() [1/2]

template<typename T, index_t M, index_t N>

T & diagonal ( index_t i )

inline

Return a reference to the ith diagonal element.

diagonal() [2/2]

template<typename T, index_t M, index_t N>

const T & diagonal ( index_t i ) const

inline

Return the ith diagonal element.

diagonal_begin() [1/2]

template<typename T, index_t M, index_t N>

T * diagonal_begin ( )

inline

Returns

An iterator over the elements of the main diagonal (those with matching row and column coordinates), pointing at element (0, 0).

diagonal_begin() [2/2]

template<typename T, index_t M, index_t N>

const T * diagonal_begin ( ) const

inline

Returns

A read-only iterator over the elements of the main diagonal (those with matching row and column coordinates), pointing at element (0, 0).

diagonal_end() [1/2]

template<typename T, index_t M, index_t N>

T * diagonal_end ( )

inline

Returns

An iterator over the elements of the main diagonal (those with matching row and column coordinates), pointing at the last diagonal element.

diagonal_end() [2/2]

template<typename T, index_t M, index_t N>

const T * diagonal_end ( ) const

inline

Returns

A read-only iterator over the elements of the main diagonal (those with matching row and column coordinates), pointing at the last diagonal element.

end()

const_iterator end ( ) const

inlineinherited

Returns

A read-only random-access row major-ordered iterator over the elements of this matrix, pointing to the element just beyond the last element in the lower right corner.

operator[]()

derived_const_row_iterator operator[] ( index_t i ) const

inlineinherited

Parameters

i	Index of row (zero-indexed)

Returns

A const iterator over the elements of row i

region_begin()

const_region_iterator region_begin ( const MatrixRegion & r ) const

inlineinherited

Parameters

r	The zero-indexed region to iterate over. The upper extreme coordinates represent the index just beyond the last element to be iterated over.

Returns

A read-only, random-access, row-major iterator over the elements in region r, pointing at the first element in the region (upper left corner).

region_end()

const_region_iterator region_end ( const MatrixRegion & r ) const

inlineinherited

Parameters

r	The zero-indexed region to iterate over. The upper extreme coordinates represent the index just beyond the last element to be iterated over.

Returns

A read-only, random-access, row-major iterator over the elements in region r, pointing at the element just beyond the last element in the region.

row()

const_row_iterator row ( index_t i ) const

inlineinherited

Parameters

i	Index of row (zero-indexed)

Returns

A const iterator over the elements of row i

---

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

• geomc/linalg/LinalgTypes.h
• geomc/linalg/mtxtypes/DiagMatrix.h