stapl::geom_vector< 3, ELEMENT > Class Template Reference

3D geometric vector More...

Public Member Functions
	geom_vector ()
	Constructor initializing each element to the value 0.
	geom_vector (element_type const &v_x, element_type const &v_y, element_type const &v_z)
element_type &	x ()
	Returns x coordinate's value. More...
element_type &	y ()
	Returns y coordinate's value. More...
element_type &	z ()
	Returns z coordinate's value. More...
element_type	x () const
	Returns a copy of the x coordinate's value. More...
element_type	y () const
	Returns a copy of the y coordinate's value. More...
element_type	z () const
	Returns a copy of the z coordinate's value. More...
template<int N>
element_type	get () const
	Returns the Nth coordinate's value with tuple interface. More...
template<int N>
void	set (element_type const &value)
	Set the Nth coordinate's value with tuple interface. More...
bool	operator== (geom_vector const &coords) const
	Coordinate-wise comparison of 2 geometric vectors. More...
geom_vector &	operator= (geom_vector const &coords)
	Assign coordinates with those of another vector coords. More...
geom_vector &	operator= (element_type const &val)
	Assign coordinates with a value val. More...
geom_vector &	operator+= (geom_vector const &coords)
	Add to coordinates those of another vector coords. More...
geom_vector &	operator-= (geom_vector const &coords)
	Subtract from the coordinates those of another vector coords. More...
geom_vector &	operator*= (element_type const &a)
	Multiply coordinates with a value a. More...
geom_vector &	operator/= (element_type const &a)
	Divide coordinates with a value a. More...
bool	operator< (geom_vector const &other) const
	'Less than' comparison with another vector. This comparator lexicographically compares the coordinates of the vectors. More...
element_type	dot (geom_vector const &other) const
	Perform a dot product with another vector other. More...
geom_vector	cross (geom_vector const &other) const
	Perform a cross product with another vector other. More...
void	normalize (element_type const &n=1.0)
	Normalize vector to a value n. More...

Public Types
typedef ELEMENT	element_type

Detailed Description

template<typename ELEMENT>
class stapl::geom_vector< 3, ELEMENT >

3D geometric vector

Template Parameters

ELEMENT

type of elements stored in vector.

Template specialization for 3D.

Constructor & Destructor Documentation

geom_vector()

template<typename ELEMENT >

stapl::geom_vector< 3, ELEMENT >::geom_vector	(	element_type const &	v_x,
		element_type const &	v_y,
		element_type const &	v_z
	)

Parameters

v_x	x coordinate's value.
v_y	y coordinate's value.
v_z	z coordinate's value.

Member Function Documentation

x() [1/2]

template<typename ELEMENT >

element_type& stapl::geom_vector< 3, ELEMENT >::x

(

)

Returns x coordinate's value.

Returns

x coordinate's value.

y() [1/2]

template<typename ELEMENT >

element_type& stapl::geom_vector< 3, ELEMENT >::y

(

)

Returns y coordinate's value.

Returns

y coordinate's value.

z() [1/2]

template<typename ELEMENT >

element_type& stapl::geom_vector< 3, ELEMENT >::z

(

)

Returns z coordinate's value.

Returns

z coordinate's value.

x() [2/2]

template<typename ELEMENT >

element_type stapl::geom_vector< 3, ELEMENT >::x

(

)

const

Returns a copy of the x coordinate's value.

Returns

copy of the x coordinate's value.

y() [2/2]

template<typename ELEMENT >

element_type stapl::geom_vector< 3, ELEMENT >::y

(

)

const

Returns a copy of the y coordinate's value.

Returns

copy of the y coordinate's value.

z() [2/2]

template<typename ELEMENT >

element_type stapl::geom_vector< 3, ELEMENT >::z

(

)

const

Returns a copy of the z coordinate's value.

Returns

copy of the z coordinate's value.

get()

template<typename ELEMENT >

template<int N>

element_type stapl::geom_vector< 3, ELEMENT >::get

(

)

const

Returns the Nth coordinate's value with tuple interface.

Returns

Nth coordinate's value.

set()

template<typename ELEMENT >

template<int N>

void stapl::geom_vector< 3, ELEMENT >::set

(

element_type const &

value

)

Set the Nth coordinate's value with tuple interface.

Parameters

Nth	coordinate's value.

operator==()

template<typename ELEMENT >

bool stapl::geom_vector< 3, ELEMENT >::operator==

(

geom_vector< 3, ELEMENT > const &

coords

)

const

Coordinate-wise comparison of 2 geometric vectors.

Parameters

coords

vector tested for equality.

Returns

true if geometric vectors are equal.

operator=() [1/2]

template<typename ELEMENT >

geom_vector& stapl::geom_vector< 3, ELEMENT >::operator=

(

geom_vector< 3, ELEMENT > const &

coords

)

Assign coordinates with those of another vector coords.

Parameters

coords

vector whose elements are used in assignment.

Returns

this geometric vector.

operator=() [2/2]

template<typename ELEMENT >

geom_vector& stapl::geom_vector< 3, ELEMENT >::operator=

(

element_type const &

val

)

Assign coordinates with a value val.

Parameters

val

value.

Returns

this geometric vector.

operator+=()

template<typename ELEMENT >

geom_vector& stapl::geom_vector< 3, ELEMENT >::operator+=

(

geom_vector< 3, ELEMENT > const &

coords

)

Add to coordinates those of another vector coords.

Parameters

coords

the vector whose elements are used in the addition.

Returns

this geometric vector.

operator-=()

template<typename ELEMENT >

geom_vector& stapl::geom_vector< 3, ELEMENT >::operator-=

(

geom_vector< 3, ELEMENT > const &

coords

)

Subtract from the coordinates those of another vector coords.

Parameters

coords

the vector whose elements are used in the subtraction.

Returns

this geometric vector.

operator*=()

template<typename ELEMENT >

geom_vector& stapl::geom_vector< 3, ELEMENT >::operator*=

(

element_type const &

a

)

Multiply coordinates with a value a.

Parameters

a

value.

Returns

this geometric vector.

operator/=()

template<typename ELEMENT >

geom_vector& stapl::geom_vector< 3, ELEMENT >::operator/=

(

element_type const &

a

)

Divide coordinates with a value a.

Parameters

a

value.

Returns

this geometric vector.

operator<()

template<typename ELEMENT >

bool stapl::geom_vector< 3, ELEMENT >::operator<

(

geom_vector< 3, ELEMENT > const &

other

)

const

'Less than' comparison with another vector. This comparator lexicographically compares the coordinates of the vectors.

Parameters

other

the vector provided for comparison.

Returns

true if this vector is less than the vector provided.

dot()

template<typename ELEMENT >

element_type stapl::geom_vector< 3, ELEMENT >::dot

(

geom_vector< 3, ELEMENT > const &

other

)

const

Perform a dot product with another vector other.

Parameters

other

the vector provided for the dot product.

Returns

value of the dot product.

cross()

template<typename ELEMENT >

geom_vector stapl::geom_vector< 3, ELEMENT >::cross

(

geom_vector< 3, ELEMENT > const &

other

)

const

Perform a cross product with another vector other.

Parameters

other

the vector provided for the cross product.

Returns

result of the cross product.

normalize()

template<typename ELEMENT >

void stapl::geom_vector< 3, ELEMENT >::normalize

(

element_type const &

n = 1.0

)

Normalize vector to a value n.

Parameters

n

value.

---

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

• geom_vector3.hpp