MatrixType Class Reference

#include <newmat.h>

Public Types
enum	Attribute {   Valid = 1, Diagonal = 2, Symmetric = 4, Band = 8,   Lower = 16, Upper = 32, Square = 64, Skew = 128,   LUDeco = 256, Ones = 512 }
enum	{   US = 0, UT = Valid + Upper + Square, LT = Valid + Lower + Square, Rt = Valid,   Sq = Valid + Square, Sm = Valid + Symmetric + Square, Sk = Valid + Skew + Square, Dg,   Id, RV = Valid, CV = Valid, BM = Valid + Band + Square,   UB = Valid + Band + Upper + Square, LB = Valid + Band + Lower + Square, SB = Valid + Band + Symmetric + Square, Ct = Valid + LUDeco + Square,   BC = Valid + Band + LUDeco + Square, Mask = ~Square }

Public Member Functions
	MatrixType ()
	MatrixType (int i)
	MatrixType (int i, bool dlok)
	MatrixType (const MatrixType &mt)
void	operator= (const MatrixType &mt)
void	SetDataLossOK ()
int	operator+ () const
MatrixType	operator+ (MatrixType mt) const
MatrixType	operator* (const MatrixType &) const
MatrixType	SP (const MatrixType &) const
MatrixType	KP (const MatrixType &) const
MatrixType	operator| (const MatrixType &mt) const
MatrixType	operator & (const MatrixType &mt) const
bool	operator>= (MatrixType mt) const
bool	operator< (MatrixType mt) const
bool	operator== (MatrixType t) const
bool	operator!= (MatrixType t) const
bool	operator! () const
MatrixType	i () const
MatrixType	t () const
MatrixType	AddEqualEl () const
MatrixType	MultRHS () const
MatrixType	sub () const
MatrixType	ssub () const
GeneralMatrix *	New () const
GeneralMatrix *	New (int, int, BaseMatrix *) const
const char *	Value () const
bool	IsBand () const
bool	IsDiagonal () const
bool	IsSymmetric () const
bool	CannotConvert () const

Static Public Member Functions
static int	nTypes ()

Public Attributes
int	attribute
bool	DataLossOK

Friends
bool	Rectangular (MatrixType a, MatrixType b, MatrixType c)
bool	Compare (const MatrixType &, MatrixType &)

Detailed Description

Definition at line 91 of file newmat.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
US
UT
LT
Rt
Sq
Sm
Sk
Dg
Id
RV
CV
BM
UB
LB
SB
Ct
BC
Mask

Definition at line 105 of file newmat.h.

                   { US = 0,
                     UT = Valid + Upper + Square,
                     LT = Valid + Lower + Square,
                     Rt = Valid,
                     Sq = Valid + Square,
                     Sm = Valid + Symmetric + Square,
                     Sk = Valid + Skew + Square,
                     Dg = Valid + Diagonal + Band + Lower + Upper + Symmetric
                        + Square,
                     Id = Valid + Diagonal + Band + Lower + Upper + Symmetric
                        + Square + Ones,
                     RV = Valid,     //   do not separate out
                     CV = Valid,     //   vectors
                     BM = Valid + Band + Square,
                     UB = Valid + Band + Upper + Square,
                     LB = Valid + Band + Lower + Square,
                     SB = Valid + Band + Symmetric + Square,
                     Ct = Valid + LUDeco + Square,
                     BC = Valid + Band + LUDeco + Square,
                     Mask = ~Square
                   };

Attribute

enum MatrixType::Attribute

Enumerator
Valid
Diagonal
Symmetric
Band
Lower
Upper
Square
Skew
LUDeco
Ones

Definition at line 94 of file newmat.h.

                  {  Valid     = 1,
                     Diagonal  = 2,             // order of these is important
                     Symmetric = 4,
                     Band      = 8,
                     Lower     = 16,
                     Upper     = 32,
                     Square    = 64,
                     Skew      = 128,
                     LUDeco    = 256,
                     Ones      = 512 };

Constructor & Destructor Documentation

MatrixType() [1/4]

MatrixType::MatrixType ( )

inline

Definition at line 135 of file newmat.h.

: DataLossOK(false) {}

MatrixType() [2/4]

MatrixType::MatrixType ( int  i )

inline

Definition at line 136 of file newmat.h.

: attribute(i), DataLossOK(false) {}

MatrixType() [3/4]

MatrixType::MatrixType ( int  i, bool  dlok  )

inline

Definition at line 137 of file newmat.h.

: attribute(i), DataLossOK(dlok) {}

MatrixType() [4/4]

MatrixType::MatrixType ( const MatrixType &  mt )

inline

Definition at line 138 of file newmat.h.

      : attribute(mt.attribute), DataLossOK(mt.DataLossOK) {}

Member Function Documentation

AddEqualEl()

MatrixType MatrixType::AddEqualEl ( ) const

inline

Definition at line 164 of file newmat.h.

      { return MatrixType(attribute & (Valid + Symmetric + Square)); }

CannotConvert()

bool MatrixType::CannotConvert ( ) const

inline

Definition at line 181 of file newmat.h.

{ return (attribute & LUDeco) != 0; }

i()

MatrixType MatrixType::i

(

)

const

Definition at line 77 of file newmat1.cpp.

References REPORT.

{
   REPORT
   int a = attribute & ~(Band+LUDeco);
   a |= (a & Diagonal) * 63;                   // recognise diagonal
   return MatrixType(a);
}

IsBand()

bool MatrixType::IsBand ( ) const

inline

Definition at line 178 of file newmat.h.

{ return (attribute & Band) != 0; }

IsDiagonal()

bool MatrixType::IsDiagonal ( ) const

inline

Definition at line 179 of file newmat.h.

{ return (attribute & Diagonal) != 0; }

IsSymmetric()

bool MatrixType::IsSymmetric ( ) const

inline

Definition at line 180 of file newmat.h.

Referenced by GetSubMatrix::operator=().

{ return (attribute & Symmetric) != 0; }

KP()

MatrixType MatrixType::KP

(

const MatrixType &

mt

)

const

Definition at line 62 of file newmat1.cpp.

References REPORT.

{
   REPORT
   int a = (attribute & mt.attribute)  & ~Ones;
   if ((attribute & Band) != 0 && (mt.attribute & Square) != 0)
      a |= Band;
   //int a = ((attribute & mt.attribute) | (attribute & Band)) & ~Ones;

   return MatrixType(a);
}

MultRHS()

MatrixType MatrixType::MultRHS

(

)

const

Definition at line 95 of file newmat1.cpp.

References REPORT.

{
   REPORT
   // remove symmetric attribute unless diagonal
   return (attribute >= Dg) ? attribute : (attribute & ~Symmetric);
}

New() [1/2]

GeneralMatrix* MatrixType::New

(

)

const

Referenced by GeneralMatrix::Evaluate(), SPMatrix::Evaluate(), ConcatenatedMatrix::Evaluate(), StackedMatrix::Evaluate(), ShiftedMatrix::Evaluate(), NegShiftedMatrix::Evaluate(), ScaledMatrix::Evaluate(), NegatedMatrix::Evaluate(), ReversedMatrix::Evaluate(), GetSubMatrix::Evaluate(), and GeneralMatrix::Transpose().

New() [2/2]

GeneralMatrix * MatrixType::New	(	int	nr,
		int	nc,
		BaseMatrix *	bm
	)		const

Definition at line 140 of file newmat1.cpp.

References BaseMatrix::BandWidth(), MatrixBandWidth::lower, MatrixErrorNoSpace(), GeneralMatrix::Protect(), REPORT, and MatrixBandWidth::upper.

{
// make a new matrix with the given attributes

   Tracer tr("New"); GeneralMatrix* gm=0;   // initialised to keep gnu happy
   switch (attribute)
   {
   case Valid:
      REPORT
      if (nc==1) { gm = new ColumnVector(nr); break; }
      if (nr==1) { gm = new RowVector(nc); break; }
      gm = new Matrix(nr, nc); break;

   case Valid+Square:
      REPORT
      if (nc!=nr) { Throw(NotSquareException()); }
      gm = new SquareMatrix(nr); break;

   case Valid+Symmetric+Square:
      REPORT gm = new SymmetricMatrix(nr); break;

   case Valid+Band+Square:
      {
         REPORT
         MatrixBandWidth bw = bm->BandWidth();
         gm = new BandMatrix(nr,bw.lower,bw.upper); break;
      }

   case Valid+Symmetric+Band+Square:
      REPORT gm = new SymmetricBandMatrix(nr,bm->BandWidth().lower); break;

   case Valid+Upper+Square:
      REPORT gm = new UpperTriangularMatrix(nr); break;

   case Valid+Diagonal+Symmetric+Band+Upper+Lower+Square:
      REPORT gm = new DiagonalMatrix(nr); break;

   case Valid+Band+Upper+Square:
      REPORT gm = new UpperBandMatrix(nr,bm->BandWidth().upper); break;

   case Valid+Lower+Square:
      REPORT gm = new LowerTriangularMatrix(nr); break;

   case Valid+Band+Lower+Square:
      REPORT gm = new LowerBandMatrix(nr,bm->BandWidth().lower); break;

   case Valid+Diagonal+Symmetric+Band+Upper+Lower+Ones+Square:
      REPORT gm = new IdentityMatrix(nr); break;

   default:
      Throw(ProgramException("Invalid matrix type"));
   }
   
   MatrixErrorNoSpace(gm); gm->Protect(); return gm;
}

nTypes()

static int MatrixType::nTypes ( )

inlinestatic

Definition at line 128 of file newmat.h.

{ return 12; }          // number of different types

operator &()

MatrixType MatrixType::operator& ( const MatrixType &  mt ) const

inline

Definition at line 151 of file newmat.h.

References attribute.

      { return MatrixType(attribute & mt.attribute & Valid); }

operator!()

bool MatrixType::operator! ( ) const

inline

Definition at line 161 of file newmat.h.

{ return (attribute & Valid) == 0; }

operator!=()

bool MatrixType::operator!= ( MatrixType  t ) const

inline

Definition at line 159 of file newmat.h.

References attribute.

      { return (attribute != t.attribute); }

operator*()

MatrixType MatrixType::operator*

(

const MatrixType &

mt

)

const

Definition at line 32 of file newmat1.cpp.

References attribute, and REPORT.

{
   REPORT
   int a = attribute & mt.attribute & ~(Symmetric | Skew);
   a |= (a & Diagonal) * 63;                   // recognise diagonal
   return MatrixType(a);
}

operator+() [1/2]

int MatrixType::operator+ ( ) const

inline

Definition at line 143 of file newmat.h.

{ return attribute; }

operator+() [2/2]

MatrixType MatrixType::operator+ ( MatrixType  mt ) const

inline

Definition at line 144 of file newmat.h.

References attribute.

      { return MatrixType(attribute & mt.attribute); }

operator<()

bool MatrixType::operator< ( MatrixType  mt ) const

inline

Definition at line 155 of file newmat.h.

      { return ( attribute & ~mt.attribute & Mask ) != 0; }

operator=()

void MatrixType::operator= ( const MatrixType &  mt )

inline

Definition at line 140 of file newmat.h.

References attribute, and DataLossOK.

      { attribute = mt.attribute; DataLossOK = mt.DataLossOK; }

operator==()

bool MatrixType::operator== ( MatrixType  t ) const

inline

Definition at line 157 of file newmat.h.

References attribute.

      { return (attribute == t.attribute); }

operator>=()

bool MatrixType::operator>= ( MatrixType  mt ) const

inline

Definition at line 153 of file newmat.h.

References attribute.

      { return ( attribute & ~mt.attribute & Mask ) == 0; }

operator|()

MatrixType MatrixType::operator| ( const MatrixType &  mt ) const

inline

Definition at line 149 of file newmat.h.

References attribute.

      { return MatrixType(attribute & mt.attribute & Valid); }

SetDataLossOK()

void MatrixType::SetDataLossOK ( )

inline

Definition at line 142 of file newmat.h.

Referenced by GeneralMatrix::Eq().

{ DataLossOK = true; }

SP()

MatrixType MatrixType::SP

(

const MatrixType &

mt

)

const

Definition at line 40 of file newmat1.cpp.

References REPORT.

Referenced by SPMatrix::Evaluate().

{
   REPORT
   int a = ((attribute | mt.attribute) & ~(Symmetric + Skew + Valid + Ones))
      | (attribute & mt.attribute);
   if ((a & Lower) != 0  &&  (a & Upper) != 0) a |= Diagonal;
   if ((attribute & Skew) != 0)
   {
      if ((mt.attribute & Symmetric) != 0) a |= Skew;  
      if ((mt.attribute & Skew) != 0) { a &= ~Skew; a |= Symmetric; }
   }
   else if ((mt.attribute & Skew) != 0 && (attribute & Symmetric) != 0)
      a |= Skew;  
   a |= (a & Diagonal) * 63;                   // recognise diagonal
   return MatrixType(a);
}

ssub()

MatrixType MatrixType::ssub ( ) const

inline

Definition at line 169 of file newmat.h.

      { return MatrixType(attribute); }        // not for selection matrix

sub()

MatrixType MatrixType::sub ( ) const

inline

Definition at line 167 of file newmat.h.

      { return MatrixType(attribute & Valid); }

t()

MatrixType MatrixType::t

(

)

const

Definition at line 85 of file newmat1.cpp.

References REPORT.

{
   REPORT
   int a = attribute;
   a ^= (((a >> 1) ^ a) & Lower) * 3;
   return MatrixType(a);
}

Value()

const char * MatrixType::Value

(

)

const

Definition at line 111 of file newmat1.cpp.

References REPORT.

Referenced by ProgramException::ProgramException().

{
// make a string with the name of matrix with the given attributes
   switch (attribute)
   {
   case Valid:                              REPORT return "Rect ";
   case Valid+Square:                       REPORT return "Squ  ";
   case Valid+Symmetric+Square:             REPORT return "Sym  ";
   case Valid+Skew+Square:                  REPORT return "Skew ";
   case Valid+Band+Square:                  REPORT return "Band ";
   case Valid+Symmetric+Band+Square:        REPORT return "SmBnd";
   case Valid+Upper+Square:                 REPORT return "UT   ";
   case Valid+Diagonal+Symmetric+Band+Upper+Lower+Square:
                                            REPORT return "Diag ";
   case Valid+Diagonal+Symmetric+Band+Upper+Lower+Ones+Square:
                                            REPORT return "Ident";
   case Valid+Band+Upper+Square:            REPORT return "UpBnd";
   case Valid+Lower+Square:                 REPORT return "LT   ";
   case Valid+Band+Lower+Square:            REPORT return "LwBnd";
   default:
      REPORT
      if (!(attribute & Valid))             return "UnSp ";
      if (attribute & LUDeco)
         return (attribute & Band) ?     "BndLU" : "Crout";
                                            return "?????";
   }
}

Friends And Related Function Documentation

Compare

bool Compare ( const MatrixType &  source, MatrixType &  destination  )

friend

Definition at line 729 of file newmat4.cpp.

{
   if (!destination) { destination=source; return true; }
   if (destination==source) return true;
   if (!destination.DataLossOK && !(destination>=source))
      Throw(ProgramException("Illegal Conversion", source, destination));
   return false;
}

Rectangular

bool Rectangular ( MatrixType  a, MatrixType  b, MatrixType  c  )

friend

Definition at line 103 of file newmat1.cpp.

{
   REPORT
   return
      ((a.attribute | b.attribute | c.attribute)
      & ~(MatrixType::Valid | MatrixType::Square)) == 0;
}

Member Data Documentation

attribute

int MatrixType::attribute

Definition at line 131 of file newmat.h.

Referenced by operator &(), operator!=(), operator*(), operator+(), operator=(), operator==(), operator>=(), operator|(), and Rectangular().

DataLossOK

bool MatrixType::DataLossOK

Definition at line 132 of file newmat.h.

Referenced by Compare(), AddedMatrix::Evaluate(), SPMatrix::Evaluate(), SubtractedMatrix::Evaluate(), and operator=().

---

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

• newmat.h
• newmat1.cpp