ConstMatrixBase Class Template Reference
[Vector and Matrix mathematics]

#include <MatrixBase.hpp>

Inheritance diagram for ConstMatrixBase:

Inheritance graph
[legend]
List of all members.

Detailed Description

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

A matrix base class for a non-modifiable matrix.

There is no operator[] for base matrix classes.

Definition at line 74 of file MatrixBase.hpp.

Public Member Functions

 ConstMatrixBase ()
 default constructor
size_t size () const
 the rows()*cols() size of the matrix.
size_t cols () const
 the number of columns in the matrix
size_t rows () const
 the number of rows in the matrix
operator() (size_t i, size_t j) const
 returns a const version of the (i,j)'th element in the matrix, valid for 0...rows()-1, 0...cols()-1.
bool isSquare () const
 returns true if this is a square matrix (false for a null matrix).
bool isUT () const
 returns true if this is an upper triangular matrix.
bool isLT () const
 returns true if this is a lower triangular matrix.
bool isDiagonal () const
 returns true if this is a diagonal matrix
bool isSymmetric () const
 returns true if this is a symmetrical matrix (across the primary diagonal)
Vector< T > colCopy (size_t c, size_t r=0) const throw (MatrixException)
 copies out column c into a vector starting with row r
Vector< T > rowCopy (size_t r, size_t c=0) const throw (MatrixException)
 copies out row r into a vector starting with column c

Protected Member Functions

constMatrixRef (size_t i, size_t j) const throw (MatrixException)
 returns the const (i,j) element from the matrix


Constructor & Destructor Documentation

ConstMatrixBase  )  [inline, explicit]
 

default constructor

Definition at line 78 of file MatrixBase.hpp.


Member Function Documentation

Vector<T> colCopy size_t  c,
size_t  r = 0
const throw (MatrixException) [inline]
 

copies out column c into a vector starting with row r

Definition at line 150 of file MatrixBase.hpp.

Referenced by SRI::operator+=(), and SRI::Qbump().

size_t cols void   )  const [inline]
 

the number of columns in the matrix

Reimplemented in Matrix, MatrixSlice, ConstMatrixSlice, MatrixColSlice, ConstMatrixColSlice, MatrixRowSlice, ConstMatrixRowSlice, RefMatrixBase, Matrix< double >, Matrix< int >, RefMatrixBase< T, MatrixRowSlice< T > >, RefMatrixBase< double, Matrix< double > >, RefMatrixBase< T, Matrix< T > >, RefMatrixBase< T, MatrixColSlice< T > >, RefMatrixBase< T, MatrixSlice< T > >, and RefMatrixBase< int, Matrix< int > >.

Definition at line 84 of file MatrixBase.hpp.

Referenced by Matrix< int >::Matrix(), and Matrix< int >::operator=().

T constMatrixRef size_t  i,
size_t  j
const throw (MatrixException) [inline, protected]
 

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

Definition at line 187 of file MatrixBase.hpp.

bool isDiagonal  )  const [inline]
 

returns true if this is a diagonal matrix

Definition at line 123 of file MatrixBase.hpp.

bool isLT  )  const [inline]
 

returns true if this is a lower triangular matrix.

Definition at line 110 of file MatrixBase.hpp.

bool isSquare  )  const [inline]
 

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

Definition at line 95 of file MatrixBase.hpp.

bool isSymmetric  )  const [inline]
 

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

Definition at line 137 of file MatrixBase.hpp.

bool isUT  )  const [inline]
 

returns true if this is an upper triangular matrix.

Definition at line 98 of file MatrixBase.hpp.

T 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.

Reimplemented in Matrix, MatrixSlice, ConstMatrixSlice, MatrixColSlice, ConstMatrixColSlice, MatrixRowSlice, ConstMatrixRowSlice, Matrix< double >, and Matrix< int >.

Definition at line 91 of file MatrixBase.hpp.

Vector<T> rowCopy size_t  r,
size_t  c = 0
const throw (MatrixException) [inline]
 

copies out row r into a vector starting with column c

Definition at line 168 of file MatrixBase.hpp.

size_t rows void   )  const [inline]
 

the number of rows in the matrix

Reimplemented in Matrix, MatrixSlice, ConstMatrixSlice, MatrixColSlice, ConstMatrixColSlice, MatrixRowSlice, ConstMatrixRowSlice, RefMatrixBase, Matrix< double >, Matrix< int >, RefMatrixBase< T, MatrixRowSlice< T > >, RefMatrixBase< double, Matrix< double > >, RefMatrixBase< T, Matrix< T > >, RefMatrixBase< T, MatrixColSlice< T > >, RefMatrixBase< T, MatrixSlice< T > >, and RefMatrixBase< int, Matrix< int > >.

Definition at line 87 of file MatrixBase.hpp.

Referenced by Matrix< int >::Matrix(), and Matrix< int >::operator=().

size_t size void   )  const [inline]
 

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

Reimplemented in Matrix, MatrixSlice, ConstMatrixSlice, MatrixColSlice, ConstMatrixColSlice, MatrixRowSlice, ConstMatrixRowSlice, RefMatrixBase, Matrix< double >, Matrix< int >, RefMatrixBase< T, MatrixRowSlice< T > >, RefMatrixBase< double, Matrix< double > >, RefMatrixBase< T, Matrix< T > >, RefMatrixBase< T, MatrixColSlice< T > >, RefMatrixBase< T, MatrixSlice< T > >, and RefMatrixBase< int, Matrix< int > >.

Definition at line 81 of file MatrixBase.hpp.

Referenced by ConstMatrixRowSlice::colSize(), MatrixRowSlice::colSize(), ConstMatrixSlice::colSize(), MatrixSlice::colSize(), Matrix< int >::operator=(), ConstMatrixColSlice::rowSize(), MatrixColSlice::rowSize(), ConstMatrixSlice::rowSize(), and MatrixSlice::rowSize().


The documentation for this class was generated from the following file:
Generated on Tue May 21 03:31:52 2013 for GPS ToolKit Software Library by  doxygen 1.3.9.1