geomc 1.0
A c++ linear algebra template library
Loading...
Searching...
No Matches
MatrixBase< T, M, N, Derived > Class Template Reference
Inheritance diagram for MatrixBase< T, M, N, Derived >:
DiagMatrix< S, J, K > WriteableMatrixBase< T, M, N, Derived > reference< elem_t > SimpleMatrix< double, 4, 4 > SimpleMatrix< double, 3, 3 > SimpleMatrix< double, 2, 2 > SimpleMatrix< double, 0, 0 > SimpleMatrix< float, 4, 4 > SimpleMatrix< float, 3, 3 > SimpleMatrix< float, 2, 2 > SimpleMatrix< float, 0, 0 > SimpleMatrix< typename Ma::elem_t, Ma::ROWDIM *Mb::COLDIM==0 ? 0 :Ma::ROWDIM, Ma::COLDIM *Mb::COLDIM==0 ? 0 :Ma::COLDIM > SimpleMatrix< typename M::elem_t, M::COLDIM, M::ROWDIM > SimpleMatrix< typename Ma::elem_t, Ma::ROWDIM, Mb::COLDIM > SimpleMatrix< typename Mat::elem_t, M, N > SimpleMatrix< typename Mat::elem_t, M, Mat::COLDIM >

Public Types

typedef MtxColIterator< const Derived, const elem_tconst_col_iterator
 Read-only iterator over the elements of a column.
 
typedef MtxSubsetIterator< const Derived, 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 Derived, const elem_tconst_row_iterator
 Read-only iterator over the elments of a row.
 
typedef T elem_t
 Element type.
 
typedef Derived recurring_t
 
typedef Storage< storage_token_t, _ImplStorageObjCount< Derived >::count > storagebuffer_t
 

Public Member Functions

const_iterator begin () const
 
const_col_iterator col (index_t i) const
 
index_t cols () const
 
const_iterator end () const
 
storagebuffer_t get_storage_token_buffer () const
 
elem_t operator() (index_t row, index_t col) 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
 

Static Public Attributes

static constexpr index_t COLDIM = N
 Column dimension template parameter.
 
static constexpr index_t ROWDIM = M
 Row dimension template parameter.
 

Member Function Documentation

◆ begin()

template<typename T, index_t M, index_t N, typename Derived>
const_iterator begin ( ) const
inline
Returns
A read-only random-access row major-ordered iterator over the elements of this matrix, pointing to the element at (0,0).

◆ col()

template<typename T, index_t M, index_t N, typename Derived>
const_col_iterator col ( index_t i) const
inline
Parameters
iIndex of column (zero-indexed)
Returns
A const iterator over the elements of column i

◆ cols()

template<typename T, index_t M, index_t N, typename Derived>
index_t cols ( ) const
inline
Returns
Number of columns in the matrix.

◆ end()

template<typename T, index_t M, index_t N, typename Derived>
const_iterator end ( ) const
inline
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()()

template<typename T, index_t M, index_t N, typename Derived>
elem_t operator() ( index_t row,
index_t col ) const
inline

Get the element at (row, col).

Parameters
rowZero-indexed row coordinate
colZero-indexed column coordinate
Returns
The element at (row, col)

◆ operator[]()

template<typename T, index_t M, index_t N, typename Derived>
derived_const_row_iterator operator[] ( index_t i) const
inline
Parameters
iIndex of row (zero-indexed)
Returns
A const iterator over the elements of row i

◆ region_begin()

template<typename T, index_t M, index_t N, typename Derived>
const_region_iterator region_begin ( const MatrixRegion & r) const
inline
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()

template<typename T, index_t M, index_t N, typename Derived>
const_region_iterator region_end ( const MatrixRegion & r) const
inline
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()

template<typename T, index_t M, index_t N, typename Derived>
const_row_iterator row ( index_t i) const
inline
Parameters
iIndex of row (zero-indexed)
Returns
A const iterator over the elements of row i

◆ rows()

template<typename T, index_t M, index_t N, typename Derived>
index_t rows ( ) const
inline
Returns
Number of rows in the matrix.

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