A vector. More...
#include <TooN/toon.h>
Public Types | |
| typedef Base::template VLayout< Size, Precision >::PointerType | PointerType |
Public Member Functions | |
Constructors | |
| Vector () | |
| Default constructor for vectors. More... | |
| Vector (Vector &&)=default | |
| Vector (const Vector &)=default | |
| Vector (int size_in) | |
| Constructor for dynamically-size vectors. More... | |
| Vector (PointerType data) | |
| Constructor used when constructing a vector which references other data, e.g. More... | |
| template<typename X = Precision> | |
| Vector (std::initializer_list< Precision > init, typename std::enable_if< sizeof(X)&&(Size< 0)>::type *=0) | |
| Construct from an initializer list. More... | |
| template<typename Precision2 , int Size2> | |
| Vector (const Precision2(&init)[Size2]) | |
| Construct from an array by reference. More... | |
| Vector (PointerType data, int size_in) | |
| Constructor used when constructing a dynamic vector which references other data, e.g. More... | |
| Vector (PointerType data_in, int size_in, int stride_in, Internal::Slicing) | |
| internal constructor | |
| template<class Op > | |
| Vector (const Operator< Op > &op) | |
| construction from Operator object More... | |
| template<int Size2, typename Precision2 , typename Base2 > | |
| Vector (const Vector< Size2, Precision2, Base2 > &from) | |
| constructor from arbitrary vector | |
Assignment | |
| Vector & | operator= (const Vector &from) |
| operator = from copy A size mismatch is a fatal error, unless the destination is resizable. More... | |
| template<int Size2, typename Precision2 , typename Base2 > | |
| Vector< Size, Precision, Base > & | operator= (const Vector< Size2, Precision2, Base2 > &from) |
| operator = another Vector A size mismatch is a fatal error, unless the destination is resizable. More... | |
| template<class Op > | |
| Vector & | operator= (const Operator< Op > &op) |
| assignment from an Operator object Assignment from sized operators causes a resize of Resizable Vectors. More... | |
Operators on the vector | |
| Vector & | operator/= (const Precision rhs) |
| divide this vector by a constant | |
| Vector & | operator*= (const Precision rhs) |
| multiply this vector by a constant | |
| template<int Size2, class Precision2 , class Base2 > | |
| Vector & | operator+= (const Vector< Size2, Precision2, Base2 > &rhs) |
| add another vector onto this one | |
| template<class Op > | |
| Vector & | operator+= (const Operator< Op > &op) |
| add an Operator object onto this vector More... | |
| 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 | |
Comparison | |
| template<int Size2, class Precision2 , class Base2 > | |
| bool | operator== (const Vector< Size2, Precision2, Base2 > &rhs) const |
| Test for equality with another vector. | |
| template<int Size2, class Precision2 , class Base2 > | |
| bool | operator!= (const Vector< Size2, Precision2, Base2 > &rhs) const |
| Test for inequality with another vector. | |
| template<class Op > | |
| bool | operator!= (const Operator< Op > &op) |
Misc | |
| Vector & | ref () |
| return me as a non const reference - useful for temporaries | |
Static Public Attributes | |
| static const int | SizeParameter = Size |
| Value of template Size parameter. More... | |
Detailed Description
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
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():
Constructor & Destructor Documentation
◆ Vector() [1/7]
|
inline |
Default constructor for vectors.
For fixed-sized vectors, this does nothing, i.e. does not guarantee to initialise the vector to any particular values. For dynamically sized vectors, this sets the vector to have a length of 0 which renders the vector useless because vectors can't be resized
◆ Vector() [2/7]
|
inlineexplicit |
Constructor for dynamically-size vectors.
This can also be used for statically sized vectors in which case the argument is ignored. The values of the vector are uninitialised
◆ Vector() [3/7]
|
inlineexplicit |
Constructor used when constructing a vector which references other data, e.g.
◆ Vector() [4/7]
|
inline |
Construct from an initializer list.
◆ Vector() [5/7]
|
inline |
Construct from an array by reference.
◆ Vector() [6/7]
|
inline |
Constructor used when constructing a dynamic vector which references other data, e.g.
◆ Vector() [7/7]
|
inline |
construction from Operator object
This is used to implement return value optimisation for vectors created from the product of a matrix and a vector, or another object like Ones
Member Function Documentation
◆ operator+=()
|
inline |
◆ operator=() [1/3]
|
inline |
operator = from copy A size mismatch is a fatal error, unless the destination is resizable.
◆ operator=() [2/3]
|
inline |
operator = another Vector A size mismatch is a fatal error, unless the destination is resizable.
◆ operator=() [3/3]
|
inline |
assignment from an Operator object Assignment from sized operators causes a resize of Resizable Vectors.
Assignment from unsized operators dows not.
Member Data Documentation
◆ SizeParameter
|
static |
Value of template Size parameter.
Used by internal classes to reduce parameter list sizes.
The documentation for this class was generated from the following file:
- TooN/internal/vector.hh
