class HCL_BandedMat_d : public HCL_Matrix_d

HCL_BandedMat_d is the HCL object representing banded matrices

Inheritance:

Public Methods

virtual ostream&

Write ( ostream & str) Prints out debugging information

Public

	Constructors HCL_BandedMat_d () Default constructor HCL_BandedMat_d (const HCL_BandedMat_d &) Copy constructor HCL_BandedMat_d (const HCL_Matrix_d &) Constructs a banded matrix from any other sparse or dense matrix HCL_BandedMat_d (HCL_RnSpace_d * d, HCL_RnSpace_d * r, int DiagLeft, int DiagRight ) Builds a matrix with domain d, range r, and specified diagonals. HCL_BandedMat_d (int m, int n, int DiagLeft, int DiagRight ) Builds matrix with m rows, n columns, and specified diagonals. HCL_BandedMat_d ( char * fname ) Initializes matrix from file
	Data Access virtual double operator) (int i, int j) Returns element i,j of matrix virtual double& operator) (int i, int j) Returns reference to element i,j of matrix double EntryOpt (int i, int j) Optimized Data Access. Non-virtual form of operator(),can be inlined double& EntryOpt (int i, int j) Optimized Data Access. Non-virtual form of operator(),can be inlined int CheckIndices (int i, int j) Returns 0 if indices are not valid, -1 otherwise void AddIndices (int i, int j) Adds the index i, j to the sparse matrix..
	Data information double* DataPtr () Returns a pointer to compressed matrix data
	Destructor virtual ~HCL_BandedMat_d () Deletes a HCL_BandedMat_d Object
	Domain and Range Information virtual HCL_VectorSpace_d& Domain () Returns a reference to the domain of the matrix virtual HCL_VectorSpace_d& Range () Returns a reference to the range of the matrix virtual HCL_EuclideanVectorSpace_d& EucRange () Returns a reference to the range of the matrix
	Operations virtual void Image (const HCL_Vector_d & xx, HCL_Vector_d & yy) Stores the image of matrix on xx in yy virtual void AdjImage (const HCL_Vector_d & xx, HCL_Vector_d &yy) Stores the adjoint image of matrix on xx in yy
	Row and Column Information virtual int Rows () Returns number of rows in matrix virtual int Cols () Returns number of columns in matrix int RowsOpt () Optimized, non-virtual form of Rows() int ColsOpt () Optimized, non-virtual form of Cols()

Protected Fields

double*	Data A pointer to the compressed matrix data
int	DiagLeft The number of diagonals to the left of the main diagonal
int	DiagRight The number of diagonals to the right of the main diagonal
int	m Domain and Range spaces of the operator
int	ndat Data length
int	numdiags The number of diagonals

Inherited from HCL_Matrix_d:

Public

Dimension Access

virtual int Rows()

Returns number of rows in the matrix

virtual int Cols()

Returns number of columns in the matrix

Operators

virtual void Image( const HCL_Vector_d & x, HCL_Vector_d & y )

Computes the action of the matrix on the HCL_Vector_d x,and stores the result in HCL_Vector_d y

virtual void AdjImage( const HCL_Vector_d & x, HCL_Vector_d & y )

Computes the action of the adjoint operator on HCL_Vector_d x, and stores the result in HCL_Vector_d y

Range and Domain Space Access

virtual HCL_VectorSpace_d& Domain()

Returns a reference to the domain of the matrix, which is a HCL_VectorSpace_d

virtual HCL_VectorSpace_d& Range()

Returns a reference to the range of the matrix, which is a HCL_VectorSpace_d

virtual HCL_EuclideanVectorSpace_d& EucRange()

Returns a reference to the range of the matrix, which is a HCL_EuclideanVectorSpace_d

Inherited from HCL_LinearOpAdjEucRange_d:

Public Methods

virtual void AdjImage( const HCL_Vector_d & y, HCL_Vector_d & x )

virtual HCL_VectorSpace_d& Domain()

virtual HCL_EuclideanVectorSpace_d& EucRange()

virtual void Image( const HCL_Vector_d & x, HCL_Vector_d & y )

virtual HCL_VectorSpace_d& Range()

Inherited from HCL_LinearOpAdj_d:

Public Methods

int TestAdj(int Display = 1, double tol = 1000 )

Inherited from HCL_LinearOp_d:

Inherited from HCL_Base:

Public Methods

int Count()

void DecCount()

void IncCount()

Private Fields

int ReferenceCount

int m

Domain and Range spaces of the operator

int DiagLeft

The number of diagonals to the left of the main diagonal

int DiagRight

The number of diagonals to the right of the main diagonal

int numdiags

The number of diagonals

int ndat

Data length

double* Data

A pointer to the compressed matrix data

Constructors

HCL_BandedMat_d()

Default constructor

HCL_BandedMat_d(const HCL_BandedMat_d &)

Copy constructor

HCL_BandedMat_d(const HCL_Matrix_d &)

Constructs a banded matrix from any other sparse or dense matrix

HCL_BandedMat_d(HCL_RnSpace_d * d, HCL_RnSpace_d * r, int DiagLeft, int DiagRight )

Builds a matrix with domain d, range r, and specified diagonals.

HCL_BandedMat_d(int m, int n, int DiagLeft, int DiagRight )

Builds matrix with m rows, n columns, and specified diagonals.

HCL_BandedMat_d( char * fname )

Initializes matrix from file. The format for the file is: rows, columns, subdiagonals, superdiagonals, and the entries from the matrix. The entries are given in the LAPACK format for banded matrices, in which an m x n matrix A with dl subdiagonals and dr superdiagonals is compressed into a (dl+dr+1) x n matrix V. A(i,j) is stored in V(dr+1+i-j,j). This matrix V must be given by columns (entries of V not corresponding to entries of A must be included but are not referenced. They can be set to zero.)

Destructor

virtual ~HCL_BandedMat_d()

Deletes a HCL_BandedMat_d Object

Domain and Range Information

virtual HCL_VectorSpace_d& Domain()

Returns a reference to the domain of the matrix

virtual HCL_VectorSpace_d& Range()

Returns a reference to the range of the matrix

virtual HCL_EuclideanVectorSpace_d& EucRange()

Returns a reference to the range of the matrix

Row and Column Information

virtual int Rows()

Returns number of rows in matrix

virtual int Cols()

Returns number of columns in matrix

int RowsOpt()

Optimized, non-virtual form of Rows()

int ColsOpt()

Optimized, non-virtual form of Cols()

Data information

double* DataPtr()

Returns a pointer to compressed matrix data

Operations

virtual void Image(const HCL_Vector_d & xx, HCL_Vector_d & yy)

Stores the image of matrix on xx in yy

virtual void AdjImage(const HCL_Vector_d & xx, HCL_Vector_d &yy)

Stores the adjoint image of matrix on xx in yy

Data Access

virtual double operator) (int i, int j)

Returns element i,j of matrix

virtual double& operator) (int i, int j)

Returns reference to element i,j of matrix

double EntryOpt(int i, int j)

Optimized Data Access. Non-virtual form of operator(),can be inlined

double& EntryOpt(int i, int j)

Optimized Data Access. Non-virtual form of operator(),can be inlined

int CheckIndices(int i, int j)

Returns 0 if indices are not valid, -1 otherwise

void AddIndices(int i, int j)

Adds the index i, j to the sparse matrix..

virtual ostream& Write( ostream & str)

Prints out debugging information

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de