VectorBase Class Template Reference

#include <BigMatrix.h>

Inheritance diagram for VectorBase:

List of all members.

---

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.

Public Member Functions
	VectorBase ()
	VectorBase (const VectorBase &b)
VectorBase &	operator= (const VectorBase &b)
	VectorBase (int m, bool lockNrow=false)
	VectorBase (int m, int leadingDim, const Scalar *s)
	VectorBase (int m, int leadingDim, Scalar *s)
	VectorBase (int m, const ELT &t)
	VectorBase (int m, bool lockNrow, const ELT &t)
	VectorBase (int m, const ELT *p)
	VectorBase (int m, bool lockNrow, const ELT *p)
	VectorBase (MatrixHelper< Scalar > &h, const typename MatrixHelper< Scalar >::ShallowCopy &s)
	VectorBase (const MatrixHelper< Scalar > &h, const typename MatrixHelper< Scalar >::ShallowCopy &s)
	VectorBase (const MatrixHelper< Scalar > &h, const typename MatrixHelper< Scalar >::DeepCopy &d)
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)
template<class EE>
VectorBase &	rowScaleInPlace (const VectorBase< EE > &v)
template<class EE>
void	rowScale (const VectorBase< EE > &v, typename EltResult< EE >::Mul &out) const
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
int	ncol () const
TAbs	abs () const
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)
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 ()
ELT	sum () const
VectorIterator< ELT, VectorBase< ELT > >	begin ()
VectorIterator< ELT, VectorBase< ELT > >	end ()
Classes
struct	EltResult

---

Constructor & Destructor Documentation

VectorBase

(

)

[inline]

VectorBase

(

const VectorBase< ELT > &

b

)

[inline]

VectorBase	(	int	m,
		bool	lockNrow = false
	)			[inline, explicit]

VectorBase	(	int	m,
		int	leadingDim,
		const Scalar *	s
	)			[inline]

VectorBase	(	int	m,
		int	leadingDim,
		Scalar *	s
	)			[inline]

VectorBase	(	int	m,
		const ELT &	t
	)			[inline]

VectorBase	(	int	m,
		bool	lockNrow,
		const ELT &	t
	)			[inline]

VectorBase	(	int	m,
		const ELT *	p
	)			[inline]

VectorBase	(	int	m,
		bool	lockNrow,
		const ELT *	p
	)			[inline]

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

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

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

---

Member Function Documentation

VectorBase& operator=

(

const VectorBase< ELT > &

b

)

[inline]

VectorBase& operator*=

(

const StdNumber &

t

)

[inline]

Reimplemented in VectorView_, Vector_, Vector_< Real >, and Vector_< SimTK::Vec< N > >.

VectorBase& operator/=

(

const StdNumber &

t

)

[inline]

Reimplemented in VectorView_, Vector_, Vector_< Real >, and Vector_< SimTK::Vec< N > >.

VectorBase& operator+=

(

const VectorBase< ELT > &

r

)

[inline]

VectorBase& operator-=

(

const VectorBase< ELT > &

r

)

[inline]

VectorBase& operator=

(

const VectorBase< EE > &

b

)

[inline]

Reimplemented in VectorView_, Vector_, Vector_< Real >, and Vector_< SimTK::Vec< N > >.

VectorBase& operator+=

(

const VectorBase< EE > &

b

)

[inline]

Reimplemented in VectorView_, Vector_, Vector_< Real >, and Vector_< SimTK::Vec< N > >.

VectorBase& operator-=

(

const VectorBase< EE > &

b

)

[inline]

Reimplemented in VectorView_, Vector_, Vector_< Real >, and Vector_< SimTK::Vec< N > >.

VectorBase& operator=

(

const ELT &

t

)

[inline]

Reimplemented from MatrixBase.

Reimplemented in VectorView_, Vector_, Vector_< Real >, and Vector_< SimTK::Vec< N > >.

VectorBase& rowScaleInPlace

(

const VectorBase< EE > &

v

)

[inline]

Reimplemented from MatrixBase.

void rowScale	(	const VectorBase< EE > &	v,
		typename EltResult< EE >::Mul &	out
	)			const [inline]

EltResult<EE>::Mul rowScale

(

const VectorBase< EE > &

v

)

const [inline]

Reimplemented from MatrixBase.

VectorBase& elementwiseInvertInPlace

(

)

[inline]

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

Reimplemented from MatrixBase.

void elementwiseInvert

(

VectorBase< typename CNT< ELT >::TInvert > &

out

)

const [inline]

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

VectorBase<typename CNT<ELT>::TInvert> elementwiseInvert

(

)

const [inline]

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

Reimplemented from MatrixBase.

VectorBase& elementwiseMultiplyInPlace

(

const VectorBase< EE > &

r

)

[inline]

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

EltResult<EE>::Mul elementwiseMultiply

(

const VectorBase< EE > &

v

)

const [inline]

VectorBase& elementwiseMultiplyFromLeftInPlace

(

const VectorBase< EE > &

r

)

[inline]

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

VectorBase<EE>::template EltResult<ELT>::Mul elementwiseMultiplyFromLeft

(

const VectorBase< EE > &

v

)

const [inline]

VectorBase& elementwiseDivideInPlace

(

const VectorBase< EE > &

r

)

[inline]

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

EltResult<EE>::Dvd elementwiseDivide

(

const VectorBase< EE > &

v

)

const [inline]

VectorBase& elementwiseDivideFromLeftInPlace

(

const VectorBase< EE > &

r

)

[inline]

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

VectorBase<EE>::template EltResult<ELT>::Dvd elementwiseDivideFromLeft

(

const VectorBase< EE > &

v

)

const [inline]

operator const Vector_< ELT > &

(

)

const [inline]

Reimplemented in TmpVectorViewT.

operator Vector_< ELT > &

(

)

[inline]

Reimplemented in TmpVectorViewT.

operator const VectorView_< ELT > &

(

)

const [inline]

operator VectorView_< ELT > &

(

)

[inline]

operator const Matrix_< ELT > &

(

)

const [inline]

operator Matrix_< ELT > &

(

)

[inline]

operator const MatrixView_< ELT > &

(

)

const [inline]

operator MatrixView_< ELT > &

(

)

[inline]

int size

(

)

const [inline]

Reimplemented from MatrixBase.

Referenced by Spline::calcDerivative(), SinusoidFunction::calcDerivative(), Function::Polynomial::calcDerivative(), Function::Linear::calcDerivative(), Spline::calcValue(), Function::Polynomial::calcValue(), Function::Linear::calcValue(), Function::Constant::calcValue(), VectorBase< SimTK::Vec< N > >::end(), SplineFitter::fitForSmoothingParameter(), SplineFitter::fitFromDOF(), SplineFitter::fitFromErrorVariance(), SplineFitter::fitFromGCV(), GCVSPLUtil::gcvspl(), OLDCPodesIntegrator::initialize(), SimTK::max(), SimTK::mean(), SimTK::min(), SimTK::operator*(), SimTK::operator-(), OptimizerSystem::setParameterLimits(), Subsystem::Guts::setQ(), Subsystem::setQ(), Subsystem::Guts::setU(), Subsystem::setU(), Subsystem::Guts::setZ(), Subsystem::setZ(), SimTK::SimTK_DEFINE_UNIQUE_INDEX_TYPE(), SimTK::sort(), GCVSPLUtil::splder(), and OLDCPodesIntegrator::step().

int nrow

(

)

const [inline]

Reimplemented from MatrixBase.

Referenced by MatrixBase::colScale(), MatrixBase::colScaleInPlace(), VectorBase< SimTK::Vec< N > >::elementwiseDivide(), VectorBase< SimTK::Vec< N > >::elementwiseDivideFromLeft(), VectorBase< SimTK::Vec< N > >::elementwiseInvert(), VectorBase< SimTK::Vec< N > >::elementwiseMultiply(), VectorBase< SimTK::Vec< N > >::elementwiseMultiplyFromLeft(), SimTK::operator*(), MatrixBase::rowAndColScale(), MatrixBase::rowAndColScaleInPlace(), MatrixBase::rowScale(), VectorBase< SimTK::Vec< N > >::rowScale(), and MatrixBase::rowScaleInPlace().

int ncol

(

)

const [inline]

Reimplemented from MatrixBase.

TAbs abs

(

)

const [inline]

Reimplemented from MatrixBase.

Referenced by SimTK::abs().

const ELT& operator[]

(

int

i

)

const [inline]

Reimplemented from MatrixBase.

ELT& operator[]

(

int

i

)

[inline]

Reimplemented from MatrixBase.

const ELT& operator()

(

int

i

)

const [inline]

Reimplemented from MatrixBase.

ELT& operator()

(

int

i

)

[inline]

Reimplemented from MatrixBase.

VectorView_<ELT> operator()	(	int	i,
		int	m
	)			const [inline]

Reimplemented from MatrixBase.

VectorView_<ELT> operator()	(	int	i,
		int	m
	)			[inline]

Reimplemented from MatrixBase.

THerm transpose

(

)

const [inline]

Reimplemented from MatrixBase.

Referenced by VectorBase< SimTK::Vec< N > >::operator~().

THerm updTranspose

(

)

[inline]

Reimplemented from MatrixBase.

Referenced by VectorBase< SimTK::Vec< N > >::operator~().

THerm operator~

(

)

const [inline]

Reimplemented from MatrixBase.

THerm operator~

(

)

[inline]

Reimplemented from MatrixBase.

const VectorBase& operator+

(

)

const [inline]

Reimplemented from MatrixBase.

const TNeg& negate

(

)

const [inline]

Reimplemented from MatrixBase.

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

TNeg& updNegate

(

)

[inline]

Reimplemented from MatrixBase.

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

const TNeg& operator-

(

)

const [inline]

Reimplemented from MatrixBase.

TNeg& operator-

(

)

[inline]

Reimplemented from MatrixBase.

VectorBase& resize

(

int

m

)

[inline]

Referenced by GCVSPLUtil::gcvspl(), and MatrixBase::rowAndColScale().

VectorBase& resizeKeep

(

int

m

)

[inline]

void clear

(

)

[inline]

Reimplemented from MatrixBase.

ELT sum

(

)

const [inline]

Reimplemented from MatrixBase.

Referenced by SimTK::sum().

VectorIterator<ELT, VectorBase<ELT> > begin

(

)

[inline]

Referenced by SimTK::median(), and SimTK::sort().

VectorIterator<ELT, VectorBase<ELT> > end

(

)

[inline]

Referenced by SimTK::median(), and SimTK::sort().

---

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

• BigMatrix.h