Matrix Class Reference

#include <newmat.h>

Inheritance diagram for Matrix:

Public Member Functions
	Matrix ()
	~Matrix ()
	Matrix (int, int)
	Matrix (const BaseMatrix &)
void	operator= (const BaseMatrix &)
void	operator= (Real f)
void	operator= (const Matrix &m)
MatrixType	Type () const
Real &	operator() (int, int)
Real &	element (int, int)
Real	operator() (int, int) const
Real	element (int, int) const
	Matrix (const Matrix &gm)
GeneralMatrix *	MakeSolver ()
Real	Trace () const
void	GetRow (MatrixRowCol &)
void	GetCol (MatrixRowCol &)
void	GetCol (MatrixColX &)
void	RestoreCol (MatrixRowCol &)
void	RestoreCol (MatrixColX &)
void	NextRow (MatrixRowCol &)
void	NextCol (MatrixRowCol &)
void	NextCol (MatrixColX &)
virtual void	ReSize (int, int)
void	ReSize (const GeneralMatrix &A)
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
void	operator+= (const Matrix &M)
void	operator-= (const Matrix &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	Solver (MatrixColX &, const MatrixColX &)
virtual void	RestoreRow (MatrixRowCol &)
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	MinimumAbsoluteValue () const
Real	Maximum () const
Real	Minimum () 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

Friends
OSSIM_DLL Real	DotProduct (const Matrix &A, const Matrix &B)

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
virtual GeneralMatrix *	Transpose (TransposedMatrix *, MatrixType)
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 543 of file newmat.h.

Constructor & Destructor Documentation

Matrix() [1/4]

Matrix::Matrix ( )

inline

Definition at line 547 of file newmat.h.

Referenced by Image().

:GeneralMatrix() {}

~Matrix()

Matrix::~Matrix ( )

inline

Definition at line 548 of file newmat.h.

{}

Matrix() [2/4]

Matrix::Matrix	(	int	m,
		int	n
	)

Definition at line 48 of file newmat4.cpp.

References n, GeneralMatrix::ncols, GeneralMatrix::nrows, and REPORT.

                           : GeneralMatrix(m*n)
{ REPORT nrows=m; ncols=n; }

Matrix() [3/4]

Matrix::Matrix

(

const BaseMatrix &

M

)

Definition at line 70 of file newmat4.cpp.

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

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

Matrix() [4/4]

Matrix::Matrix ( const Matrix &  gm )

inline

Definition at line 563 of file newmat.h.

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

Member Function Documentation

element() [1/2]

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

Definition at line 659 of file newmat6.cpp.

References n, and REPORT.

Referenced by QRZT().

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

element() [2/2]

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

Definition at line 667 of file newmat6.cpp.

References n, and REPORT.

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

GetCol() [1/2]

void Matrix::GetCol ( MatrixRowCol &  mrc )

virtual

Implements GeneralMatrix.

Reimplemented in RowVector.

Definition at line 118 of file newmat3.cpp.

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

{
   REPORT
   mrc.skip=0; mrc.storage=mrc.length=nrows;
   if ( ncols==1 && !(mrc.cw*StoreHere) )      // ColumnVector
      { REPORT mrc.data=store; }
   else
   {
      Real* ColCopy;
      if ( !(mrc.cw*(HaveStore+StoreHere)) )
      {
         REPORT
         ColCopy = new Real [nrows]; MatrixErrorNoSpace(ColCopy);
         MONITOR_REAL_NEW("Make (MatGetCol)",nrows,ColCopy)
         mrc.data = ColCopy; mrc.cw += HaveStore;
      }
      else { REPORT ColCopy = mrc.data; }
      if (+(mrc.cw*LoadOnEntry))
      {
         REPORT
         Real* Mstore = store+mrc.rowcol; int i=nrows;
         //while (i--) { *ColCopy++ = *Mstore; Mstore+=ncols; }
         if (i) for (;;)
            { *ColCopy++ = *Mstore; if (!(--i)) break; Mstore+=ncols; }
      }
   }
}

GetCol() [2/2]

void Matrix::GetCol ( MatrixColX &  mrc )

virtual

Implements GeneralMatrix.

Reimplemented in RowVector.

Definition at line 146 of file newmat3.cpp.

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

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

GetRow()

void Matrix::GetRow ( MatrixRowCol &  mrc )

virtual

Implements GeneralMatrix.

Definition at line 111 of file newmat3.cpp.

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

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

Image()

GeneralMatrix * Matrix::Image ( ) const

privatevirtual

Reimplemented from GeneralMatrix.

Reimplemented in ColumnVector, RowVector, nricMatrix, and SquareMatrix.

Definition at line 740 of file newmat4.cpp.

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

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

MakeSolver()

GeneralMatrix * Matrix::MakeSolver ( )

virtual

Reimplemented from GeneralMatrix.

Definition at line 31 of file newmat7.cpp.

References MatrixErrorNoSpace(), and REPORT.

{
   REPORT
   GeneralMatrix* gm = new CroutMatrix(*this);
   MatrixErrorNoSpace(gm); gm->ReleaseAndDelete(); return gm;
}

Maximum2()

Real Matrix::Maximum2 ( int &  i, int &  j  ) const

virtual

Reimplemented from GeneralMatrix.

Definition at line 368 of file newmat8.cpp.

References GeneralMatrix::Maximum1(), and REPORT.

{
   REPORT
   int k; Real m = GeneralMatrix::Maximum1(k); k--;
   i = k / Ncols(); j = k - i * Ncols(); i++; j++;
   return m;
}

MaximumAbsoluteValue2()

Real Matrix::MaximumAbsoluteValue2 ( int &  i, int &  j  ) const

virtual

Reimplemented from GeneralMatrix.

Definition at line 352 of file newmat8.cpp.

References GeneralMatrix::MaximumAbsoluteValue1(), and REPORT.

{
   REPORT
   int k; Real m = GeneralMatrix::MaximumAbsoluteValue1(k); k--;
   i = k / Ncols(); j = k - i * Ncols(); i++; j++;
   return m;
}

Minimum2()

Real Matrix::Minimum2 ( int &  i, int &  j  ) const

virtual

Reimplemented from GeneralMatrix.

Definition at line 376 of file newmat8.cpp.

References GeneralMatrix::Minimum1(), and REPORT.

{
   REPORT
   int k; Real m = GeneralMatrix::Minimum1(k); k--;
   i = k / Ncols(); j = k - i * Ncols(); i++; j++;
   return m;
}

MinimumAbsoluteValue2()

Real Matrix::MinimumAbsoluteValue2 ( int &  i, int &  j  ) const

virtual

Reimplemented from GeneralMatrix.

Definition at line 360 of file newmat8.cpp.

References GeneralMatrix::MinimumAbsoluteValue1(), and REPORT.

{
   REPORT
   int k; Real m = GeneralMatrix::MinimumAbsoluteValue1(k); k--;
   i = k / Ncols(); j = k - i * Ncols(); i++; j++;
   return m;
}

NextCol() [1/2]

void Matrix::NextCol ( MatrixRowCol &  mrc )

virtual

Reimplemented from GeneralMatrix.

Reimplemented in RowVector.

Definition at line 186 of file newmat3.cpp.

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

{
   REPORT                                        // 632
   if (+(mrc.cw*StoreOnExit)) { REPORT RestoreCol(mrc); }
   mrc.rowcol++;
   if (mrc.rowcol<ncols)
   {
      if (+(mrc.cw*LoadOnEntry))
      {
         REPORT
         Real* ColCopy = mrc.data;
         Real* Mstore = store+mrc.rowcol; int i=nrows;
         //while (i--) { *ColCopy++ = *Mstore; Mstore+=ncols; }
         if (i) for (;;)
            { *ColCopy++ = *Mstore; if (!(--i)) break; Mstore+=ncols; }
      }
   }
   else { REPORT mrc.cw -= StoreOnExit; }
}

NextCol() [2/2]

void Matrix::NextCol ( MatrixColX &  mrc )

virtual

Reimplemented from GeneralMatrix.

Reimplemented in RowVector.

Definition at line 206 of file newmat3.cpp.

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

{
   REPORT
   if (+(mrc.cw*StoreOnExit)) { REPORT RestoreCol(mrc); }
   mrc.rowcol++;
   if (mrc.rowcol<ncols)
   {
      if (+(mrc.cw*LoadOnEntry))
      {
         REPORT
         Real* ColCopy = mrc.data;
         Real* Mstore = store+mrc.rowcol; int i=nrows;
         // while (i--) { *ColCopy++ = *Mstore; Mstore+=ncols; }
         if (i) for (;;)
            { *ColCopy++ = *Mstore; if (!(--i)) break; Mstore+=ncols; }
      }
   }
   else { REPORT mrc.cw -= StoreOnExit; }
}

NextRow()

void Matrix::NextRow ( MatrixRowCol &  mrc )

virtual

Reimplemented from GeneralMatrix.

Definition at line 184 of file newmat3.cpp.

References MatrixRowCol::IncrMat(), and REPORT.

{ REPORT mrc.IncrMat(); }  // 1808

operator()() [1/2]

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

Definition at line 30 of file newmat6.cpp.

References n, and REPORT.

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

operator()() [2/2]

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

Definition at line 142 of file newmat6.cpp.

References n, and REPORT.

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

operator+=() [1/2]

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

inline

Definition at line 581 of file newmat.h.

{ PlusEqual(M); }

operator+=() [2/2]

void Matrix::operator+= ( Real  f )

inline

Definition at line 583 of file newmat.h.

References GeneralMatrix::Add().

{ GeneralMatrix::Add(f); }

operator-=() [1/2]

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

inline

Definition at line 582 of file newmat.h.

{ MinusEqual(M); }

operator-=() [2/2]

void Matrix::operator-= ( Real  f )

inline

Definition at line 584 of file newmat.h.

References GeneralMatrix::Add().

{ GeneralMatrix::Add(-f); }

operator=() [1/3]

void Matrix::operator=

(

const BaseMatrix &

X

)

Definition at line 345 of file newmat6.cpp.

References REPORT, and MatrixType::Rt.

Referenced by nricMatrix::operator=().

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

operator=() [2/3]

void Matrix::operator= ( Real  f )

inline

Definition at line 552 of file newmat.h.

References GeneralMatrix::operator=().

{ GeneralMatrix::operator=(f); }

operator=() [3/3]

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

inline

Definition at line 553 of file newmat.h.

{ Eq(m); }

ReSize() [1/2]

void Matrix::ReSize ( int  nr, int  nc  )

virtual

Reimplemented in ColumnVector, RowVector, nricMatrix, and SquareMatrix.

Definition at line 233 of file newmat4.cpp.

References REPORT, and GeneralMatrix::ReSize().

Referenced by QRZ(), QRZT(), ReSize(), nricMatrix::ReSize(), and SVD().

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

ReSize() [2/2]

void Matrix::ReSize ( const GeneralMatrix &  A )

virtual

Reimplemented from GeneralMatrix.

Reimplemented in ColumnVector, RowVector, nricMatrix, and SquareMatrix.

Definition at line 283 of file newmat4.cpp.

References A, REPORT, and ReSize().

{ REPORT  ReSize(A.Nrows(), A.Ncols()); }

RestoreCol() [1/2]

void Matrix::RestoreCol ( MatrixRowCol &  mrc )

virtual

Reimplemented from GeneralMatrix.

Reimplemented in RowVector.

Definition at line 160 of file newmat3.cpp.

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

{
   // always check StoreOnExit before calling RestoreCol
   REPORT                                   // 429
   if (+(mrc.cw*HaveStore))
   {
      REPORT                                // 426
      Real* Mstore = store+mrc.rowcol; int i=nrows;
      Real* Cstore = mrc.data;
      // while (i--) { *Mstore = *Cstore++; Mstore+=ncols; }
      if (i) for (;;)
          { *Mstore = *Cstore++; if (!(--i)) break; Mstore+=ncols; }
   }
}

RestoreCol() [2/2]

void Matrix::RestoreCol ( MatrixColX &  mrc )

virtual

Reimplemented from GeneralMatrix.

Reimplemented in RowVector.

Definition at line 175 of file newmat3.cpp.

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

{
   REPORT
   Real* Mstore = store+mrc.rowcol; int i=nrows; Real* Cstore = mrc.data;
   // while (i--) { *Mstore = *Cstore++; Mstore+=ncols; }
   if (i) for (;;)
      { *Mstore = *Cstore++; if (!(--i)) break; Mstore+=ncols; }
}

Trace()

Real Matrix::Trace ( ) const

virtual

Reimplemented from BaseMatrix.

Definition at line 536 of file newmat8.cpp.

References REPORT.

{
   REPORT
   Tracer trace("Trace");
   int i = nrows; int d = i+1;
   if (i != ncols) Throw(NotSquareException(*this));
   Real sum = 0.0; Real* s = store;
//   while (i--) { sum += *s; s += d; }
   if (i) for (;;) { sum += *s; if (!(--i)) break; s += d; }
   ((GeneralMatrix&)*this).tDelete(); return sum;
}

Type()

MatrixType Matrix::Type ( ) const

virtual

Implements GeneralMatrix.

Reimplemented in ColumnVector, RowVector, and SquareMatrix.

Definition at line 413 of file newmat4.cpp.

References MatrixType::Rt.

{ return MatrixType::Rt; }

Friends And Related Function Documentation

DotProduct

OSSIM_DLL Real DotProduct ( const Matrix &  A, const Matrix &  B  )

friend

Definition at line 526 of file newmat8.cpp.

{
   REPORT
   int n = A.storage;
   if (n != B.storage) Throw(IncompatibleDimensionsException(A,B));
   Real sum = 0.0; Real* a = A.store; Real* b = B.store;
   while (n--) sum += *a++ * *b++;
   return sum;
}

---

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

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