GetSubMatrix Class Reference

#include <newmat.h>

Inheritance diagram for GetSubMatrix:

Public Member Functions
	GetSubMatrix (const GetSubMatrix &g)
	~GetSubMatrix ()
GeneralMatrix *	Evaluate (MatrixType mt=MatrixTypeUnSp)
void	operator= (const BaseMatrix &)
void	operator+= (const BaseMatrix &)
void	operator-= (const BaseMatrix &)
void	operator= (const GetSubMatrix &m)
void	operator<< (const BaseMatrix &)
void	operator<< (const Real *)
void	operator<< (const int *)
MatrixInput	operator<< (Real)
MatrixInput	operator<< (int f)
void	operator= (Real)
void	operator+= (Real)
void	operator-= (Real r)
void	operator*= (Real)
void	operator/= (Real r)
void	Inject (const GeneralMatrix &)
MatrixBandWidth	BandWidth () const
Public Member Functions inherited from NegatedMatrix
	~NegatedMatrix ()
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
virtual LogAndSign	LogDeterminant () const
Real	Determinant () const
virtual Real	SumSquare () const
Real	NormFrobenius () const
virtual Real	SumAbsoluteValue () const
virtual Real	Sum () const
virtual Real	MaximumAbsoluteValue () const
virtual Real	MaximumAbsoluteValue1 (int &i) const
virtual Real	MaximumAbsoluteValue2 (int &i, int &j) const
virtual Real	MinimumAbsoluteValue () const
virtual Real	MinimumAbsoluteValue1 (int &i) const
virtual Real	MinimumAbsoluteValue2 (int &i, int &j) const
virtual Real	Maximum () const
virtual Real	Maximum1 (int &i) const
virtual Real	Maximum2 (int &i, int &j) const
virtual Real	Minimum () const
virtual Real	Minimum1 (int &i) const
virtual Real	Minimum2 (int &i, int &j) const
virtual Real	Trace () const
Real	Norm1 () const
Real	NormInfinity () const
virtual void	CleanUp ()
void	IEQND () const

Private Member Functions
	GetSubMatrix (const BaseMatrix *bmx, int rs, int rn, int cs, int cn, bool is)
void	SetUpLHS ()

Private Attributes
int	row_skip
int	row_number
int	col_skip
int	col_number
bool	IsSym

Friends
class	BaseMatrix

Additional Inherited Members
Protected Member Functions inherited from NegatedMatrix
	NegatedMatrix (const BaseMatrix *bmx)
int	search (const BaseMatrix *) const
Protected Attributes inherited from NegatedMatrix
union {
const BaseMatrix *   bm
GeneralMatrix *   gm
};

Detailed Description

Definition at line 1503 of file newmat.h.

Constructor & Destructor Documentation

GetSubMatrix() [1/2]

GetSubMatrix::GetSubMatrix ( const BaseMatrix *  bmx, int  rs, int  rn, int  cs, int  cn, bool  is  )

inlineprivate

Definition at line 1512 of file newmat.h.

      : NegatedMatrix(bmx),
      row_skip(rs), row_number(rn), col_skip(cs), col_number(cn), IsSym(is) {}

GetSubMatrix() [2/2]

GetSubMatrix::GetSubMatrix ( const GetSubMatrix &  g )

inline

Definition at line 1520 of file newmat.h.

      : NegatedMatrix(g.bm), row_skip(g.row_skip), row_number(g.row_number),
      col_skip(g.col_skip), col_number(g.col_number), IsSym(g.IsSym) {}

~GetSubMatrix()

GetSubMatrix::~GetSubMatrix ( )

inline

Definition at line 1524 of file newmat.h.

{}

Member Function Documentation

BandWidth()

MatrixBandWidth GetSubMatrix::BandWidth ( ) const

virtual

Reimplemented from NegatedMatrix.

Definition at line 517 of file newmat4.cpp.

References BaseMatrix::BandWidth(), col_number, col_skip, NegatedMatrix::gm, REPORT, row_number, and row_skip.

{

   if (row_skip==col_skip && row_number==col_number)
      { REPORT return gm->BandWidth(); }
   else { REPORT return MatrixBandWidth(-1); }
}

Evaluate()

GeneralMatrix * GetSubMatrix::Evaluate ( MatrixType  mt = MatrixTypeUnSp )

virtual

Reimplemented from NegatedMatrix.

Definition at line 276 of file newmat5.cpp.

References Compare(), MatrixRowCol::Copy(), DirectPart, LoadOnEntry, MatrixType::New(), MatrixRow::Next(), REPORT, StoreOnExit, and MatrixRowCol::SubRowCol().

{
   REPORT
   Tracer tr("SubMatrix(evaluate)");
   gm = ((BaseMatrix*&)bm)->Evaluate();
   if (row_number < 0) row_number = gm->Nrows();
   if (col_number < 0) col_number = gm->Ncols();
   if (row_skip+row_number > gm->Nrows() || col_skip+col_number > gm->Ncols())
   {
      gm->tDelete();
      Throw(SubMatrixDimensionException());
   }
   if (IsSym) Compare(gm->Type().ssub(), mt);
   else Compare(gm->Type().sub(), mt);
   GeneralMatrix* gmx = mt.New(row_number, col_number, this);
   int i = row_number;
   MatrixRow mr(gm, LoadOnEntry, row_skip); 
   MatrixRow mrx(gmx, StoreOnExit+DirectPart);
   MatrixRowCol sub;
   while (i--)
   {
      mr.SubRowCol(sub, col_skip, col_number);   // put values in sub
      mrx.Copy(sub); mrx.Next(); mr.Next();
   }
   gmx->ReleaseAndDelete(); gm->tDelete();
   return gmx;
}

Inject()

void GetSubMatrix::Inject

(

const GeneralMatrix &

gmx

)

Definition at line 210 of file submat.cpp.

References DirectPart, MatrixRowCol::Inject(), LoadOnEntry, GeneralMatrix::Ncols(), MatrixRow::Next(), GeneralMatrix::Nrows(), REPORT, StoreOnExit, and MatrixRowCol::SubRowCol().

{
   REPORT
   Tracer tr("SubMatrix(inject)");
   SetUpLHS();
   if (row_number != gmx.Nrows() || col_number != gmx.Ncols())
      Throw(IncompatibleDimensionsException());
   MatrixRow mrx((GeneralMatrix*)(&gmx), LoadOnEntry);
   MatrixRow mr(gm, LoadOnEntry+StoreOnExit+DirectPart, row_skip);
                                  // do need LoadOnEntry
   MatrixRowCol sub; int i = row_number;
   while (i--)
   {
      mr.SubRowCol(sub, col_skip, col_number);   // put values in sub
      sub.Inject(mrx); mr.Next(); mrx.Next();
   }
}

operator*=()

void GetSubMatrix::operator*=

(

Real

r

)

Definition at line 313 of file submat.cpp.

References DirectPart, LoadOnEntry, MatrixRowCol::Multiply(), MatrixRow::Next(), REPORT, StoreOnExit, and MatrixRowCol::SubRowCol().

{
   REPORT
   Tracer tr("SubMatrix(*= or /= Real)");
   // MatrixConversionCheck mcc;         // Check for loss of info
   Try
   {
      SetUpLHS();
      MatrixRow mr(gm, LoadOnEntry+StoreOnExit+DirectPart, row_skip);
                                     // do need LoadOnEntry
      MatrixRowCol sub; int i = row_number;
      while (i--)
      {
         mr.SubRowCol(sub, col_skip, col_number);   // put values in sub
         sub.Multiply(r); mr.Next();
      }
   }

   CatchAll
   {
      ReThrow;
   }
}

operator+=() [1/2]

void GetSubMatrix::operator+=

(

const BaseMatrix &

bmx

)

Definition at line 228 of file submat.cpp.

References MatrixRowCol::Add(), MatrixRowCol::Check(), DirectPart, GeneralMatrix::Evaluate(), LoadOnEntry, GeneralMatrix::Ncols(), MatrixRow::Next(), GeneralMatrix::Nrows(), REPORT, StoreOnExit, MatrixRowCol::SubRowCol(), and GeneralMatrix::tDelete().

{
   REPORT
   Tracer tr("SubMatrix(+=)"); GeneralMatrix* gmx = 0;
   // MatrixConversionCheck mcc;         // Check for loss of info
   Try
   {
      SetUpLHS(); gmx = ((BaseMatrix&)bmx).Evaluate();
      if (row_number != gmx->Nrows() || col_number != gmx->Ncols())
         Throw(IncompatibleDimensionsException());
      MatrixRow mrx(gmx, LoadOnEntry);
      MatrixRow mr(gm, LoadOnEntry+StoreOnExit+DirectPart, row_skip);
                                     // do need LoadOnEntry
      MatrixRowCol sub; int i = row_number;
      while (i--)
      {
         mr.SubRowCol(sub, col_skip, col_number);   // put values in sub
         sub.Check(mrx);                            // check for loss of info
         sub.Add(mrx); mr.Next(); mrx.Next();
      }
      gmx->tDelete();
   }

   CatchAll
   {
      if (gmx) gmx->tDelete();
      ReThrow;
   }
}

operator+=() [2/2]

void GetSubMatrix::operator+=

(

Real

r

)

Definition at line 288 of file submat.cpp.

References MatrixRowCol::Add(), MatrixRowCol::Check(), DirectPart, LoadOnEntry, MatrixRow::Next(), REPORT, StoreOnExit, and MatrixRowCol::SubRowCol().

{
   REPORT
   Tracer tr("SubMatrix(+= or -= Real)");
   // MatrixConversionCheck mcc;         // Check for loss of info
   Try
   {
      SetUpLHS();
      MatrixRow mr(gm, LoadOnEntry+StoreOnExit+DirectPart, row_skip);
                                     // do need LoadOnEntry
      MatrixRowCol sub; int i = row_number;
      while (i--)
      {
         mr.SubRowCol(sub, col_skip, col_number);   // put values in sub
         sub.Check();                               // check for loss of info
         sub.Add(r); mr.Next();
      }
   }

   CatchAll
   {
      ReThrow;
   }
}

operator-=() [1/2]

void GetSubMatrix::operator-=

(

const BaseMatrix &

bmx

)

Definition at line 258 of file submat.cpp.

References MatrixRowCol::Check(), DirectPart, GeneralMatrix::Evaluate(), LoadOnEntry, GeneralMatrix::Ncols(), MatrixRow::Next(), GeneralMatrix::Nrows(), REPORT, StoreOnExit, MatrixRowCol::Sub(), MatrixRowCol::SubRowCol(), and GeneralMatrix::tDelete().

{
   REPORT
   Tracer tr("SubMatrix(-=)"); GeneralMatrix* gmx = 0;
   // MatrixConversionCheck mcc;         // Check for loss of info
   Try
   {
      SetUpLHS(); gmx = ((BaseMatrix&)bmx).Evaluate();
      if (row_number != gmx->Nrows() || col_number != gmx->Ncols())
         Throw(IncompatibleDimensionsException());
      MatrixRow mrx(gmx, LoadOnEntry);
      MatrixRow mr(gm, LoadOnEntry+StoreOnExit+DirectPart, row_skip);
                                     // do need LoadOnEntry
      MatrixRowCol sub; int i = row_number;
      while (i--)
      {
         mr.SubRowCol(sub, col_skip, col_number);   // put values in sub
         sub.Check(mrx);                            // check for loss of info
         sub.Sub(mrx); mr.Next(); mrx.Next();
      }
      gmx->tDelete();
   }

   CatchAll
   {
      if (gmx) gmx->tDelete();
      ReThrow;
   }
}

operator-=() [2/2]

void GetSubMatrix::operator-= ( Real  r )

inline

Definition at line 1537 of file newmat.h.

{ operator+=(-r); }  // subtract constant

operator/=()

void GetSubMatrix::operator/= ( Real  r )

inline

Definition at line 1539 of file newmat.h.

{ operator*=(1.0/r); } // divide by constant

operator<<() [1/5]

void GetSubMatrix::operator<<

(

const BaseMatrix &

bmx

)

Definition at line 98 of file submat.cpp.

References MatrixRowCol::Copy(), DirectPart, GeneralMatrix::Evaluate(), LoadOnEntry, GeneralMatrix::Ncols(), MatrixRow::Next(), GeneralMatrix::Nrows(), REPORT, StoreOnExit, MatrixRowCol::SubRowCol(), and GeneralMatrix::tDelete().

{
   REPORT
   Tracer tr("SubMatrix(<<)"); GeneralMatrix* gmx = 0;
   Try
   {
      SetUpLHS(); gmx = ((BaseMatrix&)bmx).Evaluate();
      if (row_number != gmx->Nrows() || col_number != gmx->Ncols())
         Throw(IncompatibleDimensionsException());
      MatrixRow mrx(gmx, LoadOnEntry);
      MatrixRow mr(gm, LoadOnEntry+StoreOnExit+DirectPart, row_skip);
                                     // do need LoadOnEntry
      MatrixRowCol sub; int i = row_number;
      while (i--)
      {
         mr.SubRowCol(sub, col_skip, col_number);   // put values in sub
         sub.Copy(mrx); mr.Next(); mrx.Next();
      }
      gmx->tDelete();
   }

   CatchAll
   {
      if (gmx) gmx->tDelete();
      ReThrow;
   }
}

operator<<() [2/5]

void GetSubMatrix::operator<<

(

const Real *

r

)

Definition at line 161 of file submat.cpp.

References MatrixRowCol::Copy(), DirectPart, LoadOnEntry, MatrixRow::Next(), REPORT, StoreOnExit, and MatrixRowCol::SubRowCol().

{
   REPORT
   Tracer tr("SubMatrix(<<Real*)");
   SetUpLHS();
   if (row_skip+row_number > gm->Nrows() || col_skip+col_number > gm->Ncols())
      Throw(SubMatrixDimensionException());
   MatrixRow mr(gm, LoadOnEntry+StoreOnExit+DirectPart, row_skip);
                                  // do need LoadOnEntry
   MatrixRowCol sub; int i = row_number;
   while (i--)
   {
      mr.SubRowCol(sub, col_skip, col_number);   // put values in sub
      sub.Copy(r); mr.Next();
   }
}

operator<<() [3/5]

void GetSubMatrix::operator<<

(

const int *

r

)

Definition at line 178 of file submat.cpp.

References MatrixRowCol::Copy(), DirectPart, LoadOnEntry, MatrixRow::Next(), REPORT, StoreOnExit, and MatrixRowCol::SubRowCol().

{
   REPORT
   Tracer tr("SubMatrix(<<int*)");
   SetUpLHS();
   if (row_skip+row_number > gm->Nrows() || col_skip+col_number > gm->Ncols())
      Throw(SubMatrixDimensionException());
   MatrixRow mr(gm, LoadOnEntry+StoreOnExit+DirectPart, row_skip);
                                  // do need LoadOnEntry
   MatrixRowCol sub; int i = row_number;
   while (i--)
   {
      mr.SubRowCol(sub, col_skip, col_number);   // put values in sub
      sub.Copy(r); mr.Next();
   }
}

operator<<() [4/5]

MatrixInput GetSubMatrix::operator<<

(

Real

f

)

Definition at line 411 of file newmat5.cpp.

References MatrixRowCol::cw, MatrixRowCol::Data(), DirectPart, HaveStore, n, REPORT, and MatrixRowCol::Storage().

{
   REPORT
   Tracer et("MatrixInput (GetSubMatrix)");
   SetUpLHS();
   if (row_number != 1 || col_skip != 0 || col_number != gm->Ncols())
   {
      Throw(ProgramException("MatrixInput requires complete rows"));
   }
   MatrixRow mr(gm, DirectPart, row_skip);  // to pick up location and length
   int n = mr.Storage();
   if (n<=0)
   {
      Throw(ProgramException("Loading data to zero length row"));
   }
   Real* r; r = mr.Data(); *r = f; n--;
   if (+(mr.cw*HaveStore))
   {
      Throw(ProgramException("Fails with this matrix type"));
   }
   return MatrixInput(n, r+1);
}

operator<<() [5/5]

MatrixInput GetSubMatrix::operator<< ( int  f )

inline

Definition at line 1779 of file newmat.h.

{ return *this << (Real)f; }

operator=() [1/3]

void GetSubMatrix::operator=

(

const BaseMatrix &

bmx

)

Definition at line 126 of file submat.cpp.

References MatrixRowCol::CopyCheck(), DirectPart, GeneralMatrix::Evaluate(), MatrixType::IsSymmetric(), LoadOnEntry, GeneralMatrix::Ncols(), MatrixRow::Next(), GeneralMatrix::Nrows(), REPORT, StoreOnExit, MatrixRowCol::SubRowCol(), GeneralMatrix::tDelete(), and GeneralMatrix::Type().

{
   REPORT
   Tracer tr("SubMatrix(=)"); GeneralMatrix* gmx = 0;
   // MatrixConversionCheck mcc;         // Check for loss of info
   Try
   {
      SetUpLHS(); gmx = ((BaseMatrix&)bmx).Evaluate();
      if (row_number != gmx->Nrows() || col_number != gmx->Ncols())
         Throw(IncompatibleDimensionsException());
      LoadAndStoreFlag lasf =
         (  row_skip == col_skip
            && gm->Type().IsSymmetric()
            && gmx->Type().IsSymmetric() )
        ? LoadOnEntry+DirectPart
        : LoadOnEntry;
      MatrixRow mrx(gmx, lasf);
      MatrixRow mr(gm, LoadOnEntry+StoreOnExit+DirectPart, row_skip);
                                     // do need LoadOnEntry
      MatrixRowCol sub; int i = row_number;
      while (i--)
      {
         mr.SubRowCol(sub, col_skip, col_number);   // put values in sub
         sub.CopyCheck(mrx); mr.Next(); mrx.Next();
      }
      gmx->tDelete();
   }

   CatchAll
   {
      if (gmx) gmx->tDelete();
      ReThrow;
   }
}

operator=() [2/3]

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

inline

Definition at line 1529 of file newmat.h.

References operator=().

Referenced by operator=().

{ operator=((const BaseMatrix&)m); }

operator=() [3/3]

void GetSubMatrix::operator=

(

Real

r

)

Definition at line 195 of file submat.cpp.

References MatrixRowCol::Copy(), DirectPart, LoadOnEntry, MatrixRow::Next(), REPORT, StoreOnExit, and MatrixRowCol::SubRowCol().

{
   REPORT
   Tracer tr("SubMatrix(=Real)");
   SetUpLHS();
   MatrixRow mr(gm, LoadOnEntry+StoreOnExit+DirectPart, row_skip);
                                  // do need LoadOnEntry
   MatrixRowCol sub; int i = row_number;
   while (i--)
   {
      mr.SubRowCol(sub, col_skip, col_number);   // put values in sub
      sub.Copy(r); mr.Next();
   }
}

SetUpLHS()

void GetSubMatrix::SetUpLHS ( )

private

Definition at line 83 of file submat.cpp.

References GeneralMatrix::Evaluate(), GeneralMatrix::Ncols(), GeneralMatrix::Nrows(), and REPORT.

{
   REPORT
   Tracer tr("SubMatrix(LHS)");
   const BaseMatrix* bm1 = bm;
   GeneralMatrix* gm1 = ((BaseMatrix*&)bm)->Evaluate();
   if ((BaseMatrix*)gm1!=bm1)
      Throw(ProgramException("Invalid LHS"));
   if (row_number < 0) row_number = gm1->Nrows();
   if (col_number < 0) col_number = gm1->Ncols();
   if (row_skip+row_number > gm1->Nrows()
      || col_skip+col_number > gm1->Ncols())
         Throw(SubMatrixDimensionException());
}

Friends And Related Function Documentation

BaseMatrix

friend class BaseMatrix

friend

Definition at line 1516 of file newmat.h.

Member Data Documentation

col_number

int GetSubMatrix::col_number

private

Definition at line 1508 of file newmat.h.

Referenced by BandWidth().

col_skip

int GetSubMatrix::col_skip

private

Definition at line 1507 of file newmat.h.

Referenced by BandWidth().

IsSym

bool GetSubMatrix::IsSym

private

Definition at line 1509 of file newmat.h.

row_number

int GetSubMatrix::row_number

private

Definition at line 1506 of file newmat.h.

Referenced by BandWidth().

row_skip

int GetSubMatrix::row_skip

private

Definition at line 1505 of file newmat.h.

Referenced by BandWidth().

---

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

• newmat.h
• newmat4.cpp
• newmat5.cpp
• submat.cpp