This is a fixed length column vector designed for no-overhead inline computation. More...

#include <Vec.h>

Classes
struct	EltResult
struct	Result
struct	Substitute
	Shape-preserving element substitution (always packed). More...
Public Types
Advanced
These are obscure members of Vec that are used for template metaprogramming and can be ignored by most users.
enum	{ NRows = M, NCols = 1, NPackedElements = M, NActualElements = M * STRIDE, NActualScalars = CNT<E>::NActualScalars * NActualElements, RowSpacing = STRIDE, ColSpacing = NActualElements, ImagOffset = NTraits<ENumber>::ImagOffset, RealStrideFactor = 1, ArgDepth, IsScalar = 0, IsULessScalar = 0, IsNumber = 0, IsStdNumber = 0, IsPrecision = 0, SignInterpretation = CNT<E>::SignInterpretation }
	These compile-time constants are required of every Composite Numerical Type (CNT). More...
typedef ELT	E
	Element type of this Vec.
typedef CNT< E >::TNeg	ENeg
	Negated version of this Vec's element type; ENeg==negator< E >.
typedef CNT< E >::TWithoutNegator	EWithoutNegator
	Element type, stripped of negator<> if it has one.
typedef CNT< E >::TReal	EReal
	Type showing just the real part of an element of this Vec if elements are complex; otherwise just the element type.
typedef CNT< E >::TImag	EImag
	Type showing the imaginary part of an element of this Vec as real, if elements are complex; otherwise a type that can hold a zero of the element type.
typedef CNT< E >::TComplex	EComplex
	Type that elements would have if complex, if E is currently real; otherwise just the element type E.
typedef CNT< E >::THerm	EHerm
	Type of the Hermitian transpose of an element of this Vec.
typedef CNT< E >::TPosTrans	EPosTrans
	Type of a positional transpose of an element of this Vec.
typedef CNT< E >::TSqHermT	ESqHermT
	Type of the expression ~E*E (default vector and matrix square; symmetric).
typedef CNT< E >::TSqTHerm	ESqTHerm
	Type of the expression E*~E ("row square"; symmetric).
typedef CNT< E >::TSqrt	ESqrt
	Type required to hold the result of sqrt(E).
typedef CNT< E >::TAbs	EAbs
	Type required to hold the result of abs(E).
typedef CNT< E >::TStandard	EStandard
	Return type of standardize(E) method; a packed type that can hold the value of an element after eliminating negator and conjugate types.
typedef CNT< E >::TInvert	EInvert
	Packed type that can hold the value returned from invert(E), the inverse type of an element.
typedef CNT< E >::TNormalize	ENormalize
	Packed type that can hold the value returned from normalize(E).
typedef CNT< E >::Scalar	EScalar
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef CNT< E >::ULessScalar	EULessScalar
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef CNT< E >::Number	ENumber
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef CNT< E >::StdNumber	EStdNumber
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef CNT< E >::Precision	EPrecision
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef CNT< E >::ScalarNormSq	EScalarNormSq
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef Vec< M, E, STRIDE >	T
	The type of this Vec.
typedef Vec< M, ENeg, STRIDE >	TNeg
	Type this Vec would have if its elements were interpreted as negated.
typedef Vec< M, EWithoutNegator, STRIDE >	TWithoutNegator
	Type of this Vec with negator removed from its element type, if the element is negated.
typedef Vec< M, EReal, STRIDE *CNT< E >::RealStrideFactor >	TReal
	Type of this Vec cast to show only the real part of its element; this might affect the stride.
typedef Vec< M, EImag, STRIDE *CNT< E >::RealStrideFactor >	TImag
	Type of this Vec cast to show only the imaginary part of its element; this might affect the stride.
typedef Vec< M, EComplex, STRIDE >	TComplex
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef Row< M, EHerm, STRIDE >	THerm
	Type of this Vec after casting to its Hermitian transpose; that is, the Vec turns into a Row and each element turns into its Hermitian transpose.
typedef Row< M, E, STRIDE >	TPosTrans
	Type of this Vec after casting to its positional transpose; that is, the Vec turns into a Row but the element type remains unchanged.
typedef E	TElement
	Element type of this Vec.
typedef E	TRow
	Type of a row of this CNT object (for a Vec, just its element type).
typedef Vec	TCol
	Type of a column of this CNT object (for a Vec, the whole thing).
typedef Vec< M, ESqrt, 1 >	TSqrt
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef Vec< M, EAbs, 1 >	TAbs
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef Vec< M, EStandard, 1 >	TStandard
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef Row< M, EInvert, 1 >	TInvert
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef Vec< M, ENormalize, 1 >	TNormalize
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef ESqHermT	TSqHermT
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef SymMat< M, ESqTHerm >	TSqTHerm
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef EScalar	Scalar
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef EULessScalar	ULessScalar
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef ENumber	Number
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef EStdNumber	StdNumber
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef EPrecision	Precision
	These compile-time constants are required of every Composite Numerical Type (CNT).
typedef EScalarNormSq	ScalarNormSq
	These compile-time constants are required of every Composite Numerical Type (CNT).
Public Member Functions
ScalarNormSq	scalarNormSqr () const
	Scalar norm square is sum( conjugate squares of all underlying scalars ), where conjugate square of scalar s is conj(s)*s.
TSqrt	sqrt () const
	Elementwise square root; that is, the return value has the same length as this Vec but with each element replaced by whatever it thinks its square root is.
TAbs	abs () const
	Elementwise absolute value; that is, the return value has the same dimension as this Vec but with each element replaced by whatever it thinks its absolute value is.
TStandard	standardize () const
	Return a copy of this Vec but with the underlying scalar type converted (if necessary) to one of the C++ standard real or complex floating point types.
EStandard	sum () const
	Sum just adds up all the elements into a single return element that is the same type as this Vec's elements except standardized to use one of the C++ built-in real or complex types as its underlying scalars.
	Vec ()
	Default construction initializes Vec's elements to NaN when debugging but leaves them uninitialized garbage otherwise, so declarations have zero cost in Release builds.
	Vec (const Vec &src)
	Copy constructor copies the logically-included elements from the source Vec; gaps due to stride are not accessed in either source or destination.
Vec &	operator= (const Vec &src)
	Copy assignment operator copies the logically-included elements from the source Vec; gaps due to stride are not accessed in either source or destination.
template<int SS>
	Vec (const Vec< M, E, SS > &src)
	This is an implicit conversion from a Vec of the same length and element type but with a different stride.
template<int SS>
	Vec (const Vec< M, ENeg, SS > &src)
	This is an implicit conversion from a Vec of the same length and negated element type (possibly with a different stride).
template<class EE , int SS>
	Vec (const Vec< M, EE, SS > &src)
	Construct a Vec from a Vec of the same length, with any stride.
	Vec (const E &e)
	Construction from a single value of this Vec's element type assigns that value to each element.
	Vec (const ENeg &ne)
	Construction from a single value of this Vec's negated element type assigns that value to each element, requiring floating point negation to be performed once to compute the type-E representation of the type negator<E> value provided.
	Vec (int i)
	Given an int value, turn it into a suitable floating point number, convert that to element type E and then feed that to the above single-element constructor.
	Vec (const E &e0, const E &e1)
	Construct a Vec<2,E> from two elements of type E, etc.
	Vec (const E &e0, const E &e1, const E &e2)
	Vec (const E &e0, const E &e1, const E &e2, const E &e3)
	Vec (const E &e0, const E &e1, const E &e2, const E &e3, const E &e4)
	Vec (const E &e0, const E &e1, const E &e2, const E &e3, const E &e4, const E &e5)
	Vec (const E &e0, const E &e1, const E &e2, const E &e3, const E &e4, const E &e5, const E &e6)
	Vec (const E &e0, const E &e1, const E &e2, const E &e3, const E &e4, const E &e5, const E &e6, const E &e7)
	Vec (const E &e0, const E &e1, const E &e2, const E &e3, const E &e4, const E &e5, const E &e6, const E &e7, const E &e8)
template<class EE >
	Vec (const EE *p)
	Construction from a pointer to elements of any type EE assumes we're pointing at a C++ array of EE's of the right length, and that EE is assignment compatible with this Vec's element type E.
template<class EE >
Vec &	operator= (const EE *p)
	Assignment to a pointer to elements of any type EE assumes we're pointing at a C++ array of EE's of the right length, and that EE is assignment compatible with this Vec's element type E.
template<class EE , int SS>
Vec &	operator= (const Vec< M, EE, SS > &vv)
	Assignment to a conforming Vec, of any element type and stride, provided that the element types are assignment-compatible.
template<class EE , int SS>
Vec &	operator+= (const Vec< M, EE, SS > &r)
	Add in a conforming Vec, of any element type and stride, provided that the element types are addition-compatible.
template<class EE , int SS>
Vec &	operator+= (const Vec< M, negator< EE >, SS > &r)
	Add in a conforming Vec, of any negated element type and stride, provided that the element types are addition-compatible.
template<class EE , int SS>
Vec &	operator-= (const Vec< M, EE, SS > &r)
	Subtract off a conforming Vec, of any element type and stride, provided that the element types are addition-compatible.
template<class EE , int SS>
Vec &	operator-= (const Vec< M, negator< EE >, SS > &r)
	Subtract off a conforming Vec, of any negated element type and stride, provided that the element types are addition-compatible.
template<class EE , int SS>
Vec< M, typename CNT< E > ::template Result< EE >::Add >	conformingAdd (const Vec< M, EE, SS > &r) const
	Vector addition -- use operator+ instead.
template<class EE , int SS>
Vec< M, typename CNT< E > ::template Result< EE >::Sub >	conformingSubtract (const Vec< M, EE, SS > &r) const
	Vector subtraction -- use operator- instead.
template<class EE , int SS>
Mat< M, M, typename CNT< E > ::template Result< EE >::Mul >	conformingMultiply (const Row< M, EE, SS > &r) const
	Same as outer product (m = colrow) -- use operator or outer() instead.
template<class EE , int SS>
Vec< M, typename CNT< E > ::template Result< EE >::Mul >	elementwiseMultiply (const Vec< M, EE, SS > &r) const
	Elementwise multiply (Matlab .
template<class EE , int SS>
Vec< M, typename CNT< E > ::template Result< EE >::Dvd >	elementwiseDivide (const Vec< M, EE, SS > &r) const
	Elementwise divide (Matlab .
const E &	operator[] (int i) const
	Select an element of this Vec and return a const reference to it.
const E &	operator() (int i) const
	Same as const operator[] above.
E &	operator[] (int i)
	Select an element of this Vec and return a writable reference to it.
E &	operator() (int i)
	Same as non-const operator[] above.
ScalarNormSq	normSqr () const
CNT< ScalarNormSq >::TSqrt	norm () const
TNormalize	normalize () const
	If the elements of this Vec are scalars, the result is what you get by dividing each element by the norm() calculated above.
TInvert	invert () const
	This method is not supported for Vec objects.
const Vec &	operator+ () const
	Unary plus does nothing.
const TNeg &	operator- () const
	Unary minus recasts this Vec to a type that has the opposite interpretation of the sign but is otherwise identical, so no computation or copying is performed here.
TNeg &	operator- ()
	Recast to negated type and return a writable reference; writing to this will cause the negated result to be placed in the original Vec.
const THerm &	operator~ () const
	The Hermitian transpose operator recasts this Vec to a type that specifies the opposite storage order (row vs. column) then returns a reference, so no computation or copying is performed here.
THerm &	operator~ ()
	Recast to Hermitian transposed type and return a writable reference; the effect is that writing to elements of the result affects the transposed element of the original Vec.
const TNeg &	negate () const
	Non-operator version of unary negation; just a recast.
TNeg &	updNegate ()
	Non-operator version of unary negation; recasts and returns a writable reference.
const THerm &	transpose () const
	Non-operator version of Hermitian transpose; just a recast.
THerm &	updTranspose ()
	Non-operator version of Hermitian transpose; recasts and returns a writable reference.
const TPosTrans &	positionalTranspose () const
	Positional transpose turns this Vec into a Row but does not transpose the individual elements.
TPosTrans &	updPositionalTranspose ()
	Positional transpose returning a writable reference.
const TReal &	real () const
	Return a reference to the real portion of this Vec if it has complex elements; otherwise the type doesn't change.
TReal &	real ()
	Recast to show only the real portion of this Vec and return a writable reference.
const TImag &	imag () const
	Return a reference to the imaginary portion of this Vec if it has complex elements; otherwise the type doesn't change.
TImag &	imag ()
	Recast to show only the imaginary portion of this Vec and return a writable reference.
const TWithoutNegator &	castAwayNegatorIfAny () const
	Recast to remove negators from this Vec's type if present; this is handy for simplifying operations where we know the sign can be ignored such as squaring.
TWithoutNegator &	updCastAwayNegatorIfAny ()
	Recast to remove negators from this Vec's type if present and return a writable reference.
template<class EE >
Vec< M, typename CNT< E > ::template Result< EE >::Mul >	scalarMultiply (const EE &e) const
template<class EE >
Vec< M, typename CNT< EE > ::template Result< E >::Mul >	scalarMultiplyFromLeft (const EE &e) const
template<class EE >
Vec< M, typename CNT< E > ::template Result< EE >::Dvd >	scalarDivide (const EE &e) const
template<class EE >
Vec< M, typename CNT< EE > ::template Result< E >::Dvd >	scalarDivideFromLeft (const EE &e) const
template<class EE >
Vec< M, typename CNT< E > ::template Result< EE >::Add >	scalarAdd (const EE &e) const
template<class EE >
Vec< M, typename CNT< E > ::template Result< EE >::Sub >	scalarSubtract (const EE &e) const
template<class EE >
Vec< M, typename CNT< EE > ::template Result< E >::Sub >	scalarSubtractFromLeft (const EE &e) const
template<class EE >
Vec &	operator= (const EE &e)
template<class EE >
Vec &	operator+= (const EE &e)
template<class EE >
Vec &	operator-= (const EE &e)
template<class EE >
Vec &	operator*= (const EE &e)
template<class EE >
Vec &	operator/= (const EE &e)
template<class EE >
Vec &	scalarEq (const EE &ee)
template<class EE >
Vec &	scalarPlusEq (const EE &ee)
template<class EE >
Vec &	scalarMinusEq (const EE &ee)
template<class EE >
Vec &	scalarMinusEqFromLeft (const EE &ee)
template<class EE >
Vec &	scalarTimesEq (const EE &ee)
template<class EE >
Vec &	scalarTimesEqFromLeft (const EE &ee)
template<class EE >
Vec &	scalarDivideEq (const EE &ee)
template<class EE >
Vec &	scalarDivideEqFromLeft (const EE &ee)
Vec &	scalarEq (int ee)
Vec &	scalarPlusEq (int ee)
Vec &	scalarMinusEq (int ee)
Vec &	scalarTimesEq (int ee)
Vec &	scalarDivideEq (int ee)
Vec &	scalarMinusEqFromLeft (int ee)
Vec &	scalarTimesEqFromLeft (int ee)
Vec &	scalarDivideEqFromLeft (int ee)
void	setToNaN ()
	Set every scalar in this Vec to NaN; this is the default initial value in Debug builds, but not in Release.
void	setToZero ()
	Set every scalar in this Vec to zero.
template<int MM>
const Vec< MM, ELT, STRIDE > &	getSubVec (int i) const
	Extract a const reference to a sub-Vec with size known at compile time.
template<int MM>
Vec< MM, ELT, STRIDE > &	updSubVec (int i)
	Extract a writable reference to a sub-Vec with size known at compile time.
Vec< M-1, ELT, 1 >	drop1 (int p) const
	Return a vector one smaller than this one by dropping the element at the indicated position p.
template<class EE >
Vec< M+1, ELT, 1 >	append1 (const EE &v) const
	Return a vector one larger than this one by adding an element to the end.
template<class EE >
Vec< M+1, ELT, 1 >	insert1 (int p, const EE &v) const
	Return a vector one larger than this one by inserting an element before the indicated one.
bool	isNaN () const
	Return true if any element of this Vec contains a NaN anywhere.
bool	isInf () const
	Return true if any element of this Vec contains a +Infinity or -Infinity somewhere but no element contains a NaN anywhere.
bool	isFinite () const
	Return true if no element of this Vec contains an Infinity or a NaN anywhere.
template<class E2 , int RS2>
bool	isNumericallyEqual (const Vec< M, E2, RS2 > &v, double tol) const
	Test whether this vector is numerically equal to some other vector with the same shape, using a specified tolerance.
template<class E2 , int RS2>
bool	isNumericallyEqual (const Vec< M, E2, RS2 > &v) const
	Test whether this vector is numerically equal to some other vector with the same shape, using a default tolerance which is the looser of the default tolerances of the two objects being compared.
bool	isNumericallyEqual (const ELT &e, double tol=getDefaultTolerance()) const
	Test whether every element of this vector is numerically equal to the given element, using either a specified tolerance or the vector's default tolerance (which is always the same or looser than the default tolerance for one of its elements).
std::string	toString () const
	Print Vec into a string and return it.
void	set (int i, const E &value)
	Variant of operator[] that's scripting friendly to set ith entry.
const E &	get (int i) const
	Variant of operator[] that's scripting friendly to get const reference to ith entry.
Static Public Member Functions
static int	size ()
	The number of elements in this Vec (note that stride does not affect this number.)
static int	nrow ()
	The number of rows in a Vec is the number of elements.
static int	ncol ()
	The number of columns in a Vec is always 1.
template<int MM>
static const Vec &	getSubVec (const Vec< MM, ELT, STRIDE > &v, int i)
	Extract a subvector of type Vec from a longer one that has the same element type and stride, and return a const reference to the selected subsequence.
template<int MM>
static Vec &	updSubVec (Vec< MM, ELT, STRIDE > &v, int i)
	Extract a subvector of type Vec from a longer one that has the same element type and stride, and return a writable reference to the selected subsequence.
static const Vec &	getAs (const ELT *p)
	Recast an ordinary C++ array E[] to a const Vec<M,E,S>; assumes compatible length, stride, and packing.
static Vec &	updAs (ELT *p)
	Recast a writable ordinary C++ array E[] to a writable Vec<M,E,S>; assumes compatible length, stride, and packing.
static Vec< M, ELT, 1 >	getNaN ()
	Return a Vec of the same length and element type as this one but with all elements set to NaN.
static double	getDefaultTolerance ()
	For approximate comparisions, the default tolerance to use for a vector is the same as its elements' default tolerance.
Related Functions
(Note that these are not member functions.)
template<int M, class E , int S>
void	writeUnformatted (std::ostream &o, const Vec< M, E, S > &v)
	Specialize for Vec<M,E,S> to delegate to element type E, with spaces separating the elements.
template<int M, class E , int S>
bool	readUnformatted (std::istream &in, Vec< M, E, S > &v)
	Specialize for Vec<M,E,S> to delegate to element type E, with spaces separating the elements.

Detailed Description

template<int M, class ELT, int STRIDE>
class SimTK::Vec< M, ELT, STRIDE >

This is a fixed length column vector designed for no-overhead inline computation.

Template Parameters:

M	The number of rows in the vector.
ELT	The element type. Must be a composite numerical type (CNT). The default is ELT=Real.
STRIDE	The spacing from one element to the next in memory, as an integer number of elements of type ELT. The default is STRIDE=1.