A generic matrix class which can hold references to all other matrix types. More...

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

Inheritance diagram for MatrixHandle< T >:

Public Types
typedef MtxColIterator< MatrixHandle< T >, derived_reference >	col_iterator
	Writeable iterator over column elements.

typedef MtxColIterator< const MatrixHandle< T >, const elem_t >	const_col_iterator
	Read-only iterator over the elements of a column.

typedef MtxSubsetIterator< const MatrixHandle< T >, 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 MatrixHandle< T >, const elem_t >	const_row_iterator
	Read-only iterator over the elments of a row.

typedef T	elem_t
	Element type.

typedef MtxSubsetIterator< MatrixHandle< T >, derived_reference >	iterator
	Writeable row-major iterator.

typedef MatrixHandle< T >	recurring_t

typedef detail::_ImplMtxReftype< MatrixHandle< T >, T >::reference	reference

typedef iterator	region_iterator
	Writeable row-major region iterator.

typedef MtxRowIterator< MatrixHandle< T >, derived_reference >	row_iterator
	Writeable iterator over row elements.

typedef Storage< storage_token_t, _ImplStorageObjCount< MatrixHandle< T > >::count >	storagebuffer_t

Public Member Functions
iterator	begin ()

const_iterator	begin () const

const_iterator	begin () const

col_iterator	col (index_t i)

const_col_iterator	col (index_t i) const

const_col_iterator	col (index_t i) const

virtual index_t	cols () const =0

iterator	end ()

const_iterator	end () const

const_iterator	end () const

storagebuffer_t	get_storage_token_buffer () const

virtual void	get_storage_tokens (storage_token_t *buf) const =0

derived_reference	operator() (index_t row, index_t col)

virtual T	operator() (index_t r, index_t c) const =0

derived_row_iterator	operator[] (index_t i)

derived_const_row_iterator	operator[] (index_t i) const

derived_const_row_iterator	operator[] (index_t i) const

region_iterator	region_begin (const MatrixRegion &r)

const_region_iterator	region_begin (const MatrixRegion &r) const

const_region_iterator	region_begin (const MatrixRegion &r) const

region_iterator	region_end (const MatrixRegion &r)

const_region_iterator	region_end (const MatrixRegion &r) const

const_region_iterator	region_end (const MatrixRegion &r) const

row_iterator	row (index_t i)

const_row_iterator	row (index_t i) const

const_row_iterator	row (index_t i) const

virtual index_t	rows () const =0

virtual reference	set (index_t r, index_t c, T val)=0

virtual void	set_identity ()=0

virtual void	set_zero ()=0

virtual index_t	storage_token_count () const =0

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>
class geom::MatrixHandle< T >

A generic matrix class which can hold references to all other matrix types.

Member Function Documentation

◆ begin() [1/3]

iterator begin ( )

inlineinherited

Returns: A writeable, random-access, row-major iterator over the elements of this matrix, pointing to the element at (0,0).

◆ begin() [2/3]

( ) const

inherited

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

◆ begin() [3/3]

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() [1/3]

col_iterator col ( index_t i )

inlineinherited

Parameters

i	Index of column (zero-indexed)

Returns: A writeable iterator over the elements of column i.

◆ col() [2/3]

( index_t i ) const

inherited

Parameters

i	Index of column (zero-indexed)

Returns: A const iterator over the elements of column i

◆ col() [3/3]

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

◆ end() [1/3]

iterator end ( )

inlineinherited

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

◆ end() [2/3]

( ) const

inherited

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.

◆ end() [3/3]

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_reference operator()	(	index_t	row,
		index_t	col )

inlineinherited

Get the element at (row, col).

Parameters

row	Zero-indexed row coordinate
col	Zero-indexed column coordinate

Returns: A reference to the element at (row, col)

◆ operator[]() [1/3]

derived_row_iterator operator[] ( index_t i )

inlineinherited

Parameters

i	Index of row (zero-indexed)

Returns: A writeable iterator over the elements of row i.

◆ operator[]() [2/3]

( index_t i ) const

inherited

Parameters

i	Index of row (zero-indexed)

Returns: A const iterator over the elements of row i

◆ operator[]() [3/3]

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() [1/3]

region_iterator region_begin ( const MatrixRegion & r )

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 writeable, random-access, row-major iterator over the elements in region r, pointing at the first element in the region (upper left corner).

◆ region_begin() [2/3]

( const MatrixRegion & r ) const

inherited

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_begin() [3/3]

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() [1/3]

region_iterator region_end ( const MatrixRegion & r )

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 writeable, random-access, row-major iterator over the elements in region r, pointing at the element just beyond the last element in the region.

◆ region_end() [2/3]

( const MatrixRegion & r ) const

inherited

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.

◆ region_end() [3/3]

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() [1/3]

row_iterator row ( index_t i )

inlineinherited

Parameters

i	Index of row (zero-indexed)

Returns: A writeable iterator over the elements of row i.

◆ row() [2/3]

( index_t i ) const

inherited

Parameters

i	Index of row (zero-indexed)

Returns: A const iterator over the elements of row i

◆ row() [3/3]

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/MatrixHandle.h

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ begin() [1/3]

◆ begin() [2/3]

◆ begin() [3/3]

◆ col() [1/3]

◆ col() [2/3]

◆ col() [3/3]

◆ end() [1/3]

◆ end() [2/3]

◆ end() [3/3]

◆ operator()()

◆ operator[]() [1/3]

◆ operator[]() [2/3]

◆ operator[]() [3/3]

◆ region_begin() [1/3]

◆ region_begin() [2/3]

◆ region_begin() [3/3]

◆ region_end() [1/3]

◆ region_end() [2/3]

◆ region_end() [3/3]

◆ row() [1/3]

◆ row() [2/3]

◆ row() [3/3]