SimTK::MatrixCharacter Class Reference

A MatrixCharacter is a set containing a value for each of the matrix characteristics except element type, which is part of the templatized declaration of a Matrix, Vector, or RowVector handle. More...

#include <MatrixCharacteristics.h>

Inheritance diagram for SimTK::MatrixCharacter:

List of all members.

Classes
class	LapackFull
	Predefined MatrixCharacter for an ordinary Lapack-style full matrix of a particular dimension m x n (nrows X ncols). More...
class	Mask
	This class collects masks of each characteristic type for representing sets of accceptable characteristics. More...
class	RowVector
	Predefined MatrixCharacter for an ordinary row vector of a particular size. More...
class	Vector
	Predefined MatrixCharacter for an ordinary column vector of a particular size. More...
Public Member Functions
	MatrixCharacter ()
	Default constructor sets lengths to zero and the other characteristics to "none specified".
MatrixCharacter &	setToNone ()
	Restore this MatrixCharacter to its default-constructed state of "none".
int	nrow () const
int	ncol () const
std::pair< int, int >	getSize () const
ptrdiff_t	nelt () const
int	getLowerBandwidth () const
int	getUpperBandwidth () const
std::pair< int, int >	getBandwidth () const
const MatrixStructure &	getStructure () const
const MatrixStorage &	getStorage () const
const MatrixOutline &	getOutline () const
const MatrixCondition &	getCondition () const
MatrixStructure &	updStructure ()
MatrixStorage &	updStorage ()
MatrixOutline &	updOutline ()
MatrixCondition &	updCondition ()
MatrixCharacter &	setStructure (const MatrixStructure &sa)
MatrixCharacter &	setStorage (const MatrixStorage &sa)
MatrixCharacter &	setOutline (const MatrixOutline &oa)
MatrixCharacter &	setCondition (const MatrixCondition &ca)
MatrixCharacter &	setActualSize (int m, int n)
	Set the actual size and update the outline to match.
MatrixCharacter &	setActualNumRows (int m)
MatrixCharacter &	setActualNumCols (int n)
MatrixCharacter &	setBandwidth (int lb, int ub)
MatrixCharacter &	setLowerBandwidth (int lb)
MatrixCharacter &	setUpperBandwidth (int ub)
Protected Member Functions
	MatrixCharacter (int m, int n, int lb, int ub, MatrixStructure structure, MatrixStorage storage, MatrixCondition condition)
Protected Attributes
int	nr
	actual number of rows
int	nc
	actual number of columns
int	lband
	actual lower bandwidth, if banded
int	uband
	actual upper bandwidth, if banded
MatrixStructure	structure
MatrixStorage	storage
MatrixOutline	outline
MatrixCondition	condition

---

Detailed Description

A MatrixCharacter is a set containing a value for each of the matrix characteristics except element type, which is part of the templatized declaration of a Matrix, Vector, or RowVector handle.

MatrixCharacters are used both as the handle "commitment", setting restrictions on what kinds of matrices a handle can reference, and as the "facts on the ground" current character of the matrix being referenced. The current character must always satisfy the character commitment.

---

Constructor & Destructor Documentation

SimTK::MatrixCharacter::MatrixCharacter

(

)

[inline]

Default constructor sets lengths to zero and the other characteristics to "none specified".

SimTK::MatrixCharacter::MatrixCharacter	(	int	m,
		int	n,
		int	lb,
		int	ub,
		MatrixStructure	structure,
		MatrixStorage	storage,
		MatrixCondition	condition
	)		[inline, protected]

---

Member Function Documentation

MatrixCharacter& SimTK::MatrixCharacter::setToNone

(

)

[inline]

Restore this MatrixCharacter to its default-constructed state of "none".

int SimTK::MatrixCharacter::nrow

(

)

const [inline]

int SimTK::MatrixCharacter::ncol

(

)

const [inline]

std::pair<int,int> SimTK::MatrixCharacter::getSize

(

)

const [inline]

ptrdiff_t SimTK::MatrixCharacter::nelt

(

)

const [inline]

int SimTK::MatrixCharacter::getLowerBandwidth

(

)

const [inline]

int SimTK::MatrixCharacter::getUpperBandwidth

(

)

const [inline]

std::pair<int,int> SimTK::MatrixCharacter::getBandwidth

(

)

const [inline]

const MatrixStructure& SimTK::MatrixCharacter::getStructure

(

)

const [inline]

const MatrixStorage& SimTK::MatrixCharacter::getStorage

(

)

const [inline]

const MatrixOutline& SimTK::MatrixCharacter::getOutline

(

)

const [inline]

const MatrixCondition& SimTK::MatrixCharacter::getCondition

(

)

const [inline]

MatrixStructure& SimTK::MatrixCharacter::updStructure

(

)

[inline]

MatrixStorage& SimTK::MatrixCharacter::updStorage

(

)

[inline]

MatrixOutline& SimTK::MatrixCharacter::updOutline

(

)

[inline]

MatrixCondition& SimTK::MatrixCharacter::updCondition

(

)

[inline]

MatrixCharacter& SimTK::MatrixCharacter::setStructure

(

const MatrixStructure &

sa

)

[inline]

MatrixCharacter& SimTK::MatrixCharacter::setStorage

(

const MatrixStorage &

sa

)

[inline]

MatrixCharacter& SimTK::MatrixCharacter::setOutline

(

const MatrixOutline &

oa

)

[inline]

MatrixCharacter& SimTK::MatrixCharacter::setCondition

(

const MatrixCondition &

ca

)

[inline]

MatrixCharacter& SimTK::MatrixCharacter::setActualSize	(	int	m,
		int	n
	)		[inline]

Set the actual size and update the outline to match.

MatrixCharacter& SimTK::MatrixCharacter::setActualNumRows

(

int

m

)

[inline]

MatrixCharacter& SimTK::MatrixCharacter::setActualNumCols

(

int

n

)

[inline]

MatrixCharacter& SimTK::MatrixCharacter::setBandwidth	(	int	lb,
		int	ub
	)		[inline]

MatrixCharacter& SimTK::MatrixCharacter::setLowerBandwidth

(

int

lb

)

[inline]

MatrixCharacter& SimTK::MatrixCharacter::setUpperBandwidth

(

int

ub

)

[inline]

---

Member Data Documentation

int SimTK::MatrixCharacter::nr [protected]

actual number of rows

int SimTK::MatrixCharacter::nc [protected]

actual number of columns

int SimTK::MatrixCharacter::lband [protected]

actual lower bandwidth, if banded

int SimTK::MatrixCharacter::uband [protected]

actual upper bandwidth, if banded

MatrixStructure SimTK::MatrixCharacter::structure [protected]

MatrixStorage SimTK::MatrixCharacter::storage [protected]

MatrixOutline SimTK::MatrixCharacter::outline [protected]

MatrixCondition SimTK::MatrixCharacter::condition [protected]

---

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

• MatrixCharacteristics.h