Simbody  3.6
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Friends | List of all members
SimTK::MatrixCharacter::Mask Class Reference

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

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"). More...
 
bool isUncommitted () const
 Return if all fields are set to "Uncommitted" (all bits are one). More...
 
bool isSatisfiedBy (const MatrixCharacter &actual) const
 Check whether an actual matrix character satisfies this matrix commitment. More...
 
bool isSizeOK (int m, int n) const
 Check whether an actual size satisfies the size commitment. More...
 
bool isBandwidthOK (int lower, int upper) const
 Check whether an actual bandwidth satisfies the bandwidth commitment. More...
 

Public Attributes

SizeMask nr
 number of rows More...
 
SizeMask nc
 number of columns More...
 
SizeMask lband
 lower bandwidth, if banded More...
 
SizeMask uband
 upper bandwidth, if banded More...
 
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

◆ SizeMask

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

Constructor & Destructor Documentation

◆ Mask()

SimTK::MatrixCharacter::Mask::Mask ( )
inline

Member Function Documentation

◆ isResizeable()

bool SimTK::MatrixCharacter::Mask::isResizeable ( ) const
inline

◆ isFullyResizeable()

bool SimTK::MatrixCharacter::Mask::isFullyResizeable ( ) const
inline

◆ isNumRowsLocked()

bool SimTK::MatrixCharacter::Mask::isNumRowsLocked ( ) const
inline

◆ isNumColsLocked()

bool SimTK::MatrixCharacter::Mask::isNumColsLocked ( ) const
inline

◆ getNumRowsMask()

unsigned int SimTK::MatrixCharacter::Mask::getNumRowsMask ( ) const
inline

◆ getNumColsMask()

unsigned int SimTK::MatrixCharacter::Mask::getNumColsMask ( ) const
inline

◆ getLowerBandwidthMask()

unsigned int SimTK::MatrixCharacter::Mask::getLowerBandwidthMask ( ) const
inline

◆ getUpperBandwidthMask()

unsigned int SimTK::MatrixCharacter::Mask::getUpperBandwidthMask ( ) const
inline

◆ getDefaultNumRows()

int SimTK::MatrixCharacter::Mask::getDefaultNumRows ( ) const
inline

◆ getDefaultNumCols()

int SimTK::MatrixCharacter::Mask::getDefaultNumCols ( ) const
inline

◆ isLowerBandwidthLocked()

bool SimTK::MatrixCharacter::Mask::isLowerBandwidthLocked ( ) const
inline

◆ isUpperBandwidthLocked()

bool SimTK::MatrixCharacter::Mask::isUpperBandwidthLocked ( ) const
inline

◆ getDefaultLowerBandwidth()

int SimTK::MatrixCharacter::Mask::getDefaultLowerBandwidth ( ) const
inline

◆ getDefaultUpperBandwidth()

int SimTK::MatrixCharacter::Mask::getDefaultUpperBandwidth ( ) const
inline

◆ setToUncommitted()

Mask& SimTK::MatrixCharacter::Mask::setToUncommitted ( )
inline

Set all bits to one ("Uncommitted").

◆ isUncommitted()

bool SimTK::MatrixCharacter::Mask::isUncommitted ( ) const
inline

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

◆ isSatisfiedBy()

bool SimTK::MatrixCharacter::Mask::isSatisfiedBy ( const MatrixCharacter &  actual) const
inline

Check whether an actual matrix character satisfies this matrix commitment.

◆ isSizeOK()

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

Check whether an actual size satisfies the size commitment.

◆ isBandwidthOK()

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

◆ MatrixCommitment

friend class MatrixCommitment
friend

Member Data Documentation

◆ SizeUncommitted

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

◆ nr

SizeMask SimTK::MatrixCharacter::Mask::nr

number of rows

◆ nc

SizeMask SimTK::MatrixCharacter::Mask::nc

number of columns

◆ lband

SizeMask SimTK::MatrixCharacter::Mask::lband

lower bandwidth, if banded

◆ uband

SizeMask SimTK::MatrixCharacter::Mask::uband

upper bandwidth, if banded

◆ structure

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

◆ storage

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

◆ outline

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

◆ condition

MatrixCondition::Mask SimTK::MatrixCharacter::Mask::condition
The documentation for this class was generated from the following file: