Matrix_< ELT > Class Template Reference

This is the Matrix class intended to appear in user code. More...

#include <BigMatrix.h>

Inheritance diagram for Matrix_< ELT >:

List of all members.

Public Member Functions
	Matrix_ ()
	Matrix_ (const MatrixCommitment &mc)
	Matrix_ (const Matrix_ &src)
Matrix_ &	operator= (const Matrix_ &src)
	Matrix_ (const Base &v)
	Matrix_ (const BaseNeg &v)
	Matrix_ (int m, int n)
	Matrix_ (int m, int n, const ELT *cppInitialValuesByRow)
	Matrix_ (int m, int n, const ELT &initialValue)
	Matrix_ (int m, int n, int leadingDim, const S *data)
	Matrix_ (int m, int n, int leadingDim, S *data)
template<int M, int N, int CS, int RS>
	Matrix_ (const Mat< M, N, ELT, CS, RS > &mat)
	Convert a Mat to a Matrix_.
Matrix_ &	operator= (const ELT &v)
	Matrix assignment to an element sets only the *diagonal* elements to the indicated value; everything else is set to zero.
template<class EE >
Matrix_ &	operator= (const MatrixBase< EE > &m)
template<class EE >
Matrix_ &	operator+= (const MatrixBase< EE > &m)
template<class EE >
Matrix_ &	operator-= (const MatrixBase< EE > &m)
Matrix_ &	operator*= (const StdNumber &t)
Matrix_ &	operator/= (const StdNumber &t)
Matrix_ &	operator+= (const ELT &r)
Matrix_ &	operator-= (const ELT &r)
const TNeg &	negate () const
TNeg &	updNegate ()
const TNeg &	operator- () const
TNeg &	operator- ()

---

Detailed Description

template<class ELT>
class SimTK::Matrix_< ELT >

This is the Matrix class intended to appear in user code.

It can be a fixed-size view of someone else's data, or can be a resizable data owner itself.

---

Constructor & Destructor Documentation

Matrix_

(

)

[inline]

Matrix_

(

const MatrixCommitment &

mc

)

[inline]

Matrix_

(

const Matrix_< ELT > &

src

)

[inline]

Matrix_

(

const Base &

v

)

[inline]

Matrix_

(

const BaseNeg &

v

)

[inline]

Matrix_	(	int	m,
		int	n
	)			[inline]

Matrix_	(	int	m,
		int	n,
		const ELT *	cppInitialValuesByRow
	)			[inline]

Matrix_	(	int	m,
		int	n,
		const ELT &	initialValue
	)			[inline]

Matrix_	(	int	m,
		int	n,
		int	leadingDim,
		const S *	data
	)			[inline]

Matrix_	(	int	m,
		int	n,
		int	leadingDim,
		S *	data
	)			[inline]

Matrix_

(

const Mat< M, N, ELT, CS, RS > &

mat

)

[inline, explicit]

Convert a Mat to a Matrix_.

References MatrixBase< ELT >::updElt().

---

Member Function Documentation

const TNeg& negate

(

)

const [inline]

Reimplemented from MatrixBase< ELT >.

Referenced by Matrix_< ELT >::operator-().

Matrix_& operator*=

(

const StdNumber &

t

)

[inline]

Reimplemented from MatrixBase< ELT >.

References MatrixBase< ELT >::operator*=().

Matrix_& operator+=

(

const ELT &

r

)

[inline]

References MatrixBase< ELT >::updDiag().

Matrix_& operator+=

(

const MatrixBase< EE > &

m

)

[inline]

References MatrixBase< ELT >::operator+=().

TNeg& operator-

(

)

[inline]

Reimplemented from MatrixBase< ELT >.

References Matrix_< ELT >::updNegate().

const TNeg& operator-

(

)

const [inline]

Reimplemented from MatrixBase< ELT >.

References Matrix_< ELT >::negate().

Matrix_& operator-=

(

const ELT &

r

)

[inline]

References MatrixBase< ELT >::updDiag().

Matrix_& operator-=

(

const MatrixBase< EE > &

m

)

[inline]

References MatrixBase< ELT >::operator-=().

Matrix_& operator/=

(

const StdNumber &

t

)

[inline]

Reimplemented from MatrixBase< ELT >.

References MatrixBase< ELT >::operator/=().

Matrix_& operator=

(

const MatrixBase< EE > &

m

)

[inline]

References MatrixBase< ELT >::operator=().

Matrix_& operator=

(

const ELT &

t

)

[inline]

Matrix assignment to an element sets only the *diagonal* elements to the indicated value; everything else is set to zero.

This is particularly useful for setting a Matrix to zero or to the identity; for other values it creates a Matrix which acts like the scalar. That is, if the scalar is s and we do M=s, then multiplying another Matrix B by the resulting diagonal matrix M gives the same result as multiplying B by s. That is (M=s)*B == s*B.

NOTE: this must be overridden for Vector and RowVector since then scalar assignment is defined to copy the scalar to every element.

Reimplemented from MatrixBase< ELT >.

References MatrixBase< ELT >::operator=().

Matrix_& operator=

(

const Matrix_< ELT > &

src

)

[inline]

Reimplemented from MatrixBase< ELT >.

References MatrixBase< ELT >::operator=().

TNeg& updNegate

(

)

[inline]

Reimplemented from MatrixBase< ELT >.

Referenced by Matrix_< ELT >::operator-().

---

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

• BigMatrix.h