NOX::LAPACK::Matrix< T > Class Template Reference

A simple square matrix class for use by NOX::LAPACK::Group. More...

#include <NOX_LAPACK_Matrix.H>

Inheritance diagram for NOX::LAPACK::Matrix< T >:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 Matrix ()
 Create an empty matrix.
 Matrix (int m, int n)
 Create a m x n matrix with all entries zero.
 Matrix (const Matrix &a)
 Copy constructor.
 ~Matrix ()
 Destructor.
T & operator() (int i, int j)
 Access the (i,j) entry of A.
const T & operator() (int i, int j) const
 Access the (i,j) entry of A.
void scale (T v)
 Scale the matrix by a constant value.
bool print (std::ostream &stream) const
 Prints out the matrix.
int numRows () const
 Returns the number of rows in the matrix.
int numCols () const
 Returns the number of columns in the matrix.

Private Attributes

int p
 This is a p x q matrix.
int q
std::vector< T > entries
 Entries of the matrix.


Detailed Description

template<typename T>
class NOX::LAPACK::Matrix< T >

A simple square matrix class for use by NOX::LAPACK::Group.

The matrix is stored as a vector<T> array. It is templated so it can store entries of different types. For example, the LOCA LAPACK group stores a complex matrix for Hopf tracking.

Definition at line 58 of file NOX_LAPACK_Matrix.H.


Constructor & Destructor Documentation

template<typename T>
NOX::LAPACK::Matrix< T >::Matrix (  )  [inline]

Create an empty matrix.

Definition at line 63 of file NOX_LAPACK_Matrix.H.

template<typename T>
NOX::LAPACK::Matrix< T >::Matrix ( int  m,
int  n 
) [inline]

Create a m x n matrix with all entries zero.

Definition at line 66 of file NOX_LAPACK_Matrix.H.

template<typename T>
NOX::LAPACK::Matrix< T >::Matrix ( const Matrix< T > &  a  )  [inline]

Copy constructor.

Definition at line 69 of file NOX_LAPACK_Matrix.H.

template<typename T>
NOX::LAPACK::Matrix< T >::~Matrix (  )  [inline]

Destructor.

Definition at line 73 of file NOX_LAPACK_Matrix.H.


Member Function Documentation

template<typename T>
T& NOX::LAPACK::Matrix< T >::operator() ( int  i,
int  j 
) [inline]

Access the (i,j) entry of A.

Definition at line 76 of file NOX_LAPACK_Matrix.H.

template<typename T>
const T& NOX::LAPACK::Matrix< T >::operator() ( int  i,
int  j 
) const [inline]

Access the (i,j) entry of A.

Definition at line 79 of file NOX_LAPACK_Matrix.H.

template<typename T>
void NOX::LAPACK::Matrix< T >::scale ( v  )  [inline]

Scale the matrix by a constant value.

This is needed to manipulate matrices in the LOCA library routines.

Definition at line 85 of file NOX_LAPACK_Matrix.H.

Referenced by LOCA::LAPACK::Group::augmentJacobianForHomotopy(), and LOCA::LAPACK::Interface::computeShiftedMatrix().

template<typename T>
bool NOX::LAPACK::Matrix< T >::print ( std::ostream &  stream  )  const [inline]

Prints out the matrix.

Definition at line 91 of file NOX_LAPACK_Matrix.H.

template<typename T>
int NOX::LAPACK::Matrix< T >::numRows (  )  const [inline]

template<typename T>
int NOX::LAPACK::Matrix< T >::numCols (  )  const [inline]

Returns the number of columns in the matrix.

Definition at line 105 of file NOX_LAPACK_Matrix.H.

Referenced by LOCA::LAPACK::Interface::computeShiftedMatrix().


Member Data Documentation

template<typename T>
int NOX::LAPACK::Matrix< T >::p [private]

template<typename T>
std::vector<T> NOX::LAPACK::Matrix< T >::entries [private]


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

Generated on Wed Oct 21 14:28:47 2009 for Nonlinear Solver Project by  doxygen 1.5.9