gnsstk::ConstMatrixBase< T, BaseClass > Class Template Reference

Detailed Description

template<class T, class BaseClass>
class gnsstk::ConstMatrixBase< T, BaseClass >

A matrix base class for a non-modifiable matrix. There is no operator[] for base matrix classes.

Definition at line 65 of file MatrixBase.hpp.

#include <MatrixBase.hpp>

Inheritance diagram for gnsstk::ConstMatrixBase< T, BaseClass >:

Public Member Functions
Vector< T >	colCopy (size_t c, size_t r=0) const
size_t	cols () const
	the number of columns in the matrix More...
	ConstMatrixBase ()
	default constructor More...
Vector< T >	diagCopy (void) const
bool	isDiagonal () const
	returns true if this is a diagonal matrix More...
bool	isLT () const
	returns true if this is a lower triangular matrix. More...
bool	isSquare () const
	returns true if this is a square matrix (false for a null matrix). More...
bool	isSymmetric () const
bool	isUT () const
	returns true if this is an upper triangular matrix. More...
T	operator() (size_t i, size_t j) const
Vector< T >	rowCopy (size_t r, size_t c=0) const
size_t	rows () const
	the number of rows in the matrix More...
size_t	size () const
	the rows()*cols() size of the matrix. More...
virtual	~ConstMatrixBase ()

Protected Member Functions
T	constMatrixRef (size_t i, size_t j) const

Constructor & Destructor Documentation

ConstMatrixBase()

template<class T , class BaseClass >

gnsstk::ConstMatrixBase< T, BaseClass >::ConstMatrixBase ( )

inlineexplicit

default constructor

Definition at line 69 of file MatrixBase.hpp.

~ConstMatrixBase()

template<class T , class BaseClass >

virtual gnsstk::ConstMatrixBase< T, BaseClass >::~ConstMatrixBase ( )

inlinevirtual

Definition at line 71 of file MatrixBase.hpp.

Member Function Documentation

colCopy()

template<class T , class BaseClass >

Vector<T> gnsstk::ConstMatrixBase< T, BaseClass >::colCopy ( size_t  c, size_t  r = 0  ) const

inline

copies out column c into a vector starting with row r

Exceptions

MatrixException

Definition at line 146 of file MatrixBase.hpp.

cols()

template<class T , class BaseClass >

size_t gnsstk::ConstMatrixBase< T, BaseClass >::cols ( ) const

inline

the number of columns in the matrix

Definition at line 78 of file MatrixBase.hpp.

constMatrixRef()

template<class T , class BaseClass >

T gnsstk::ConstMatrixBase< T, BaseClass >::constMatrixRef ( size_t  i, size_t  j  ) const

inlineprotected

returns the const (i,j) element from the matrix

Exceptions

MatrixException

Definition at line 198 of file MatrixBase.hpp.

diagCopy()

template<class T , class BaseClass >

Vector<T> gnsstk::ConstMatrixBase< T, BaseClass >::diagCopy ( void  ) const

inline

copies out diagonal into a vector

Exceptions

MatrixException

Definition at line 184 of file MatrixBase.hpp.

isDiagonal()

template<class T , class BaseClass >

bool gnsstk::ConstMatrixBase< T, BaseClass >::isDiagonal ( ) const

inline

returns true if this is a diagonal matrix

Definition at line 117 of file MatrixBase.hpp.

isLT()

template<class T , class BaseClass >

bool gnsstk::ConstMatrixBase< T, BaseClass >::isLT ( ) const

inline

returns true if this is a lower triangular matrix.

Definition at line 104 of file MatrixBase.hpp.

isSquare()

template<class T , class BaseClass >

bool gnsstk::ConstMatrixBase< T, BaseClass >::isSquare ( ) const

inline

returns true if this is a square matrix (false for a null matrix).

Definition at line 89 of file MatrixBase.hpp.

isSymmetric()

template<class T , class BaseClass >

bool gnsstk::ConstMatrixBase< T, BaseClass >::isSymmetric ( ) const

inline

returns true if this is a symmetrical matrix (across the primary diagonal)

Definition at line 131 of file MatrixBase.hpp.

isUT()

template<class T , class BaseClass >

bool gnsstk::ConstMatrixBase< T, BaseClass >::isUT ( ) const

inline

returns true if this is an upper triangular matrix.

Definition at line 92 of file MatrixBase.hpp.

operator()()

template<class T , class BaseClass >

T gnsstk::ConstMatrixBase< T, BaseClass >::operator() ( size_t  i, size_t  j  ) const

inline

returns a const version of the (i,j)'th element in the matrix, valid for 0...rows()-1, 0...cols()-1.

Definition at line 85 of file MatrixBase.hpp.

rowCopy()

template<class T , class BaseClass >

Vector<T> gnsstk::ConstMatrixBase< T, BaseClass >::rowCopy ( size_t  r, size_t  c = 0  ) const

inline

copies out row r into a vector starting with column c

Exceptions

MatrixException

Definition at line 165 of file MatrixBase.hpp.

rows()

template<class T , class BaseClass >

size_t gnsstk::ConstMatrixBase< T, BaseClass >::rows ( ) const

inline

the number of rows in the matrix

Definition at line 81 of file MatrixBase.hpp.

size()

template<class T , class BaseClass >

size_t gnsstk::ConstMatrixBase< T, BaseClass >::size ( ) const

inline

the rows()*cols() size of the matrix.

Definition at line 75 of file MatrixBase.hpp.

---

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

• MatrixBase.hpp