Simbody  3.5
Public Member Functions | List of all members
SimTK::MatrixCommitment::Symmetric Class Reference

This is the default commitment for a symmetric (*not* Hermitian) matrix. More...

+ Inheritance diagram for SimTK::MatrixCommitment::Symmetric:

Public Member Functions

 Symmetric ()
 
- Public Member Functions inherited from SimTK::MatrixCommitment
 MatrixCommitment ()
 
 MatrixCommitment (const MatrixStructure &str)
 This is an implicit conversion from a MatrixStructure specification to a MatrixCommitment with storage, outline, and condition uncommitted. More...
 
MatrixCommitment & commitSize (int m, int n)
 
MatrixCommitment & commitNumRows (int m)
 
MatrixCommitment & commitNumCols (int n)
 
MatrixCommitment & commitBandwidth (int lb, int ub)
 
MatrixCommitment & commitLowerBandwidth (int lb)
 
MatrixCommitment & commitUpperBandwidth (int ub)
 
MatrixCommitment & commitStructure (const MatrixStructure &s)
 
MatrixCommitment & commitStorage (const MatrixStorage &s)
 
MatrixCommitment & commitOutline (const MatrixOutline &o)
 
MatrixCommitment & commitCondition (const MatrixCondition &c)
 
MatrixCharacter calcDefaultCharacter (int minNumRows, int minNumCols) const
 For any handle commitment, we can calculate a "best character" for an allocation that satisfies the commitment, optionally with an initial allocation size. More...
 
const MatrixStructure & getStructureCommitment () const
 These report the commitment as it was specified. More...
 
const MatrixStorage & getStorageCommitment () const
 
const MatrixOutline & getOutlineCommitment () const
 
const MatrixCondition & getConditionCommitment () const
 
const MatrixStructure::Mask & getStructureMask () const
 These report the masks of acceptable values generated from the commitment. More...
 
const MatrixStorage::Mask & getStorageMask () const
 
const MatrixOutline::Mask & getOutlineMask () const
 
const MatrixCondition::Mask & getConditionMask () const
 
MatrixCharacter::Mask::SizeMask getNumRowsMask () const
 
MatrixCharacter::Mask::SizeMask getNumColsMask () const
 
MatrixCharacter::Mask::SizeMask getLowerBandwidthMask () const
 
MatrixCharacter::Mask::SizeMask getUpperBandwidthMask () const
 
int getDefaultNumRows () const
 
int getDefaultNumCols () const
 
bool isSizeOK (int m, int n) const
 
bool isSizeOK (const std::pair< int, int > &mn) const
 
bool isBandwidthOK (int lower, int upper) const
 
bool isSatisfiedBy (const MatrixCharacter &actual) const
 
bool isStructureOK (const MatrixStructure &s) const
 
bool isStorageOK (const MatrixStorage &s) const
 
bool isOutlineOK (const MatrixOutline &o) const
 
bool isConditionOK (const MatrixCondition &c) const
 
bool isResizeable () const
 
bool isFullyResizeable () const
 
bool isNumRowsLocked () const
 
bool isNumColsLocked () const
 
bool isStructureCommitted () const
 
bool isStorageCommitted () const
 
bool isOutlineCommitted () const
 
bool isConditionCommitted () const
 
void clear ()
 Set commitment s to "none" and masks to "uncommitted" for all characteristics. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SimTK::MatrixCommitment
 MatrixCommitment (const MatrixStructure &structure, const MatrixStorage &storage, const MatrixOutline &outline, const MatrixCondition &condition)
 
- Protected Attributes inherited from SimTK::MatrixCommitment
MatrixStructure structure
 These are the commitments as specified. More...
 
MatrixStorage storage
 
MatrixOutline outline
 
MatrixCondition condition
 
MatrixCharacter::Mask masks
 These are the bitmasks of acceptable characteristics which would satisfy the above-specified commitments. More...
 
- Related Functions inherited from SimTK::MatrixCommitment
std::ostream & operator<< (std::ostream &o, const MatrixCommitment &)
 Output a textual description of a MatrixCommitment; handy for debugging. More...
 

Detailed Description

This is the default commitment for a symmetric (*not* Hermitian) matrix.

There are no restrictions on the underlying elements or diagonals.

Constructor & Destructor Documentation

SimTK::MatrixCommitment::Symmetric::Symmetric ( )
inline
The documentation for this class was generated from the following file: