jrlMathTools::Vector3D< T > Struct Template Reference

Generic 3d vector. More...

#include <jrl/mathtools/vector3.hh>

Public Member Functions
	Vector3D ()
	Default constructor: all fields are set to zero.
	Vector3D (const T x, const T y, const T z)
Vector3D< T > &	operator= (const Vector3D< T > &v)
	Assignment operator.
Vector3D< T >	operator- () const
	Unary operator -.
T &	operator[] (unsigned i)
	Array operator.
T	operator[] (unsigned i) const
	Array operator.
T &	operator() (unsigned i)
	Array operator.
T	operator() (unsigned i) const
	Array operator.
bool	operator== (const Vector3D< T > &v) const
	Binary operator ==.
bool	operator!= (const Vector3D< T > &v) const
	Binary operator !=.
Vector3D< T >	operator+ (const Vector3D< T > &v) const
	Binary operator +.
Vector3D< T >	operator- (const Vector3D< T > &v) const
	Binary operator -.
void	operator+= (const Vector3D< T > &v)
	Binary operator +=.
void	operator-= (const Vector3D< T > &v)
	Binary operator -=.
Vector3D< T >	operator* (const T &t) const
	Binary operator *.
T	operator* (const Vector3D< T > &v) const
	Binary operator * : dot product.
Vector3D< T >	operator/ (const T &t) const
	Binary operator /.
void	operator*= (const T &t)
	Binary operator *=.
void	operator/= (const T &t)
	Binary operator /=.
void	normalize ()
	Normalize .
T	norm () const
	Get the norm.
bool	IsZero () const
	Check if the vector is set to zero.
T	normsquared () const
	Get the norm squared.
Vector3D< T >	operator^ (const Vector3D< T > &v2) const
	Cross product.
std::ostream &	display (std::ostream &os) const

Public Attributes
T	m_x
T	m_y
T	m_z

Detailed Description

template<typename T>
struct jrlMathTools::Vector3D< T >

Generic 3d vector.

Constructor & Destructor Documentation

Vector3D() [1/2]

template<typename T>

jrlMathTools::Vector3D< T >::Vector3D ( )

inline

Default constructor: all fields are set to zero.

References m_x, m_y, and m_z.

Referenced by operator!=(), operator*(), operator*(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator=(), operator==(), and operator^().

Vector3D() [2/2]

template<typename T>

jrlMathTools::Vector3D< T >::Vector3D ( const T x, const T y, const T z )

inline

References m_x, m_y, and m_z.

Member Function Documentation

display()

template<typename T>

std::ostream & jrlMathTools::Vector3D< T >::display ( std::ostream & os ) const

inline

References m_x, m_y, and m_z.

Referenced by jrlMathTools::operator<<().

IsZero()

template<typename T>

bool jrlMathTools::Vector3D< T >::IsZero ( ) const

inline

Check if the vector is set to zero.

References m_x, m_y, and m_z.

norm()

template<typename T>

T jrlMathTools::Vector3D< T >::norm ( ) const

inline

Get the norm.

References m_x, m_y, and m_z.

normalize()

template<typename T>

void jrlMathTools::Vector3D< T >::normalize ( )

inline

Normalize .

References m_x, m_y, and m_z.

normsquared()

template<typename T>

T jrlMathTools::Vector3D< T >::normsquared ( ) const

inline

Get the norm squared.

References m_x, m_y, and m_z.

operator!=()

template<typename T>

bool jrlMathTools::Vector3D< T >::operator!= ( const Vector3D< T > & v ) const

inline

Binary operator !=.

References m_x, m_y, m_z, and Vector3D().

operator()() [1/2]

template<typename T>

T & jrlMathTools::Vector3D< T >::operator() ( unsigned i )

inline

Array operator.

operator()() [2/2]

template<typename T>

T jrlMathTools::Vector3D< T >::operator() ( unsigned i ) const

inline

Array operator.

operator*() [1/2]

template<typename T>

Vector3D< T > jrlMathTools::Vector3D< T >::operator* ( const T & t ) const

inline

Binary operator *.

References m_x, m_y, m_z, and Vector3D().

operator*() [2/2]

template<typename T>

T jrlMathTools::Vector3D< T >::operator* ( const Vector3D< T > & v ) const

inline

Binary operator * : dot product.

References m_x, m_y, m_z, and Vector3D().

operator*=()

template<typename T>

void jrlMathTools::Vector3D< T >::operator*= ( const T & t )

inline

Binary operator *=.

References m_x, m_y, and m_z.

operator+()

template<typename T>

Vector3D< T > jrlMathTools::Vector3D< T >::operator+ ( const Vector3D< T > & v ) const

inline

Binary operator +.

References m_x, m_y, m_z, and Vector3D().

operator+=()

template<typename T>

void jrlMathTools::Vector3D< T >::operator+= ( const Vector3D< T > & v )

inline

Binary operator +=.

References m_x, m_y, m_z, and Vector3D().

operator-() [1/2]

template<typename T>

Vector3D< T > jrlMathTools::Vector3D< T >::operator- ( ) const

inline

Unary operator -.

References m_x, m_y, m_z, and Vector3D().

operator-() [2/2]

template<typename T>

Vector3D< T > jrlMathTools::Vector3D< T >::operator- ( const Vector3D< T > & v ) const

inline

Binary operator -.

References m_x, m_y, m_z, and Vector3D().

operator-=()

template<typename T>

void jrlMathTools::Vector3D< T >::operator-= ( const Vector3D< T > & v )

inline

Binary operator -=.

References m_x, m_y, m_z, and Vector3D().

operator/()

template<typename T>

Vector3D< T > jrlMathTools::Vector3D< T >::operator/ ( const T & t ) const

inline

Binary operator /.

References m_x, m_y, m_z, and Vector3D().

operator/=()

template<typename T>

void jrlMathTools::Vector3D< T >::operator/= ( const T & t )

inline

Binary operator /=.

References m_x, m_y, and m_z.

operator=()

template<typename T>

Vector3D< T > & jrlMathTools::Vector3D< T >::operator= ( const Vector3D< T > & v )

inline

Assignment operator.

References m_x, m_y, m_z, and Vector3D().

operator==()

template<typename T>

bool jrlMathTools::Vector3D< T >::operator== ( const Vector3D< T > & v ) const

inline

Binary operator ==.

References m_x, m_y, m_z, and Vector3D().

operator[]() [1/2]

template<typename T>

T & jrlMathTools::Vector3D< T >::operator[] ( unsigned i )

inline

Array operator.

References m_x, m_y, and m_z.

operator[]() [2/2]

template<typename T>

T jrlMathTools::Vector3D< T >::operator[] ( unsigned i ) const

inline

Array operator.

References m_x, m_y, and m_z.

operator^()

template<typename T>

Vector3D< T > jrlMathTools::Vector3D< T >::operator^ ( const Vector3D< T > & v2 ) const

inline

Cross product.

References m_x, m_y, m_z, and Vector3D().

Member Data Documentation

m_x

template<typename T>

T jrlMathTools::Vector3D< T >::m_x

Referenced by display(), IsZero(), norm(), normalize(), normsquared(), operator!=(), jrlMathTools::Matrix4x4< T >::operator*(), operator*(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator/=(), operator=(), jrlMathTools::Vector4D< T >::operator=(), operator==(), operator[](), operator[](), operator^(), Vector3D(), and Vector3D().

m_y

template<typename T>

T jrlMathTools::Vector3D< T >::m_y

Referenced by display(), IsZero(), norm(), normalize(), normsquared(), operator!=(), jrlMathTools::Matrix4x4< T >::operator*(), operator*(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator/=(), operator=(), jrlMathTools::Vector4D< T >::operator=(), operator==(), operator[](), operator[](), operator^(), Vector3D(), and Vector3D().

m_z

template<typename T>

T jrlMathTools::Vector3D< T >::m_z

Referenced by display(), IsZero(), norm(), normalize(), normsquared(), operator!=(), jrlMathTools::Matrix4x4< T >::operator*(), operator*(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator/=(), operator=(), jrlMathTools::Vector4D< T >::operator=(), operator==(), operator[](), operator[](), operator^(), Vector3D(), and Vector3D().