SymmetricMatrix Class Reference

#include <newmat.h>

Inheritance diagram for SymmetricMatrix:

Public Member Functions
	SymmetricMatrix ()
	~SymmetricMatrix ()
	SymmetricMatrix (ArrayLengthSpecifier)
	SymmetricMatrix (const BaseMatrix &)
void	operator= (const BaseMatrix &)
void	operator= (Real f)
void	operator= (const SymmetricMatrix &m)
Real &	operator() (int, int)
Real &	element (int, int)
Real	operator() (int, int) const
Real	element (int, int) const
MatrixType	Type () const
	SymmetricMatrix (const SymmetricMatrix &gm)
Real	SumSquare () const
Real	SumAbsoluteValue () const
Real	Sum () const
Real	Trace () const
void	GetRow (MatrixRowCol &)
void	GetCol (MatrixRowCol &)
void	GetCol (MatrixColX &)
void	RestoreCol (MatrixRowCol &)
void	RestoreCol (MatrixColX &)
GeneralMatrix *	Transpose (TransposedMatrix *, MatrixType)
void	ReSize (int)
void	ReSize (const GeneralMatrix &A)
void	operator+= (const SymmetricMatrix &M)
void	operator-= (const SymmetricMatrix &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 GeneralMatrix *	MakeSolver ()
virtual void	Solver (MatrixColX &, const MatrixColX &)
virtual void	RestoreRow (MatrixRowCol &)
virtual void	NextRow (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	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
LogAndSign	LogDeterminant () 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
virtual MatrixBandWidth	BandWidth () 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 650 of file newmat.h.

Constructor & Destructor Documentation

SymmetricMatrix() [1/4]

SymmetricMatrix::SymmetricMatrix ( )

inline

Definition at line 654 of file newmat.h.

Referenced by Image().

:GeneralMatrix() {}

~SymmetricMatrix()

SymmetricMatrix::~SymmetricMatrix ( )

inline

Definition at line 655 of file newmat.h.

{}

SymmetricMatrix() [2/4]

SymmetricMatrix::SymmetricMatrix

(

ArrayLengthSpecifier

n

)

Definition at line 55 of file newmat4.cpp.

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

SymmetricMatrix() [3/4]

SymmetricMatrix::SymmetricMatrix

(

const BaseMatrix &

M

)

Definition at line 121 of file newmat4.cpp.

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

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

SymmetricMatrix() [4/4]

SymmetricMatrix::SymmetricMatrix ( const SymmetricMatrix &  gm )

inline

Definition at line 670 of file newmat.h.

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

Member Function Documentation

element() [1/2]

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

Definition at line 675 of file newmat6.cpp.

References n, and REPORT.

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

element() [2/2]

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

Definition at line 684 of file newmat6.cpp.

References n, and REPORT.

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

GetCol() [1/2]

void SymmetricMatrix::GetCol ( MatrixRowCol &  mrc )

virtual

Implements GeneralMatrix.

Definition at line 430 of file newmat3.cpp.

References MatrixRowCol::cw, MatrixRowCol::data, DirectPart, HaveStore, MatrixRowCol::length, LoadOnEntry, MatrixErrorNoSpace(), MONITOR_REAL_NEW, REPORT, MatrixRowCol::rowcol, MatrixRowCol::skip, MatrixRowCol::storage, StoreHere, and StoreOnExit.

{
   // do not allow StoreHere
   if (+(mrc.cw*StoreHere))
      Throw(InternalException("SymmetricMatrix::GetCol(MatrixRowCol&)"));

   int col=mrc.rowcol; mrc.length=nrows;
   REPORT
   mrc.skip=0;
   if (+(mrc.cw*DirectPart))    // actually get row ??
      { REPORT mrc.storage=col+1; mrc.data=store+(col*(col+1))/2; }
   else
   {
      // do not allow StoreOnExit and !DirectPart
      if (+(mrc.cw*StoreOnExit))
         Throw(InternalException("SymmetricMatrix::GetCol(MatrixRowCol&)"));

      mrc.storage=ncols; Real* ColCopy;
      if ( +(mrc.cw*HaveStore)) { REPORT ColCopy = mrc.data; }
      else
      {
         REPORT                                      // not accessed
         ColCopy = new Real [ncols]; MatrixErrorNoSpace(ColCopy);
         MONITOR_REAL_NEW("Make (SymGetCol)",ncols,ColCopy)
         mrc.cw += HaveStore; mrc.data = ColCopy;
      }
      if (+(mrc.cw*LoadOnEntry))
      {
         REPORT
         Real* Mstore = store+(col*(col+1))/2; int i = col;
         while (i--) *ColCopy++ = *Mstore++;
         i = ncols-col;
         // while (i--) { *ColCopy++ = *Mstore; Mstore += ++col; }
         if (i) for (;;)
            { *ColCopy++ = *Mstore; if (!(--i)) break; Mstore += ++col; }
      }
   }
}

GetCol() [2/2]

void SymmetricMatrix::GetCol ( MatrixColX &  mrc )

virtual

Implements GeneralMatrix.

Definition at line 469 of file newmat3.cpp.

References MatrixRowCol::cw, MatrixRowCol::data, DirectPart, MatrixRowCol::length, LoadOnEntry, REPORT, MatrixRowCol::rowcol, MatrixRowCol::skip, MatrixRowCol::storage, MatrixColX::store, and StoreOnExit.

{
   int col=mrc.rowcol; mrc.length=nrows;
   if (+(mrc.cw*DirectPart))
   {
      REPORT
      mrc.skip=col; int i=nrows-col; mrc.storage=i;
      mrc.data = mrc.store+col;
      if (+(mrc.cw*LoadOnEntry))
      {
         REPORT                           // not accessed
         Real* ColCopy = mrc.data;
         Real* Mstore = store+(col*(col+3))/2;
         // while (i--) { *ColCopy++ = *Mstore; Mstore += ++col; }
         if (i) for (;;)
            { *ColCopy++ = *Mstore; if (!(--i)) break; Mstore += ++col; }
      }
   }
   else
   {
      REPORT
      // do not allow StoreOnExit and !DirectPart
      if (+(mrc.cw*StoreOnExit))
         Throw(InternalException("SymmetricMatrix::GetCol(MatrixColX&)"));

      mrc.skip=0; mrc.storage=ncols;
      if (+(mrc.cw*LoadOnEntry))
      {
         REPORT
         Real* ColCopy = mrc.data;
         Real* Mstore = store+(col*(col+1))/2; int i = col;
         while (i--) *ColCopy++ = *Mstore++;
         i = ncols-col;
         // while (i--) { *ColCopy++ = *Mstore; Mstore += ++col; }
         if (i) for (;;)
            { *ColCopy++ = *Mstore; if (!(--i)) break; Mstore += ++col; }
      }
   }
}

GetRow()

void SymmetricMatrix::GetRow ( MatrixRowCol &  mrc )

virtual

Implements GeneralMatrix.

Definition at line 397 of file newmat3.cpp.

References MatrixRowCol::cw, MatrixRowCol::data, DirectPart, HaveStore, MatrixRowCol::length, LoadOnEntry, MatrixErrorNoSpace(), MONITOR_REAL_NEW, REPORT, MatrixRowCol::rowcol, MatrixRowCol::skip, MatrixRowCol::storage, and StoreOnExit.

{
   REPORT                                                //571
   mrc.skip=0; int row=mrc.rowcol; mrc.length=ncols;
   if (+(mrc.cw*DirectPart))
      { REPORT mrc.storage=row+1; mrc.data=store+(row*(row+1))/2; }
   else
   {
      // do not allow StoreOnExit and !DirectPart
      if (+(mrc.cw*StoreOnExit))
         Throw(InternalException("SymmetricMatrix::GetRow(MatrixRowCol&)"));
      mrc.storage=ncols; Real* RowCopy;
      if (!(mrc.cw*HaveStore))
      {
         REPORT
         RowCopy = new Real [ncols]; MatrixErrorNoSpace(RowCopy);
         MONITOR_REAL_NEW("Make (SymGetRow)",ncols,RowCopy)
         mrc.cw += HaveStore; mrc.data = RowCopy;
      }
      else { REPORT RowCopy = mrc.data; }
      if (+(mrc.cw*LoadOnEntry))
      {
         REPORT                                         // 544
         Real* Mstore = store+(row*(row+1))/2; int i = row;
         while (i--) *RowCopy++ = *Mstore++;
         i = ncols-row;
         // while (i--) { *RowCopy++ = *Mstore; Mstore += ++row; }
         if (i) for (;;)
            { *RowCopy++ = *Mstore; if (!(--i)) break; Mstore += ++row; }
      }
   }
}

Image()

GeneralMatrix * SymmetricMatrix::Image ( ) const

privatevirtual

Reimplemented from GeneralMatrix.

Definition at line 754 of file newmat4.cpp.

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

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

operator()() [1/2]

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

Definition at line 38 of file newmat6.cpp.

References n, and REPORT.

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

operator()() [2/2]

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

Definition at line 150 of file newmat6.cpp.

References n, and REPORT.

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

operator+=() [1/2]

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

inline

Definition at line 683 of file newmat.h.

{ PlusEqual(M); }

operator+=() [2/2]

void SymmetricMatrix::operator+= ( Real  f )

inline

Definition at line 685 of file newmat.h.

References GeneralMatrix::Add().

{ GeneralMatrix::Add(f); }

operator-=() [1/2]

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

inline

Definition at line 684 of file newmat.h.

{ MinusEqual(M); }

operator-=() [2/2]

void SymmetricMatrix::operator-= ( Real  f )

inline

Definition at line 686 of file newmat.h.

References GeneralMatrix::Add().

{ GeneralMatrix::Add(-f); }

operator=() [1/3]

void SymmetricMatrix::operator=

(

const BaseMatrix &

X

)

Definition at line 387 of file newmat6.cpp.

References REPORT, and MatrixType::Sm.

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

operator=() [2/3]

void SymmetricMatrix::operator= ( Real  f )

inline

Definition at line 659 of file newmat.h.

References GeneralMatrix::operator=().

{ GeneralMatrix::operator=(f); }

operator=() [3/3]

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

inline

Definition at line 660 of file newmat.h.

{ Eq(m); }

ReSize() [1/2]

void SymmetricMatrix::ReSize

(

int

nr

)

Definition at line 247 of file newmat4.cpp.

References REPORT, and GeneralMatrix::ReSize().

Referenced by ReSize().

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

ReSize() [2/2]

void SymmetricMatrix::ReSize ( const GeneralMatrix &  A )

virtual

Reimplemented from GeneralMatrix.

Definition at line 307 of file newmat4.cpp.

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

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

RestoreCol() [1/2]

void SymmetricMatrix::RestoreCol ( MatrixRowCol &  )

inlinevirtual

Reimplemented from GeneralMatrix.

Definition at line 678 of file newmat.h.

{}

RestoreCol() [2/2]

void SymmetricMatrix::RestoreCol ( MatrixColX &  mrc )

virtual

Reimplemented from GeneralMatrix.

Definition at line 511 of file newmat3.cpp.

References MatrixRowCol::data, REPORT, and MatrixRowCol::rowcol.

{
   REPORT
   // Really do restore column
   int col=mrc.rowcol; Real* Cstore = mrc.data;
   Real* Mstore = store+(col*(col+3))/2; int i = nrows-col;
   // while (i--) { *Mstore = *Cstore++; Mstore+= ++col; }
   if (i) for (;;)
      { *Mstore = *Cstore++; if (!(--i)) break; Mstore+= ++col; }

}

Sum()

Real SymmetricMatrix::Sum ( ) const

virtual

Reimplemented from GeneralMatrix.

Definition at line 413 of file newmat8.cpp.

References REPORT.

{
   REPORT
   Real sum1 = 0.0; Real sum2 = 0.0; Real* s = store; int nr = nrows;
   for (int i = 0; i<nr; i++)
   {
      int j = i;
      while (j--) sum2 += *s++;
      sum1 += *s++;
   }
   ((GeneralMatrix&)*this).tDelete(); return sum1 + 2.0 * sum2;
}

SumAbsoluteValue()

Real SymmetricMatrix::SumAbsoluteValue ( ) const

virtual

Reimplemented from GeneralMatrix.

Definition at line 397 of file newmat8.cpp.

References REPORT.

{
   REPORT
   Real sum1 = 0.0; Real sum2 = 0.0; Real* s = store; int nr = nrows;
   for (int i = 0; i<nr; i++)
   {
      int j = i;
      while (j--) sum2 += fabs(*s++);
      sum1 += fabs(*s++);
   }
   ((GeneralMatrix&)*this).tDelete(); return sum1 + 2.0 * sum2;
}

SumSquare()

Real SymmetricMatrix::SumSquare ( ) const

virtual

Reimplemented from GeneralMatrix.

Definition at line 384 of file newmat8.cpp.

References REPORT, and square().

{
   REPORT
   Real sum1 = 0.0; Real sum2 = 0.0; Real* s = store; int nr = nrows;
   for (int i = 0; i<nr; i++)
   {
      int j = i;
      while (j--) sum2 += square(*s++);
      sum1 += square(*s++);
   }
   ((GeneralMatrix&)*this).tDelete(); return sum1 + 2.0 * sum2;
}

Trace()

Real SymmetricMatrix::Trace ( ) const

virtual

Reimplemented from BaseMatrix.

Definition at line 556 of file newmat8.cpp.

References REPORT.

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

Transpose()

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

virtual

Reimplemented from GeneralMatrix.

Definition at line 53 of file newmat5.cpp.

References REPORT.

{ REPORT  return Evaluate(mt); }

Type()

MatrixType SymmetricMatrix::Type ( ) const

virtual

Implements GeneralMatrix.

Definition at line 415 of file newmat4.cpp.

References MatrixType::Sm.

{ return MatrixType::Sm; }

---

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

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