MatrixHelper Class Template Reference

#include <MatrixHelper.h>

List of all members.

template<class S>
class SimTK::MatrixHelper< S >

Public Member Functions
	~MatrixHelper ()
	MatrixHelper (int esz, int cppEsz)
void	clear ()
	MatrixHelper (int esz, int cppEsz, int m, int n, bool lockNrow=false, bool lockNcol=false)
	MatrixHelper (int esz, int cppEsz, int m, int n, int leadingDim, const S *)
	MatrixHelper (int esz, int cppEsz, int m, int n, int leadingDim, S *)
	MatrixHelper (const MatrixHelper &, int i, int j, int nrow, int ncol)
	MatrixHelper (MatrixHelper &, int i, int j, int nrow, int ncol)
	MatrixHelper (const MatrixHelper< typename CNT< S >::THerm > &, const TransposeView &)
	MatrixHelper (MatrixHelper< typename CNT< S >::THerm > &, const TransposeView &)
	MatrixHelper (const MatrixHelper &, const DiagonalView &)
	MatrixHelper (MatrixHelper &, const DiagonalView &)
	MatrixHelper (const MatrixHelper &, const ShallowCopy &)
	MatrixHelper (MatrixHelper &, const ShallowCopy &)
	MatrixHelper (const MatrixHelper &, const DeepCopy &)
	MatrixHelper (const MatrixHelper< typename CNT< S >::TNeg > &, const DeepCopy &)
MatrixHelper &	copyAssign (const MatrixHelper &)
MatrixHelper &	negatedCopyAssign (const MatrixHelper< typename CNT< S >::TNeg > &)
MatrixHelper &	readOnlyViewAssign (const MatrixHelper &)
MatrixHelper &	writableViewAssign (MatrixHelper &)
const S *	getElt (int i, int j) const
S *	updElt (int i, int j)
void	sum (S *eltp) const
void	colSum (int j, S *eltp) const
void	rowSum (int i, S *eltp) const
void	addIn (const MatrixHelper &)
void	addIn (const MatrixHelper< typename CNT< S >::TNeg > &)
void	subIn (const MatrixHelper &)
void	subIn (const MatrixHelper< typename CNT< S >::TNeg > &)
void	fillWith (const S *eltp)
void	copyInByRows (const S *elts)
void	fillWithScalar (const StdNumber &)
void	scaleBy (const StdNumber &)
S	scalarSum () const
S	scalarColSum (int j) const
S	scalarRowSum (int i) const
void	invertInPlace ()
void	dump (const char *msg=0) const
template<class SA, class SB>
void	matmul (const StdNumber &beta, const StdNumber &alpha, const MatrixHelper< SA > &A, const MatrixHelper< SB > &B)
const S &	getScalar (int i, int j) const
S &	updScalar (int i, int j)
int	nrow () const
int	ncol () const
long	size () const
void	resize (int m, int n)
void	resizeKeep (int m, int n)
void	lockNRows ()
void	lockNCols ()
void	lockShape ()
void	unlockNRows ()
void	unlockNCols ()
void	unlockShape ()
void	setMatrixStructure (MatrixStructures::Structure)
MatrixStructures::Structure	getMatrixStructure () const
void	setMatrixShape (MatrixShapes::Shape)
MatrixShapes::Shape	getMatrixShape () const
void	setMatrixSparsity (MatrixSparseFormats::Sparsity)
MatrixSparseFormats::Sparsity	getMatrixSparsity () const
void	setMatrixStorage (MatrixStorageFormats::Storage)
MatrixStorageFormats::Storage	getMatrixStorage () const
void	setMatrixCondition (MatrixConditions::Condition)
MatrixConditions::Condition	getMatrixCondition () const
bool	hasContiguousData () const
long	getContiguousDataLength () const
const S *	getContiguousData () const
S *	updContiguousData ()
void	replaceContiguousData (S *newData, long length, bool takeOwnership)
void	replaceContiguousData (const S *newData, long length)
void	swapOwnedContiguousData (S *newData, int length, S *&oldData)
Public Attributes
class MatrixHelperRep< S > *	rep
Classes
class	DeepCopy
class	DiagonalView
class	ShallowCopy
class	TransposeView

---

Constructor & Destructor Documentation

~MatrixHelper

(

)

MatrixHelper	(	int	esz,
		int	cppEsz
	)			[explicit]

MatrixHelper	(	int	esz,
		int	cppEsz,
		int	m,
		int	n,
		bool	lockNrow = false,
		bool	lockNcol = false
	)

MatrixHelper	(	int	esz,
		int	cppEsz,
		int	m,
		int	n,
		int	leadingDim,
		const S *
	)

MatrixHelper	(	int	esz,
		int	cppEsz,
		int	m,
		int	n,
		int	leadingDim,
		S *
	)

MatrixHelper	(	const MatrixHelper< S > &	,
		int	i,
		int	j,
		int	nrow,
		int	ncol
	)

MatrixHelper	(	MatrixHelper< S > &	,
		int	i,
		int	j,
		int	nrow,
		int	ncol
	)

MatrixHelper	(	const MatrixHelper< typename CNT< S >::THerm > &	,
		const TransposeView &
	)

MatrixHelper	(	MatrixHelper< typename CNT< S >::THerm > &	,
		const TransposeView &
	)

MatrixHelper	(	const MatrixHelper< S > &	,
		const DiagonalView &
	)

MatrixHelper	(	MatrixHelper< S > &	,
		const DiagonalView &
	)

MatrixHelper	(	const MatrixHelper< S > &	,
		const ShallowCopy &
	)

MatrixHelper	(	MatrixHelper< S > &	,
		const ShallowCopy &
	)

MatrixHelper	(	const MatrixHelper< S > &	,
		const DeepCopy &
	)

MatrixHelper	(	const MatrixHelper< typename CNT< S >::TNeg > &	,
		const DeepCopy &
	)

---

Member Function Documentation

void clear

(

)

Referenced by MatrixBase< SimTK::Vec< N > >::clear().

MatrixHelper& copyAssign

(

const MatrixHelper< S > &

)

Referenced by MatrixBase< SimTK::Vec< N > >::copyAssign().

MatrixHelper& negatedCopyAssign

(

const MatrixHelper< typename CNT< S >::TNeg > &

)

MatrixHelper& readOnlyViewAssign

(

const MatrixHelper< S > &

)

MatrixHelper& writableViewAssign

(

MatrixHelper< S > &

)

Referenced by MatrixBase< SimTK::Vec< N > >::viewAssign().

const S* getElt	(	int	i,
		int	j
	)			const

Referenced by MatrixBase< SimTK::Vec< N > >::getElt().

S* updElt	(	int	i,
		int	j
	)

Referenced by MatrixBase< SimTK::Vec< N > >::updElt().

void sum

(

S *

eltp

)

const

Referenced by RowVectorBase::sum(), and VectorBase< SimTK::Vec< N > >::sum().

void colSum	(	int	j,
		S *	eltp
	)			const

Referenced by MatrixBase< SimTK::Vec< N > >::sum().

void rowSum	(	int	i,
		S *	eltp
	)			const

void addIn

(

const MatrixHelper< S > &

)

Referenced by MatrixBase< SimTK::Vec< N > >::operator+=().

void addIn

(

const MatrixHelper< typename CNT< S >::TNeg > &

)

void subIn

(

const MatrixHelper< S > &

)

Referenced by MatrixBase< SimTK::Vec< N > >::operator-=().

void subIn

(

const MatrixHelper< typename CNT< S >::TNeg > &

)

void fillWith

(

const S *

eltp

)

Referenced by MatrixBase< SimTK::Vec< N > >::MatrixBase(), and MatrixBase< SimTK::Vec< N > >::setTo().

void copyInByRows

(

const S *

elts

)

Referenced by MatrixBase< SimTK::Vec< N > >::MatrixBase().

void fillWithScalar

(

const StdNumber &

)

Referenced by MatrixBase< SimTK::Vec< N > >::setToNaN(), and MatrixBase< SimTK::Vec< N > >::setToZero().

void scaleBy

(

const StdNumber &

)

Referenced by MatrixBase< SimTK::Vec< N > >::operator*=(), and MatrixBase< SimTK::Vec< N > >::operator/=().

S scalarSum

(

)

const

S scalarColSum

(

int

j

)

const

S scalarRowSum

(

int

i

)

const

void invertInPlace

(

)

Referenced by MatrixBase< SimTK::Vec< N > >::invert().

void dump

(

const char *

msg = 0

)

const

Referenced by MatrixBase< SimTK::Vec< N > >::dump().

void matmul	(	const StdNumber &	beta,
		const StdNumber &	alpha,
		const MatrixHelper< SA > &	A,
		const MatrixHelper< SB > &	B
	)			[inline]

Referenced by MatrixBase< SimTK::Vec< N > >::matmul().

const S& getScalar	(	int	i,
		int	j
	)			const

S& updScalar	(	int	i,
		int	j
	)

int nrow

(

)

const

Referenced by MatrixBase< SimTK::Vec< N > >::nrow().

int ncol

(

)

const

Referenced by MatrixBase< SimTK::Vec< N > >::ncol().

long size

(

)

const

Referenced by MatrixBase< SimTK::Vec< N > >::size().

void resize	(	int	m,
		int	n
	)

Referenced by MatrixBase< SimTK::Vec< N > >::resize().

void resizeKeep	(	int	m,
		int	n
	)

Referenced by MatrixBase< SimTK::Vec< N > >::resizeKeep().

void lockNRows

(

)

Referenced by MatrixBase< SimTK::Vec< N > >::lockNRows().

void lockNCols

(

)

Referenced by MatrixBase< SimTK::Vec< N > >::lockNCols().

void lockShape

(

)

Referenced by MatrixBase< SimTK::Vec< N > >::lockShape().

void unlockNRows

(

)

Referenced by MatrixBase< SimTK::Vec< N > >::unlockNRows().

void unlockNCols

(

)

Referenced by MatrixBase< SimTK::Vec< N > >::unlockNCols().

void unlockShape

(

)

Referenced by MatrixBase< SimTK::Vec< N > >::unlockShape().

void setMatrixStructure

(

MatrixStructures::Structure

)

Referenced by MatrixBase< SimTK::Vec< N > >::setMatrixStructure().

MatrixStructures::Structure getMatrixStructure

(

)

const

Referenced by MatrixBase< SimTK::Vec< N > >::getMatrixStructure().

void setMatrixShape

(

MatrixShapes::Shape

)

Referenced by MatrixBase< SimTK::Vec< N > >::setMatrixShape().

MatrixShapes::Shape getMatrixShape

(

)

const

Referenced by MatrixBase< SimTK::Vec< N > >::getMatrixShape().

void setMatrixSparsity

(

MatrixSparseFormats::Sparsity

)

Referenced by MatrixBase< SimTK::Vec< N > >::setMatrixSparsity().

MatrixSparseFormats::Sparsity getMatrixSparsity

(

)

const

Referenced by MatrixBase< SimTK::Vec< N > >::getMatrixSparsity().

void setMatrixStorage

(

MatrixStorageFormats::Storage

)

Referenced by MatrixBase< SimTK::Vec< N > >::setMatrixStorage().

MatrixStorageFormats::Storage getMatrixStorage

(

)

const

Referenced by MatrixBase< SimTK::Vec< N > >::getMatrixStorage().

void setMatrixCondition

(

MatrixConditions::Condition

)

Referenced by MatrixBase< SimTK::Vec< N > >::setMatrixCondition().

MatrixConditions::Condition getMatrixCondition

(

)

const

Referenced by MatrixBase< SimTK::Vec< N > >::getMatrixCondition().

bool hasContiguousData

(

)

const

Referenced by MatrixBase< SimTK::Vec< N > >::hasContiguousData().

long getContiguousDataLength

(

)

const

Referenced by MatrixBase< SimTK::Vec< N > >::getContiguousScalarDataLength().

const S* getContiguousData

(

)

const

Referenced by MatrixBase< SimTK::Vec< N > >::getContiguousScalarData().

S* updContiguousData

(

)

Referenced by MatrixBase< SimTK::Vec< N > >::updContiguousScalarData().

void replaceContiguousData	(	S *	newData,
		long	length,
		bool	takeOwnership
	)

Referenced by MatrixBase< SimTK::Vec< N > >::replaceContiguousScalarData().

void replaceContiguousData	(	const S *	newData,
		long	length
	)

void swapOwnedContiguousData	(	S *	newData,
		int	length,
		S *&	oldData
	)

Referenced by MatrixBase< SimTK::Vec< N > >::swapOwnedContiguousScalarData().

---

Member Data Documentation

class MatrixHelperRep< S >* rep

---

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

• MatrixHelper.h