Emdee
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
Vector3 Class Reference

The Vector3 class is a simple and performance-centric 3D vector class. More...

#include <vector3.h>

Public Member Functions

 Vector3 ()
 
 Vector3 (double x, double y, double z)
 
 Vector3 (arma::rowvec armaVector)
 
void zeros ()
 
double x () const
 
double y () const
 
double z () const
 
uint size () const
 
double & operator() (const int component)
 
double & operator[] (const int component)
 
double operator() (const int component) const
 
double operator[] (const int component) const
 
Vector3operator= (const Vector3 &vector2)
 
Vector3operator+= (const Vector3 &vector2)
 
Vector3operator-= (const Vector3 &vector2)
 
Vector3operator*= (double value)
 
Vector3operator/= (double value)
 

Static Public Member Functions

static Vector3 ones ()
 
static Vector3 createZeros ()
 
static const Vector3 zeroVector ()
 
static double dot (const Vector3 &vector1, const Vector3 &vector2)
 
static double distanceSquared (const Vector3 &vector1, const Vector3 &vector2)
 
static double distance (const Vector3 &vector1, const Vector3 &vector2)
 

Protected Attributes

double mem_local [3]
 

Friends

std::ostream & operator<< (std::ostream &out, const Vector3 &vector)
 
Vector3 operator+ (const Vector3 &vector1, const Vector3 &vector2)
 
Vector3 operator- (const Vector3 &vector1, const Vector3 &vector2)
 
Vector3 operator+ (const Vector3 &vector1)
 
Vector3 operator- (const Vector3 &vector1)
 
Vector3 operator* (const Vector3 &vector1, const Vector3 &vector2)
 Vector3::operator * returns the dot product of the two vectors. More...
 
bool operator== (const Vector3 &vector1, const Vector3 &vector2)
 
bool operator!= (const Vector3 &vector1, const Vector3 &vector2)
 
Vector3 operator* (const Vector3 &vector1, double value)
 
Vector3 operator* (double value, const Vector3 &vector1)
 
Vector3 operator/ (const Vector3 &vector1, double value)
 

Detailed Description

The Vector3 class is a simple and performance-centric 3D vector class.

Constructor & Destructor Documentation

Vector3::Vector3 ( )
inline
Vector3::Vector3 ( double  x,
double  y,
double  z 
)
inline
Vector3::Vector3 ( arma::rowvec  armaVector)
inline

Member Function Documentation

Vector3 Vector3::createZeros ( )
static
double Vector3::distance ( const Vector3 vector1,
const Vector3 vector2 
)
inlinestatic
double Vector3::distanceSquared ( const Vector3 vector1,
const Vector3 vector2 
)
inlinestatic
double Vector3::dot ( const Vector3 vector1,
const Vector3 vector2 
)
inlinestatic
Vector3 Vector3::ones ( )
static
double & Vector3::operator() ( const int  component)
inline
double Vector3::operator() ( const int  component) const
inline
Vector3 & Vector3::operator*= ( double  value)
inline
Vector3 & Vector3::operator+= ( const Vector3 vector2)
inline
Vector3 & Vector3::operator-= ( const Vector3 vector2)
inline
Vector3 & Vector3::operator/= ( double  value)
inline
Vector3 & Vector3::operator= ( const Vector3 vector2)
inline
double & Vector3::operator[] ( const int  component)
inline
double Vector3::operator[] ( const int  component) const
inline
uint Vector3::size ( ) const
inline
double Vector3::x ( ) const
inline
double Vector3::y ( ) const
inline
double Vector3::z ( ) const
inline
void Vector3::zeros ( )
inline
const Vector3 Vector3::zeroVector ( )
inlinestatic

Friends And Related Function Documentation

bool operator!= ( const Vector3 vector1,
const Vector3 vector2 
)
friend
Vector3 operator* ( const Vector3 vector1,
const Vector3 vector2 
)
friend

Vector3::operator * returns the dot product of the two vectors.

Parameters
vector1
vector2
Returns
Vector3 operator* ( const Vector3 vector1,
double  value 
)
friend
Vector3 operator* ( double  value,
const Vector3 vector1 
)
friend
Vector3 operator+ ( const Vector3 vector1,
const Vector3 vector2 
)
friend
Vector3 operator+ ( const Vector3 vector1)
friend
Vector3 operator- ( const Vector3 vector1,
const Vector3 vector2 
)
friend
Vector3 operator- ( const Vector3 vector1)
friend
Vector3 operator/ ( const Vector3 vector1,
double  value 
)
friend
std::ostream& operator<< ( std::ostream &  out,
const Vector3 vector 
)
friend
bool operator== ( const Vector3 vector1,
const Vector3 vector2 
)
friend

Member Data Documentation

double Vector3::mem_local[3]
protected

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