ML Reference
|
Declaration of float vector type traits: More...
#include <mlVector2.h>
Public Types | |
typedef FloatingPointVector< DT, 2, Vector2DataContainer< DT > > | Superclass |
A typedef as a shorthand for the base class. | |
typedef DT | ComponentType |
A typedef to "export" the type of components. | |
Public Types inherited from ml::FloatingPointVector< DT, 2, Vector2DataContainer< DT > > | |
enum | |
This enum grants access to the size during compile time, e.g. More... | |
typedef DT | ComponentType |
A typedef to "export" the type of components. | |
Public Member Functions | |
Tvec3< DT > | affineVec () const |
Builds a homogeneous Tvec3vector from *this and return it, i.e. | |
Tvec3< DT > | affinePoint () const |
Builds a homogeneous Tvec3point from *this and return it, i.e. | |
Constructors | |
Tvec2 (const DT value=0) | |
Default and value constructor. | |
Tvec2 (const Superclass &v) | |
Copy constructor from FloatingPointVector. | |
Tvec2 (const DT px, const DT py) | |
Constructor building the vector x (first entry) and y (second entry). | |
void | assign (const DT px, const DT py) |
Sets all components to the passed values. | |
Tvec2 (const Tvec3< DT > &v, const bool normalize) | |
Casts v to Tvec2. | |
Tvec2 (const Tvec3< DT > &v, const int axis) | |
Casts v3 to v2. | |
Public Member Functions inherited from ml::FloatingPointVector< DT, 2, Vector2DataContainer< DT > > | |
FloatingPointVector (DT value=DT(0)) | |
Default and value constructor. | |
FloatingPointVector< DT, size, Vector2DataContainer< DT > > & | operator= (DT value) |
Assignment of scalar value to all components. | |
bool | operator== (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &buffer) const |
Returns whether *this and buffer are component wise equal. | |
bool | operator!= (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &buffer) const |
Returns whether any components of *this and buffer are not equal. | |
bool | operator< (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &buffer) const |
Defines an artificial order for use in sort algorithms (lexicographical order). | |
const DT & | operator[] (const size_t i) const |
Constant indexing operators. | |
DT & | operator[] (const size_t i) |
Indexing operators. | |
size_t | getSize () const |
Returns the number of elements of value buffer. | |
DT | norm2 () const |
Returns the Euclidean norm (the vector length), i.e., square root of sum of squares of all components. | |
DT | norm2 (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &weight) const |
Returns the weighted Euclidean norm, i.e., square root of sum of squares of all components multiplied with corresponding squared component of weight. | |
DT | dot (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &buffer) const |
Returns the dot product, i.e., sum of all components multiplied with corresponding components of buffer. | |
DT | normalize () |
Normalizes the buffer and returns the Euclidean length of vector before normalization, i.e., norm2. | |
DT | length () const |
Returns the length of the vector, i.e. norm2(). | |
DT | distance (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &buffer) const |
Returns the distance of this vector to a given one. | |
DT | distanceSquared (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &buffer) const |
Returns the squared distance of this vector to a given one. | |
DT | lengthSquared () const |
Returns the squared length of the vector. | |
DT | compSum () const |
Returns the sum of all components. | |
DT | compMul () const |
Returns the product of all vector components. | |
DT | compMaxAbs () const |
Returns the maximum of absolute component values. | |
void | compMin (FloatingPointVector< DT, size, Vector2DataContainer< DT > > buffer) |
Sets the component wise minimum of *this and buffer in *this. | |
void | compMax (FloatingPointVector< DT, size, Vector2DataContainer< DT > > buffer) |
Sets the component wise maximum of *this and buffer in *this. | |
void | compAbs () |
Kills negative signs from all components. | |
void | compDiv (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &d) |
Divides each vector component by the corresponding one of d. | |
void | compSqr () |
Calculates and sets the square of all components. | |
void | compSqrt () |
Calculates and sets square root of all components. | |
void | clampMin (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &lower) |
Calculates and sets all components clamped to lower, i.e., if any component is smaller than the corresponding one in lower then it is set to the one from lower. | |
void | clampMax (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &upper) |
Calculates and sets all components clamped to upper, i.e., if any component is greater than the corresponding one in upper then it is set to the one from upper. | |
void | clamp (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &lower, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &upper) |
Calculates and sets all components of *this so that they are between minimum min and maximum max. | |
void | compRound () |
Rounds all components of this vector using floor(component + 0.5). | |
void | compFloor () |
Rounds all components of this vector using floor(component). | |
void | compCeil () |
Rounds all components of this vector to integer using ceil(component). | |
FloatingPointVector< DT, 3, Vector2DataContainer< DT > > | cross (const FloatingPointVector< DT, 3, Vector2DataContainer< DT > > &b) const |
Returns the cross product for elements, i.e., return vector vertical to *this and b. | |
void | apply (ML_LA_FROM_DOUBLE_TO_DOUBLE f) |
Applies the function f to each component starting from index 0 to index size-1. | |
std::ostream & | writeOut (std::ostream &os) const |
Writes all components to ostream os starting from index 0 to size-1. | |
std::istream & | readIn (std::istream &is) |
Reads all components from istream is starting starting from index 0 to size-1. | |
Additional Inherited Members | ||
Public Attributes inherited from ml::Vector2DataContainer< DT > | ||
union { | ||
struct { | ||
DT x | ||
X-component of the vector, same as _buffer[0]. More... | ||
DT y | ||
Y-component of the vector, same as _buffer[1]. More... | ||
} | ||
DT _buffer [2] | ||
Data members as vector to provide array access, same as x and y members. More... | ||
}; | ||
Related Symbols inherited from ml::FloatingPointVector< DT, 2, Vector2DataContainer< DT > > | ||
DT | compMul (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &vec) | |
Returns the product of all components. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | compMin (FloatingPointVector< DT, size, Vector2DataContainer< DT > > buffer1, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &buffer2) | |
Component wise minimum of buffer1 and buffer2. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | compMax (FloatingPointVector< DT, size, Vector2DataContainer< DT > > buffer1, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &buffer2) | |
Component wise maximum of buffer1 and buffer2. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | compAbs (FloatingPointVector< DT, size, Vector2DataContainer< DT > > vec) | |
Returns a vector with all components from vec without negative sign. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | compDiv (FloatingPointVector< DT, size, Vector2DataContainer< DT > > vec, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &d) | |
Component wise division of vec / d. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | compSqr (FloatingPointVector< DT, size, Vector2DataContainer< DT > > vec) | |
Returns a vector with all components from vec squared. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | compSqrt (FloatingPointVector< DT, size, Vector2DataContainer< DT > > vec) | |
Returns a vector with all components from vec square-rooted. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | clampMin (FloatingPointVector< DT, size, Vector2DataContainer< DT > > vec, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &m) | |
Returns a new vector with all components from vec clamped to minimum m. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | clampMax (FloatingPointVector< DT, size, Vector2DataContainer< DT > > vec, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &m) | |
Returns a new vector with all components from vec clamped to maximum m. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | clamp (FloatingPointVector< DT, size, Vector2DataContainer< DT > > vec, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &lower, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &upper) | |
Returns a new vector with all components from vec clamped to range [lower, upper]. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > & | operator+= (FloatingPointVector< DT, size, Vector2DataContainer< DT > > &op1, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &buffer) | |
Arithmetic assignment: Component wise addition. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > & | operator-= (FloatingPointVector< DT, size, Vector2DataContainer< DT > > &op1, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &buffer) | |
Arithmetic assignment: Component wise subtraction of buffer from *this. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > & | operator*= (FloatingPointVector< DT, size, Vector2DataContainer< DT > > &op1, MLdouble value) | |
Arithmetic assignment: Component wise multiplication *this with specialized MLdouble scalar value. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > & | operator*= (FloatingPointVector< DT, size, Vector2DataContainer< DT > > &op1, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &op2) | |
Arithmetic assignment: Component wise multiplication *this with a vector of the same size. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > & | operator/= (FloatingPointVector< DT, size, Vector2DataContainer< DT > > &op1, MLdouble value) | |
Arithmetic assignment: Component wise division of *this by scalar value. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > & | operator/= (FloatingPointVector< DT, size, Vector2DataContainer< DT > > &op1, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &op2) | |
Arithmetic assignment: Component wise division of *this by the values of a vector of the same size. | ||
bool | operator! (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &a) | |
Returns whether all components are 0. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | operator+ (FloatingPointVector< DT, size, Vector2DataContainer< DT > > lhs, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &rhs) | |
Return value is the component wise addition of lhs and rhs. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | operator+ (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &buffer) | |
Unary plus, for completeness and for those who really want to use that... | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | operator- (FloatingPointVector< DT, size, Vector2DataContainer< DT > > lhs, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &rhs) | |
Return value is the component wise subtraction of rhs from lhs. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | operator- (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &buffer) | |
Unary minus, all components of the vector are multiplied with -1. | ||
DT | operator* (const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &a, const FloatingPointVector< DT, size, Vector2DataContainer< DT > > &b) | |
Dot product, returns a.dot(b). | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | operator* (FloatingPointVector< DT, size, Vector2DataContainer< DT > > lhs, MLdouble rhs) | |
Component wise multiplication of lhs with rhs. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | operator* (MLdouble lhs, FloatingPointVector< DT, size, Vector2DataContainer< DT > > rhs) | |
Component wise multiplication of rhs with lhs. | ||
FloatingPointVector< DT, size, Vector2DataContainer< DT > > | operator/ (FloatingPointVector< DT, size, Vector2DataContainer< DT > > lhs, MLdouble rhs) | |
Component wise division of lhs by specialized rhs of type MLdouble. | ||
Declaration of float vector type traits:
Forward declarations to resolve header file dependencies.
A two dimensional vector class for floating point types.
Definition at line 56 of file mlVector2.h.
typedef DT ml::Tvec2< DT >::ComponentType |
A typedef to "export" the type of components.
Definition at line 64 of file mlVector2.h.
typedef FloatingPointVector<DT, 2, Vector2DataContainer<DT> > ml::Tvec2< DT >::Superclass |
A typedef as a shorthand for the base class.
Definition at line 61 of file mlVector2.h.
|
inlineexplicit |
Default and value constructor.
Set all entries to a user given value. value is the init value for all entries. 0 is the default value.
Definition at line 72 of file mlVector2.h.
|
inline |
Copy constructor from FloatingPointVector.
This allows the usage of SclarVectorTemplate objects of the same DT in operators using the Tvec2, because the FloatingPointVector objects can implicitly be cast.
Definition at line 79 of file mlVector2.h.
|
inline |
Constructor building the vector x (first entry) and y (second entry).
Definition at line 84 of file mlVector2.h.
Casts v to Tvec2.
If normalize is true then the first two components are divided by the last one to implement a homogeneous cast. In that case it is up to the caller to avoid a division by zero. If normalize if false then the first two components are taken unchanged.
Definition at line 100 of file mlVector2.h.
References ML_CHECK_FLOAT_THROW.
Casts v3 to v2.
axis specifies component to be thrown away. All other components are copied sequentially. If axis is not within [0,2] then the last component is thrown away.
Definition at line 118 of file mlVector2.h.
Builds a homogeneous Tvec3point from *this and return it, i.e.
leaves all components unchanged and set the third component to 1.
Definition at line 140 of file mlVector2.h.
Builds a homogeneous Tvec3vector from *this and return it, i.e.
leaves all components unchanged and set the third component to 0.
Definition at line 133 of file mlVector2.h.
|
inline |
Sets all components to the passed values.
Definition at line 90 of file mlVector2.h.