ergo
Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
mat::MatrixHierarchicBase< Treal, Telement > Class Template Reference

Base class for Matrix and Matrix specialization. More...

#include <MatrixHierarchicBase.h>

Inheritance diagram for mat::MatrixHierarchicBase< Treal, Telement >:
mat::Matrix< Treal >

Public Member Functions

bool operator== (int k) const
 
const int & nScalarsRows () const
 
const int & nScalarsCols () const
 
const int & nrows () const
 
const int & ncols () const
 
Telement & operator ()(int row
 
 assert (row >=0)
 
 assert (col >=0)
 
 assert (row< nrows())
 
 assert (col< ncols())
 
const Telement & operator ()(int row
 
 assert (row >=0)
 
 assert (col >=0)
 
 assert (row< nrows())
 
 assert (col< ncols())
 
Telement & operator[] (int index)
 
Telement const & operator[] (int index) const
 
bool is_zero () const
 
int nElements () const
 
void resetRows (SizesAndBlocks const &newRows)
 
void resetCols (SizesAndBlocks const &newCols)
 
void getRows (SizesAndBlocks &rowsCopy) const
 
void getCols (SizesAndBlocks &colsCopy) const
 
bool highestLevel () const
 
bool is_empty () const
 Check if matrix is empty Empty is different from zero, a zero matrix contains information about blocksizes etc.
 

Public Attributes

Telement int col
 
return elements [row+col *nrows()]
 
const Telement int col const
 

Protected Member Functions

 MatrixHierarchicBase ()
 
 MatrixHierarchicBase (SizesAndBlocks const &rowsInp, SizesAndBlocks const &colsInp)
 
 MatrixHierarchicBase (const MatrixHierarchicBase< Treal, Telement > &mat)
 
MatrixHierarchicBase< Treal, Telement > & operator= (const MatrixHierarchicBase< Treal, Telement > &mat)
 
virtual ~MatrixHierarchicBase ()
 

Static Protected Member Functions

static void swap (MatrixHierarchicBase< Treal, Telement > &A, MatrixHierarchicBase< Treal, Telement > &B)
 

Protected Attributes

SizesAndBlocks rows
 
SizesAndBlocks cols
 
Telement * elements
 

Detailed Description

template<class Treal, class Telement = Treal>
class mat::MatrixHierarchicBase< Treal, Telement >

Base class for Matrix and Matrix specialization.

See also
Matrix
Permutation

Constructor & Destructor Documentation

◆ MatrixHierarchicBase() [1/3]

template<class Treal , class Telement = Treal>
mat::MatrixHierarchicBase< Treal, Telement >::MatrixHierarchicBase ( )
inlineprotected

◆ MatrixHierarchicBase() [2/3]

template<class Treal , class Telement = Treal>
mat::MatrixHierarchicBase< Treal, Telement >::MatrixHierarchicBase ( SizesAndBlocks const & rowsInp,
SizesAndBlocks const & colsInp )
inlineprotected

◆ MatrixHierarchicBase() [3/3]

template<class Treal , class Telement >
mat::MatrixHierarchicBase< Treal, Telement >::MatrixHierarchicBase ( const MatrixHierarchicBase< Treal, Telement > & mat)
protected

References mat::allocateElements(), mat::MatrixHierarchicBase< Treal, Telement >::elements, and mat::MatrixHierarchicBase< Treal, Telement >::nElements().

◆ ~MatrixHierarchicBase()

template<class Treal , class Telement >
mat::MatrixHierarchicBase< Treal, Telement >::~MatrixHierarchicBase ( )
protectedvirtual

References mat::freeElements().

Member Function Documentation

◆ assert() [1/8]

template<class Treal , class Telement = Treal>
mat::MatrixHierarchicBase< Treal, Telement >::assert ( col >= 0)

◆ assert() [2/8]

template<class Treal , class Telement = Treal>
mat::MatrixHierarchicBase< Treal, Telement >::assert ( col >= 0)

◆ assert() [3/8]

template<class Treal , class Telement = Treal>
mat::MatrixHierarchicBase< Treal, Telement >::assert ( )

◆ assert() [4/8]

template<class Treal , class Telement = Treal>
mat::MatrixHierarchicBase< Treal, Telement >::assert ( )

◆ assert() [5/8]

template<class Treal , class Telement = Treal>
mat::MatrixHierarchicBase< Treal, Telement >::assert ( row >= 0)

◆ assert() [6/8]

template<class Treal , class Telement = Treal>
mat::MatrixHierarchicBase< Treal, Telement >::assert ( row >= 0)

◆ assert() [7/8]

template<class Treal , class Telement = Treal>
mat::MatrixHierarchicBase< Treal, Telement >::assert ( )

Referenced by mat::MatrixHierarchicBase< Treal, Telement >::operator[](), and mat::MatrixHierarchicBase< Treal, Telement >::operator[]().

◆ assert() [8/8]

template<class Treal , class Telement = Treal>
mat::MatrixHierarchicBase< Treal, Telement >::assert ( )

◆ getCols()

template<class Treal , class Telement = Treal>
void mat::MatrixHierarchicBase< Treal, Telement >::getCols ( SizesAndBlocks & colsCopy) const
inline

References mat::MatrixHierarchicBase< Treal, Telement >::cols.

◆ getRows()

template<class Treal , class Telement = Treal>
void mat::MatrixHierarchicBase< Treal, Telement >::getRows ( SizesAndBlocks & rowsCopy) const
inline

References mat::MatrixHierarchicBase< Treal, Telement >::rows.

◆ highestLevel()

template<class Treal , class Telement = Treal>
bool mat::MatrixHierarchicBase< Treal, Telement >::highestLevel ( ) const
inline

References mat::MatrixHierarchicBase< Treal, Telement >::cols, mat::SizesAndBlocks::getNScalars(), mat::SizesAndBlocks::getNTotalScalars(), and mat::MatrixHierarchicBase< Treal, Telement >::rows.

◆ is_empty()

template<class Treal , class Telement = Treal>
bool mat::MatrixHierarchicBase< Treal, Telement >::is_empty ( ) const
inline

Check if matrix is empty Empty is different from zero, a zero matrix contains information about blocksizes etc.


References mat::MatrixHierarchicBase< Treal, Telement >::cols, mat::SizesAndBlocks::is_empty(), and mat::MatrixHierarchicBase< Treal, Telement >::rows.

◆ is_zero()

template<class Treal , class Telement = Treal>
bool mat::MatrixHierarchicBase< Treal, Telement >::is_zero ( ) const
inline

References mat::MatrixHierarchicBase< Treal, Telement >::elements.

Referenced by mat::MatrixHierarchicBase< Treal, Telement >::operator==().

◆ ncols()

template<class Treal , class Telement = Treal>
const int & mat::MatrixHierarchicBase< Treal, Telement >::ncols ( ) const
inline

References mat::MatrixHierarchicBase< Treal, Telement >::cols, and mat::SizesAndBlocks::getNBlocks().

◆ nElements()

template<class Treal , class Telement = Treal>
int mat::MatrixHierarchicBase< Treal, Telement >::nElements ( ) const
inline

References mat::MatrixHierarchicBase< Treal, Telement >::cols, mat::SizesAndBlocks::getNBlocks(), and mat::MatrixHierarchicBase< Treal, Telement >::rows.

Referenced by mat::MatrixHierarchicBase< Treal, Telement >::MatrixHierarchicBase(), mat::MatrixHierarchicBase< Treal, Telement >::operator[](), and mat::MatrixHierarchicBase< Treal, Telement >::operator[]().

◆ nrows()

template<class Treal , class Telement = Treal>
const int & mat::MatrixHierarchicBase< Treal, Telement >::nrows ( ) const
inline

References mat::SizesAndBlocks::getNBlocks(), and mat::MatrixHierarchicBase< Treal, Telement >::rows.

◆ nScalarsCols()

template<class Treal , class Telement = Treal>
const int & mat::MatrixHierarchicBase< Treal, Telement >::nScalarsCols ( ) const
inline

References mat::MatrixHierarchicBase< Treal, Telement >::cols, and mat::SizesAndBlocks::getNScalars().

◆ nScalarsRows()

template<class Treal , class Telement = Treal>
const int & mat::MatrixHierarchicBase< Treal, Telement >::nScalarsRows ( ) const
inline

References mat::SizesAndBlocks::getNScalars(), and mat::MatrixHierarchicBase< Treal, Telement >::rows.

◆ operator() [1/2]

template<class Treal , class Telement = Treal>
Telement & mat::MatrixHierarchicBase< Treal, Telement >::operator ( )
inline

◆ operator() [2/2]

template<class Treal , class Telement = Treal>
const Telement & mat::MatrixHierarchicBase< Treal, Telement >::operator ( )
inline

◆ operator=()

template<class Treal , class Telement >
MatrixHierarchicBase< Treal, Telement > & mat::MatrixHierarchicBase< Treal, Telement >::operator= ( const MatrixHierarchicBase< Treal, Telement > & mat)
protected

References mat::allocateElements(), cols, mat::freeElements(), and rows.

Referenced by mat::Matrix< Treal, Telement >::operator=(), and mat::Matrix< Treal >::operator=().

◆ operator==()

template<class Treal , class Telement = Treal>
bool mat::MatrixHierarchicBase< Treal, Telement >::operator== ( int k) const
inline

References mat::MatrixHierarchicBase< Treal, Telement >::is_zero().

◆ operator[]() [1/2]

template<class Treal , class Telement = Treal>
Telement & mat::MatrixHierarchicBase< Treal, Telement >::operator[] ( int index)
inline

References mat::MatrixHierarchicBase< Treal, Telement >::assert(), mat::MatrixHierarchicBase< Treal, Telement >::elements, and mat::MatrixHierarchicBase< Treal, Telement >::nElements().

◆ operator[]() [2/2]

template<class Treal , class Telement = Treal>
Telement const & mat::MatrixHierarchicBase< Treal, Telement >::operator[] ( int index) const
inline

References mat::MatrixHierarchicBase< Treal, Telement >::assert(), mat::MatrixHierarchicBase< Treal, Telement >::elements, and mat::MatrixHierarchicBase< Treal, Telement >::nElements().

◆ resetCols()

template<class Treal , class Telement = Treal>
void mat::MatrixHierarchicBase< Treal, Telement >::resetCols ( SizesAndBlocks const & newCols)
inline

References mat::MatrixHierarchicBase< Treal, Telement >::cols, mat::MatrixHierarchicBase< Treal, Telement >::elements, and mat::freeElements().

◆ resetRows()

template<class Treal , class Telement = Treal>
void mat::MatrixHierarchicBase< Treal, Telement >::resetRows ( SizesAndBlocks const & newRows)
inline

References mat::MatrixHierarchicBase< Treal, Telement >::elements, mat::freeElements(), and mat::MatrixHierarchicBase< Treal, Telement >::rows.

◆ swap()

template<class Treal , class Telement >
void mat::MatrixHierarchicBase< Treal, Telement >::swap ( MatrixHierarchicBase< Treal, Telement > & A,
MatrixHierarchicBase< Treal, Telement > & B )
staticprotected

References A, and B.

Member Data Documentation

◆ col

template<class Treal , class Telement = Treal>
Telement int mat::MatrixHierarchicBase< Treal, Telement >::col
Initial value:
{
assert(elements)
mat::MatrixHierarchicBase::elements
return elements[row+col *nrows()]
Definition MatrixHierarchicBase.h:81

◆ cols

template<class Treal , class Telement = Treal>
SizesAndBlocks mat::MatrixHierarchicBase< Treal, Telement >::cols
protected

Referenced by mat::MatrixHierarchicBase< Treal, Telement >::getCols(), mat::MatrixHierarchicBase< Treal, Telement >::highestLevel(), mat::MatrixHierarchicBase< Treal, Telement >::is_empty(), mat::MatrixHierarchicBase< Treal, Telement >::ncols(), mat::MatrixHierarchicBase< Treal, Telement >::nElements(), mat::MatrixHierarchicBase< Treal, Telement >::nScalarsCols(), and mat::MatrixHierarchicBase< Treal, Telement >::resetCols().

◆ const

template<class Treal , class Telement = Treal>
const Telement int col mat::MatrixHierarchicBase< Treal, Telement >::const
Initial value:
{
assert(elements)

◆ elements [1/2]

template<class Treal , class Telement = Treal>
return mat::MatrixHierarchicBase< Treal, Telement >::elements

Referenced by mat::MatrixHierarchicBase< Treal, Telement >::is_zero(), mat::MatrixHierarchicBase< Treal, Telement >::MatrixHierarchicBase(), mat::MatrixHierarchicBase< Treal, Telement >::operator[](), mat::MatrixHierarchicBase< Treal, Telement >::operator[](), mat::MatrixHierarchicBase< Treal, Telement >::resetCols(), and mat::MatrixHierarchicBase< Treal, Telement >::resetRows().

◆ elements [2/2]

template<class Treal , class Telement = Treal>
Telement* mat::MatrixHierarchicBase< Treal, Telement >::elements
protected

◆ rows

template<class Treal , class Telement = Treal>
SizesAndBlocks mat::MatrixHierarchicBase< Treal, Telement >::rows
protected

Referenced by mat::MatrixHierarchicBase< Treal, Telement >::getRows(), mat::MatrixHierarchicBase< Treal, Telement >::highestLevel(), mat::MatrixHierarchicBase< Treal, Telement >::is_empty(), mat::MatrixHierarchicBase< Treal, Telement >::nElements(), mat::MatrixHierarchicBase< Treal, Telement >::nrows(), mat::MatrixHierarchicBase< Treal, Telement >::nScalarsRows(), and mat::MatrixHierarchicBase< Treal, Telement >::resetRows().

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