SimTK::MatrixCharacter::Mask Class Reference

This class collects masks of each characteristic type for representing sets of accceptable characteristics. More...

#include <MatrixCharacteristics.h>

List of all members.

Public Types
typedef unsigned int	SizeMask
Public Member Functions
	Mask ()
bool	isResizeable () const
bool	isFullyResizeable () const
bool	isNumRowsLocked () const
bool	isNumColsLocked () const
unsigned int	getNumRowsMask () const
unsigned int	getNumColsMask () const
unsigned int	getLowerBandwidthMask () const
unsigned int	getUpperBandwidthMask () const
int	getDefaultNumRows () const
int	getDefaultNumCols () const
bool	isLowerBandwidthLocked () const
bool	isUpperBandwidthLocked () const
int	getDefaultLowerBandwidth () const
int	getDefaultUpperBandwidth () const
Mask &	setToUncommitted ()
	Set all bits to one ("Uncommitted").
bool	isUncommitted () const
	Return if all fields are set to "Uncommitted" (all bits are one).
bool	isSatisfiedBy (const MatrixCharacter &actual) const
	Check whether an actual matrix character satisfies this matrix commitment.
bool	isSizeOK (int m, int n) const
	Check whether an actual size satisfies the size commitment.
bool	isBandwidthOK (int lower, int upper) const
	Check whether an actual bandwidth satisfies the bandwidth commitment.
Public Attributes
SizeMask	nr
	number of rows
SizeMask	nc
	number of columns
SizeMask	lband
	lower bandwidth, if banded
SizeMask	uband
	upper bandwidth, if banded
MatrixStructure::Mask	structure
MatrixStorage::Mask	storage
MatrixOutline::Mask	outline
MatrixCondition::Mask	condition
Static Public Attributes
static const SizeMask	SizeUncommitted = 0xffffffffU
Friends
class	MatrixCommitment

---

Detailed Description

This class collects masks of each characteristic type for representing sets of accceptable characteristics.

---

Member Typedef Documentation

typedef unsigned int SimTK::MatrixCharacter::Mask::SizeMask

---

Constructor & Destructor Documentation

SimTK::MatrixCharacter::Mask::Mask

(

)

[inline]

---

Member Function Documentation

bool SimTK::MatrixCharacter::Mask::isResizeable

(

)

const [inline]

bool SimTK::MatrixCharacter::Mask::isFullyResizeable

(

)

const [inline]

bool SimTK::MatrixCharacter::Mask::isNumRowsLocked

(

)

const [inline]

bool SimTK::MatrixCharacter::Mask::isNumColsLocked

(

)

const [inline]

unsigned int SimTK::MatrixCharacter::Mask::getNumRowsMask

(

)

const [inline]

unsigned int SimTK::MatrixCharacter::Mask::getNumColsMask

(

)

const [inline]

unsigned int SimTK::MatrixCharacter::Mask::getLowerBandwidthMask

(

)

const [inline]

unsigned int SimTK::MatrixCharacter::Mask::getUpperBandwidthMask

(

)

const [inline]

int SimTK::MatrixCharacter::Mask::getDefaultNumRows

(

)

const [inline]

int SimTK::MatrixCharacter::Mask::getDefaultNumCols

(

)

const [inline]

bool SimTK::MatrixCharacter::Mask::isLowerBandwidthLocked

(

)

const [inline]

bool SimTK::MatrixCharacter::Mask::isUpperBandwidthLocked

(

)

const [inline]

int SimTK::MatrixCharacter::Mask::getDefaultLowerBandwidth

(

)

const [inline]

int SimTK::MatrixCharacter::Mask::getDefaultUpperBandwidth

(

)

const [inline]

Mask& SimTK::MatrixCharacter::Mask::setToUncommitted

(

)

[inline]

Set all bits to one ("Uncommitted").

bool SimTK::MatrixCharacter::Mask::isUncommitted

(

)

const [inline]

Return if all fields are set to "Uncommitted" (all bits are one).

bool SimTK::MatrixCharacter::Mask::isSatisfiedBy

(

const MatrixCharacter &

actual

)

const [inline]

Check whether an actual matrix character satisfies this matrix commitment.

bool SimTK::MatrixCharacter::Mask::isSizeOK	(	int	m,
		int	n
	)		const [inline]

Check whether an actual size satisfies the size commitment.

bool SimTK::MatrixCharacter::Mask::isBandwidthOK	(	int	lower,
		int	upper
	)		const [inline]

Check whether an actual bandwidth satisfies the bandwidth commitment.

(If the matrix isn't banded any bandwidth will be OK.)

---

Friends And Related Function Documentation

friend class MatrixCommitment [friend]

---

Member Data Documentation

const SizeMask SimTK::MatrixCharacter::Mask::SizeUncommitted = 0xffffffffU [static]

SizeMask SimTK::MatrixCharacter::Mask::nr

number of rows

SizeMask SimTK::MatrixCharacter::Mask::nc

number of columns

SizeMask SimTK::MatrixCharacter::Mask::lband

lower bandwidth, if banded

SizeMask SimTK::MatrixCharacter::Mask::uband

upper bandwidth, if banded

MatrixStructure::Mask SimTK::MatrixCharacter::Mask::structure

MatrixStorage::Mask SimTK::MatrixCharacter::Mask::storage

MatrixOutline::Mask SimTK::MatrixCharacter::Mask::outline

MatrixCondition::Mask SimTK::MatrixCharacter::Mask::condition

---

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

• MatrixCharacteristics.h