Represents n-dimensional vectors. More...

#include <Vector.hxx>

Public Types
using	value_type = T
	value type, first keyword, expected to be a primitive type.

using	size_type = std::size_t
	size type, second keyword, expected to be a positive number.

using	iterator = T *
	iterator type.

Public Member Functions
	Vector ()
	Default constructor.

	Vector (const Vector< value_type, S > &rhs)
	Copy constructor. More...

	Vector (std::initializer_list< value_type > values)
	Aggregate constructor from a brace-init-list. More...

	Vector (T *values)
	Initializes the vector from an array. More...

	Vector (T value)
	Initializes all components of the vector to the same value. More...

Vector< value_type, S > &	operator= (const Vector< value_type, S > &rhs)
	Copy assignment operator. More...

Vector< value_type, S > &	operator= (Vector< value_type, S > &&rhs)
	Move assignment operator. More...

Vector< value_type, S > &	operator+= (const Vector< value_type, S > &rhs)
	Vector addition. More...

Vector< value_type, S > &	operator-= (const Vector< value_type, S > &rhs)
	Vector subtraction. More...

Vector< value_type, S > &	operator*= (const T &rhs)
	Scales up this vector by a multiplying it with a number. More...

Vector< value_type, S > &	operator/= (const T &rhs)
	Scales down this vector by a diving it by a number. More...

value_type &	operator[] (size_type idx)
	Array subscript operator. More...

const value_type &	operator[] (size_type idx) const
	Array subscript operator (const). More...

Vector< value_type, S >	cross (const Vector< value_type, S > &rhs)
	Vector cross product. More...

iterator	begin ()
	Iterator begin. More...

iterator	end ()
	Iterator end. More...

value_type *	data ()
	Access data. More...

Friends
Vector< value_type, S >	operator+ (Vector< value_type, S > lhs, const Vector< value_type, S > &rhs)
	Vector addition. More...

Vector< value_type, S >	operator- (Vector< value_type, S > lhs, const Vector< value_type, S > &rhs)
	Vector subtraction. More...

value_type	operator* (Vector< value_type, S > lhs, const Vector< value_type, S > &rhs)
	Vector dot product. More...

Vector< value_type, S >	operator* (Vector< value_type, S > lhs, const T &rhs)
	Scales up the vector by a multiplying it with a number. More...

Vector< value_type, S >	operator/ (Vector< value_type, S > lhs, const T &rhs)
	Scales down the vector by diving it by a number. More...

bool	operator== (const Vector< value_type, S > &lhs, const Vector< value_type, S > &rhs)
	Equality operator. More...

bool	operator!= (const Vector< value_type, S > &lhs, const Vector< value_type, S > &rhs)
	Inequality operator. More...

std::ostream &	operator<< (std::ostream &lhs, Vector< value_type, S > &rhs)
	Stream extraction operator. More...

std::istream &	operator>> (std::istream &lhs, Vector< value_type, S > &rhs)
	Stream insertion operator. More...

Detailed Description

template<typename T, std::size_t S>
class geomdl::Vector< T, S >

Represents n-dimensional vectors.

Template Parameters

T	type of the values contained, e.g. float, double
S	dimension

Constructor & Destructor Documentation

template<typename T, std::size_t S>

geomdl::Vector< T, S >::Vector ( const Vector< value_type, S > & rhs )

inline

Copy constructor.

Parameters

rhs	object on the right hand side

template<typename T, std::size_t S>

geomdl::Vector< T, S >::Vector ( std::initializer_list< value_type > values )

inline

Aggregate constructor from a brace-init-list.

Parameters

values brace-init-list

template<typename T, std::size_t S>

geomdl::Vector< T, S >::Vector ( T * values )

inlineexplicit

Initializes the vector from an array.

Parameters

values array containing the initial values

template<typename T, std::size_t S>

geomdl::Vector< T, S >::Vector ( T value )

inlineexplicit

Initializes all components of the vector to the same value.

Parameters

value initial value

Member Function Documentation

template<typename T, std::size_t S>

iterator geomdl::Vector< T, S >::begin ( )

inline

Iterator begin.

Returns: iterator

template<typename T, std::size_t S>

Vector<value_type, S> geomdl::Vector< T, S >::cross ( const Vector< value_type, S > & rhs )

inline

Vector cross product.

Parameters

rhs	3 dimensional vector on the right hand side of the cross product

Returns: a new vector object as a result of the operation

template<typename T, std::size_t S>

value_type* geomdl::Vector< T, S >::data ( )

inline

Access data.

Returns the direct pointer to the array used internally.

Returns: pointer to the array

template<typename T, std::size_t S>

iterator geomdl::Vector< T, S >::end ( )

inline

Iterator end.

Returns: iterator

template<typename T, std::size_t S>

Vector<value_type, S>& geomdl::Vector< T, S >::operator*= ( const T & rhs )

inline

Scales up this vector by a multiplying it with a number.

Parameters

rhs	scaling factor

Returns: current vector scaled up

template<typename T, std::size_t S>

Vector<value_type, S>& geomdl::Vector< T, S >::operator+= ( const Vector< value_type, S > & rhs )

inline

Vector addition.

Parameters

rhs	object on the right hand side

Returns: object after operation

template<typename T, std::size_t S>

Vector<value_type, S>& geomdl::Vector< T, S >::operator-= ( const Vector< value_type, S > & rhs )

inline

Vector subtraction.

Parameters

rhs	object on the right hand side

Returns: object after operation

template<typename T, std::size_t S>

Vector<value_type, S>& geomdl::Vector< T, S >::operator/= ( const T & rhs )

inline

Scales down this vector by a diving it by a number.

Parameters

rhs	scaling factor

Returns: current vector scaled down

template<typename T, std::size_t S>

Vector<value_type, S>& geomdl::Vector< T, S >::operator= ( const Vector< value_type, S > & rhs )

inline

Copy assignment operator.

Parameters

rhs	object to be copied

Returns: vector

template<typename T, std::size_t S>

Vector<value_type, S>& geomdl::Vector< T, S >::operator= ( Vector< value_type, S > && rhs )

inline

Move assignment operator.

Parameters

rhs	object to be moved

Returns: vector

template<typename T, std::size_t S>

value_type& geomdl::Vector< T, S >::operator[] ( size_type idx )

inline

Array subscript operator.

Parameters

idx	array index

Returns: value corresponding to the index

template<typename T, std::size_t S>

const value_type& geomdl::Vector< T, S >::operator[] ( size_type idx ) const

inline

Array subscript operator (const).

Parameters

idx	array index

Returns: value corresponding to the index

Friends And Related Function Documentation

template<typename T, std::size_t S>

bool operator!=	(	const Vector< value_type, S > &	lhs,
		const Vector< value_type, S > &	rhs
	)

friend

Inequality operator.

Parameters

lhs	object on the left hand side
rhs	object on the right hand side

Returns: object after operation

template<typename T, std::size_t S>

value_type operator*	(	Vector< value_type, S >	lhs,
		const Vector< value_type, S > &	rhs
	)

friend

Vector dot product.

Parameters

lhs	vector on the left hand side
rhs	vector on the right hand side

Returns: result of the operation

template<typename T, std::size_t S>

Vector<value_type, S> operator*	(	Vector< value_type, S >	lhs,
		const T &	rhs
	)

friend

Scales up the vector by a multiplying it with a number.

Parameters

lhs	vector to be scaled up
rhs	scaling factor

Returns: the scaled vector

template<typename T, std::size_t S>

Vector<value_type, S> operator+	(	Vector< value_type, S >	lhs,
		const Vector< value_type, S > &	rhs
	)

friend

Vector addition.

Parameters

lhs	object on the left hand side
rhs	object on the right hand side

Returns: object after operation

template<typename T, std::size_t S>

Vector<value_type, S> operator-	(	Vector< value_type, S >	lhs,
		const Vector< value_type, S > &	rhs
	)

friend

Vector subtraction.

Parameters

lhs	object on the left hand side
rhs	object on the right hand side

Returns: object after operation

template<typename T, std::size_t S>

Vector<value_type, S> operator/	(	Vector< value_type, S >	lhs,
		const T &	rhs
	)

friend

Scales down the vector by diving it by a number.

Parameters

lhs	vector to be scaled down
rhs	scaling factor

Returns: the scaled vector

template<typename T, std::size_t S>

std::ostream& operator<<	(	std::ostream &	lhs,
		Vector< value_type, S > &	rhs
	)

friend

Stream extraction operator.

Parameters

lhs	object on the left hand side
rhs	object on the right hand side

Returns: object after operation

template<typename T, std::size_t S>

bool operator==	(	const Vector< value_type, S > &	lhs,
		const Vector< value_type, S > &	rhs
	)

friend

Equality operator.

Parameters

lhs	object on the left hand side
rhs	object on the right hand side

Returns: object after operation

template<typename T, std::size_t S>

std::istream& operator>>	(	std::istream &	lhs,
		Vector< value_type, S > &	rhs
	)

friend

Stream insertion operator.

Parameters

lhs	object on the left hand side
rhs	object on the right hand side

Returns: object after operation

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

include/Vector.hxx

Public Types

Public Member Functions

Friends

Detailed Description

template<typename T, std::size_t S> class geomdl::Vector< T, S >

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<typename T, std::size_t S>
class geomdl::Vector< T, S >