DiagonalMatrix Class Reference

#include <newmat.h>

Inheritance diagram for DiagonalMatrix:

Public Member Functions
	DiagonalMatrix ()
	~DiagonalMatrix ()
	DiagonalMatrix (ArrayLengthSpecifier)
	DiagonalMatrix (const BaseMatrix &)
	DiagonalMatrix (const DiagonalMatrix &gm)
void	operator= (const BaseMatrix &)
void	operator= (Real f)
void	operator= (const DiagonalMatrix &m)
Real &	operator() (int, int)
Real &	operator() (int)
Real	operator() (int, int) const
Real	operator() (int) const
Real &	element (int, int)
Real &	element (int)
Real	element (int, int) const
Real	element (int) const
MatrixType	Type () const
LogAndSign	LogDeterminant () const
Real	Trace () const
void	GetRow (MatrixRowCol &)
void	GetCol (MatrixRowCol &)
void	GetCol (MatrixColX &)
void	NextRow (MatrixRowCol &)
void	NextCol (MatrixRowCol &)
void	NextCol (MatrixColX &)
GeneralMatrix *	MakeSolver ()
void	Solver (MatrixColX &, const MatrixColX &)
GeneralMatrix *	Transpose (TransposedMatrix *, MatrixType)
void	ReSize (int)
void	ReSize (const GeneralMatrix &A)
Real *	nric () const
MatrixBandWidth	BandWidth () const
void	operator+= (const DiagonalMatrix &M)
void	operator-= (const DiagonalMatrix &M)
void	operator+= (Real f)
void	operator-= (Real f)
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	RestoreCol (MatrixRowCol &)
virtual void	RestoreCol (MatrixColX &)
Real	SumSquare () const
Real	SumAbsoluteValue () const
Real	Sum () const
Real	MaximumAbsoluteValue1 (int &i) const
Real	MinimumAbsoluteValue1 (int &i) const
Real	Maximum1 (int &i) const
Real	Minimum1 (int &i) const
Real	MaximumAbsoluteValue () const
Real	MaximumAbsoluteValue2 (int &i, int &j) const
Real	MinimumAbsoluteValue () const
Real	MinimumAbsoluteValue2 (int &i, int &j) const
Real	Maximum () const
Real	Maximum2 (int &i, int &j) const
Real	Minimum () const
Real	Minimum2 (int &i, int &j) const
virtual bool	IsEqual (const GeneralMatrix &) const
void	CheckStore () const
virtual void	SetParameters (const GeneralMatrix *)
	operator ReturnMatrix () const
ReturnMatrix	ForReturn () const
virtual bool	SameStorageType (const GeneralMatrix &A) const
virtual void	ReSizeForAdd (const GeneralMatrix &A, const GeneralMatrix &B)
virtual void	ReSizeForSP (const GeneralMatrix &A, const GeneralMatrix &B)
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
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
void	CheckConversion (const BaseMatrix &)
void	ReSize (int, int, int)
virtual short	SimpleAddOK (const GeneralMatrix *)
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 772 of file newmat.h.

Constructor & Destructor Documentation

DiagonalMatrix() [1/4]

DiagonalMatrix::DiagonalMatrix ( )

inline

Definition at line 776 of file newmat.h.

Referenced by Image().

:GeneralMatrix() {}

~DiagonalMatrix()

DiagonalMatrix::~DiagonalMatrix ( )

inline

Definition at line 777 of file newmat.h.

{}

DiagonalMatrix() [2/4]

DiagonalMatrix::DiagonalMatrix

(

ArrayLengthSpecifier

m

)

Definition at line 67 of file newmat4.cpp.

References GeneralMatrix::ncols, GeneralMatrix::nrows, REPORT, and ArrayLengthSpecifier::Value().

                                                     : GeneralMatrix(m)
{ REPORT nrows=m.Value(); ncols=m.Value(); }

DiagonalMatrix() [3/4]

DiagonalMatrix::DiagonalMatrix

(

const BaseMatrix &

M

)

Definition at line 145 of file newmat4.cpp.

References MatrixType::Dg, GeneralMatrix::Evaluate(), GeneralMatrix::GetMatrix(), and REPORT.

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

DiagonalMatrix() [4/4]

DiagonalMatrix::DiagonalMatrix ( const DiagonalMatrix &  gm )

inline

Definition at line 780 of file newmat.h.

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

Member Function Documentation

BandWidth()

MatrixBandWidth DiagonalMatrix::BandWidth ( ) const

virtual

Reimplemented from BaseMatrix.

Definition at line 432 of file newmat4.cpp.

References REPORT.

{ REPORT return 0; }

element() [1/4]

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

Definition at line 725 of file newmat6.cpp.

References n, and REPORT.

Referenced by SVD().

{
   REPORT
   if (n<0 || m!=n || m>=nrows || n>=ncols)
      Throw(IndexException(m,n,*this,true));
   return store[n];
}

element() [2/4]

Real & DiagonalMatrix::element

(

int

m

)

Definition at line 741 of file newmat6.cpp.

References REPORT.

{
   REPORT
   if (m<0 || m>=nrows) Throw(IndexException(m,*this,true));
   return store[m];
}

element() [3/4]

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

Definition at line 733 of file newmat6.cpp.

References n, and REPORT.

{
   REPORT
   if (n<0 || m!=n || m>=nrows || n>=ncols)
      Throw(IndexException(m,n,*this,true));
   return store[n];
}

element() [4/4]

Real DiagonalMatrix::element

(

int

m

)

const

Definition at line 748 of file newmat6.cpp.

References REPORT.

{
   REPORT
   if (m<0 || m>=nrows) Throw(IndexException(m,*this,true));
   return store[m];
}

GetCol() [1/2]

void DiagonalMatrix::GetCol ( MatrixRowCol &  mrc )

virtual

Implements GeneralMatrix.

Definition at line 235 of file newmat3.cpp.

References MatrixRowCol::cw, MatrixRowCol::data, MatrixRowCol::length, REPORT, MatrixRowCol::rowcol, MatrixRowCol::skip, MatrixRowCol::storage, and StoreHere.

{
   REPORT
   mrc.skip=mrc.rowcol; mrc.storage=1; mrc.length=nrows;
   if (+(mrc.cw*StoreHere))              // should not happen
      Throw(InternalException("DiagonalMatrix::GetCol(MatrixRowCol&)"));
   else  { REPORT mrc.data=store+mrc.skip; }
                                                      // not accessed
}

GetCol() [2/2]

void DiagonalMatrix::GetCol ( MatrixColX &  mrc )

virtual

Implements GeneralMatrix.

Definition at line 245 of file newmat3.cpp.

References MatrixRowCol::data, MatrixRowCol::length, REPORT, MatrixRowCol::rowcol, MatrixRowCol::skip, MatrixRowCol::storage, and MatrixColX::store.

{
   REPORT
   mrc.skip=mrc.rowcol; mrc.storage=1; mrc.length=nrows;
   mrc.data = mrc.store+mrc.skip;
   *(mrc.data)=*(store+mrc.skip);
}

GetRow()

void DiagonalMatrix::GetRow ( MatrixRowCol &  mrc )

virtual

Implements GeneralMatrix.

Definition at line 228 of file newmat3.cpp.

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

{
   REPORT
   mrc.skip=mrc.rowcol; mrc.storage=1;
   mrc.data=store+mrc.skip; mrc.length=ncols;
}

Image()

GeneralMatrix * DiagonalMatrix::Image ( ) const

privatevirtual

Reimplemented from GeneralMatrix.

Definition at line 775 of file newmat4.cpp.

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

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

LogDeterminant()

LogAndSign DiagonalMatrix::LogDeterminant ( ) const

virtual

Reimplemented from GeneralMatrix.

Definition at line 649 of file newmat8.cpp.

References REPORT.

{
   REPORT
   int i = nrows; LogAndSign sum; Real* s = store;
   while (i--) sum *= *s++;
   ((GeneralMatrix&)*this).tDelete(); return sum;
}

MakeSolver()

GeneralMatrix* DiagonalMatrix::MakeSolver ( )

inlinevirtual

Reimplemented from GeneralMatrix.

Definition at line 806 of file newmat.h.

{ return this; } // for solving

NextCol() [1/2]

void DiagonalMatrix::NextCol ( MatrixRowCol &  mrc )

virtual

Reimplemented from GeneralMatrix.

Definition at line 256 of file newmat3.cpp.

References MatrixRowCol::IncrDiag(), and REPORT.

{ REPORT mrc.IncrDiag(); }

NextCol() [2/2]

void DiagonalMatrix::NextCol ( MatrixColX &  mrc )

virtual

Reimplemented from GeneralMatrix.

Definition at line 259 of file newmat3.cpp.

References MatrixRowCol::cw, MatrixRowCol::data, MatrixRowCol::IncrDiag(), LoadOnEntry, REPORT, MatrixRowCol::rowcol, and StoreOnExit.

{
   REPORT
   if (+(mrc.cw*StoreOnExit))
      { REPORT *(store+mrc.rowcol)=*(mrc.data); }
   mrc.IncrDiag();
   int t1 = +(mrc.cw*LoadOnEntry);
   if (t1 && mrc.rowcol < ncols)
      { REPORT *(mrc.data)=*(store+mrc.rowcol); }
}

NextRow()

void DiagonalMatrix::NextRow ( MatrixRowCol &  mrc )

virtual

Reimplemented from GeneralMatrix.

Definition at line 253 of file newmat3.cpp.

References MatrixRowCol::IncrDiag(), and REPORT.

{ REPORT mrc.IncrDiag(); }

nric()

Real* DiagonalMatrix::nric ( ) const

inline

Definition at line 811 of file newmat.h.

      { CheckStore(); return store-1; }         // for use by NRIC

operator()() [1/4]

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

Definition at line 63 of file newmat6.cpp.

References n, and REPORT.

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

operator()() [2/4]

Real & DiagonalMatrix::operator()

(

int

m

)

Definition at line 71 of file newmat6.cpp.

References REPORT.

{
   REPORT
   if (m<=0 || m>nrows) Throw(IndexException(m,*this));
   return store[m-1];
}

operator()() [3/4]

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

Definition at line 175 of file newmat6.cpp.

References n, and REPORT.

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

operator()() [4/4]

Real DiagonalMatrix::operator()

(

int

m

)

const

Definition at line 183 of file newmat6.cpp.

References REPORT.

{
   REPORT
   if (m<=0 || m>nrows) Throw(IndexException(m,*this));
   return store[m-1];
}

operator+=() [1/2]

void DiagonalMatrix::operator+= ( const DiagonalMatrix &  M )

inline

Definition at line 815 of file newmat.h.

{ PlusEqual(M); }

operator+=() [2/2]

void DiagonalMatrix::operator+= ( Real  f )

inline

Definition at line 817 of file newmat.h.

References GeneralMatrix::operator+=().

{ GeneralMatrix::operator+=(f); }

operator-=() [1/2]

void DiagonalMatrix::operator-= ( const DiagonalMatrix &  M )

inline

Definition at line 816 of file newmat.h.

{ MinusEqual(M); }

operator-=() [2/2]

void DiagonalMatrix::operator-= ( Real  f )

inline

Definition at line 818 of file newmat.h.

References GeneralMatrix::operator-=().

{ GeneralMatrix::operator-=(f); }

operator=() [1/3]

void DiagonalMatrix::operator=

(

const BaseMatrix &

X

)

Definition at line 408 of file newmat6.cpp.

References MatrixType::Dg, and REPORT.

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

operator=() [2/3]

void DiagonalMatrix::operator= ( Real  f )

inline

Definition at line 782 of file newmat.h.

References GeneralMatrix::operator=().

{ GeneralMatrix::operator=(f); }

operator=() [3/3]

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

inline

Definition at line 783 of file newmat.h.

{ Eq(m); }

ReSize() [1/2]

void DiagonalMatrix::ReSize

(

int

nr

)

Definition at line 256 of file newmat4.cpp.

References REPORT, and GeneralMatrix::ReSize().

Referenced by NonLinearLeastSquares::GetHatDiagonal(), ReSize(), and SVD().

{ REPORT GeneralMatrix::ReSize(nr,nr,nr); }

ReSize() [2/2]

void DiagonalMatrix::ReSize ( const GeneralMatrix &  A )

virtual

Reimplemented from GeneralMatrix.

Definition at line 319 of file newmat4.cpp.

References A, n, REPORT, and ReSize().

{
   REPORT
   int n = A.Nrows();
   if (n != A.Ncols())
   {
      Tracer tr("DiagonalMatrix::ReSize(GM)");
      Throw(NotSquareException(*this));
   }
   ReSize(n);
}

Solver()

void DiagonalMatrix::Solver ( MatrixColX &  mrc, const MatrixColX &  mrc1  )

virtual

Reimplemented from GeneralMatrix.

Definition at line 496 of file newmat2.cpp.

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

{
   // mrc = mrc / mrc1   (elementwise)
   REPORT
   int f = mrc1.skip; int f0 = mrc.skip;
   int l = f + mrc1.storage; int lx = f0 + mrc.storage;
   if (f < f0) { f = f0; if (l < f) l = f; }
   if (l > lx) { l = lx; if (f > lx) f = lx; }

   Real* elx = mrc.data; Real* eld = store+f;

   int l1 = f-f0;    while (l1--) *elx++ = 0.0;
       l1 = l-f;     while (l1--) *elx++ /= *eld++;
       lx -= l;      while (lx--) *elx++ = 0.0;
   // Solver makes sure input and output point to same memory
}

Trace()

Real DiagonalMatrix::Trace ( ) const

virtual

Reimplemented from BaseMatrix.

Definition at line 548 of file newmat8.cpp.

References REPORT.

{
   REPORT
   int i = nrows; Real sum = 0.0; Real* s = store;
   while (i--) sum += *s++;
   ((GeneralMatrix&)*this).tDelete(); return sum;
}

Transpose()

GeneralMatrix * DiagonalMatrix::Transpose ( TransposedMatrix *  , MatrixType  mt  )

virtual

Reimplemented from GeneralMatrix.

Definition at line 57 of file newmat5.cpp.

References REPORT.

{ REPORT return Evaluate(mt); }

Type()

MatrixType DiagonalMatrix::Type ( ) const

virtual

Implements GeneralMatrix.

Definition at line 418 of file newmat4.cpp.

References MatrixType::Dg.

{ return MatrixType::Dg; }

---

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

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