geomc 1.0
A c++ linear algebra template library
Loading...
Searching...
No Matches
MatrixHandle< T > Class Template Referenceabstract

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 >:
WriteableMatrixBase< T, DYNAMIC_DIM, DYNAMIC_DIM, MatrixHandle< T > > MatrixBase< T, M, N, MatrixHandle< T > >

Public Types

typedef MtxColIterator< MatrixHandle< T >, derived_reference > col_iterator
 Writeable iterator over column elements.
typedef MtxColIterator< const MatrixHandle< T >, const elem_tconst_col_iterator
 Read-only iterator over the elements of a column.
typedef MtxSubsetIterator< const MatrixHandle< T >, const elem_tconst_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_tconst_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

const_iterator begin () const
const_col_iterator col (index_t i) const
virtual index_t cols () const =0
const_iterator end () const
storagebuffer_t get_storage_token_buffer () const
virtual void get_storage_tokens (storage_token_t *buf) const =0
virtual T operator() (index_t r, index_t c) const =0
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
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()

( ) 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).

◆ col()

( index_t i) const
inherited
Parameters
iIndex of column (zero-indexed)
Returns
A const iterator over the elements of column i

◆ end()

( ) 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.

◆ operator[]()

( index_t i) const
inherited
Parameters
iIndex of row (zero-indexed)
Returns
A const iterator over the elements of row i

◆ region_begin()

( const MatrixRegion & r) const
inherited
Parameters
rThe 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 MatrixRegion & r) const
inherited
Parameters
rThe 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()

( index_t i) const
inherited
Parameters
iIndex 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: