Simple 3D vector class with focus on performance and readability. 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

Vector3 &	operator= (const Vector3 &vector2)

Vector3 &	operator+= (const Vector3 &vector2)

Vector3 &	operator-= (const Vector3 &vector2)

Vector3 &	operator*= (double value)

Vector3 &	operator/= (double value)

Static Public Member Functions
static Vector3	ones ()

static Vector3	createZeros ()

static double	dot (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

Simple 3D vector class with focus on performance and readability.

Definition at line 9 of file vector3.h.

Constructor & Destructor Documentation

Vector3::Vector3 ( )

inline

Definition at line 72 of file vector3.h.

 {
     mem_local[0] = 0;
     mem_local[1] = 0;
     mem_local[2] = 0;
 }

Vector3::Vector3	(	double	x,
		double	y,
		double	z
	)

inline

Definition at line 79 of file vector3.h.

 {
     mem_local[0] = x;
     mem_local[1] = y;
     mem_local[2] = z;
 }

Vector3::Vector3 ( arma::rowvec armaVector)

inline

Definition at line 86 of file vector3.h.

 {
     mem_local[0] = armaVector(0);
     mem_local[1] = armaVector(1);
     mem_local[2] = armaVector(2);
 }

Member Function Documentation

Vector3 Vector3::createZeros ( )

static

Definition at line 22 of file vector3.cpp.

 {
     return Vector3(0,0,0);
 }

double Vector3::dot	(	const Vector3 &	vector1,
		const Vector3 &	vector2
	)

inlinestatic

Definition at line 219 of file vector3.h.

                                                                          {
     return (vector1.mem_local[0] * vector2.mem_local[0] + vector1.mem_local[1] * vector2.mem_local[1] + vector1.mem_local[2] * vector2.mem_local[2]);
 }

Vector3 Vector3::ones ( )

static

Definition at line 16 of file vector3.cpp.

 {
     return Vector3(1,1,1);
 }

double & Vector3::operator() ( const int component)

inline

Definition at line 106 of file vector3.h.

 {
     return mem_local[component];
 }

double Vector3::operator() ( const int component) const

inline

Definition at line 117 of file vector3.h.

 {
     return mem_local[component];
 }

Vector3 & Vector3::operator*= ( double value)

inline

Definition at line 159 of file vector3.h.

 {
     this->mem_local[0] *= value;
     this->mem_local[1] *= value;
     this->mem_local[2] *= value;
     return *this;
 }

Vector3 & Vector3::operator+= ( const Vector3 & vector2)

inline

Definition at line 151 of file vector3.h.

 {
     this->mem_local[0] += vector2.mem_local[0];
     this->mem_local[1] += vector2.mem_local[1];
     this->mem_local[2] += vector2.mem_local[2];
     return *this;
 }

Vector3 & Vector3::operator-= ( const Vector3 & vector2)

inline

Definition at line 190 of file vector3.h.

 {
     this->mem_local[0] -= vector2.mem_local[0];
     this->mem_local[1] -= vector2.mem_local[1];
     this->mem_local[2] -= vector2.mem_local[2];
     return *this;
 }

Vector3 & Vector3::operator/= ( double value)

inline

Definition at line 167 of file vector3.h.

 {
     this->mem_local[0] /= value;
     this->mem_local[1] /= value;
     this->mem_local[2] /= value;
     return *this;
 }

Vector3 & Vector3::operator= ( const Vector3 & vector2)

inline

Definition at line 143 of file vector3.h.

 {
     this->mem_local[0] = vector2.mem_local[0];
     this->mem_local[1] = vector2.mem_local[1];
     this->mem_local[2] = vector2.mem_local[2];
     return *this;
 }

double & Vector3::operator[] ( const int component)

inline

Definition at line 101 of file vector3.h.

 {
     return mem_local[component];
 }

double Vector3::operator[] ( const int component) const

inline

Definition at line 112 of file vector3.h.

 {
     return mem_local[component];
 }

uint Vector3::size ( ) const

inline

Definition at line 128 of file vector3.h.

                                 {
     return 3;
 }

double Vector3::x ( ) const

inline

Definition at line 236 of file vector3.h.

                                {
     return mem_local[0];
 }

double Vector3::y ( ) const

inline

Definition at line 239 of file vector3.h.

                                {
     return mem_local[1];
 }

double Vector3::z ( ) const

inline

Definition at line 242 of file vector3.h.

                                {
     return mem_local[2];
 }

void Vector3::zeros ( )

inline

Definition at line 122 of file vector3.h.

                            {
     mem_local[0] = 0;
     mem_local[1] = 0;
     mem_local[2] = 0;
 }

Friends And Related Function Documentation

bool operator!=	(	const Vector3 &	vector1,
		const Vector3 &	vector2
	)

friend

Definition at line 231 of file vector3.h.

 {
     return !(vector1 == vector2);
 }

Vector3 operator*	(	const Vector3 &	vector1,
		const Vector3 &	vector2
	)

friend

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

Parameters

vector1
vector2

Returns

Definition at line 214 of file vector3.h.

 {
     return Vector3(vector1.mem_local[0] * vector2.mem_local[0], vector1.mem_local[1] * vector2.mem_local[1], vector1.mem_local[2] * vector2.mem_local[2]);
 }

Vector3 operator*	(	const Vector3 &	vector1,
		double	value
	)

friend

Definition at line 175 of file vector3.h.

 {
     return Vector3(vector1.mem_local[0]*value, vector1.mem_local[1]*value, vector1.mem_local[2]*value);
 }

Vector3 operator*	(	double	value,
		const Vector3 &	vector1
	)

friend

Definition at line 180 of file vector3.h.

 {
     return Vector3(vector1.mem_local[0]*value, vector1.mem_local[1]*value, vector1.mem_local[2]*value);
 }

Vector3 operator+	(	const Vector3 &	vector1,
		const Vector3 &	vector2
	)

friend

Definition at line 133 of file vector3.h.

 {
     return Vector3(vector1.mem_local[0] + vector2.mem_local[0], vector1.mem_local[1] + vector2.mem_local[1], vector1.mem_local[2] + vector2.mem_local[2]);
 }

Vector3 operator+ ( const Vector3 & vector1)

friend

Definition at line 198 of file vector3.h.

 {
     return Vector3(vector1.mem_local[0], vector1.mem_local[1], vector1.mem_local[2]);
 }

Vector3 operator-	(	const Vector3 &	vector1,
		const Vector3 &	vector2
	)

friend

Definition at line 138 of file vector3.h.

 {
     return Vector3(vector1.mem_local[0] - vector2.mem_local[0], vector1.mem_local[1] - vector2.mem_local[1], vector1.mem_local[2] - vector2.mem_local[2]);
 }

Vector3 operator- ( const Vector3 & vector1)

friend

Definition at line 203 of file vector3.h.

 {
     return Vector3(-vector1.mem_local[0], -vector1.mem_local[1], -vector1.mem_local[2]);
 }

Vector3 operator/	(	const Vector3 &	vector1,
		double	value
	)

friend

Definition at line 185 of file vector3.h.

 {
     return Vector3(vector1.mem_local[0]/value, vector1.mem_local[1]/value, vector1.mem_local[2]/value);
 }

std::ostream& operator<<	(	std::ostream &	out,
		const Vector3 &	vector
	)

friend

Definition at line 10 of file vector3.cpp.

 {
     out << vector.mem_local[0] << ", " << vector.mem_local[1] << ", " << vector.mem_local[2];
     return out;
 }

bool operator==	(	const Vector3 &	vector1,
		const Vector3 &	vector2
	)

friend

Definition at line 224 of file vector3.h.

 {
     return ((vector1.mem_local[0] == vector2.mem_local[0]) &&
             (vector1.mem_local[1] == vector2.mem_local[1]) &&
             (vector1.mem_local[2] == vector2.mem_local[2]));
 }

Member Data Documentation

double Vector3::mem_local[3]

protected

Definition at line 12 of file vector3.h.

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

/home/svenni/Dropbox/projects/programming/hartree-fock/hartree-fock/src/math/vector3.h
/home/svenni/Dropbox/projects/programming/hartree-fock/hartree-fock/src/math/vector3.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation