vector3d Class Reference

A vector. More...

#include <vector3d.hpp>

Public Member Functions
	vector3d (const double x_, const double y_, const double z_)
	vector3d constructor.
const double	length () const
	Length of a vector3d instance.
const vector3d	normalize () const
	Normalize vector3d instance.

Static Public Member Functions
static const vector3d	cross_product (const vector3d &v1, const vector3d &v2)
	Takes the cross product of two vectors.
static const double	dot_product (const vector3d &v1, const vector3d &v2)
	Takes the doc product of two vectors.

Public Attributes
const double	x
	x component.
const double	y
	y component.
const double	z
	z component.

Detailed Description

A vector.

Class representing a vector in cartesian coordinates.

Constructor & Destructor Documentation

vector3d()

vector3d::vector3d	(	const double	x_,
		const double	y_,
		const double	z_
	)

vector3d constructor.

Constructs a vector at a x, y, z position.

Parameters

[in]	x_	X position.
[in]	y_	Y position.
[in]	z_	Z position.

Member Function Documentation

cross_product()

const vector3d vector3d::cross_product ( const vector3d &  v1, const vector3d &  v2  )

static

Takes the cross product of two vectors.

V1 X V2.

Parameters

[in]	v1	First vector.
[in]	v2	Second vector.

Returns

Cross product of v1 and v2.

dot_product()

const double vector3d::dot_product ( const vector3d &  v1, const vector3d &  v2  )

static

Takes the doc product of two vectors.

V1 . V2.

Parameters

[in]	v1	First vector.
[in]	v2	Second vector.

Returns

Dot product of v1 and v2.

length()

const double vector3d::length

(

)

const

Length of a vector3d instance.

Length is defined as Sqrt(V.V).

Returns

Length of vector.

normalize()

const vector3d vector3d::normalize

(

)

const

Normalize vector3d instance.

The normalized vector is defined as V/|V|.

Returns

Normalized vector.

---

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

• LGRID/Sources/vector3d.hpp
• LGRID/Sources/vector3d.cpp