|
|
| Vector () |
|
| Vector (int size_in) |
|
| Vector (PointerType data) |
|
| Vector (PointerType data, int size_in) |
|
| Vector (PointerType data_in, int size_in, int stride_in, Internal::Slicing) |
| internal constructor More...
|
|
template<class Op > |
| Vector (const Operator< Op > &op) |
|
template<int Size2, typename Precision2 , typename Base2 > |
| Vector (const Vector< Size2, Precision2, Base2 > &from) |
| constructor from arbitrary vector More...
|
|
|
Vector & | operator= (const Vector &from) |
|
template<int Size2, typename Precision2 , typename Base2 > |
Vector< Size, Precision, Base > & | operator= (const Vector< Size2, Precision2, Base2 > &from) |
|
template<class Op > |
Vector & | operator= (const Operator< Op > &op) |
|
|
Vector & | operator/= (const Precision &rhs) |
| divide this vector by a constant More...
|
|
Vector & | operator*= (const Precision &rhs) |
| multiply this vector by a constant More...
|
|
template<int Size2, class Precision2 , class Base2 > |
Vector & | operator+= (const Vector< Size2, Precision2, Base2 > &rhs) |
| add another vector onto this one More...
|
|
template<class Op > |
Vector & | operator+= (const Operator< Op > &op) |
|
template<class Op > |
Vector & | operator-= (const Operator< Op > &op) |
|
template<int Size2, class Precision2 , class Base2 > |
Vector & | operator-= (const Vector< Size2, Precision2, Base2 > &rhs) |
| subtract another vector from this one More...
|
|
|
template<int Size2, class Precision2 , class Base2 > |
bool | operator== (const Vector< Size2, Precision2, Base2 > &rhs) const |
| Test for equality with another vector. More...
|
|
template<int Size2, class Precision2 , class Base2 > |
bool | operator!= (const Vector< Size2, Precision2, Base2 > &rhs) const |
| Test for inequality with another vector. More...
|
|
|
Vector & | ref () |
| return me as a non const reference - useful for temporaries More...
|
|
template<int Size = Dynamic, typename Precision = DefaultPrecision, typename Base = Internal::VBase>
class TooN::Vector< Size, Precision, Base >
A vector. Support is provided for all the usual vector operations:
- elements can be accessed using the familiar [] notation with the index starting at 0
- they can be added or subtracted
- they can be printed or loaded from streams
- they can be multiplied (on either side) or divided by a scalar on the right:
- the vector dot product can be computed
- subvectors can be extracted using the templated slice() member function
- the vector cross product can be computed for statically sized 3-vectors
See individual member function documentation for examples of usage.
- Statically- and dynamically-sized vectors
The library provides classes for both statically- and dynamically-sized vectors. If you know what dimension of vector you're going to use (e.g. 3 to represent a point in 3D space), it's more efficient to statically sized vectors. The size of static vectors is determined at compile time; that of dynamically-sized vectors at run-time.
To create a 3-dimensional vector, use:
and to create a vector of some other dimensionality just replace 3 with the positive integer of your choice, or some expression which the compiler can evaluate to an integer at compile time.
The preferred way of initialising a vector is to use makeVector. The makeVector function constructs a static vector initialised to the size and the contents of the comma-separated list of argments. The makeVector vectors are real Vectors and so can be used anywhere where a vector is needed, not just in initialisations. For example
Because the make_Vector syntax creates actual vectors, compile-time checking is done to ensure that all vectors defined in this way have the correct number of elements.
- Dynamically-sized vectors
To create a dynamically sized vector, use:
where size is an integer which will be evaluated at run time.
Vector<> is actually a synonym for Vector<Dynamic> which is Vector<-1> being a template specialisation of Vector<N> with a special implementation that allows the size to be determined at runtime.
- Row vectors and column vectors
This library makes no distinction between row vectors and column vectors. Vectors that appear on the left of a multiplication are treated as row vectors while those that appear on the right are treated as column vectors (thus v1*v2
means the dot product). This means that sometimes you have to be careful to include prarentheses since it is possible to write obscure stuff like
Vector<4> v4 = v1 * v2 * v3;
which in the absence of any extra parentheses means 'compute the dot product between v1
and v2
and then multiply v3
by this scalar and assign to v4
'.
If the row-column distinction is important, then vectors can be turned into matrices with one row or column by using as_row() or as_col():
double d[3] = {1,2,3};
Vector<3> v(d);
Matrix<3,3> M = v.as_col() * v.as_row();
Definition at line 138 of file TooN.h.