BandMatrix Class Reference
[Newmat matrix manipulation library]

Band matrix. More...

#include <newmat.h>

Inheritance diagram for BandMatrix:

[legend]

List of all members.

Public Member Functions
	BandMatrix (const BandMatrix &gm)
	BandMatrix (int n, int lb, int ub)
	BandMatrix ()
Real	maximum () const
Real	maximum_absolute_value () const
Real	minimum () const
Real	minimum_absolute_value () const
void	operator<< (const BaseMatrix &X)
MatrixInput	operator<< (int f)
void	operator= (const BandMatrix &m)
void	operator= (Real f)
void	ReSize (const GeneralMatrix &A)
virtual void	ReSize (int m, int n, int b)
void	RestoreCol (MatrixColX &c)
Real	sum () const
Real	sum_absolute_value () const
Real	sum_square () const
	~BandMatrix ()
MatrixBandWidth	bandwidth () const
void	swap (BandMatrix &gm)
MatrixType	type () const
Real	element (int, int) const
Real &	element (int, int)
Real	operator() (int, int) const
Real &	operator() (int, int)
void	GetCol (MatrixColX &)
void	GetCol (MatrixRowCol &)
void	GetRow (MatrixRowCol &)
void	NextRow (MatrixRowCol &)
void	RestoreCol (MatrixRowCol &)
void	operator<< (const int *r)
void	operator<< (const float *r)
void	operator<< (const double *r)
MatrixInput	operator<< (float)
MatrixInput	operator<< (double)
Real	trace () const
Public Attributes
int	lower_val
int	upper_val
GeneralMatrix *	Image () const
void	CornerClear () const
	set unused parts of BandMatrix to zero
short	SimpleAddOK (const GeneralMatrix *gm)
	can we add two band matrices with simple vector add
	BandMatrix (const BaseMatrix &)
LogAndSign	log_determinant () const
GeneralMatrix *	MakeSolver ()
void	operator= (const BaseMatrix &)
	assignment operator for BandMatrix
void	resize (const GeneralMatrix &A)
	resize BandMatrix
virtual void	resize (int, int, int)
void	SetParameters (const GeneralMatrix *)

---

Detailed Description

Band matrix.

Definition at line 1096 of file newmat.h.

---

Constructor & Destructor Documentation

BandMatrix::BandMatrix

(

)

[inline]

Definition at line 1104 of file newmat.h.

BandMatrix::~BandMatrix

(

)

[inline]

Definition at line 1105 of file newmat.h.

BandMatrix::BandMatrix	(	int	n,
		int	lb,
		int	ub
	)			[inline]

Definition at line 1106 of file newmat.h.

BandMatrix::BandMatrix

(

const BaseMatrix &

M

)

Definition at line 35 of file bandmat.cpp.

BandMatrix::BandMatrix

(

const BandMatrix &

gm

)

[inline]

Definition at line 1122 of file newmat.h.

---

Member Function Documentation

MatrixBandWidth BandMatrix::bandwidth

(

)

const [virtual]

Reimplemented from BaseMatrix.

Definition at line 681 of file newmat4.cpp.

void BandMatrix::CornerClear

(

)

const [protected]

set unused parts of BandMatrix to zero

Definition at line 180 of file bandmat.cpp.

Real BandMatrix::element	(	int	m,
		int	n
	)			const

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 815 of file newmat6.cpp.

Real & BandMatrix::element	(	int	m,
		int	n
	)

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 806 of file newmat6.cpp.

void BandMatrix::GetCol

(

MatrixColX &

mrc

)

[virtual]

Implements GeneralMatrix.

Definition at line 621 of file newmat3.cpp.

void BandMatrix::GetCol

(

MatrixRowCol &

mrc

)

[virtual]

Implements GeneralMatrix.

Definition at line 593 of file newmat3.cpp.

void BandMatrix::GetRow

(

MatrixRowCol &

mrc

)

[virtual]

Implements GeneralMatrix.

Definition at line 572 of file newmat3.cpp.

GeneralMatrix * BandMatrix::Image

(

)

const [private, virtual]

Reimplemented from GeneralMatrix.

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 636 of file bandmat.cpp.

LogAndSign BandMatrix::log_determinant

(

)

const [virtual]

Reimplemented from GeneralMatrix.

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 500 of file bandmat.cpp.

GeneralMatrix * BandMatrix::MakeSolver

(

)

[virtual]

Reimplemented from GeneralMatrix.

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 365 of file bandmat.cpp.

Real BandMatrix::maximum

(

)

const [inline, virtual]

Reimplemented from GeneralMatrix.

Definition at line 1136 of file newmat.h.

Real BandMatrix::maximum_absolute_value

(

)

const [inline, virtual]

Reimplemented from GeneralMatrix.

Definition at line 1132 of file newmat.h.

Real BandMatrix::minimum

(

)

const [inline, virtual]

Reimplemented from GeneralMatrix.

Definition at line 1137 of file newmat.h.

Real BandMatrix::minimum_absolute_value

(

)

const [inline, virtual]

Reimplemented from GeneralMatrix.

Definition at line 1134 of file newmat.h.

void BandMatrix::NextRow

(

MatrixRowCol &

mrc

)

[virtual]

Reimplemented from GeneralMatrix.

Definition at line 584 of file newmat3.cpp.

Real BandMatrix::operator()	(	int	m,
		int	n
	)			const

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 208 of file newmat6.cpp.

Real & BandMatrix::operator()	(	int	m,
		int	n
	)

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 96 of file newmat6.cpp.

void BandMatrix::operator<<

(

const BaseMatrix &

X

)

[inline]

Reimplemented from GeneralMatrix.

Definition at line 1161 of file newmat.h.

void BandMatrix::operator<<

(

const int *

r

)

Reimplemented from GeneralMatrix.

Definition at line 521 of file newmat5.cpp.

void BandMatrix::operator<<

(

const float *

r

)

Reimplemented from GeneralMatrix.

Definition at line 518 of file newmat5.cpp.

void BandMatrix::operator<<

(

const double *

r

)

Reimplemented from GeneralMatrix.

Definition at line 515 of file newmat5.cpp.

MatrixInput BandMatrix::operator<<

(

float

)

Reimplemented from GeneralMatrix.

Definition at line 506 of file newmat5.cpp.

MatrixInput BandMatrix::operator<<

(

double

)

Reimplemented from GeneralMatrix.

Definition at line 497 of file newmat5.cpp.

void BandMatrix::operator=

(

const BandMatrix &

m

)

[inline]

Definition at line 1111 of file newmat.h.

void BandMatrix::operator=

(

Real

f

)

[inline]

Reimplemented from GeneralMatrix.

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 1110 of file newmat.h.

void BandMatrix::operator=

(

const BaseMatrix &

X

)

assignment operator for BandMatrix

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 172 of file bandmat.cpp.

void BandMatrix::ReSize

(

const GeneralMatrix &

A

)

[inline, virtual]

Reimplemented from GeneralMatrix.

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 1147 of file newmat.h.

void BandMatrix::resize

(

const GeneralMatrix &

A

)

[virtual]

resize BandMatrix

Reimplemented from GeneralMatrix.

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 123 of file bandmat.cpp.

virtual void BandMatrix::ReSize	(	int	m,
		int	n,
		int	b
	)			[inline, virtual]

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 1145 of file newmat.h.

void BandMatrix::resize	(	int	n,
		int	lb,
		int	ub
	)			[virtual]

Reimplemented from GeneralMatrix.

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 50 of file bandmat.cpp.

void BandMatrix::RestoreCol

(

MatrixColX &

c

)

[inline, virtual]

Reimplemented from GeneralMatrix.

Definition at line 1142 of file newmat.h.

void BandMatrix::RestoreCol

(

MatrixRowCol &

mrc

)

[virtual]

Reimplemented from GeneralMatrix.

Definition at line 640 of file newmat3.cpp.

void BandMatrix::SetParameters

(

const GeneralMatrix *

gmx

)

[virtual]

Reimplemented from GeneralMatrix.

Definition at line 43 of file bandmat.cpp.

short BandMatrix::SimpleAddOK

(

const GeneralMatrix *

gm

)

[protected, virtual]

can we add two band matrices with simple vector add

For band matrices the bandwidths must agree

Reimplemented from GeneralMatrix.

Definition at line 74 of file bandmat.cpp.

Real BandMatrix::sum

(

)

const [inline, virtual]

Reimplemented from GeneralMatrix.

Definition at line 1130 of file newmat.h.

Real BandMatrix::sum_absolute_value

(

)

const [inline, virtual]

Reimplemented from GeneralMatrix.

Definition at line 1128 of file newmat.h.

Real BandMatrix::sum_square

(

)

const [inline, virtual]

Reimplemented from GeneralMatrix.

Definition at line 1126 of file newmat.h.

void BandMatrix::swap

(

BandMatrix &

gm

)

Definition at line 1292 of file newmat4.cpp.

Real BandMatrix::trace

(

)

const [virtual]

Reimplemented from BaseMatrix.

Definition at line 590 of file newmat8.cpp.

MatrixType BandMatrix::type

(

)

const [virtual]

Implements GeneralMatrix.

Reimplemented in UpperBandMatrix, and LowerBandMatrix.

Definition at line 662 of file newmat4.cpp.

---

Member Data Documentation

int BandMatrix::lower_val

Definition at line 1103 of file newmat.h.

int BandMatrix::upper_val

Definition at line 1103 of file newmat.h.

---

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

• newmat.h
• bandmat.cpp
• newmat3.cpp
• newmat4.cpp
• newmat5.cpp
• newmat6.cpp
• newmat8.cpp