Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples | Search for 

RefMatrixBase Class Template Reference
[Vector and Matrix mathematics]

#include <MatrixBase.hpp>

Inheritance diagram for RefMatrixBase:

Inheritance graph
[legend]
Collaboration diagram for RefMatrixBase:

Collaboration graph
[legend]
List of all members.

Detailed Description

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

A matrix base class that allows assignment of the internal matrix.

There is no operator[] for base matrix classes.

Definition at line 197 of file MatrixBase.hpp.

Public Member Functions

 RefMatrixBase ()
 default constructor
T & operator() (size_t i, size_t j)
 returns a reference to the (i,j) element of the matrix.
size_t size () const
 returns the rows()*cols() size of the matrix
size_t cols () const
 returns the number of columns in the matrix
size_t rows () const
 returns the number of rows in the matrix
BaseClass & zeroize ()
 any value with absolute value below RefVectorBaseHelper::zeroTolerance is set to 0.
BaseClass & zeroizeRow (size_t r)
 any value in row r with absolute value below RefVectorBaseHelper::zeroTolerance is set to 0.
BaseClass & zeroizeCol (size_t c)
 any value in column c with absolute value below RefVectorBaseHelper::zeroTolerance is set to 0.
template<class E>
BaseClass & assignFrom (const ConstMatrixBase< T, E > &x) throw (MatrixException)
 performs = on each element of this matrix with each element of x
template<class E>
BaseClass & assignFrom (const ConstVectorBase< T, E > &x) throw (MatrixException)
 performs = on each element of this matrix with each element of x
BaseClass & assignFrom (const std::valarray< T > &x) throw (MatrixException)
 performs = on each element of this matrix with each element of x
BaseClass & assignFrom (const T *x)
 performs = on each element of this matrix with each element of x
BaseClass & assignFrom (T x)
 performs = on each element of this matrix with x
template<class E>
BaseClass & operator+= (const ConstMatrixBase< T, E > &x) throw (MatrixException)
 performs += on each element of this matrix with each element of x
template<class E>
BaseClass & operator+= (const ConstVectorBase< T, E > &x) throw (MatrixException)
 performs += on each element of this matrix with each element of x
BaseClass & operator+= (const std::valarray< T > &x) throw (MatrixException)
 performs += on each element of this matrix with each element of x
BaseClass & operator+= (const T *x)
 performs += on each element of this matrix with each element of x
BaseClass & operator+= (T x)
 performs += on each element of this matrix with x
template<class E>
BaseClass & operator-= (const ConstMatrixBase< T, E > &x) throw (MatrixException)
 performs -= on each element of this matrix with each element of x
template<class E>
BaseClass & operator-= (const ConstVectorBase< T, E > &x) throw (MatrixException)
 performs -= on each element of this matrix with each element of x
BaseClass & operator-= (const std::valarray< T > &x) throw (MatrixException)
 performs -= on each element of this matrix with each element of x
BaseClass & operator-= (const T *x)
 performs -= on each element of this matrix with each element of x
BaseClass & operator-= (T x)
 performs -= on each element of this matrix with x
BaseClass & operator *= (const T x)
 multiplies each element in this matrix by x.
BaseClass & operator/= (const T x)
 divides each element in this matrix by x.
const BaseClass operator- () const
 unary minus: multiplies each element in this matrix by -1.
BaseClass & swapRows (size_t row1, size_t row2) throw (MatrixException)
 swaps rows row1 and row2 in this matrix.
BaseClass & swapCols (size_t col1, size_t col2) throw (MatrixException)
 swaps columns col1 and col2 in this matrix.

Constructor & Destructor Documentation

RefMatrixBase (   )  [inline, explicit]
 

default constructor

Definition at line 201 of file MatrixBase.hpp.

Member Function Documentation

BaseClass& assignFrom (  T  x  )  [inline]
 

performs = on each element of this matrix with x

Definition at line 384 of file MatrixBase.hpp.

BaseClass& assignFrom (  const T *  x  )  [inline]
 

performs = on each element of this matrix with each element of x

Definition at line 373 of file MatrixBase.hpp.

BaseClass& assignFrom (  const std::valarray< T > &  x  )  throw (MatrixException) [inline]
 

performs = on each element of this matrix with each element of x

Definition at line 355 of file MatrixBase.hpp.

BaseClass& assignFrom (  const ConstVectorBase< T, E > &  x  )  throw (MatrixException) [inline]
 

performs = on each element of this matrix with each element of x

Definition at line 337 of file MatrixBase.hpp.

BaseClass& assignFrom (  const ConstMatrixBase< T, E > &  x  )  throw (MatrixException) [inline]
 

performs = on each element of this matrix with each element of x

Definition at line 319 of file MatrixBase.hpp.

size_t cols (  void   )  const [inline]
 

returns the number of columns in the matrix

Reimplemented from ConstMatrixBase.

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

Definition at line 211 of file MatrixBase.hpp.

BaseClass& operator *= (  const T  x  )  [inline]
 

multiplies each element in this matrix by x.

Definition at line 555 of file MatrixBase.hpp.

T& operator() (  size_t  i,
size_t  j
)  [inline]
 

returns a reference to the (i,j) element of the matrix.

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

Definition at line 204 of file MatrixBase.hpp.

BaseClass& operator+= (  T  x  )  [inline]
 

performs += on each element of this matrix with x

Definition at line 463 of file MatrixBase.hpp.

BaseClass& operator+= (  const T *  x  )  [inline]
 

performs += on each element of this matrix with each element of x

Definition at line 452 of file MatrixBase.hpp.

BaseClass& operator+= (  const std::valarray< T > &  x  )  throw (MatrixException) [inline]
 

performs += on each element of this matrix with each element of x

Definition at line 434 of file MatrixBase.hpp.

BaseClass& operator+= (  const ConstVectorBase< T, E > &  x  )  throw (MatrixException) [inline]
 

performs += on each element of this matrix with each element of x

Definition at line 416 of file MatrixBase.hpp.

BaseClass& operator+= (  const ConstMatrixBase< T, E > &  x  )  throw (MatrixException) [inline]
 

performs += on each element of this matrix with each element of x

Definition at line 398 of file MatrixBase.hpp.

const BaseClass operator- (   )  const [inline]
 

unary minus: multiplies each element in this matrix by -1.

Definition at line 587 of file MatrixBase.hpp.

BaseClass& operator-= (  T  x  )  [inline]
 

performs -= on each element of this matrix with x

Definition at line 542 of file MatrixBase.hpp.

BaseClass& operator-= (  const T *  x  )  [inline]
 

performs -= on each element of this matrix with each element of x

Definition at line 531 of file MatrixBase.hpp.

BaseClass& operator-= (  const std::valarray< T > &  x  )  throw (MatrixException) [inline]
 

performs -= on each element of this matrix with each element of x

Definition at line 513 of file MatrixBase.hpp.

BaseClass& operator-= (  const ConstVectorBase< T, E > &  x  )  throw (MatrixException) [inline]
 

performs -= on each element of this matrix with each element of x

Definition at line 495 of file MatrixBase.hpp.

BaseClass& operator-= (  const ConstMatrixBase< T, E > &  x  )  throw (MatrixException) [inline]
 

performs -= on each element of this matrix with each element of x

Definition at line 477 of file MatrixBase.hpp.

BaseClass& operator/= (  const T  x  )  [inline]
 

divides each element in this matrix by x.

Definition at line 567 of file MatrixBase.hpp.

size_t rows (  void   )  const [inline]
 

returns the number of rows in the matrix

Reimplemented from ConstMatrixBase.

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

Definition at line 214 of file MatrixBase.hpp.

size_t size (  void   )  const [inline]
 

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

Reimplemented from ConstMatrixBase.

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

Definition at line 208 of file MatrixBase.hpp.

BaseClass& swapCols (  size_t  col1,
size_t  col2
)  throw (MatrixException) [inline]
 

swaps columns col1 and col2 in this matrix.

Definition at line 622 of file MatrixBase.hpp.

BaseClass& swapRows (  size_t  row1,
size_t  row2
)  throw (MatrixException) [inline]
 

swaps rows row1 and row2 in this matrix.

Definition at line 599 of file MatrixBase.hpp.

BaseClass& zeroize (   )  [inline]
 

any value with absolute value below RefVectorBaseHelper::zeroTolerance is set to 0.

Definition at line 218 of file MatrixBase.hpp.

BaseClass& zeroizeCol (  size_t  c  )  [inline]
 

any value in column c with absolute value below RefVectorBaseHelper::zeroTolerance is set to 0.

Definition at line 241 of file MatrixBase.hpp.

BaseClass& zeroizeRow (  size_t  r  )  [inline]
 

any value in row r with absolute value below RefVectorBaseHelper::zeroTolerance is set to 0.

Definition at line 230 of file MatrixBase.hpp.

The documentation for this class was generated from the following file:
Generated on Wed Feb 8 03:31:39 2012 for GPS ToolKit Software Library by  doxygen 1.3.9.1