UpperBandMatrix Class Reference

#include <newmat.h>

Inheritance diagram for UpperBandMatrix:

Public Member Functions
	UpperBandMatrix ()
	~UpperBandMatrix ()
	UpperBandMatrix (int n, int ubw)
	UpperBandMatrix (const BaseMatrix &)
void	operator= (const BaseMatrix &)
void	operator= (Real f)
void	operator= (const UpperBandMatrix &m)
MatrixType	Type () const
	UpperBandMatrix (const UpperBandMatrix &gm)
GeneralMatrix *	MakeSolver ()
void	Solver (MatrixColX &, const MatrixColX &)
LogAndSign	LogDeterminant () const
void	ReSize (int, int, int)
void	ReSize (int n, int ubw)
void	ReSize (const GeneralMatrix &A)
Real &	operator() (int, int)
Real	operator() (int, int) const
Real &	element (int, int)
Real	element (int, int) const
Public Member Functions inherited from BandMatrix
	BandMatrix ()
	~BandMatrix ()
	BandMatrix (int n, int lb, int ub)
	BandMatrix (const BaseMatrix &)
void	operator= (const BaseMatrix &)
void	operator= (Real f)
void	operator= (const BandMatrix &m)
Real &	operator() (int, int)
Real &	element (int, int)
Real	operator() (int, int) const
Real	element (int, int) const
	BandMatrix (const BandMatrix &gm)
Real	Trace () const
Real	SumSquare () const
Real	SumAbsoluteValue () const
Real	Sum () const
Real	MaximumAbsoluteValue () const
Real	MinimumAbsoluteValue () const
Real	Maximum () const
Real	Minimum () const
void	GetRow (MatrixRowCol &)
void	GetCol (MatrixRowCol &)
void	GetCol (MatrixColX &)
void	RestoreCol (MatrixRowCol &)
void	RestoreCol (MatrixColX &c)
void	NextRow (MatrixRowCol &)
bool	SameStorageType (const GeneralMatrix &A) const
void	ReSizeForAdd (const GeneralMatrix &A, const GeneralMatrix &B)
void	ReSizeForSP (const GeneralMatrix &A, const GeneralMatrix &B)
MatrixBandWidth	BandWidth () const
void	SetParameters (const GeneralMatrix *)
MatrixInput	operator<< (Real)
MatrixInput	operator<< (int f)
void	operator<< (const Real *r)
void	operator<< (const int *r)
void	operator<< (const BaseMatrix &X)
Public Member Functions inherited from GeneralMatrix
GeneralMatrix *	Evaluate (MatrixType mt=MatrixTypeUnSp)
int	Nrows () const
int	Ncols () const
int	Storage () const
Real *	Store () const
virtual	~GeneralMatrix ()
void	tDelete ()
bool	reuse ()
void	Protect ()
int	Tag () const
bool	IsZero () const
void	Release ()
void	Release (int t)
void	ReleaseAndDelete ()
void	operator<< (const Real *)
void	operator<< (const int *)
void	operator<< (const BaseMatrix &X)
void	Inject (const GeneralMatrix &)
void	operator+= (const BaseMatrix &)
void	operator-= (const BaseMatrix &)
void	operator*= (const BaseMatrix &)
void	operator|= (const BaseMatrix &)
void	operator &= (const BaseMatrix &)
void	operator+= (Real)
void	operator-= (Real r)
void	operator*= (Real)
void	operator/= (Real r)
virtual void	RestoreRow (MatrixRowCol &)
virtual void	NextCol (MatrixRowCol &)
virtual void	NextCol (MatrixColX &)
Real	MaximumAbsoluteValue1 (int &i) const
Real	MinimumAbsoluteValue1 (int &i) const
Real	Maximum1 (int &i) const
Real	Minimum1 (int &i) const
Real	MaximumAbsoluteValue2 (int &i, int &j) const
Real	MinimumAbsoluteValue2 (int &i, int &j) const
Real	Maximum2 (int &i, int &j) const
Real	Minimum2 (int &i, int &j) const
virtual bool	IsEqual (const GeneralMatrix &) const
void	CheckStore () const
	operator ReturnMatrix () const
ReturnMatrix	ForReturn () const
MatrixInput	operator<< (Real)
MatrixInput	operator<< (int f)
void	CleanUp ()
Public Member Functions inherited from BaseMatrix
AddedMatrix	operator+ (const BaseMatrix &) const
MultipliedMatrix	operator* (const BaseMatrix &) const
SubtractedMatrix	operator- (const BaseMatrix &) const
ConcatenatedMatrix	operator| (const BaseMatrix &) const
StackedMatrix	operator & (const BaseMatrix &) const
ShiftedMatrix	operator+ (Real) const
ScaledMatrix	operator* (Real) const
ScaledMatrix	operator/ (Real) const
ShiftedMatrix	operator- (Real) const
TransposedMatrix	t () const
NegatedMatrix	operator- () const
ReversedMatrix	Reverse () const
InvertedMatrix	i () const
RowedMatrix	AsRow () const
ColedMatrix	AsColumn () const
DiagedMatrix	AsDiagonal () const
MatedMatrix	AsMatrix (int, int) const
GetSubMatrix	SubMatrix (int, int, int, int) const
GetSubMatrix	SymSubMatrix (int, int) const
GetSubMatrix	Row (int) const
GetSubMatrix	Rows (int, int) const
GetSubMatrix	Column (int) const
GetSubMatrix	Columns (int, int) const
Real	AsScalar () const
Real	Determinant () const
Real	NormFrobenius () const
Real	Norm1 () const
Real	NormInfinity () const
void	IEQND () const

Private Member Functions
GeneralMatrix *	Image () const

Additional Inherited Members
Public Attributes inherited from BandMatrix
int	lower
int	upper
Protected Member Functions inherited from BandMatrix
void	CornerClear () const
short	SimpleAddOK (const GeneralMatrix *gm)
Protected Member Functions inherited from GeneralMatrix
	GeneralMatrix ()
	GeneralMatrix (ArrayLengthSpecifier)
void	Add (GeneralMatrix *, Real)
void	Add (Real)
void	NegAdd (GeneralMatrix *, Real)
void	NegAdd (Real)
void	Multiply (GeneralMatrix *, Real)
void	Multiply (Real)
void	Negate (GeneralMatrix *)
void	Negate ()
void	ReverseElements ()
void	ReverseElements (GeneralMatrix *)
void	operator= (Real)
Real *	GetStore ()
GeneralMatrix *	BorrowStore (GeneralMatrix *, MatrixType)
void	GetMatrix (const GeneralMatrix *)
void	Eq (const BaseMatrix &, MatrixType)
void	Eq (const GeneralMatrix &)
void	Eq (const BaseMatrix &, MatrixType, bool)
void	Eq2 (const BaseMatrix &, MatrixType)
int	search (const BaseMatrix *) const
virtual GeneralMatrix *	Transpose (TransposedMatrix *, MatrixType)
void	CheckConversion (const BaseMatrix &)
void	ReSize (int, int, int)
virtual void	MiniCleanUp ()
void	PlusEqual (const GeneralMatrix &gm)
void	MinusEqual (const GeneralMatrix &gm)
void	PlusEqual (Real f)
void	MinusEqual (Real f)
Protected Attributes inherited from GeneralMatrix
int	tag
int	nrows
int	ncols
int	storage
Real *	store

Detailed Description

Definition at line 992 of file newmat.h.

Constructor & Destructor Documentation

UpperBandMatrix() [1/4]

UpperBandMatrix::UpperBandMatrix ( )

inline

Definition at line 996 of file newmat.h.

Referenced by Image().

:BandMatrix() {}

~UpperBandMatrix()

UpperBandMatrix::~UpperBandMatrix ( )

inline

Definition at line 997 of file newmat.h.

{}

UpperBandMatrix() [2/4]

UpperBandMatrix::UpperBandMatrix ( int  n, int  ubw  )

inline

Definition at line 998 of file newmat.h.

      : BandMatrix(n, 0, ubw) {}

UpperBandMatrix() [3/4]

UpperBandMatrix::UpperBandMatrix

(

const BaseMatrix &

M

)

Definition at line 196 of file bandmat.cpp.

References GeneralMatrix::Evaluate(), REPORT, and MatrixType::UB.

{
   REPORT // CheckConversion(M);
   // MatrixConversionCheck mcc;
   GeneralMatrix* gmx=((BaseMatrix&)M).Evaluate(MatrixType::UB);
   GetMatrix(gmx); CornerClear();
}

UpperBandMatrix() [4/4]

UpperBandMatrix::UpperBandMatrix ( const UpperBandMatrix &  gm )

inline

Definition at line 1005 of file newmat.h.

:BandMatrix(gm) { GetMatrix(&gm); }

Member Function Documentation

element() [1/2]

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

Definition at line 801 of file newmat6.cpp.

References n, and REPORT.

{
   REPORT
   int w = upper+1; int i = n-m;
   if (m<0 || m>= nrows || n<0 || n>= ncols || i<0 || i>=w)
      Throw(IndexException(m,n,*this,true));
   return store[w*m+i];
}

element() [2/2]

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

Definition at line 810 of file newmat6.cpp.

References n, and REPORT.

{
   REPORT
   int w = upper+1; int i = n-m;
   if (m<0 || m>= nrows || n<0 || n>= ncols || i<0 || i>=w)
      Throw(IndexException(m,n,*this,true));
   return store[w*m+i];
}

Image()

GeneralMatrix * UpperBandMatrix::Image ( ) const

privatevirtual

Reimplemented from BandMatrix.

Definition at line 803 of file newmat4.cpp.

References MatrixErrorNoSpace(), REPORT, and UpperBandMatrix().

{
   REPORT
   GeneralMatrix* gm = new UpperBandMatrix(*this); MatrixErrorNoSpace(gm);
   return gm;
}

LogDeterminant()

LogAndSign UpperBandMatrix::LogDeterminant ( ) const

virtual

Reimplemented from BandMatrix.

Definition at line 413 of file bandmat.cpp.

References REPORT.

{
   REPORT
   int i = nrows; LogAndSign sum; Real* s = store; int j = upper + 1;
//   while (i--) { sum *= *s; s += j; }
   if (i) for (;;) { sum *= *s; if (!(--i)) break; s += j; }
   ((GeneralMatrix&)*this).tDelete(); return sum;
}

MakeSolver()

GeneralMatrix* UpperBandMatrix::MakeSolver ( )

inlinevirtual

Reimplemented from BandMatrix.

Definition at line 1006 of file newmat.h.

{ return this; }

operator()() [1/2]

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

Definition at line 101 of file newmat6.cpp.

References n, and REPORT.

{
   REPORT
   int w = upper+1; int i = n-m;
   if (m<=0 || m>nrows || n<=0 || n>ncols || i<0 || i>=w)
      Throw(IndexException(m,n,*this));
   return store[w*(m-1)+i];
}

operator()() [2/2]

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

Definition at line 213 of file newmat6.cpp.

References n, and REPORT.

{
   REPORT
   int w = upper+1; int i = n-m;
   if (m<=0 || m>nrows || n<=0 || n>ncols || i<0 || i>=w)
      Throw(IndexException(m,n,*this));
   return store[w*(m-1)+i];
}

operator=() [1/3]

void UpperBandMatrix::operator=

(

const BaseMatrix &

X

)

Definition at line 204 of file bandmat.cpp.

References REPORT, and MatrixType::UB.

{
   REPORT // CheckConversion(X);
   // MatrixConversionCheck mcc;
   Eq(X,MatrixType::UB); CornerClear();
}

operator=() [2/3]

void UpperBandMatrix::operator= ( Real  f )

inline

Definition at line 1002 of file newmat.h.

References GeneralMatrix::operator=().

{ GeneralMatrix::operator=(f); }

operator=() [3/3]

void UpperBandMatrix::operator= ( const UpperBandMatrix &  m )

inline

Definition at line 1003 of file newmat.h.

{ Eq(m); }

ReSize() [1/3]

void UpperBandMatrix::ReSize ( int  n, int  lb, int  ub  )

virtual

Reimplemented from BandMatrix.

Definition at line 81 of file bandmat.cpp.

References n, REPORT, and BandMatrix::ReSize().

{
   REPORT
   if (lb != 0)
   {
      Tracer tr("UpperBandMatrix::ReSize");
      Throw(ProgramException("UpperBandMatrix with non-zero lower band" ));
   }
   BandMatrix::ReSize(n, lb, ub);
}

ReSize() [2/3]

void UpperBandMatrix::ReSize ( int  n, int  ubw  )

inline

Definition at line 1010 of file newmat.h.

References n, and BandMatrix::ReSize().

      { BandMatrix::ReSize(n,0,ubw); }

ReSize() [3/3]

void UpperBandMatrix::ReSize ( const GeneralMatrix &  A )

inlinevirtual

Reimplemented from BandMatrix.

Definition at line 1012 of file newmat.h.

References A, and BandMatrix::ReSize().

{ BandMatrix::ReSize(A); }

Solver()

void UpperBandMatrix::Solver ( MatrixColX &  mcout, const MatrixColX &  mcin  )

virtual

Reimplemented from GeneralMatrix.

Definition at line 354 of file bandmat.cpp.

References MatrixRowCol::data, REPORT, MatrixRowCol::skip, and MatrixRowCol::storage.

{
   REPORT
   int i = mcin.skip-mcout.skip; Real* elx = mcin.data-i;
   while (i-- > 0) *elx++ = 0.0;
   int nr = mcin.skip+mcin.storage;
   elx = mcin.data+mcin.storage; Real* el = elx;
   int j = mcout.skip+mcout.storage-nr; i = nr-mcout.skip;
   while (j-- > 0) *elx++ = 0.0;

   Real* Ael = store + (upper+1)*(i-1)+1; j = 0;
   if (i > 0) for(;;)
   {
      elx = el; Real sum = 0.0; int jx = j;
      while (jx--) sum += *(--Ael) * *(--elx);
      elx--; *elx = (*elx - sum) / *(--Ael);
      if (--i <= 0) break;
      if (j<upper) Ael -= upper - (++j); else el--;
   }
}

Type()

MatrixType UpperBandMatrix::Type ( ) const

virtual

Reimplemented from BandMatrix.

Definition at line 423 of file newmat4.cpp.

References MatrixType::UB.

{ return MatrixType::UB; }

---

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

• newmat.h
• bandmat.cpp
• newmat4.cpp
• newmat6.cpp