MatrixCharacteristics.h File Reference

Here we declare the classes needed for managing the properties of matrices, which we call Matrix Characteristics. More...

#include "SimTKcommon/Scalar.h"
#include <iostream>
#include <cassert>
#include <complex>
#include <cstddef>
#include <utility>

Go to the source code of this file.

Classes
class	SimTK::MatrixStructure
	Matrix "structure" refers to an inherent mathematical (or at least algorithmic) characteristic of the matrix rather than a storage strategy. More...
struct	SimTK::MatrixStructure::Mask
class	SimTK::MatrixStorage
	Matrix "storage" refers to the physical layout of data in the computer’s memory. More...
struct	SimTK::MatrixStorage::Mask
	Use this class to represent sets of acceptable values for each of the storage attributes (packing, position, order, diagonal). More...
class	SimTK::MatrixOutline
	Matrix "outline" refers to the characteristic relationship between the number of rows and columns of a matrix, without necessarily specifying the absolute dimensions. More...
struct	SimTK::MatrixOutline::Mask
class	SimTK::MatrixCondition
	Matrix "condition" is a statement about the numerical characteristics of a Matrix. More...
struct	SimTK::MatrixCondition::Mask
	Use this class to represent a set of acceptable Condition values. More...
class	SimTK::MatrixCharacter
	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...
class	SimTK::MatrixCharacter::LapackFull
	Predefined MatrixCharacter for an ordinary Lapack-style full matrix of a particular dimension m x n (nrows X ncols). More...
class	SimTK::MatrixCharacter::Vector
	Predefined MatrixCharacter for an ordinary column vector of a particular size. More...
class	SimTK::MatrixCharacter::RowVector
	Predefined MatrixCharacter for an ordinary row vector of a particular size. More...
class	SimTK::MatrixCharacter::Mask
	This class collects masks of each characteristic type for representing sets of accceptable characteristics. More...
class	SimTK::MatrixCommitment
	A MatrixCommitment provides a set of acceptable matrix characteristics. More...
class	SimTK::MatrixCommitment::Vector
	This is the default commitment for a column vector. More...
class	SimTK::MatrixCommitment::RowVector
	This is the default commitment for a row vector. More...
class	SimTK::MatrixCommitment::Triangular
	This is the default commitment for a triangular matrix. More...
class	SimTK::MatrixCommitment::Symmetric
	This is the default commitment for a symmetric (*not* Hermitian) matrix. More...
class	SimTK::MatrixCommitment::Hermitian
	This is the default commitment for a Hermitian (*not* symmetric) matrix. More...
class	SimTK::MatrixCommitment::SkewSymmetric
	This is the default commitment for skew symmetric (*not* skew Hermitian) matrix. More...
class	SimTK::MatrixCommitment::SkewHermitian
	This is the default commitment for a skew Hermitian (*not* skew symmetric) matrix. More...
Namespaces
namespace	SimTK
	This is the top-level SimTK namespace into which all SimTK names are placed to avoid collision with other symbols.
Functions
std::ostream &	SimTK::operator<< (std::ostream &o, const MatrixCharacter &)
	Output a textual description of a MatrixCharacter; handy for debugging.
std::ostream &	SimTK::operator<< (std::ostream &o, const MatrixCommitment &)
	Output a textual description of a MatrixCommitment; handy for debugging.

---

Detailed Description

Here we declare the classes needed for managing the properties of matrices, which we call Matrix Characteristics.