Simbody  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
SimTK::VectorBase< ELT > Class Template Reference

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

+ Inheritance diagram for SimTK::VectorBase< ELT >:

Classes

struct  EltResult
 

Public Member Functions

VectorBaseoperator= (const VectorBase &b)
 Copy assignment is deep copy but behavior depends on type of lhs: if view, rhs must match. More...
 
VectorBaseoperator*= (const StdNumber &t)
 
VectorBaseoperator/= (const StdNumber &t)
 
VectorBaseoperator+= (const VectorBase &r)
 
VectorBaseoperator-= (const VectorBase &r)
 
template<class EE >
VectorBaseoperator= (const VectorBase< EE > &b)
 
template<class EE >
VectorBaseoperator+= (const VectorBase< EE > &b)
 
template<class EE >
VectorBaseoperator-= (const VectorBase< EE > &b)
 
VectorBaseoperator= (const ELT &t)
 Fill current allocation with copies of element. More...
 
template<class EE >
VectorBaserowScaleInPlace (const VectorBase< EE > &v)
 There's only one column here so it's a bit weird to use rowScale rather than elementwiseMultiply, but there's nothing really wrong with it. More...
 
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
 
CNT< ScalarNormSq >::TSqrt normRMS (int *worstOne=0) const
 Return the root-mean-square (RMS) norm of a Vector of scalars, with optional return of the index of the element of largest absolute value. More...
 
template<class EE >
CNT< ScalarNormSq >::TSqrt weightedNormRMS (const VectorBase< EE > &w, int *worstOne=0) const
 Return the weighted root-mean-square (WRMS) norm of a Vector of scalars, with optional return of the index of the weighted element of largest absolute value. More...
 
EAbs normInf (int *worstOne=0) const
 Return the infinity norm (max absolute value) of a Vector of scalars, with optional return of the index of the element of largest absolute value. More...
 
template<class EE >
EAbs weightedNormInf (const VectorBase< EE > &w, int *worstOne=0) const
 Return the weighted infinity norm (max absolute value) WInf of a Vector of scalars, with optional return of the index of the weighted element of largest absolute value. More...
 
VectorBaseelementwiseInvertInPlace ()
 Set this[i] = this[i]^-1. More...
 
void elementwiseInvert (VectorBase< typename CNT< ELT >::TInvert > &out) const
 Set supplied out[i] = this[i]^-1. More...
 
VectorBase< typename CNT< ELT >
::TInvert
elementwiseInvert () const
 Return out[i]=this[i]^-1 as function return. More...
 
template<class EE >
VectorBaseelementwiseMultiplyInPlace (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 >
VectorBaseelementwiseMultiplyFromLeftInPlace (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 >
VectorBaseelementwiseDivideInPlace (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 >
VectorBaseelementwiseDivideFromLeftInPlace (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
 
ptrdiff_t nelt () 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)
 
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 VectorBaseoperator+ () const
 
const TNegnegate () const
 
TNegupdNegate ()
 
const TNegoperator- () const
 
TNegoperator- ()
 
VectorBaseresize (int m)
 
VectorBaseresizeKeep (int m)
 
void clear ()
 
ELT sum () const
 
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. More...
 
 VectorBase (const VectorBase &source)
 Copy constructor is a deep copy (not appropriate for views!). More...
 
 VectorBase (const TNeg &source)
 Implicit conversion from compatible vector with negated elements. More...
 
 VectorBase (int m, const ELT &initialValue)
 Construct an owner vector of length m, with each element initialized to the given value. More...
 
 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. More...
 
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. More...
 
 VectorBase (int m, int stride, Scalar *s)
 Construct a writable view into existing data. More...
 
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. More...
 
 VectorBase (const MatrixHelper< Scalar > &h, const typename MatrixHelper< Scalar >::ShallowCopy &s)
 Construct a read-only view of the source data. More...
 
 VectorBase (const MatrixHelper< Scalar > &h, const typename MatrixHelper< Scalar >::DeepCopy &d)
 Construct a new owner vector initialized with the data from the source. More...
 
- Public Member Functions inherited from SimTK::MatrixBase< ELT >
const MatrixCommitmentgetCharacterCommitment () const
 
const MatrixCharactergetMatrixCharacter () const
 
void commitTo (const MatrixCommitment &mc)
 Change the handle commitment for this matrix handle; only allowed if the handle is currently clear. More...
 
int nrow () const
 Return the number of rows m in the logical shape of this matrix. More...
 
int ncol () const
 Return the number of columns n in the logical shape of this matrix. More...
 
ptrdiff_t nelt () const
 Return the number of elements in the logical shape of this matrix. More...
 
bool isResizeable () const
 Return true if either dimension of this Matrix is resizable. More...
 
 MatrixBase ()
 The default constructor builds a 0x0 matrix managed by a helper that understands how many scalars there are in one of our elements but is otherwise uncommitted. More...
 
 MatrixBase (int m, int n)
 This constructor allocates the default matrix a completely uncommitted matrix commitment, given particular initial dimensions. More...
 
 MatrixBase (const MatrixCommitment &commitment)
 This constructor takes a handle commitment and allocates the default matrix for that kind of commitment. More...
 
 MatrixBase (const MatrixCommitment &commitment, int m, int n)
 This constructor takes a handle commitment and allocates the default matrix for that kind of commitment given particular initial minimum dimensions, which cannot be larger than those permitted by the commitment. More...
 
 MatrixBase (const MatrixBase &b)
 Copy constructor is a deep copy (not appropriate for views!). More...
 
 MatrixBase (const TNeg &b)
 Implicit conversion from matrix with negated elements (otherwise this is just like the copy constructor. More...
 
MatrixBasecopyAssign (const MatrixBase &b)
 Copy assignment is a deep copy but behavior depends on type of lhs: if view, rhs must match. More...
 
MatrixBaseoperator= (const MatrixBase &b)
 
MatrixBaseviewAssign (const MatrixBase &src)
 View assignment is a shallow copy, meaning that we disconnect the MatrixBase from whatever it used to refer to (destructing as necessary), then make it a new view for the data descriptor referenced by the source. More...
 
 MatrixBase (const MatrixCommitment &commitment, int m, int n, const ELT &initialValue)
 Initializing constructor with all of the initially-allocated elements initialized to the same value. More...
 
 MatrixBase (const MatrixCommitment &commitment, int m, int n, const ELT *cppInitialValuesByRow)
 Initializing constructor with the initially-allocated elements initialized from a C++ array of elements, which is provided in row major order. More...
 
 MatrixBase (const MatrixCommitment &commitment, MatrixHelper< Scalar > &source, const typename MatrixHelper< Scalar >::ShallowCopy &shallow)
 
 MatrixBase (const MatrixCommitment &commitment, const MatrixHelper< Scalar > &source, const typename MatrixHelper< Scalar >::ShallowCopy &shallow)
 
 MatrixBase (const MatrixCommitment &commitment, const MatrixHelper< Scalar > &source, const typename MatrixHelper< Scalar >::DeepCopy &deep)
 
void clear ()
 This restores the MatrixBase to the state it would be in had it been constructed specifying only its handle commitment. More...
 
MatrixBaseoperator*= (const StdNumber &t)
 
MatrixBaseoperator/= (const StdNumber &t)
 
MatrixBaseoperator+= (const MatrixBase &r)
 
MatrixBaseoperator-= (const MatrixBase &r)
 
template<class EE >
 MatrixBase (const MatrixBase< EE > &b)
 
template<class EE >
MatrixBaseoperator= (const MatrixBase< EE > &b)
 
template<class EE >
MatrixBaseoperator+= (const MatrixBase< EE > &b)
 
template<class EE >
MatrixBaseoperator-= (const MatrixBase< EE > &b)
 
MatrixBaseoperator= (const ELT &t)
 Matrix assignment to an element sets only the *diagonal* elements to the indicated value; everything else is set to zero. More...
 
template<class S >
MatrixBasescalarAssign (const S &s)
 Set M's diagonal elements to a "scalar" value S, and all off-diagonal elements to zero. More...
 
template<class S >
MatrixBasescalarAddInPlace (const S &s)
 Add a scalar to M's diagonal. More...
 
template<class S >
MatrixBasescalarSubtractInPlace (const S &s)
 Subtract a scalar from M's diagonal. More...
 
template<class S >
MatrixBasescalarSubtractFromLeftInPlace (const S &s)
 Set M(i,i) = S - M(i,i), M(i,j) = -M(i,j) for i!=j. More...
 
template<class S >
MatrixBasescalarMultiplyInPlace (const S &)
 Set M(i,j) = M(i,j)*S for some "scalar" S. More...
 
template<class S >
MatrixBasescalarMultiplyFromLeftInPlace (const S &)
 Set M(i,j) = S * M(i,j) for some "scalar" S. More...
 
template<class S >
MatrixBasescalarDivideInPlace (const S &)
 Set M(i,j) = M(i,j)/S for some "scalar" S. More...
 
template<class S >
MatrixBasescalarDivideFromLeftInPlace (const S &)
 Set M(i,j) = S/M(i,j) for some "scalar" S. More...
 
template<class EE >
MatrixBaserowScaleInPlace (const VectorBase< EE > &)
 M = diag(r) * M; r must have nrow() elements. More...
 
template<class EE >
void rowScale (const VectorBase< EE > &r, 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. More...
 
template<class EE >
EltResult< EE >::Mul rowScale (const VectorBase< EE > &r) const
 
template<class EE >
MatrixBasecolScaleInPlace (const VectorBase< EE > &)
 M = M * diag(c); c must have ncol() elements. More...
 
template<class EE >
void colScale (const VectorBase< EE > &c, typename EltResult< EE >::Mul &out) const
 
template<class EE >
EltResult< EE >::Mul colScale (const VectorBase< EE > &c) const
 
template<class ER , class EC >
MatrixBaserowAndColScaleInPlace (const VectorBase< ER > &r, const VectorBase< EC > &c)
 M = diag(r) * M * diag(c); r must have nrow() elements; must have ncol() elements. More...
 
template<class ER , class EC >
void rowAndColScale (const VectorBase< ER > &r, const VectorBase< EC > &c, typename EltResult< typename VectorBase< ER >::template EltResult< EC >::Mul >::Mul &out) const
 
template<class ER , class EC >
EltResult< typename VectorBase
< ER >::template EltResult< EC >
::Mul >::Mul 
rowAndColScale (const VectorBase< ER > &r, const VectorBase< EC > &c) const
 
template<class S >
MatrixBaseelementwiseAssign (const S &s)
 Set M(i,j)=s for every element of M and some value s. More...
 
MatrixBaseelementwiseAssign (int s)
 Overloaded to allow an integer argument, which is converted to Real. More...
 
MatrixBaseelementwiseInvertInPlace ()
 Set M(i,j) = M(i,j)^-1. More...
 
void elementwiseInvert (MatrixBase< typename CNT< E >::TInvert > &out) const
 
MatrixBase< typename CNT< E >
::TInvert
elementwiseInvert () const
 
template<class S >
MatrixBaseelementwiseAddScalarInPlace (const S &s)
 Set M(i,j)+=s for every element of M and some value s. More...
 
template<class S >
void elementwiseAddScalar (const S &s, typename EltResult< S >::Add &) const
 
template<class S >
EltResult< S >::Add elementwiseAddScalar (const S &s) const
 
template<class S >
MatrixBaseelementwiseSubtractScalarInPlace (const S &s)
 Set M(i,j)-=s for every element of M and some value s. More...
 
template<class S >
void elementwiseSubtractScalar (const S &s, typename EltResult< S >::Sub &) const
 
template<class S >
EltResult< S >::Sub elementwiseSubtractScalar (const S &s) const
 
template<class S >
MatrixBaseelementwiseSubtractFromScalarInPlace (const S &s)
 Set M(i,j) = s - M(i,j) for every element of M and some value s. More...
 
template<class S >
void elementwiseSubtractFromScalar (const S &, typename MatrixBase< S >::template EltResult< E >::Sub &) const
 
template<class S >
MatrixBase< S >::template
EltResult< E >::Sub 
elementwiseSubtractFromScalar (const S &s) const
 
template<class EE >
MatrixBaseelementwiseMultiplyInPlace (const MatrixBase< EE > &)
 M(i,j) *= R(i,j); R must have same dimensions as this. More...
 
template<class EE >
void elementwiseMultiply (const MatrixBase< EE > &, typename EltResult< EE >::Mul &) const
 
template<class EE >
EltResult< EE >::Mul elementwiseMultiply (const MatrixBase< EE > &m) const
 
template<class EE >
MatrixBaseelementwiseMultiplyFromLeftInPlace (const MatrixBase< EE > &)
 M(i,j) = R(i,j) * M(i,j); R must have same dimensions as this. More...
 
template<class EE >
void elementwiseMultiplyFromLeft (const MatrixBase< EE > &, typename MatrixBase< EE >::template EltResult< E >::Mul &) const
 
template<class EE >
MatrixBase< EE >::template
EltResult< E >::Mul 
elementwiseMultiplyFromLeft (const MatrixBase< EE > &m) const
 
template<class EE >
MatrixBaseelementwiseDivideInPlace (const MatrixBase< EE > &)
 M(i,j) /= R(i,j); R must have same dimensions as this. More...
 
template<class EE >
void elementwiseDivide (const MatrixBase< EE > &, typename EltResult< EE >::Dvd &) const
 
template<class EE >
EltResult< EE >::Dvd elementwiseDivide (const MatrixBase< EE > &m) const
 
template<class EE >
MatrixBaseelementwiseDivideFromLeftInPlace (const MatrixBase< EE > &)
 M(i,j) = R(i,j) / M(i,j); R must have same dimensions as this. More...
 
template<class EE >
void elementwiseDivideFromLeft (const MatrixBase< EE > &, typename MatrixBase< EE >::template EltResult< E >::Dvd &) const
 
template<class EE >
MatrixBase< EE >::template
EltResult< EE >::Dvd 
elementwiseDivideFromLeft (const MatrixBase< EE > &m) const
 
MatrixBasesetTo (const ELT &t)
 Fill every element in current allocation with given element (or NaN or 0). More...
 
MatrixBasesetToNaN ()
 
MatrixBasesetToZero ()
 
RowVectorView_< ELT > row (int i) const
 
RowVectorView_< ELT > updRow (int i)
 
VectorView_< ELT > col (int j) const
 
VectorView_< ELT > updCol (int j)
 
RowVectorView_< ELT > operator[] (int i) const
 
RowVectorView_< ELT > operator[] (int i)
 
VectorView_< ELT > operator() (int j) const
 
VectorView_< ELT > operator() (int j)
 
MatrixView_< ELT > block (int i, int j, int m, int n) const
 
MatrixView_< ELT > updBlock (int i, int j, int m, int n)
 
MatrixView_< ELT > operator() (int i, int j, int m, int n) const
 
MatrixView_< ELT > operator() (int i, int j, int m, int n)
 
MatrixView_< EHermtranspose () const
 
MatrixView_< EHermupdTranspose ()
 
MatrixView_< EHermoperator~ () const
 
MatrixView_< EHermoperator~ ()
 
VectorView_< ELT > diag () const
 Select main diagonal (of largest leading square if rectangular) and return it as a read-only view of the diagonal elements of this Matrix. More...
 
VectorView_< ELT > updDiag ()
 Select main diagonal (of largest leading square if rectangular) and return it as a writable view of the diagonal elements of this Matrix. More...
 
VectorView_< ELT > diag ()
 This non-const version of diag() is an alternate name for updDiag() available for historical reasons. More...
 
TInvert invert () const
 
void invertInPlace ()
 
void dump (const char *msg=0) const
 Matlab-compatible debug output. More...
 
const ELT & getElt (int i, int j) const
 Element selection for stored elements. More...
 
ELT & updElt (int i, int j)
 
const ELT & operator() (int i, int j) const
 
ELT & operator() (int i, int j)
 
void getAnyElt (int i, int j, ELT &value) const
 This returns a copy of the element value for any position in the logical matrix, regardless of whether it is stored in memory. More...
 
ELT getAnyElt (int i, int j) const
 
ScalarNormSq scalarNormSqr () const
 Scalar norm square is sum( squares of all scalars ). More...
 
void abs (TAbs &mabs) const
 abs() is elementwise absolute value; that is, the return value has the same dimension as this Matrix but with each element replaced by whatever it thinks its absolute value is. More...
 
TAbs abs () const
 abs() with the result as a function return. More...
 
TStandard standardize () const
 Return a Matrix of the same shape and contents as this one but with the element type converted to one based on the standard C++ scalar types: float, double, complex<float>, complex<double>. More...
 
ScalarNormSq normSqr () const
 This is the scalar Frobenius norm, and its square. More...
 
CNT< ScalarNormSq >::TSqrt norm () const
 
CNT< ScalarNormSq >::TSqrt normRMS () const
 We only allow RMS norm if the elements are scalars. More...
 
RowVector_< ELT > colSum () const
 Form the column sums of this matrix, returned as a RowVector. More...
 
RowVector_< ELT > sum () const
 Alternate name for colSum(); behaves like the Matlab function sum(). More...
 
Vector_< ELT > rowSum () const
 Form the row sums of this matrix, returned as a Vector. More...
 
const MatrixBaseoperator+ () const
 
const TNegnegate () const
 
TNegupdNegate ()
 
const TNegoperator- () const
 
TNegoperator- ()
 
MatrixBasenegateInPlace ()
 
MatrixBaseresize (int m, int n)
 Change the size of this matrix. More...
 
MatrixBaseresizeKeep (int m, int n)
 Change the size of this matrix, retaining as much of the old data as will fit. More...
 
void lockShape ()
 
void unlockShape ()
 
const MatrixView_< ELT > & getAsMatrixView () const
 
MatrixView_< ELT > & updAsMatrixView ()
 
const Matrix_< ELT > & getAsMatrix () const
 
Matrix_< ELT > & updAsMatrix ()
 
const VectorView_< ELT > & getAsVectorView () const
 
VectorView_< ELT > & updAsVectorView ()
 
const Vector_< ELT > & getAsVector () const
 
Vector_< ELT > & updAsVector ()
 
const VectorBase< ELT > & getAsVectorBase () const
 
VectorBase< ELT > & updAsVectorBase ()
 
const RowVectorView_< ELT > & getAsRowVectorView () const
 
RowVectorView_< ELT > & updAsRowVectorView ()
 
const RowVector_< ELT > & getAsRowVector () const
 
RowVector_< ELT > & updAsRowVector ()
 
const RowVectorBase< ELT > & getAsRowVectorBase () const
 
RowVectorBase< ELT > & updAsRowVectorBase ()
 
int getNScalarsPerElement () const
 This is the number of consecutive scalars used to represent one element of type ELT. More...
 
int getPackedSizeofElement () const
 This is like sizeof(ELT), but returning the number of bytes we use to store the element which may be fewer than what C++ would use. More...
 
bool hasContiguousData () const
 
ptrdiff_t getContiguousScalarDataLength () const
 
const ScalargetContiguousScalarData () const
 
ScalarupdContiguousScalarData ()
 
void replaceContiguousScalarData (Scalar *newData, ptrdiff_t length, bool takeOwnership)
 
void replaceContiguousScalarData (const Scalar *newData, ptrdiff_t length)
 
void swapOwnedContiguousScalarData (Scalar *newData, ptrdiff_t length, Scalar *&oldData)
 
 MatrixBase (MatrixHelperRep< Scalar > *hrep)
 Helper rep-stealing constructor. More...
 
template<class EE >
MatrixBase< ELT > & rowScaleInPlace (const VectorBase< EE > &v)
 
template<class EE >
void rowScale (const VectorBase< EE > &v, typename MatrixBase< ELT >::template EltResult< EE >::Mul &out) const
 
template<class EE >
MatrixBase< ELT > & colScaleInPlace (const VectorBase< EE > &v)
 
template<class EE >
void colScale (const VectorBase< EE > &v, typename MatrixBase< ELT >::template EltResult< EE >::Mul &out) const
 
template<class ER , class EC >
MatrixBase< ELT > & rowAndColScaleInPlace (const VectorBase< ER > &r, const VectorBase< EC > &c)
 
template<class S >
MatrixBase< ELT > & elementwiseAssign (const S &s)
 
template<class S >
MatrixBase< ELT > & elementwiseAddScalarInPlace (const S &s)
 
template<class S >
void elementwiseAddScalar (const S &s, typename MatrixBase< ELT >::template EltResult< S >::Add &out) const
 
template<class S >
MatrixBase< ELT > & elementwiseSubtractScalarInPlace (const S &s)
 
template<class S >
void elementwiseSubtractScalar (const S &s, typename MatrixBase< ELT >::template EltResult< S >::Sub &out) const
 
template<class S >
MatrixBase< ELT > & elementwiseSubtractFromScalarInPlace (const S &s)
 
template<class EE >
MatrixBase< ELT > & elementwiseMultiplyInPlace (const MatrixBase< EE > &r)
 
template<class EE >
void elementwiseMultiply (const MatrixBase< EE > &r, typename MatrixBase< ELT >::template EltResult< EE >::Mul &out) const
 
template<class EE >
MatrixBase< ELT > & elementwiseMultiplyFromLeftInPlace (const MatrixBase< EE > &r)
 
template<class EE >
MatrixBase< ELT > & elementwiseDivideInPlace (const MatrixBase< EE > &r)
 
template<class EE >
void elementwiseDivide (const MatrixBase< EE > &r, typename MatrixBase< ELT >::template EltResult< EE >::Dvd &out) const
 
template<class EE >
MatrixBase< ELT > & elementwiseDivideFromLeftInPlace (const MatrixBase< EE > &r)
 
 MatrixBase (const MatrixCommitment &commitment, const MatrixCharacter &character, int spacing, const Scalar *data)
 Construct a read-only view of pre-existing data. More...
 
 MatrixBase (const MatrixCommitment &commitment, const MatrixCharacter &character, int spacing, Scalar *data)
 Construct a writable view of pre-existing data. More...
 

Protected Member Functions

 VectorBase (MatrixHelperRep< Scalar > *hrep)
 
- Protected Member Functions inherited from SimTK::MatrixBase< ELT >
const MatrixHelper< Scalar > & getHelper () const
 
MatrixHelper< Scalar > & updHelper ()
 

Related Functions

(Note that these are not member functions.)

Matrix_<T> serialization and I/O

These methods are at namespace scope but are logically part of the Vector classes.

These deal with reading and writing Vectors from and to streams, which places an additional requirement on the element type T: the element must support the same operation you are trying to do on the Vector as a whole.

template<class E >
void writeUnformatted (std::ostream &o, const VectorBase< E > &v)
 Specialize for VectorBase<E> to delegate to element type E, with spaces separating the elements. More...
 

Additional Inherited Members

- Public Types inherited from SimTK::MatrixBase< ELT >
enum  {
  NScalarsPerElement = CNT<E>::NActualScalars,
  CppNScalarsPerElement = sizeof(E) / sizeof(Scalar)
}
 
typedef ELT E
 
typedef CNT< E >::TNeg ENeg
 
typedef CNT< E >::TWithoutNegator EWithoutNegator
 
typedef CNT< E >::TReal EReal
 
typedef CNT< E >::TImag EImag
 
typedef CNT< E >::TComplex EComplex
 
typedef CNT< E >::THerm EHerm
 
typedef CNT< E >::TPosTrans EPosTrans
 
typedef CNT< E >::TAbs EAbs
 
typedef CNT< E >::TStandard EStandard
 
typedef CNT< E >::TInvert EInvert
 
typedef CNT< E >::TNormalize ENormalize
 
typedef CNT< E >::TSqHermT ESqHermT
 
typedef CNT< E >::TSqTHerm ESqTHerm
 
typedef CNT< E >::Scalar EScalar
 
typedef CNT< E >::Number ENumber
 
typedef CNT< E >::StdNumber EStdNumber
 
typedef CNT< E >::Precision EPrecision
 
typedef CNT< E >::ScalarNormSq EScalarNormSq
 
typedef EScalar Scalar
 
typedef ENumber Number
 
typedef EStdNumber StdNumber
 
typedef EPrecision Precision
 
typedef EScalarNormSq ScalarNormSq
 
typedef MatrixBase< ET
 
typedef MatrixBase< ENegTNeg
 
typedef MatrixBase
< EWithoutNegator
TWithoutNegator
 
typedef MatrixBase< ERealTReal
 
typedef MatrixBase< EImagTImag
 
typedef MatrixBase< EComplexTComplex
 
typedef MatrixBase< EHermTHerm
 
typedef MatrixBase< ETPosTrans
 
typedef MatrixBase< EAbsTAbs
 
typedef MatrixBase< EStandardTStandard
 
typedef MatrixBase< EInvertTInvert
 
typedef MatrixBase< ENormalizeTNormalize
 
typedef MatrixBase< ESqHermTTSqHermT
 
typedef MatrixBase< ESqTHermTSqTHerm
 

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)
inlineexplicit

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)
inlineexplicitprotected

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
template<class ELT>
VectorBase& SimTK::VectorBase< ELT >::operator/= ( const StdNumber t)
inline
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
template<class ELT>
template<class EE >
VectorBase& SimTK::VectorBase< ELT >::operator+= ( const VectorBase< EE > &  b)
inline
template<class ELT>
template<class EE >
VectorBase& SimTK::VectorBase< ELT >::operator-= ( const VectorBase< EE > &  b)
inline
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.)

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 weird 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.

template<class ELT>
template<class EE >
void SimTK::VectorBase< ELT >::rowScale ( const VectorBase< EE > &  v,
typename EltResult< EE >::Mul &  out 
) const
inline
template<class ELT>
template<class EE >
EltResult<EE>::Mul SimTK::VectorBase< ELT >::rowScale ( const VectorBase< EE > &  v) const
inline
template<class ELT>
CNT<ScalarNormSq>::TSqrt SimTK::VectorBase< ELT >::normRMS ( int *  worstOne = 0) const
inline

Return the root-mean-square (RMS) norm of a Vector of scalars, with optional return of the index of the element of largest absolute value.

The RMS norm of a Vector v of length n is rms=sqrt(~v*v/n). If n==0 we define the RMS norm to be zero but return the element index as -1.

template<class ELT>
template<class EE >
CNT<ScalarNormSq>::TSqrt SimTK::VectorBase< ELT >::weightedNormRMS ( const VectorBase< EE > &  w,
int *  worstOne = 0 
) const
inline

Return the weighted root-mean-square (WRMS) norm of a Vector of scalars, with optional return of the index of the weighted element of largest absolute value.

The WRMS norm of a Vector v of length n with weights w is wrms=sqrt(sum_i((w_i*v_i)^2))/n). If n==0 we define the WRMS norm to be zero but return the element index as -1.

template<class ELT>
EAbs SimTK::VectorBase< ELT >::normInf ( int *  worstOne = 0) const
inline

Return the infinity norm (max absolute value) of a Vector of scalars, with optional return of the index of the element of largest absolute value.

The Inf norm of a Vector v is inf=max_i(|v_i|). If n==0 we define the Inf norm to be zero but return the element index as -1.

template<class ELT>
template<class EE >
EAbs SimTK::VectorBase< ELT >::weightedNormInf ( const VectorBase< EE > &  w,
int *  worstOne = 0 
) const
inline

Return the weighted infinity norm (max absolute value) WInf of a Vector of scalars, with optional return of the index of the weighted element of largest absolute value.

The WInf norm of a Vector v of length n with weights w is winf=max_i(|w_i*v_i|). If n==0 we define the WInf norm to be zero but return the element index as -1.

template<class ELT>
VectorBase& SimTK::VectorBase< ELT >::elementwiseInvertInPlace ( )
inline

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

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.

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
template<class ELT>
int SimTK::VectorBase< ELT >::ncol ( ) const
inline
template<class ELT>
ptrdiff_t SimTK::VectorBase< ELT >::nelt ( ) const
inline
template<class ELT>
TAbs SimTK::VectorBase< ELT >::abs ( ) const
inline
template<class ELT>
const ELT& SimTK::VectorBase< ELT >::operator[] ( int  i) const
inline
template<class ELT>
ELT& SimTK::VectorBase< ELT >::operator[] ( int  i)
inline
template<class ELT>
const ELT& SimTK::VectorBase< ELT >::operator() ( int  i) const
inline
template<class ELT>
ELT& SimTK::VectorBase< ELT >::operator() ( int  i)
inline
template<class ELT>
VectorView_<ELT> SimTK::VectorBase< ELT >::operator() ( int  i,
int  m 
) const
inline
template<class ELT>
VectorView_<ELT> SimTK::VectorBase< ELT >::operator() ( int  i,
int  m 
)
inline
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
template<class ELT>
THerm SimTK::VectorBase< ELT >::updTranspose ( )
inline
template<class ELT>
THerm SimTK::VectorBase< ELT >::operator~ ( ) const
inline
template<class ELT>
THerm SimTK::VectorBase< ELT >::operator~ ( )
inline
template<class ELT>
const VectorBase& SimTK::VectorBase< ELT >::operator+ ( ) const
inline
template<class ELT>
const TNeg& SimTK::VectorBase< ELT >::negate ( ) const
inline
template<class ELT>
TNeg& SimTK::VectorBase< ELT >::updNegate ( )
inline
template<class ELT>
const TNeg& SimTK::VectorBase< ELT >::operator- ( ) const
inline
template<class ELT>
TNeg& SimTK::VectorBase< ELT >::operator- ( )
inline
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
template<class ELT>
ELT SimTK::VectorBase< ELT >::sum ( ) const
inline
template<class ELT>
VectorIterator<ELT, VectorBase<ELT> > SimTK::VectorBase< ELT >::begin ( )
inline
template<class ELT>
VectorIterator<ELT, VectorBase<ELT> > SimTK::VectorBase< ELT >::end ( )
inline

Friends And Related Function Documentation

template<class E >
void writeUnformatted ( std::ostream &  o,
const VectorBase< E > &  v 
)
related

Specialize for VectorBase<E> to delegate to element type E, with spaces separating the elements.


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