Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::fem::ItpackSparseMatrix Class Reference

a compressed row sparse matrix representation that makes use of itpack to dynamically assemble the matrix. More...

#include <itkFEMItpackSparseMatrix.h>

List of all members.

Public Types

typedef itpack::integer integer
typedef itpack::doublereal doublereal

Public Methods

 ItpackSparseMatrix ()
 ItpackSparseMatrix (integer order)
 ItpackSparseMatrix (integer order, integer maxNonZeroValues)
 ~ItpackSparseMatrix ()
void SetOrder (integer order)
void SetMaxNonZeroValues (integer maxNonZeroValues)
void Set (integer i, integer j, doublereal value)
void Add (integer i, integer j, doublereal value)
doublereal Get (integer i, integer j)
integerGetN ()
integerGetIA ()
void SetCompressedRow (integer *ia, integer *ja, doublereal *a)
integerGetJA ()
doublerealGetA ()
doublerealGetValueArray ()
integerGetColumnArray ()
integerGetRowArray ()
integer GetOrder () const
integer GetMaxNonZeroValues () const
void Clear ()
void mult (doublereal *vector, doublereal *result)
void mult (ItpackSparseMatrix *rightMatrix, ItpackSparseMatrix *resultMatrix)
void PrintCompressedRow ()

Friends

class LinearSystemWrapperItpack


Detailed Description

a compressed row sparse matrix representation that makes use of itpack to dynamically assemble the matrix.

See also:
ItpackLinearSystemWrapper

Definition at line 40 of file itkFEMItpackSparseMatrix.h.


Member Typedef Documentation

typedef itpack::doublereal itk::fem::ItpackSparseMatrix::doublereal
 

typedef for itpack double type

Definition at line 48 of file itkFEMItpackSparseMatrix.h.

Referenced by GetMaxNonZeroValues().

typedef itpack::integer itk::fem::ItpackSparseMatrix::integer
 

typedef for itpack integer type

Definition at line 45 of file itkFEMItpackSparseMatrix.h.

Referenced by GetColumnArray(), GetN(), GetOrder(), GetRowArray(), GetValueArray(), SetMaxNonZeroValues(), and SetOrder().


Constructor & Destructor Documentation

itk::fem::ItpackSparseMatrix::ItpackSparseMatrix  
 

Constructor

itk::fem::ItpackSparseMatrix::ItpackSparseMatrix integer    order
 

Constructor with single parameter

Parameters:
order  the order of the matrix to be created

itk::fem::ItpackSparseMatrix::ItpackSparseMatrix integer    order,
integer    maxNonZeroValues
 

Constructor with two parameters

Parameters:
order  the order of the matrix to be created
maxNonZeroValues  the maximum number of non-zero values that may appear in the matrix

itk::fem::ItpackSparseMatrix::~ItpackSparseMatrix  
 

Destructor


Member Function Documentation

void itk::fem::ItpackSparseMatrix::Add integer    i,
integer    j,
doublereal    value
 

Add to existing entry of matrix

Parameters:
i  row index
j  column index
value  value to add to current value at (i,j)

void itk::fem::ItpackSparseMatrix::Clear  
 

Clear the memory

doublereal itk::fem::ItpackSparseMatrix::Get integer    i,
integer    j
 

Get a value from the matrix

Parameters:
i  row index
j  column index

doublereal* itk::fem::ItpackSparseMatrix::GetA  
 

Get the values of the matrix (via "itpack-like" naming scheme)

integer* itk::fem::ItpackSparseMatrix::GetColumnArray   [inline]
 

Get the column indices

Definition at line 145 of file itkFEMItpackSparseMatrix.h.

References GetIA(), and integer.

integer* itk::fem::ItpackSparseMatrix::GetIA  
 

Get the row indices of the matrix (via "itpack-like" naming scheme)

Referenced by GetColumnArray().

integer* itk::fem::ItpackSparseMatrix::GetJA  
 

Get the column indices of the matrix (via "itpack-like" naming scheme)

Referenced by GetValueArray().

integer itk::fem::ItpackSparseMatrix::GetMaxNonZeroValues   const [inline]
 

Get the maximum number of non-zero values allowed in the matrix

Definition at line 160 of file itkFEMItpackSparseMatrix.h.

References doublereal.

integer* itk::fem::ItpackSparseMatrix::GetN   [inline]
 

Get the order of the matrix (via "itpack-like" naming scheme)

Definition at line 112 of file itkFEMItpackSparseMatrix.h.

References integer.

integer itk::fem::ItpackSparseMatrix::GetOrder   const [inline]
 

Get the order of the matrix

Definition at line 155 of file itkFEMItpackSparseMatrix.h.

References integer.

integer* itk::fem::ItpackSparseMatrix::GetRowArray   [inline]
 

Get the row indices

Definition at line 150 of file itkFEMItpackSparseMatrix.h.

References integer.

doublereal* itk::fem::ItpackSparseMatrix::GetValueArray   [inline]
 

Get the values of the matrix

Definition at line 140 of file itkFEMItpackSparseMatrix.h.

References GetJA(), and integer.

void itk::fem::ItpackSparseMatrix::mult ItpackSparseMatrix *    rightMatrix,
ItpackSparseMatrix *    resultMatrix
 

Multiply the matrix by another ItpackSparseMatrix

void itk::fem::ItpackSparseMatrix::mult doublereal   vector,
doublereal   result
 

Multiply the matrix by a vector

void itk::fem::ItpackSparseMatrix::PrintCompressedRow  
 

output compressed row vectors: IA, JA, A

void itk::fem::ItpackSparseMatrix::Set integer    i,
integer    j,
doublereal    value
 

Insert a value into the matrix

Parameters:
i  row index
j  column index
value  value to be added at (i,j)

void itk::fem::ItpackSparseMatrix::SetCompressedRow integer   ia,
integer   ja,
doublereal   a
 

Pass pointers to compressed row format arrays

Parameters:
ia  row indices
ja  column indices
a  matrix values

void itk::fem::ItpackSparseMatrix::SetMaxNonZeroValues integer    maxNonZeroValues [inline]
 

Set the maximum number of non-zero values that may appear in the matrix

Parameters:
maxNonZeroValues  maximum number of non-zero values that may appear in matrix
Note:
the maxNonZeroValues must be set before any values are entered

Definition at line 85 of file itkFEMItpackSparseMatrix.h.

References integer.

void itk::fem::ItpackSparseMatrix::SetOrder integer    order [inline]
 

Set the order of the matrix

Parameters:
order  the order of the matrix
Note:
the order must be set before any values are entered

Definition at line 78 of file itkFEMItpackSparseMatrix.h.

References integer.


Friends And Related Function Documentation

friend class LinearSystemWrapperItpack [friend]
 

friend class

Definition at line 183 of file itkFEMItpackSparseMatrix.h.


The documentation for this class was generated from the following file:
Generated at Wed Mar 12 01:22:19 2003 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000