3D vector class inheriting from glm::vec3. More...

#include <headers/utility/math/vector.hpp>

Inheritance diagram for utility::math::Vector< VectorComponentType, VectorDimension >:

Collaboration diagram for utility::math::Vector< VectorComponentType, VectorDimension >:

Public Member Functions
	Vector (void)
	Default constructor initializing vector values to zero.

	Vector (const glm::vec< VectorDimension, VectorComponentType > &v)
	Construct from a GLM vector.

	Vector (std::initializer_list< VectorComponentType > values)
	Construct from initializer list of float values.

	Vector (VectorComponentType value)
	Construct by filling all components with the same float value.

	Vector (const Vector &other)=default
	Copy constructor.

	Vector (Vector &&other) noexcept=default
	Move constructor.

	~Vector (void)=default
	Default destructor for Vector.

Vector &	operator= (const Vector &other)=default
	Copy assignment operator.

Vector &	operator= (Vector &&other) noexcept=default
	Move assignment operator.

Vector	operator+ (const Vector &rhs) const noexcept
	Vector addition.

Vector &	operator+= (const Vector &rhs) noexcept
	Vector addition assignment.

Vector	operator- (const Vector &rhs) const noexcept
	Vector subtraction.

Vector &	operator-= (const Vector &rhs) noexcept
	Vector subtraction assignment.

Vector	operator* (VectorComponentType scalar) const noexcept
	Scalar multiplication.

Vector &	operator*= (VectorComponentType scalar) noexcept
	Scalar multiplication assignment.

Vector	operator/ (VectorComponentType scalar) const
	Scalar division.

Vector &	operator/= (VectorComponentType scalar)
	Scalar division assignment.

Vector	operator* (const Vector &rhs) const noexcept
	Element-wise multiplication.

Vector &	operator*= (const Vector &rhs) noexcept
	Element-wise multiplication assignment.

Vector	operator/ (const Vector &rhs) const
	Element-wise division.

Vector &	operator/= (const Vector &rhs)
	Element-wise division assignment.

bool	operator== (const Vector &rhs) const noexcept
	Equality comparison.

bool	equalsEpsilon (const Vector &rhs, VectorComponentType epsilon=VectorComponentType { 1e-5 }) const
	Approximate equality using an epsilon threshold.

bool	operator!= (const Vector &rhs) const noexcept
	Inequality comparison.

Vector	operator- () const noexcept
	Unary negation.

Friends
Vector	operator* (VectorComponentType scalar, const Vector &vec)
	Friend function for scalar multiplication with scalar on the left.

Detailed Description

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>
class utility::math::Vector< VectorComponentType, VectorDimension >

3D vector class inheriting from glm::vec3.

Template Parameters

Type	Floating-point type for vector components.

Definition at line 82 of file vector.hpp.

Constructor & Destructor Documentation

◆ Vector() [1/6]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

utility::math::Vector< VectorComponentType, VectorDimension >::Vector ( void )

inline

Default constructor initializing vector values to zero.

Definition at line 88 of file vector.hpp.

Here is the caller graph for this function:

◆ Vector() [2/6]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

utility::math::Vector< VectorComponentType, VectorDimension >::Vector ( const glm::vec< VectorDimension, VectorComponentType > & v )

inlineexplicit

Construct from a GLM vector.

Parameters

v	Source GLM vector.

Definition at line 97 of file vector.hpp.

◆ Vector() [3/6]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

utility::math::Vector< VectorComponentType, VectorDimension >::Vector ( std::initializer_list< VectorComponentType > values )

inline

Construct from initializer list of float values.

Parameters

values The initializer list containing vector components.

Exceptions

std::invalid_argument if the list size does not match the vector dimension.

Definition at line 108 of file vector.hpp.

◆ Vector() [4/6]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

utility::math::Vector< VectorComponentType, VectorDimension >::Vector ( VectorComponentType value )

inlineexplicit

Construct by filling all components with the same float value.

Parameters

value The float value to fill all components with.

Definition at line 125 of file vector.hpp.

◆ Vector() [5/6]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

utility::math::Vector< VectorComponentType, VectorDimension >::Vector ( const Vector< VectorComponentType, VectorDimension > & other )

default

Copy constructor.

Parameters

other The Vector object to copy from.

◆ Vector() [6/6]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

utility::math::Vector< VectorComponentType, VectorDimension >::Vector ( Vector< VectorComponentType, VectorDimension > && other )

defaultnoexcept

Move constructor.

Parameters

other The Vector object to move from.

Member Function Documentation

◆ equalsEpsilon()

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

bool utility::math::Vector< VectorComponentType, VectorDimension >::equalsEpsilon	(	const Vector< VectorComponentType, VectorDimension > &	rhs,
		VectorComponentType	epsilon = `VectorComponentType { 1e-5 }`
	)		const

inline

Approximate equality using an epsilon threshold.

Returns true if each component is within epsilon of its counterpart in rhs.

Parameters

rhs	The vector to compare with.
epsilon	The maximum allowed difference per component.

Returns: True if the vectors are equal within epsilon.

Definition at line 378 of file vector.hpp.

◆ operator!=()

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

bool utility::math::Vector< VectorComponentType, VectorDimension >::operator!= ( const Vector< VectorComponentType, VectorDimension > & rhs ) const

inlinenoexcept

Inequality comparison.

Parameters

rhs	The vector to compare with.

Returns: True if the vectors are not equal, false otherwise.

Definition at line 395 of file vector.hpp.

◆ operator*() [1/2]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector utility::math::Vector< VectorComponentType, VectorDimension >::operator* ( const Vector< VectorComponentType, VectorDimension > & rhs ) const

inlinenoexcept

Element-wise multiplication.

Parameters

rhs	The vector to multiply with.

Returns: The resulting vector.

Definition at line 284 of file vector.hpp.

Here is the call graph for this function:

◆ operator*() [2/2]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector utility::math::Vector< VectorComponentType, VectorDimension >::operator* ( VectorComponentType scalar ) const

inlinenoexcept

Scalar multiplication.

Parameters

scalar The scalar value to multiply with.

Returns: The resulting vector.

Definition at line 226 of file vector.hpp.

Here is the call graph for this function:

◆ operator*=() [1/2]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector & utility::math::Vector< VectorComponentType, VectorDimension >::operator*= ( const Vector< VectorComponentType, VectorDimension > & rhs )

inlinenoexcept

Element-wise multiplication assignment.

Parameters

rhs	The vector to multiply with.

Returns: A reference to this vector after multiplication.

Definition at line 299 of file vector.hpp.

◆ operator*=() [2/2]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector & utility::math::Vector< VectorComponentType, VectorDimension >::operator*= ( VectorComponentType scalar )

inlinenoexcept

Scalar multiplication assignment.

Parameters

scalar The scalar value to multiply with.

Returns: A reference to this vector after multiplication.

Definition at line 239 of file vector.hpp.

◆ operator+()

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector utility::math::Vector< VectorComponentType, VectorDimension >::operator+ ( const Vector< VectorComponentType, VectorDimension > & rhs ) const

inlinenoexcept

Vector addition.

Parameters

rhs	The vector to add.

Returns: The resulting vector.

Definition at line 166 of file vector.hpp.

Here is the call graph for this function:

◆ operator+=()

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector & utility::math::Vector< VectorComponentType, VectorDimension >::operator+= ( const Vector< VectorComponentType, VectorDimension > & rhs )

inlinenoexcept

Vector addition assignment.

Parameters

rhs	The vector to add.

Returns: A reference to this vector after addition.

Definition at line 181 of file vector.hpp.

◆ operator-() [1/2]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector utility::math::Vector< VectorComponentType, VectorDimension >::operator- ( ) const

inlinenoexcept

Unary negation.

Returns: The negated vector.

Definition at line 404 of file vector.hpp.

Here is the call graph for this function:

◆ operator-() [2/2]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector utility::math::Vector< VectorComponentType, VectorDimension >::operator- ( const Vector< VectorComponentType, VectorDimension > & rhs ) const

inlinenoexcept

Vector subtraction.

Parameters

rhs	The vector to subtract.

Returns: The resulting vector.

Definition at line 196 of file vector.hpp.

Here is the call graph for this function:

◆ operator-=()

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector & utility::math::Vector< VectorComponentType, VectorDimension >::operator-= ( const Vector< VectorComponentType, VectorDimension > & rhs )

inlinenoexcept

Vector subtraction assignment.

Parameters

rhs	The vector to subtract.

Returns: A reference to this vector after subtraction.

Definition at line 211 of file vector.hpp.

◆ operator/() [1/2]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector utility::math::Vector< VectorComponentType, VectorDimension >::operator/ ( const Vector< VectorComponentType, VectorDimension > & rhs ) const

inline

Element-wise division.

Parameters

rhs	The vector to divide by.

Returns: The resulting vector.

Exceptions

std::invalid_argument if any component of rhs is zero.

Definition at line 315 of file vector.hpp.

Here is the call graph for this function:

◆ operator/() [2/2]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector utility::math::Vector< VectorComponentType, VectorDimension >::operator/ ( VectorComponentType scalar ) const

inline

Scalar division.

Parameters

scalar The scalar value to divide by.

Returns: The resulting vector.

Exceptions

std::invalid_argument if scalar is zero.

Definition at line 252 of file vector.hpp.

Here is the call graph for this function:

◆ operator/=() [1/2]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector & utility::math::Vector< VectorComponentType, VectorDimension >::operator/= ( const Vector< VectorComponentType, VectorDimension > & rhs )

inline

Element-wise division assignment.

Parameters

rhs	The vector to divide by.

Returns: A reference to this vector after division.

Exceptions

std::invalid_argument if any component of rhs is zero.

Definition at line 336 of file vector.hpp.

◆ operator/=() [2/2]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector & utility::math::Vector< VectorComponentType, VectorDimension >::operator/= ( VectorComponentType scalar )

inline

Scalar division assignment.

Parameters

scalar The scalar value to divide by.

Returns: A reference to this vector after division.

Exceptions

std::invalid_argument if scalar is zero.

Definition at line 269 of file vector.hpp.

◆ operator=() [1/2]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector & utility::math::Vector< VectorComponentType, VectorDimension >::operator= ( const Vector< VectorComponentType, VectorDimension > & other )

default

Copy assignment operator.

Parameters

other The Vector object to copy from.

Returns: A reference to this Vector object.

◆ operator=() [2/2]

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector & utility::math::Vector< VectorComponentType, VectorDimension >::operator= ( Vector< VectorComponentType, VectorDimension > && other )

defaultnoexcept

Move assignment operator.

Parameters

other The Vector object to move from.

Returns: A reference to this Vector object.

◆ operator==()

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

bool utility::math::Vector< VectorComponentType, VectorDimension >::operator== ( const Vector< VectorComponentType, VectorDimension > & rhs ) const

inlinenoexcept

Equality comparison.

Uses exact component-wise equality. For floating-point types prefer equalsEpsilon to tolerate rounding error.

Parameters

rhs	The vector to compare with.

Returns: True if the vectors are equal, false otherwise.

Definition at line 359 of file vector.hpp.

Friends And Related Symbol Documentation

◆ operator*

template<CanBeVectorComponent VectorComponentType, std::size_t VectorDimension>

Vector operator*	(	VectorComponentType	scalar,
		const Vector< VectorComponentType, VectorDimension > &	vec
	)

friend

Friend function for scalar multiplication with scalar on the left.

Parameters

scalar	The scalar value to multiply with.
vec	The vector to multiply.

Returns: The resulting vector.

Definition at line 419 of file vector.hpp.

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

headers/utility/math/vector.hpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Vector() [1/6]

◆ Vector() [2/6]

◆ Vector() [3/6]

◆ Vector() [4/6]

◆ Vector() [5/6]

◆ Vector() [6/6]

Member Function Documentation

◆ equalsEpsilon()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

Friends And Related Symbol Documentation

◆ operator*