jrlMathTools::Vector3D< T > Struct Template Reference

Generic 3d vector. More...

#include <jrl/mathtools/vector3.hh>

List of all members.

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

template<typename T>

jrlMathTools::Vector3D< T >::Vector3D

(

)

[inline]

Default constructor: all fields are set to zero.

template<typename T>

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

---

Member Function Documentation

template<typename T>

std::ostream& jrlMathTools::Vector3D< T >::display

(

std::ostream &

os

)

const [inline]

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

bool jrlMathTools::Vector3D< T >::IsZero

(

)

const [inline]

Check if the vector is set to zero.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

T jrlMathTools::Vector3D< T >::norm

(

)

const [inline]

Get the norm.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

void jrlMathTools::Vector3D< T >::normalize

(

)

[inline]

Normalize .

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

T jrlMathTools::Vector3D< T >::normsquared

(

)

const [inline]

Get the norm squared.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

bool jrlMathTools::Vector3D< T >::operator!=

(

const Vector3D< T > &

v

)

const [inline]

Binary operator !=.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

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

(

unsigned

i

)

[inline]

Array operator.

template<typename T>

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

(

unsigned

i

)

const [inline]

Array operator.

template<typename T>

Vector3D<T> jrlMathTools::Vector3D< T >::operator*

(

const T &

t

)

const [inline]

Binary operator *.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

T jrlMathTools::Vector3D< T >::operator*

(

const Vector3D< T > &

v

)

const [inline]

Binary operator * : dot product.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

void jrlMathTools::Vector3D< T >::operator*=

(

const T &

t

)

[inline]

Binary operator *=.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

Vector3D<T> jrlMathTools::Vector3D< T >::operator+

(

const Vector3D< T > &

v

)

const [inline]

Binary operator +.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

void jrlMathTools::Vector3D< T >::operator+=

(

const Vector3D< T > &

v

)

[inline]

Binary operator +=.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

Vector3D<T> jrlMathTools::Vector3D< T >::operator-

(

)

const [inline]

Unary operator -.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

Vector3D<T> jrlMathTools::Vector3D< T >::operator-

(

const Vector3D< T > &

v

)

const [inline]

Binary operator -.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

void jrlMathTools::Vector3D< T >::operator-=

(

const Vector3D< T > &

v

)

[inline]

Binary operator -=.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

Vector3D<T> jrlMathTools::Vector3D< T >::operator/

(

const T &

t

)

const [inline]

Binary operator /.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

void jrlMathTools::Vector3D< T >::operator/=

(

const T &

t

)

[inline]

Binary operator /=.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

Vector3D<T>& jrlMathTools::Vector3D< T >::operator=

(

const Vector3D< T > &

v

)

[inline]

Assignment operator.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

bool jrlMathTools::Vector3D< T >::operator==

(

const Vector3D< T > &

v

)

const [inline]

Binary operator ==.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

T& jrlMathTools::Vector3D< T >::operator[]

(

unsigned

i

)

[inline]

Array operator.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

T jrlMathTools::Vector3D< T >::operator[]

(

unsigned

i

)

const [inline]

Array operator.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

template<typename T>

Vector3D<T> jrlMathTools::Vector3D< T >::operator^

(

const Vector3D< T > &

v2

)

const [inline]

Cross product.

References jrlMathTools::Vector3D< T >::m_x, jrlMathTools::Vector3D< T >::m_y, and jrlMathTools::Vector3D< T >::m_z.

---

Member Data Documentation

template<typename T>

T jrlMathTools::Vector3D< T >::m_x

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

template<typename T>

T jrlMathTools::Vector3D< T >::m_y

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

template<typename T>

T jrlMathTools::Vector3D< T >::m_z

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