This is a dataless rehash of the MatrixBase class to specialize it for Vectors. More...

#include <BigMatrix.h>

Inheritance diagram for SimTK::VectorBase< ELT >:

Classes
struct	EltResult
Public Member Functions
VectorBase &	operator= (const VectorBase &b)
	Copy assignment is deep copy but behavior depends on type of lhs: if view, rhs must match.
VectorBase &	operator*= (const StdNumber &t)
VectorBase &	operator/= (const StdNumber &t)
VectorBase &	operator+= (const VectorBase &r)
VectorBase &	operator-= (const VectorBase &r)
template<class EE >
VectorBase &	operator= (const VectorBase< EE > &b)
template<class EE >
VectorBase &	operator+= (const VectorBase< EE > &b)
template<class EE >
VectorBase &	operator-= (const VectorBase< EE > &b)
VectorBase &	operator= (const ELT &t)
	Fill current allocation with copies of element.
template<class EE >
VectorBase &	rowScaleInPlace (const VectorBase< EE > &v)
	There's only one column here so it's a bit wierd to use rowScale rather than elementwiseMultiply, but there's nothing really wrong with it.
template<class EE >
void	rowScale (const VectorBase< EE > &v, typename EltResult< EE >::Mul &out) const
	Return type is a new matrix which will have the same dimensions as 'this' but will have element types appropriate for the elementwise multiply being performed.
template<class EE >
EltResult< EE >::Mul	rowScale (const VectorBase< EE > &v) const
VectorBase &	elementwiseInvertInPlace ()
	Set this[i] = this[i]^-1.
void	elementwiseInvert (VectorBase< typename CNT< ELT >::TInvert > &out) const
	Set supplied out[i] = this[i]^-1.
VectorBase< typename CNT< ELT > ::TInvert >	elementwiseInvert () const
	Return out[i]=this[i]^-1 as function return.
template<class EE >
VectorBase &	elementwiseMultiplyInPlace (const VectorBase< EE > &r)
template<class EE >
void	elementwiseMultiply (const VectorBase< EE > &v, typename EltResult< EE >::Mul &out) const
template<class EE >
EltResult< EE >::Mul	elementwiseMultiply (const VectorBase< EE > &v) const
template<class EE >
VectorBase &	elementwiseMultiplyFromLeftInPlace (const VectorBase< EE > &r)
template<class EE >
void	elementwiseMultiplyFromLeft (const VectorBase< EE > &v, typename VectorBase< EE >::template EltResult< ELT >::Mul &out) const
template<class EE >
VectorBase< EE >::template EltResult< ELT >::Mul	elementwiseMultiplyFromLeft (const VectorBase< EE > &v) const
template<class EE >
VectorBase &	elementwiseDivideInPlace (const VectorBase< EE > &r)
template<class EE >
void	elementwiseDivide (const VectorBase< EE > &v, typename EltResult< EE >::Dvd &out) const
template<class EE >
EltResult< EE >::Dvd	elementwiseDivide (const VectorBase< EE > &v) const
template<class EE >
VectorBase &	elementwiseDivideFromLeftInPlace (const VectorBase< EE > &r)
template<class EE >
void	elementwiseDivideFromLeft (const VectorBase< EE > &v, typename VectorBase< EE >::template EltResult< ELT >::Dvd &out) const
template<class EE >
VectorBase< EE >::template EltResult< ELT >::Dvd	elementwiseDivideFromLeft (const VectorBase< EE > &v) const
	operator const Vector_< ELT > & () const
	operator Vector_< ELT > & ()
	operator const VectorView_< ELT > & () const
	operator VectorView_< ELT > & ()
	operator const Matrix_< ELT > & () const
	operator Matrix_< ELT > & ()
	operator const MatrixView_< ELT > & () const
	operator MatrixView_< ELT > & ()
int	size () const
int	nrow () const
	Return the number of rows m in the logical shape of this matrix.
int	ncol () const
	Return the number of columns n in the logical shape of this matrix.
ptrdiff_t	nelt () const
	Return the number of elements in the logical shape of this matrix.
TAbs	abs () const
	abs() with the result as a function return.
const ELT &	operator[] (int i) const
ELT &	operator[] (int i)
const ELT &	operator() (int i) const
ELT &	operator() (int i)
VectorView_< ELT >	operator() (int i, int m) const
VectorView_< ELT >	operator() (int i, int m)
VectorView_< ELT >	index (const Array_< int > &indices) const
VectorView_< ELT >	updIndex (const Array_< int > &indices)
VectorView_< ELT >	operator() (const Array_< int > &indices) const
VectorView_< ELT >	operator() (const Array_< int > &indices)
THerm	transpose () const
THerm	updTranspose ()
THerm	operator~ () const
THerm	operator~ ()
const VectorBase &	operator+ () const
const TNeg &	negate () const
TNeg &	updNegate ()
const TNeg &	operator- () const
TNeg &	operator- ()
VectorBase &	resize (int m)
VectorBase &	resizeKeep (int m)
void	clear ()
	This restores the MatrixBase to the state it would be in had it been constructed specifying only its handle commitment.
ELT	sum () const
	Form the column sums of this matrix, returned as a RowVector.
VectorIterator< ELT, VectorBase< ELT > >	begin ()
VectorIterator< ELT, VectorBase< ELT > >	end ()
VectorBase "owner" construction
These constructors create new VectorBase objects which own their own data and are (at least by default) resizable. The resulting matrices are m X 1 with the number of columns locked at 1. If there is any data allocated but not explicitly initialized, that data will be uninitialized garbage in Release builds but will be initialized to NaN (at a performance cost) in Debug builds.
	VectorBase (int m=0)
	Default constructor makes a 0x1 matrix locked at 1 column; you can provide an initial allocation if you want.
	VectorBase (const VectorBase &source)
	Copy constructor is a deep copy (not appropriate for views!).
	VectorBase (const TNeg &source)
	Implicit conversion from compatible vector with negated elements.
	VectorBase (int m, const ELT &initialValue)
	Construct an owner vector of length m, with each element initialized to the given value.
	VectorBase (int m, const ELT *cppInitialValues)
	Construct an owner vector of length m, with the elements initialized sequentially from a C++ array of elements which is assumed to be of length m.
VectorBase construction from pre-existing data
Construct a non-resizeable, VectorBase view of externally supplied data. Note that stride should be interpreted as "the number of scalars between elements" and for composite elements may have a different value if the source is a C++ array of elements vs. a Simmatrix packed data array. We provide constructors for both read-only and writable external data.
	VectorBase (int m, int stride, const Scalar *s)
	Construct a read-only view of existing data.
	VectorBase (int m, int stride, Scalar *s)
	Construct a writable view into existing data.
VectorBase construction from an existing Helper.
Create a new VectorBase from an existing helper. Both shallow (view) and deep copies are possible. For shallow copies, there is a constructor providing a read-only view of the original data and one providing a writable view into the original data.
	VectorBase (MatrixHelper< Scalar > &h, const typename MatrixHelper< Scalar >::ShallowCopy &s)
	Construct a writable view into the source data.
	VectorBase (const MatrixHelper< Scalar > &h, const typename MatrixHelper< Scalar >::ShallowCopy &s)
	Construct a read-only view of the source data.
	VectorBase (const MatrixHelper< Scalar > &h, const typename MatrixHelper< Scalar >::DeepCopy &d)
	Construct a new owner vector initialized with the data from the source.
Protected Member Functions
	VectorBase (MatrixHelperRep< Scalar > *hrep)

Detailed Description

template<class ELT>
class SimTK::VectorBase< ELT >

This is a dataless rehash of the MatrixBase class to specialize it for Vectors.

This mostly entails overriding a few of the methods. Note that all the MatrixBase operations remain available if you static_cast<> this up to a MatrixBase.

Constructor & Destructor Documentation

template<class ELT>

SimTK::VectorBase< ELT >::VectorBase ( int m = 0 ) [inline, explicit]

Default constructor makes a 0x1 matrix locked at 1 column; you can provide an initial allocation if you want.

template<class ELT>

SimTK::VectorBase< ELT >::VectorBase ( const VectorBase< ELT > & source ) [inline]

Copy constructor is a deep copy (not appropriate for views!).

That means it creates a new, densely packed vector whose elements are initialized from the source object.

template<class ELT>

SimTK::VectorBase< ELT >::VectorBase ( const TNeg & source ) [inline]

Implicit conversion from compatible vector with negated elements.

template<class ELT>

SimTK::VectorBase< ELT >::VectorBase	(	int	m,
		const ELT &	initialValue
	)		`[inline]`

Construct an owner vector of length m, with each element initialized to the given value.

template<class ELT>

SimTK::VectorBase< ELT >::VectorBase	(	int	m,
		const ELT *	cppInitialValues
	)		`[inline]`

Construct an owner vector of length m, with the elements initialized sequentially from a C++ array of elements which is assumed to be of length m.

Note that we are expecting C++ packing; don't use this to initialize one Simmatrix vector from another because Simmatrix may pack its elements more densely than C++.

template<class ELT>

SimTK::VectorBase< ELT >::VectorBase	(	int	m,
		int	stride,
		const Scalar *	s
	)		`[inline]`

Construct a read-only view of existing data.

template<class ELT>

SimTK::VectorBase< ELT >::VectorBase	(	int	m,
		int	stride,
		Scalar *	s
	)		`[inline]`

Construct a writable view into existing data.

template<class ELT>

SimTK::VectorBase< ELT >::VectorBase	(	MatrixHelper< Scalar > &	h,
		const typename MatrixHelper< Scalar >::ShallowCopy &	s
	)		`[inline]`

Construct a writable view into the source data.

template<class ELT>

SimTK::VectorBase< ELT >::VectorBase	(	const MatrixHelper< Scalar > &	h,
		const typename MatrixHelper< Scalar >::ShallowCopy &	s
	)		`[inline]`

Construct a read-only view of the source data.

template<class ELT>

SimTK::VectorBase< ELT >::VectorBase	(	const MatrixHelper< Scalar > &	h,
		const typename MatrixHelper< Scalar >::DeepCopy &	d
	)		`[inline]`

Construct a new owner vector initialized with the data from the source.

template<class ELT>

SimTK::VectorBase< ELT >::VectorBase ( MatrixHelperRep< Scalar > * hrep ) [inline, explicit, protected]

Member Function Documentation

template<class ELT>

VectorBase& SimTK::VectorBase< ELT >::operator= ( const VectorBase< ELT > & b ) [inline]

Copy assignment is deep copy but behavior depends on type of lhs: if view, rhs must match.

If owner, we reallocate and copy rhs.

template<class ELT>

VectorBase& SimTK::VectorBase< ELT >::operator*= ( const StdNumber & t ) [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

Reimplemented in SimTK::VectorView_< ELT >, SimTK::Vector_< ELT >, SimTK::Vector_< T >, and SimTK::Vector_< Real >.

template<class ELT>

VectorBase& SimTK::VectorBase< ELT >::operator/= ( const StdNumber & t ) [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

Reimplemented in SimTK::VectorView_< ELT >, SimTK::Vector_< ELT >, SimTK::Vector_< T >, and SimTK::Vector_< Real >.

template<class ELT>

VectorBase& SimTK::VectorBase< ELT >::operator+= ( const VectorBase< ELT > & r ) [inline]

template<class ELT>

VectorBase& SimTK::VectorBase< ELT >::operator-= ( const VectorBase< ELT > & r ) [inline]

template<class ELT>

template<class EE >

VectorBase& SimTK::VectorBase< ELT >::operator= ( const VectorBase< EE > & b ) [inline]

Reimplemented in SimTK::VectorView_< ELT >, SimTK::Vector_< ELT >, SimTK::Vector_< T >, and SimTK::Vector_< Real >.

template<class ELT>

template<class EE >

VectorBase& SimTK::VectorBase< ELT >::operator+= ( const VectorBase< EE > & b ) [inline]

Reimplemented in SimTK::VectorView_< ELT >, SimTK::Vector_< ELT >, SimTK::Vector_< T >, and SimTK::Vector_< Real >.

template<class ELT>

template<class EE >

VectorBase& SimTK::VectorBase< ELT >::operator-= ( const VectorBase< EE > & b ) [inline]

Reimplemented in SimTK::VectorView_< ELT >, SimTK::Vector_< ELT >, SimTK::Vector_< T >, and SimTK::Vector_< Real >.

template<class ELT>

VectorBase& SimTK::VectorBase< ELT >::operator= ( const ELT & t ) [inline]

Fill current allocation with copies of element.

Note that this is not the same behavior as assignment for Matrices, where only the diagonal is set (and everything else is set to zero.)

Reimplemented from SimTK::MatrixBase< ELT >.

Reimplemented in SimTK::VectorView_< ELT >, SimTK::Vector_< ELT >, SimTK::Vector_< T >, and SimTK::Vector_< Real >.

template<class ELT>

template<class EE >

VectorBase& SimTK::VectorBase< ELT >::rowScaleInPlace ( const VectorBase< EE > & v ) [inline]

There's only one column here so it's a bit wierd to use rowScale rather than elementwiseMultiply, but there's nothing really wrong with it.

Using colScale would be really wacky since it is the same as a scalar multiply. We won't support colScale here except through inheritance where it will not be much use.

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

template<class EE >

void SimTK::VectorBase< ELT >::rowScale	(	const VectorBase< EE > &	r,
		typename EltResult< EE >::Mul &	out
	)		const `[inline]`

Return type is a new matrix which will have the same dimensions as 'this' but will have element types appropriate for the elementwise multiply being performed.

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

template<class EE >

EltResult<EE>::Mul SimTK::VectorBase< ELT >::rowScale ( const VectorBase< EE > & v ) const [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

VectorBase& SimTK::VectorBase< ELT >::elementwiseInvertInPlace ( ) [inline]

Set this[i] = this[i]^-1.

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

void SimTK::VectorBase< ELT >::elementwiseInvert ( VectorBase< typename CNT< ELT >::TInvert > & out ) const [inline]

Set supplied out[i] = this[i]^-1.

template<class ELT>

VectorBase<typename CNT<ELT>::TInvert> SimTK::VectorBase< ELT >::elementwiseInvert ( ) const [inline]

Return out[i]=this[i]^-1 as function return.

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

template<class EE >

VectorBase& SimTK::VectorBase< ELT >::elementwiseMultiplyInPlace ( const VectorBase< EE > & r ) [inline]

template<class ELT>

template<class EE >

void SimTK::VectorBase< ELT >::elementwiseMultiply	(	const VectorBase< EE > &	v,
		typename EltResult< EE >::Mul &	out
	)		const `[inline]`

template<class ELT>

template<class EE >

EltResult<EE>::Mul SimTK::VectorBase< ELT >::elementwiseMultiply ( const VectorBase< EE > & v ) const [inline]

template<class ELT>

template<class EE >

VectorBase& SimTK::VectorBase< ELT >::elementwiseMultiplyFromLeftInPlace ( const VectorBase< EE > & r ) [inline]

template<class ELT>

template<class EE >

void SimTK::VectorBase< ELT >::elementwiseMultiplyFromLeft	(	const VectorBase< EE > &	v,
		typename VectorBase< EE >::template EltResult< ELT >::Mul &	out
	)		const `[inline]`

template<class ELT>

template<class EE >

VectorBase<EE>::template EltResult<ELT>::Mul SimTK::VectorBase< ELT >::elementwiseMultiplyFromLeft ( const VectorBase< EE > & v ) const [inline]

template<class ELT>

template<class EE >

VectorBase& SimTK::VectorBase< ELT >::elementwiseDivideInPlace ( const VectorBase< EE > & r ) [inline]

template<class ELT>

template<class EE >

void SimTK::VectorBase< ELT >::elementwiseDivide	(	const VectorBase< EE > &	v,
		typename EltResult< EE >::Dvd &	out
	)		const `[inline]`

template<class ELT>

template<class EE >

EltResult<EE>::Dvd SimTK::VectorBase< ELT >::elementwiseDivide ( const VectorBase< EE > & v ) const [inline]

template<class ELT>

template<class EE >

VectorBase& SimTK::VectorBase< ELT >::elementwiseDivideFromLeftInPlace ( const VectorBase< EE > & r ) [inline]

template<class ELT>

template<class EE >

void SimTK::VectorBase< ELT >::elementwiseDivideFromLeft	(	const VectorBase< EE > &	v,
		typename VectorBase< EE >::template EltResult< ELT >::Dvd &	out
	)		const `[inline]`

template<class ELT>

template<class EE >

VectorBase<EE>::template EltResult<ELT>::Dvd SimTK::VectorBase< ELT >::elementwiseDivideFromLeft ( const VectorBase< EE > & v ) const [inline]

template<class ELT>

SimTK::VectorBase< ELT >::operator const Vector_< ELT > & ( ) const [inline]

template<class ELT>

SimTK::VectorBase< ELT >::operator Vector_< ELT > & ( ) [inline]

template<class ELT>

SimTK::VectorBase< ELT >::operator const VectorView_< ELT > & ( ) const [inline]

template<class ELT>

SimTK::VectorBase< ELT >::operator VectorView_< ELT > & ( ) [inline]

template<class ELT>

SimTK::VectorBase< ELT >::operator const Matrix_< ELT > & ( ) const [inline]

template<class ELT>

SimTK::VectorBase< ELT >::operator Matrix_< ELT > & ( ) [inline]

template<class ELT>

SimTK::VectorBase< ELT >::operator const MatrixView_< ELT > & ( ) const [inline]

template<class ELT>

SimTK::VectorBase< ELT >::operator MatrixView_< ELT > & ( ) [inline]

template<class ELT>

int SimTK::VectorBase< ELT >::size ( ) const [inline]

template<class ELT>

int SimTK::VectorBase< ELT >::nrow ( ) const [inline]

Return the number of rows m in the logical shape of this matrix.

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

int SimTK::VectorBase< ELT >::ncol ( ) const [inline]

Return the number of columns n in the logical shape of this matrix.

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

ptrdiff_t SimTK::VectorBase< ELT >::nelt ( ) const [inline]

Return the number of elements in the logical shape of this matrix.

This has nothing to do with how many elements are actually stored; it is simply the product of the logical number of rows and columns, that is, nrow()*ncol(). Note that although each dimension is limited to a 32 bit size, the product of those dimensions may be > 32 bits on a 64 bit machine so the return type may be larger than that of nrow() and ncol().

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

TAbs SimTK::VectorBase< ELT >::abs ( ) const [inline]

abs() with the result as a function return.

More convenient than the other abs() member function, but may involve an additional copy of the matrix.

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

const ELT& SimTK::VectorBase< ELT >::operator[] ( int i ) const [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

ELT& SimTK::VectorBase< ELT >::operator[] ( int i ) [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

const ELT& SimTK::VectorBase< ELT >::operator() ( int i ) const [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

ELT& SimTK::VectorBase< ELT >::operator() ( int i ) [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

VectorView_<ELT> SimTK::VectorBase< ELT >::operator()	(	int	i,
		int	m
	)		const `[inline]`

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

VectorView_<ELT> SimTK::VectorBase< ELT >::operator()	(	int	i,
		int	m
	)		`[inline]`

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

VectorView_<ELT> SimTK::VectorBase< ELT >::index ( const Array_< int > & indices ) const [inline]

template<class ELT>

VectorView_<ELT> SimTK::VectorBase< ELT >::updIndex ( const Array_< int > & indices ) [inline]

template<class ELT>

VectorView_<ELT> SimTK::VectorBase< ELT >::operator() ( const Array_< int > & indices ) const [inline]

template<class ELT>

VectorView_<ELT> SimTK::VectorBase< ELT >::operator() ( const Array_< int > & indices ) [inline]

template<class ELT>

THerm SimTK::VectorBase< ELT >::transpose ( ) const [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

THerm SimTK::VectorBase< ELT >::updTranspose ( ) [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

THerm SimTK::VectorBase< ELT >::operator~ ( ) const [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

THerm SimTK::VectorBase< ELT >::operator~ ( ) [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

const VectorBase& SimTK::VectorBase< ELT >::operator+ ( ) const [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

const TNeg& SimTK::VectorBase< ELT >::negate ( ) const [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

TNeg& SimTK::VectorBase< ELT >::updNegate ( ) [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

const TNeg& SimTK::VectorBase< ELT >::operator- ( ) const [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

TNeg& SimTK::VectorBase< ELT >::operator- ( ) [inline]

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

VectorBase& SimTK::VectorBase< ELT >::resize ( int m ) [inline]

template<class ELT>

VectorBase& SimTK::VectorBase< ELT >::resizeKeep ( int m ) [inline]

template<class ELT>

void SimTK::VectorBase< ELT >::clear ( ) [inline]

This restores the MatrixBase to the state it would be in had it been constructed specifying only its handle commitment.

The size will have been reduced to the smallest size consistent with the commitment.

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

ELT SimTK::VectorBase< ELT >::sum ( ) const [inline]

Form the column sums of this matrix, returned as a RowVector.

Reimplemented from SimTK::MatrixBase< ELT >.

template<class ELT>

VectorIterator<ELT, VectorBase<ELT> > SimTK::VectorBase< ELT >::begin ( ) [inline]

template<class ELT>

VectorIterator<ELT, VectorBase<ELT> > SimTK::VectorBase< ELT >::end ( ) [inline]

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

BigMatrix.h

SimTK::VectorBase< ELT > Class Template Reference

Classes

Public Member Functions

Protected Member Functions

Detailed Description

template<class ELT> class SimTK::VectorBase< ELT >

Constructor & Destructor Documentation

Member Function Documentation

template<class ELT>
class SimTK::VectorBase< ELT >