MatrixType Class Reference
[Newmat matrix manipulation library]

#include <newmat.h>

List of all members.

Public Types
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, KB = Valid + Band + Skew + Square,   Ct = Valid + LUDeco + Square, BC = Valid + Band + LUDeco + Square, Mask = ~Square }
enum	Attribute {   Valid = 1, Diagonal = 2, Symmetric = 4, Band = 8,   Lower = 16, Upper = 32, Square = 64, Skew = 128,   LUDeco = 256, Ones = 512 }
Public Member Functions
MatrixType	AddEqualEl () const
	< add constant to matrix
bool	CannotConvert () const
bool	is_band () const
bool	is_diagonal () const
bool	is_symmetric () const
	MatrixType (const MatrixType &mt)
	MatrixType (int i, bool dlok)
	MatrixType (int i)
	MatrixType ()
GeneralMatrix *	New () const
	new matrix of given type
bool	operator! () const
bool	operator!= (MatrixType t) const
MatrixType	operator& (const MatrixType &mt) const
MatrixType	operator+ (MatrixType mt) const
int	operator+ () const
bool	operator< (MatrixType mt) const
void	operator= (const MatrixType &mt)
bool	operator== (MatrixType t) const
bool	operator>= (MatrixType mt) const
MatrixType	operator| (const MatrixType &mt) const
void	SetDataLossOK ()
MatrixType	ssub () const
	< type of sym submatrix
MatrixType	sub () const
	< type of submatrix
const char *	Value () const
MatrixType	i () const
	type of inverse
MatrixType	KP (const MatrixType &) const
MatrixType	MultRHS () const
	type for rhs of multiply
GeneralMatrix *	New (int, int, BaseMatrix *) const
	new matrix of given type
MatrixType	operator* (const MatrixType &) const
MatrixType	SP (const MatrixType &) const
MatrixType	t () const
	type of transpose
const char *	value () const
	type as char string
Static Public Member Functions
static int	nTypes ()
Public Attributes
int	attribute
bool	DataLossOK
Friends
bool	Compare (const MatrixType &, MatrixType &)
	compare and check conversion
bool	Rectangular (MatrixType a, MatrixType b, MatrixType c)

---

Detailed Description

Find the type of a matrix resulting from matrix operations. Also identify what conversions are permissible. This class must be updated when new matrix types are added.

Definition at line 98 of file newmat.h.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

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

Definition at line 112 of file newmat.h.

enum MatrixType::Attribute

Enumerator:

Valid
Diagonal
Symmetric
Band
Lower
Upper
Square
Skew
LUDeco
Ones

Definition at line 101 of file newmat.h.

---

Constructor & Destructor Documentation

MatrixType::MatrixType

(

)

[inline]

Definition at line 143 of file newmat.h.

MatrixType::MatrixType

(

int

i

)

[inline]

Definition at line 144 of file newmat.h.

MatrixType::MatrixType	(	int	i,
		bool	dlok
	)			[inline]

Definition at line 145 of file newmat.h.

MatrixType::MatrixType

(

const MatrixType &

mt

)

[inline]

Definition at line 146 of file newmat.h.

---

Member Function Documentation

MatrixType MatrixType::AddEqualEl

(

)

const [inline]

< add constant to matrix

Definition at line 172 of file newmat.h.

bool MatrixType::CannotConvert

(

)

const [inline]

Definition at line 190 of file newmat.h.

MatrixType MatrixType::i

(

)

const

type of inverse

Definition at line 82 of file newmat1.cpp.

bool MatrixType::is_band

(

)

const [inline]

Definition at line 187 of file newmat.h.

bool MatrixType::is_diagonal

(

)

const [inline]

Definition at line 188 of file newmat.h.

bool MatrixType::is_symmetric

(

)

const [inline]

Definition at line 189 of file newmat.h.

MatrixType MatrixType::KP

(

const MatrixType &

mt

)

const

Definition at line 67 of file newmat1.cpp.

MatrixType MatrixType::MultRHS

(

)

const

type for rhs of multiply

Definition at line 100 of file newmat1.cpp.

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

new matrix of given type

Definition at line 146 of file newmat1.cpp.

GeneralMatrix* MatrixType::New

(

)

const

new matrix of given type

static int MatrixType::nTypes

(

)

[inline, static]

Definition at line 136 of file newmat.h.

bool MatrixType::operator!

(

)

const [inline]

Definition at line 169 of file newmat.h.

bool MatrixType::operator!=

(

MatrixType

t

)

const [inline]

Definition at line 167 of file newmat.h.

MatrixType MatrixType::operator&

(

const MatrixType &

mt

)

const [inline]

Definition at line 159 of file newmat.h.

MatrixType MatrixType::operator*

(

const MatrixType &

mt

)

const

Definition at line 37 of file newmat1.cpp.

MatrixType MatrixType::operator+

(

MatrixType

mt

)

const [inline]

Definition at line 152 of file newmat.h.

int MatrixType::operator+

(

)

const [inline]

Definition at line 151 of file newmat.h.

bool MatrixType::operator<

(

MatrixType

mt

)

const [inline]

Definition at line 163 of file newmat.h.

void MatrixType::operator=

(

const MatrixType &

mt

)

[inline]

Definition at line 148 of file newmat.h.

bool MatrixType::operator==

(

MatrixType

t

)

const [inline]

Definition at line 165 of file newmat.h.

bool MatrixType::operator>=

(

MatrixType

mt

)

const [inline]

Definition at line 161 of file newmat.h.

MatrixType MatrixType::operator|

(

const MatrixType &

mt

)

const [inline]

Definition at line 157 of file newmat.h.

void MatrixType::SetDataLossOK

(

)

[inline]

Definition at line 150 of file newmat.h.

MatrixType MatrixType::SP

(

const MatrixType &

mt

)

const

Definition at line 45 of file newmat1.cpp.

MatrixType MatrixType::ssub

(

)

const [inline]

< type of sym submatrix

Definition at line 177 of file newmat.h.

MatrixType MatrixType::sub

(

)

const [inline]

< type of submatrix

Definition at line 175 of file newmat.h.

MatrixType MatrixType::t

(

)

const

type of transpose

Definition at line 90 of file newmat1.cpp.

const char* MatrixType::Value

(

)

const [inline]

Definition at line 183 of file newmat.h.

const char * MatrixType::value

(

)

const

type as char string

Definition at line 116 of file newmat1.cpp.

---

Friends And Related Function Documentation

bool Compare	(	const MatrixType &	source,
		MatrixType &	destination
	)			[friend]

compare and check conversion

Definition at line 980 of file newmat4.cpp.

bool Rectangular	(	MatrixType	a,
		MatrixType	b,
		MatrixType	c
	)			[friend]

Definition at line 108 of file newmat1.cpp.

---

Member Data Documentation

int MatrixType::attribute

Definition at line 139 of file newmat.h.

bool MatrixType::DataLossOK

Definition at line 140 of file newmat.h.

---

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

• newmat.h
• newmat1.cpp