BaseMatrix Class Reference
[Newmat matrix manipulation library]

Base of the matrix classes. More...

#include <newmat.h>

Inheritance diagram for BaseMatrix:

[legend]

List of all members.

Public Member Functions
ColedMatrix	AsColumn () const
DiagedMatrix	AsDiagonal () const
MatedMatrix	AsMatrix (int m, int n) const
RowedMatrix	AsRow () const
Real	AsScalar () const
virtual MatrixBandWidth	BandWidth () const
void	CleanUp ()
virtual void	cleanup ()
GetSubMatrix	Column (int f) const
GetSubMatrix	Columns (int f, int l) const
Real	Determinant () const
virtual GeneralMatrix *	Evaluate (MatrixType mt=MatrixTypeUnSp)=0
void	IEQND () const
LogAndSign	LogDeterminant () const
Real	Maximum () const
Real	Maximum1 (int &i) const
Real	Maximum2 (int &i, int &j) const
Real	MaximumAbsoluteValue () const
Real	MaximumAbsoluteValue1 (int &i) const
Real	MaximumAbsoluteValue2 (int &i, int &j) const
Real	Minimum () const
Real	Minimum1 (int &i) const
Real	Minimum2 (int &i, int &j) const
Real	MinimumAbsoluteValue () const
Real	MinimumAbsoluteValue1 (int &i) const
Real	MinimumAbsoluteValue2 (int &i, int &j) const
Real	Norm1 () const
Real	norm_frobenius () const
Real	NormFrobenius () const
Real	NormInfinity () const
ReversedMatrix	Reverse () const
GetSubMatrix	Row (int f) const
GetSubMatrix	Rows (int f, int l) const
GetSubMatrix	SubMatrix (int fr, int lr, int fc, int lc) const
virtual Real	Sum () const
Real	SumAbsoluteValue () const
Real	SumSquare () const
GetSubMatrix	SymSubMatrix (int f, int l) const
Real	Trace () const
ColedMatrix	as_column () const
DiagedMatrix	as_diagonal () const
MatedMatrix	as_matrix (int, int) const
RowedMatrix	as_row () const
Real	as_scalar () const
InvertedMatrix	i () const
StackedMatrix	operator& (const BaseMatrix &) const
ScaledMatrix	operator* (Real) const
MultipliedMatrix	operator* (const BaseMatrix &) const
ShiftedMatrix	operator+ (Real) const
AddedMatrix	operator+ (const BaseMatrix &) const
NegatedMatrix	operator- () const
ShiftedMatrix	operator- (Real) const
SubtractedMatrix	operator- (const BaseMatrix &) const
ScaledMatrix	operator/ (Real) const
ConcatenatedMatrix	operator| (const BaseMatrix &) const
ReversedMatrix	reverse () const
TransposedMatrix	t () const
virtual MatrixBandWidth	bandwidth () const
GetSubMatrix	column (int) const
GetSubMatrix	columns (int, int) const
GetSubMatrix	row (int) const
GetSubMatrix	rows (int, int) const
GetSubMatrix	submatrix (int, int, int, int) const
GetSubMatrix	sym_submatrix (int, int) const
Real	determinant () const
virtual LogAndSign	log_determinant () const
virtual Real	maximum () const
virtual Real	maximum1 (int &i) const
virtual Real	maximum2 (int &i, int &j) const
virtual Real	maximum_absolute_value () const
virtual Real	maximum_absolute_value1 (int &i) const
virtual Real	maximum_absolute_value2 (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	minimum_absolute_value () const
virtual Real	minimum_absolute_value1 (int &i) const
virtual Real	minimum_absolute_value2 (int &i, int &j) const
Real	norm_Frobenius () const
virtual Real	sum () const
virtual Real	sum_absolute_value () const
ReturnMatrix	sum_columns () const
ReturnMatrix	sum_rows () const
virtual Real	sum_square () const
ReturnMatrix	sum_square_columns () const
ReturnMatrix	sum_square_rows () const
virtual Real	trace () const
Real	norm1 () const
Real	norm_infinity () const
Protected Member Functions
virtual int	search (const BaseMatrix *) const =0
Friends
class	AddedMatrix
class	BandMatrix
class	ColedMatrix
class	ColumnVector
class	ConcatenatedMatrix
class	CroutMatrix
class	DiagedMatrix
class	DiagonalMatrix
class	GeneralMatrix
class	GenericMatrix
class	GetSubMatrix
class	InvertedMatrix
class	KPMatrix
class	LinearEquationSolver
class	LowerBandMatrix
class	LowerTriangularMatrix
class	MatedMatrix
class	Matrix
class	MultipliedMatrix
class	NegatedMatrix
class	NegShiftedMatrix
class	nricMatrix
class	ReturnMatrix
class	ReversedMatrix
class	RowedMatrix
class	RowVector
class	ScaledMatrix
class	ShiftedMatrix
class	SolvedMatrix
class	SPMatrix
class	SquareMatrix
class	StackedMatrix
class	SubtractedMatrix
class	SymmetricBandMatrix
class	SymmetricMatrix
class	TransposedMatrix
class	UpperBandMatrix
class	UpperTriangularMatrix

---

Detailed Description

Base of the matrix classes.

Definition at line 292 of file newmat.h.

---

Member Function Documentation

ColedMatrix BaseMatrix::as_column

(

)

const

Definition at line 336 of file newmat6.cpp.

DiagedMatrix BaseMatrix::as_diagonal

(

)

const

Definition at line 339 of file newmat6.cpp.

MatedMatrix BaseMatrix::as_matrix	(	int	nrx,
		int	ncx
	)			const

Definition at line 342 of file newmat6.cpp.

RowedMatrix BaseMatrix::as_row

(

)

const

Definition at line 333 of file newmat6.cpp.

Real BaseMatrix::as_scalar

(

)

const

Definition at line 258 of file newmat6.cpp.

virtual MatrixBandWidth BaseMatrix::BandWidth

(

)

const [inline, virtual]

Definition at line 389 of file newmat.h.

MatrixBandWidth BaseMatrix::bandwidth

(

)

const [virtual]

Reimplemented in UpperTriangularMatrix, LowerTriangularMatrix, DiagonalMatrix, BandMatrix, SymmetricBandMatrix, BandLUMatrix, IdentityMatrix, GenericMatrix, MultipliedMatrix, AddedMatrix, SPMatrix, KPMatrix, ConcatenatedMatrix, SolvedMatrix, ScaledMatrix, NegatedMatrix, TransposedMatrix, InvertedMatrix, RowedMatrix, ColedMatrix, DiagedMatrix, MatedMatrix, ReturnMatrix, and GetSubMatrix.

Definition at line 671 of file newmat4.cpp.

void BaseMatrix::CleanUp

(

)

[inline, virtual]

Reimplemented from Janitor.

Definition at line 396 of file newmat.h.

virtual void BaseMatrix::cleanup

(

)

[inline, virtual]

Reimplemented in GeneralMatrix, nricMatrix, RowVector, ColumnVector, CroutMatrix, BandLUMatrix, GenericMatrix, and LinearEquationSolver.

Definition at line 395 of file newmat.h.

GetSubMatrix BaseMatrix::column

(

int

first_col

)

const

Definition at line 68 of file submat.cpp.

GetSubMatrix BaseMatrix::columns	(	int	first_col,
		int	last_col
	)			const

Definition at line 77 of file submat.cpp.

Real BaseMatrix::Determinant

(

)

const [inline]

Definition at line 344 of file newmat.h.

Real BaseMatrix::determinant

(

)

const

Definition at line 719 of file newmat8.cpp.

virtual GeneralMatrix* BaseMatrix::Evaluate

(

MatrixType

mt = MatrixTypeUnSp

)

[pure virtual]

Implemented in GeneralMatrix, CroutMatrix, BandLUMatrix, GenericMatrix, MultipliedMatrix, AddedMatrix, SPMatrix, KPMatrix, ConcatenatedMatrix, StackedMatrix, SolvedMatrix, SubtractedMatrix, ShiftedMatrix, NegShiftedMatrix, ScaledMatrix, NegatedMatrix, TransposedMatrix, ReversedMatrix, InvertedMatrix, RowedMatrix, ColedMatrix, DiagedMatrix, MatedMatrix, ReturnMatrix, GetSubMatrix, and LinearEquationSolver.

InvertedMatrix BaseMatrix::i

(

)

const

Definition at line 329 of file newmat6.cpp.

void BaseMatrix::IEQND

(

)

const

Definition at line 318 of file newmatex.cpp.

LogAndSign BaseMatrix::log_determinant

(

)

const [virtual]

Reimplemented in GeneralMatrix, UpperTriangularMatrix, LowerTriangularMatrix, DiagonalMatrix, CroutMatrix, BandMatrix, UpperBandMatrix, LowerBandMatrix, SymmetricBandMatrix, BandLUMatrix, and IdentityMatrix.

Definition at line 690 of file newmat8.cpp.

LogAndSign BaseMatrix::LogDeterminant

(

)

const [inline]

Definition at line 342 of file newmat.h.

Real BaseMatrix::Maximum

(

)

const [inline]

Definition at line 371 of file newmat.h.

Real BaseMatrix::maximum

(

)

const [virtual]

Reimplemented in GeneralMatrix, BandMatrix, and SymmetricBandMatrix.

Definition at line 494 of file newmat8.cpp.

Real BaseMatrix::Maximum1

(

int &

i

)

const [inline]

Definition at line 373 of file newmat.h.

Real BaseMatrix::maximum1

(

int &

i

)

const [virtual]

Reimplemented in GeneralMatrix.

Definition at line 500 of file newmat8.cpp.

Real BaseMatrix::Maximum2	(	int &	i,
		int &	j
	)			const [inline]

Definition at line 375 of file newmat.h.

Real BaseMatrix::maximum2	(	int &	i,
		int &	j
	)			const [virtual]

Reimplemented in GeneralMatrix, and Matrix.

Definition at line 506 of file newmat8.cpp.

Real BaseMatrix::maximum_absolute_value

(

)

const [virtual]

Reimplemented in GeneralMatrix, BandMatrix, and SymmetricBandMatrix.

Definition at line 458 of file newmat8.cpp.

Real BaseMatrix::maximum_absolute_value1

(

int &

i

)

const [virtual]

Reimplemented in GeneralMatrix.

Definition at line 464 of file newmat8.cpp.

Real BaseMatrix::maximum_absolute_value2	(	int &	i,
		int &	j
	)			const [virtual]

Reimplemented in GeneralMatrix, and Matrix.

Definition at line 470 of file newmat8.cpp.

Real BaseMatrix::MaximumAbsoluteValue

(

)

const [inline]

Definition at line 355 of file newmat.h.

Real BaseMatrix::MaximumAbsoluteValue1

(

int &

i

)

const [inline]

Definition at line 357 of file newmat.h.

Real BaseMatrix::MaximumAbsoluteValue2	(	int &	i,
		int &	j
	)			const [inline]

Definition at line 360 of file newmat.h.

Real BaseMatrix::Minimum

(

)

const [inline]

Definition at line 377 of file newmat.h.

Real BaseMatrix::minimum

(

)

const [virtual]

Reimplemented in GeneralMatrix, BandMatrix, and SymmetricBandMatrix.

Definition at line 512 of file newmat8.cpp.

Real BaseMatrix::Minimum1

(

int &

i

)

const [inline]

Definition at line 379 of file newmat.h.

Real BaseMatrix::minimum1

(

int &

i

)

const [virtual]

Reimplemented in GeneralMatrix.

Definition at line 518 of file newmat8.cpp.

Real BaseMatrix::Minimum2	(	int &	i,
		int &	j
	)			const [inline]

Definition at line 381 of file newmat.h.

Real BaseMatrix::minimum2	(	int &	i,
		int &	j
	)			const [virtual]

Reimplemented in GeneralMatrix, and Matrix.

Definition at line 524 of file newmat8.cpp.

Real BaseMatrix::minimum_absolute_value

(

)

const [virtual]

Reimplemented in GeneralMatrix, BandMatrix, and SymmetricBandMatrix.

Definition at line 476 of file newmat8.cpp.

Real BaseMatrix::minimum_absolute_value1

(

int &

i

)

const [virtual]

Reimplemented in GeneralMatrix.

Definition at line 482 of file newmat8.cpp.

Real BaseMatrix::minimum_absolute_value2	(	int &	i,
		int &	j
	)			const [virtual]

Reimplemented in GeneralMatrix, and Matrix.

Definition at line 488 of file newmat8.cpp.

Real BaseMatrix::MinimumAbsoluteValue

(

)

const [inline]

Definition at line 363 of file newmat.h.

Real BaseMatrix::MinimumAbsoluteValue1

(

int &

i

)

const [inline]

Definition at line 365 of file newmat.h.

Real BaseMatrix::MinimumAbsoluteValue2	(	int &	i,
		int &	j
	)			const [inline]

Definition at line 368 of file newmat.h.

Real BaseMatrix::Norm1

(

)

const [inline]

Definition at line 385 of file newmat.h.

Real BaseMatrix::norm1

(

)

const

Definition at line 712 of file newmat7.cpp.

Real BaseMatrix::norm_frobenius

(

)

const [inline]

Definition at line 348 of file newmat.h.

Real BaseMatrix::norm_Frobenius

(

)

const

Definition at line 443 of file newmat8.cpp.

Real BaseMatrix::norm_infinity

(

)

const

Definition at line 724 of file newmat7.cpp.

Real BaseMatrix::NormFrobenius

(

)

const [inline]

Definition at line 349 of file newmat.h.

Real BaseMatrix::NormInfinity

(

)

const [inline]

Definition at line 387 of file newmat.h.

StackedMatrix BaseMatrix::operator&

(

const BaseMatrix &

bm

)

const

Definition at line 290 of file newmat6.cpp.

ScaledMatrix BaseMatrix::operator*

(

Real

f

)

const

Reimplemented in InvertedMatrix.

Definition at line 308 of file newmat6.cpp.

MultipliedMatrix BaseMatrix::operator*

(

const BaseMatrix &

bm

)

const

Reimplemented in InvertedMatrix.

Definition at line 284 of file newmat6.cpp.

ShiftedMatrix BaseMatrix::operator+

(

Real

f

)

const

Definition at line 299 of file newmat6.cpp.

AddedMatrix BaseMatrix::operator+

(

const BaseMatrix &

bm

)

const

Definition at line 275 of file newmat6.cpp.

NegatedMatrix BaseMatrix::operator-

(

void

)

const

Definition at line 323 of file newmat6.cpp.

ShiftedMatrix BaseMatrix::operator-

(

Real

f

)

const

Definition at line 317 of file newmat6.cpp.

SubtractedMatrix BaseMatrix::operator-

(

const BaseMatrix &

bm

)

const

Definition at line 296 of file newmat6.cpp.

ScaledMatrix BaseMatrix::operator/

(

Real

f

)

const

Definition at line 311 of file newmat6.cpp.

ConcatenatedMatrix BaseMatrix::operator|

(

const BaseMatrix &

bm

)

const

Definition at line 287 of file newmat6.cpp.

ReversedMatrix BaseMatrix::reverse

(

)

const

Definition at line 326 of file newmat6.cpp.

GetSubMatrix BaseMatrix::row

(

int

first_row

)

const

Definition at line 49 of file submat.cpp.

GetSubMatrix BaseMatrix::rows	(	int	first_row,
		int	last_row
	)			const

Definition at line 58 of file submat.cpp.

virtual int BaseMatrix::search

(

const BaseMatrix *

)

const [protected, pure virtual]

Implemented in GeneralMatrix, GenericMatrix, MultipliedMatrix, ShiftedMatrix, NegatedMatrix, ReturnMatrix, and LinearEquationSolver.

GetSubMatrix BaseMatrix::submatrix	(	int	first_row,
		int	last_row,
		int	first_col,
		int	last_col
	)			const

Definition at line 27 of file submat.cpp.

virtual Real BaseMatrix::Sum

(

)

const [inline, virtual]

Definition at line 353 of file newmat.h.

Real BaseMatrix::sum

(

)

const [virtual]

Reimplemented in GeneralMatrix, SymmetricMatrix, BandMatrix, SymmetricBandMatrix, and IdentityMatrix.

Definition at line 452 of file newmat8.cpp.

Real BaseMatrix::sum_absolute_value

(

)

const [virtual]

Reimplemented in GeneralMatrix, SymmetricMatrix, BandMatrix, SymmetricBandMatrix, and IdentityMatrix.

Definition at line 446 of file newmat8.cpp.

ReturnMatrix BaseMatrix::sum_columns

(

)

const

Definition at line 805 of file newmat8.cpp.

ReturnMatrix BaseMatrix::sum_rows

(

)

const

Definition at line 781 of file newmat8.cpp.

Real BaseMatrix::sum_square

(

)

const [virtual]

Reimplemented in GeneralMatrix, SymmetricMatrix, BandMatrix, SymmetricBandMatrix, and IdentityMatrix.

Definition at line 437 of file newmat8.cpp.

ReturnMatrix BaseMatrix::sum_square_columns

(

)

const

Definition at line 760 of file newmat8.cpp.

ReturnMatrix BaseMatrix::sum_square_rows

(

)

const

Definition at line 736 of file newmat8.cpp.

Real BaseMatrix::SumAbsoluteValue

(

)

const [inline]

Definition at line 351 of file newmat.h.

Real BaseMatrix::SumSquare

(

)

const [inline]

Definition at line 346 of file newmat.h.

GetSubMatrix BaseMatrix::sym_submatrix	(	int	first_row,
		int	last_row
	)			const

Definition at line 39 of file submat.cpp.

TransposedMatrix BaseMatrix::t

(

)

const

Definition at line 320 of file newmat6.cpp.

Real BaseMatrix::Trace

(

)

const [inline]

Definition at line 383 of file newmat.h.

Real BaseMatrix::trace

(

)

const [virtual]

Reimplemented in Matrix, SymmetricMatrix, UpperTriangularMatrix, LowerTriangularMatrix, DiagonalMatrix, BandMatrix, SymmetricBandMatrix, and IdentityMatrix.

Definition at line 617 of file newmat8.cpp.

---

Friends And Related Function Documentation

friend class AddedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 417 of file newmat.h.

friend class BandMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 413 of file newmat.h.

friend class ColedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 433 of file newmat.h.

friend class ColumnVector [friend]

Reimplemented in GeneralMatrix.

Definition at line 407 of file newmat.h.

friend class ConcatenatedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 422 of file newmat.h.

friend class CroutMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 412 of file newmat.h.

friend class DiagedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 434 of file newmat.h.

friend class DiagonalMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 411 of file newmat.h.

friend class GeneralMatrix [friend]

Reimplemented in MultipliedMatrix, AddedMatrix, SPMatrix, KPMatrix, ConcatenatedMatrix, StackedMatrix, SubtractedMatrix, ShiftedMatrix, NegShiftedMatrix, and ScaledMatrix.

Definition at line 402 of file newmat.h.

friend class GenericMatrix [friend]

Reimplemented in GeneralMatrix, MultipliedMatrix, AddedMatrix, SPMatrix, KPMatrix, ConcatenatedMatrix, StackedMatrix, SubtractedMatrix, ShiftedMatrix, NegShiftedMatrix, and ScaledMatrix.

Definition at line 439 of file newmat.h.

friend class GetSubMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 436 of file newmat.h.

friend class InvertedMatrix [friend]

Reimplemented in GeneralMatrix, and SolvedMatrix.

Definition at line 431 of file newmat.h.

friend class KPMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 421 of file newmat.h.

friend class LinearEquationSolver [friend]

Reimplemented in GeneralMatrix.

Definition at line 438 of file newmat.h.

friend class LowerBandMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 414 of file newmat.h.

friend class LowerTriangularMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 410 of file newmat.h.

friend class MatedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 435 of file newmat.h.

friend class Matrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 403 of file newmat.h.

friend class MultipliedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 418 of file newmat.h.

friend class NegatedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 430 of file newmat.h.

friend class NegShiftedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 426 of file newmat.h.

friend class nricMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 405 of file newmat.h.

friend class ReturnMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 437 of file newmat.h.

friend class ReversedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 429 of file newmat.h.

friend class RowedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 432 of file newmat.h.

friend class RowVector [friend]

Reimplemented in GeneralMatrix.

Definition at line 406 of file newmat.h.

friend class ScaledMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 427 of file newmat.h.

friend class ShiftedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 425 of file newmat.h.

friend class SolvedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 424 of file newmat.h.

friend class SPMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 420 of file newmat.h.

friend class SquareMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 404 of file newmat.h.

friend class StackedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 423 of file newmat.h.

friend class SubtractedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 419 of file newmat.h.

friend class SymmetricBandMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 416 of file newmat.h.

friend class SymmetricMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 408 of file newmat.h.

friend class TransposedMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 428 of file newmat.h.

friend class UpperBandMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 415 of file newmat.h.

friend class UpperTriangularMatrix [friend]

Reimplemented in GeneralMatrix.

Definition at line 409 of file newmat.h.

---

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

• newmat.h
• newmat4.cpp
• newmat6.cpp
• newmat7.cpp
• newmat8.cpp
• newmatex.cpp
• submat.cpp