ML Reference
ml::Tvec8< DT > Class Template Reference

An eight dimensional vector class for floating point types. More...

#include <mlVector8.h>

Inheritance diagram for ml::Tvec8< DT >:
ml::FloatingPointVector< DT, 8 > ml::FloatingPointVectorDataContainerBase< DT, size >

Public Types

typedef FloatingPointVector< DT, 8 > 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, 8 >
enum  
typedef DT ComponentType
 A typedef to 'export' the type of components.

Public Member Functions

constructors
 Tvec8 (const DT value=0)
 Tvec8 (const Superclass &v)
 Tvec8 (const DT x, const DT y, const DT z, const DT c, const DT t, const DT u, const DT v, const DT w)
Other operators and methods
void assign (const DT x, const DT y, const DT z, const DT c, const DT t, const DT u, const DT v, const DT w)
 Sets all components to the passed values.
Public Member Functions inherited from ml::FloatingPointVector< DT, 8 >
 FloatingPointVector (DT value=DT(0))
FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > & operator= (DT value)
 Assignment of scalar value to all components.
bool operator== (const FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > &buffer) const
 Returns whether *this and buffer are component-wise equal.
bool operator!= (const FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > &buffer) const
 Returns whether any components of *this and buffer are not equal.
bool operator< (const FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > &buffer) const
const DT & operator[] (const size_t i) const
DT & operator[] (const size_t i)
size_t getSize () const
 Returns the number of elements of value buffer.
DT norm2 () const
DT norm2 (const FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > &weight) const
DT dot (const FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > &buffer) const
DT normalize ()
DT length () const
 Returns the length of the vector, i.e., norm2().
DT distance (const FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > &buffer) const
 Returns the distance of this vector to a given one.
DT distanceSquared (const FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > &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, FloatingPointVectorDataContainerBase< DT, size > > buffer)
 Sets the component-wise minimum of *this and buffer in *this.
void compMax (FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > 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, FloatingPointVectorDataContainerBase< DT, size > > &d)
void compSqr ()
 Calculates and sets the square of all components.
void compSqrt ()
void clampMin (const FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > &lower)
void clampMax (const FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > &upper)
void clamp (const FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > &lower, const FloatingPointVector< DT, size, FloatingPointVectorDataContainerBase< DT, size > > &upper)
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, FloatingPointVectorDataContainerBase< DT, size > > cross (const FloatingPointVector< DT, 3, FloatingPointVectorDataContainerBase< DT, size > > &b) const
 Returns the cross product for elements, i.e., the returned vector is orthogonal 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
std::istream & readIn (std::istream &is)
 Reads all components from istream is starting starting from index 0 to size-1.

Additional Inherited Members

Protected Attributes inherited from ml::FloatingPointVectorDataContainerBase< DT, size >
DT _buffer [size]
Related Symbols inherited from ml::FloatingPointVector< DT, 8 >

Detailed Description

template<class DT>
class ml::Tvec8< DT >

An eight dimensional vector class for floating point types.

A eight dimensional vector class.

Definition at line 31 of file mlVector8.h.

Member Typedef Documentation

◆ ComponentType

template<class DT>
typedef DT ml::Tvec8< DT >::ComponentType

A typedef to 'export' the type of components.

Definition at line 39 of file mlVector8.h.

◆ Superclass

template<class DT>
typedef FloatingPointVector<DT,8> ml::Tvec8< DT >::Superclass

A typedef as a shorthand for the base class.

Definition at line 36 of file mlVector8.h.

Constructor & Destructor Documentation

◆ Tvec8() [1/3]

template<class DT>
ml::Tvec8< DT >::Tvec8 ( const DT value = 0)
inlineexplicit

Default and value constructor. Sets all entries to a user given value. value is the init value for all entries. 0 is the default value.

Definition at line 47 of file mlVector8.h.

◆ Tvec8() [2/3]

template<class DT>
ml::Tvec8< DT >::Tvec8 ( const Superclass & v)
inline

Copy constructor from FloatingPointVector. This allows the usage of SclarVectorTemplate objects of the same DT in operators using the Tvec8, because the FloatingPointVector objects can implicitly be cast.

Definition at line 54 of file mlVector8.h.

◆ Tvec8() [3/3]

template<class DT>
ml::Tvec8< DT >::Tvec8 ( const DT x,
const DT y,
const DT z,
const DT c,
const DT t,
const DT u,
const DT v,
const DT w )
inline

Builds the vector from the scalars x, y, z, c, t, u, v, and w to the components 0 to 7, respectively.

Definition at line 60 of file mlVector8.h.

Member Function Documentation

◆ assign()

template<class DT>
void ml::Tvec8< DT >::assign ( const DT x,
const DT y,
const DT z,
const DT c,
const DT t,
const DT u,
const DT v,
const DT w )
inline

Sets all components to the passed values.

Definition at line 72 of file mlVector8.h.

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