SimTK::MatrixCharacter::Vector Class Reference

Predefined MatrixCharacter for an ordinary column vector of a particular size. More...

#include <MatrixCharacteristics.h>

Inheritance diagram for SimTK::MatrixCharacter::Vector:

Public Member Functions
	Vector (int m)
Public Member Functions inherited from SimTK::MatrixCharacter
	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
	These are dimensions of the logical matrix and have nothing to do with how much storage may be used to hold the elements.
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)

Additional Inherited Members
Protected Member Functions inherited from SimTK::MatrixCharacter
	MatrixCharacter (int m, int n, int lb, int ub, MatrixStructure structure, MatrixStorage storage, MatrixCondition condition)
Protected Attributes inherited from SimTK::MatrixCharacter
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
Related Functions inherited from SimTK::MatrixCharacter
std::ostream &	operator<< (std::ostream &o, const MatrixCharacter &)
	Output a textual description of a MatrixCharacter; handy for debugging.

Detailed Description

Predefined MatrixCharacter for an ordinary column vector of a particular size.

Note that standard vector storage allows for a "stride" greater than 1, but that is not considered part of the matrix character. Stride is dealt with separately.

Constructor & Destructor Documentation

SimTK::MatrixCharacter::Vector::Vector ( int  m )

inline

---

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

• MatrixCharacteristics.h