mal_math::vec< L, T > Struct Template Reference

Definition of the mathematical vector with fixed size L and type T More...

#include "vecn.hpp"

Inheritance diagram for mal_math::vec< L, T >:

Collaboration diagram for mal_math::vec< L, T >:

Public Types
using	type = T
	Type of the vector elements.

Public Member Functions
constexpr	vec ()=default
	Default constructor.
template<Primitive U>
constexpr	vec (U value)
	Constructor initializing all elements to the given value.
template<typename... U>
constexpr	vec (U... data)
	Variadic constructor.
constexpr	vec (std::array< T, size > const &arr)
	Constructor from std::array.
constexpr	vec (std::array< T, size > &&arr)
	Move constructor from std::array.
constexpr void	reset () noexcept
	Resets the vector to the zero vector.
template<typename U >
constexpr vec< size, T > &	operator= (vec< size, U > const &b)
	Overloaded assignment operator.
template<Primitive U>
constexpr vec< L, T > &	operator+= (U const value) noexcept
template<Primitive U>
constexpr vec< L, T > &	operator-= (U const value) noexcept
template<Primitive U>
constexpr vec< L, T > &	operator*= (U const value) noexcept
template<Primitive U>
constexpr vec< L, T > &	operator/= (U const value) noexcept
template<Primitive U>
constexpr vec< L, T > &	operator%= (U const value) noexcept
template<AnyVec U> requires (size == U::size)
constexpr vec< L, T > &	operator+= (U const &other) noexcept
template<AnyVec U> requires (size == U::size)
constexpr vec< L, T > &	operator-= (U const &other) noexcept
template<AnyVec U> requires (size == U::size)
constexpr vec< L, T > &	operator*= (U const &other) noexcept
template<AnyVec U> requires (size == U::size)
constexpr vec< L, T > &	operator/= (U const &other) noexcept
template<AnyVec U> requires (size == U::size)
constexpr vec< L, T > &	operator%= (U const &other) noexcept
constexpr T &	operator[] (size_t i)
	Overloaded subscript operator for non-const rvec.
constexpr T const &	operator[] (size_t i) const
	Overloaded subscript operator for const rvec.

Public Attributes
std::array< T, size >	data
	The underlying data of the vector.

Static Public Attributes
static constexpr size_t	size = L
	Number of elements in the vector.

Private Member Functions
template<Primitive U>
constexpr void	unpack_data (size_t offset, U u)
	Unpacks a single primitive value into the vector data.
template<class V >
constexpr void	unpack_data (size_t offset, V vec)
	Unpacks a vector into the matrix data.
template<typename A , typename B , typename... C>
constexpr void	unpack_data (size_t offset, A a, B b, C... c)
	Recursively unpacks multiple values into the vector data.

Static Private Member Functions
template<Primitive _>
static constexpr size_t	get_parameter_pack_size ()
	Determines the size of a parameter pack for primitive types.
template<class V >
static constexpr size_t	get_parameter_pack_size ()
	Determines the size of a parameter pack for vector types.
template<typename A , typename B , typename... C>
static constexpr size_t	get_parameter_pack_size ()
	Determines the size of a parameter pack for a mixed set of types.

Detailed Description

template<size_t L, Primitive T>
struct mal_math::vec< L, T >

Definition of the mathematical vector with fixed size L and type T

Represents a generic vector of a given primitive type.

Template Parameters

L	Length of the vector.
T	The primitive type of the vector.

Definition at line 21 of file vecn.hpp.

Member Typedef Documentation

type

template<size_t L, Primitive T>

using mal_math::vec< L, T >::type = T

Type of the vector elements.

Definition at line 25 of file vecn.hpp.

Constructor & Destructor Documentation

vec() [1/5]

template<size_t L, Primitive T>

mal_math::vec< L, T >::vec ( )

constexprdefault

Default constructor.

vec() [2/5]

template<size_t L, Primitive T>

template<Primitive U>

mal_math::vec< L, T >::vec ( U value )

explicitconstexpr

Constructor initializing all elements to the given value.

Template Parameters

U	Type of the value.

Parameters

value

The value to initialize all elements with.

Definition at line 7 of file vecn.inl.

vec() [3/5]

template<size_t L, Primitive T>

template<typename... U>

mal_math::vec< L, T >::vec ( U... data )

explicitconstexpr

Variadic constructor.

Template Parameters

U	Types of the values.

Parameters

data	Values to initialize the vector with.

Definition at line 16 of file vecn.inl.

vec() [4/5]

template<size_t L, Primitive T>

mal_math::vec< L, T >::vec ( std::array< T, size > const & arr )

inlineexplicitconstexpr

Constructor from std::array.

Parameters

arr	Array from which to initialize the vector.

Definition at line 52 of file vecn.hpp.

vec() [5/5]

template<size_t L, Primitive T>

mal_math::vec< L, T >::vec ( std::array< T, size > && arr )

inlineexplicitconstexpr

Move constructor from std::array.

Parameters

arr	Array from which to move-initialize the vector.

Definition at line 58 of file vecn.hpp.

Member Function Documentation

get_parameter_pack_size() [1/3]

template<size_t L, Primitive T>

template<class V >

size_t mal_math::vec< L, T >::get_parameter_pack_size ( )

staticconstexprprivate

Determines the size of a parameter pack for primitive types.

Returns

size_t Always returns 1 for primitive types.

Definition at line 146 of file vecn.inl.

Here is the caller graph for this function:

get_parameter_pack_size() [2/3]

template<size_t L, Primitive T>

template<class V >

static constexpr size_t mal_math::vec< L, T >::get_parameter_pack_size ( )

staticconstexprprivate

Determines the size of a parameter pack for vector types.

Returns

size_t Returns the size attribute of the vector type.

get_parameter_pack_size() [3/3]

template<size_t L, Primitive T>

template<typename A , typename B , typename... C>

size_t mal_math::vec< L, T >::get_parameter_pack_size ( )

staticconstexprprivate

Determines the size of a parameter pack for a mixed set of types.

Returns

size_t Returns the cumulative size of the parameter pack types.

Definition at line 158 of file vecn.inl.

operator%=() [1/2]

template<size_t L, Primitive T>
requires (size == U::size)

template<AnyVec U>
requires (size == U::size)

vec< L, T > & mal_math::vec< L, T >::operator%= ( U const & other )

constexprnoexcept

Definition at line 123 of file vecn.inl.

operator%=() [2/2]

template<size_t L, Primitive T>

template<Primitive U>

vec< L, T > & mal_math::vec< L, T >::operator%= ( U const value )

constexprnoexcept

Definition at line 73 of file vecn.inl.

operator*=() [1/2]

template<size_t L, Primitive T>
requires (size == U::size)

template<AnyVec U>
requires (size == U::size)

vec< L, T > & mal_math::vec< L, T >::operator*= ( U const & other )

constexprnoexcept

Definition at line 103 of file vecn.inl.

operator*=() [2/2]

template<size_t L, Primitive T>

template<Primitive U>

vec< L, T > & mal_math::vec< L, T >::operator*= ( U const value )

constexprnoexcept

Definition at line 53 of file vecn.inl.

operator+=() [1/2]

template<size_t L, Primitive T>
requires (size == U::size)

template<AnyVec U>
requires (size == U::size)

vec< L, T > & mal_math::vec< L, T >::operator+= ( U const & other )

constexprnoexcept

Definition at line 83 of file vecn.inl.

operator+=() [2/2]

template<size_t L, Primitive T>

template<Primitive U>

vec< L, T > & mal_math::vec< L, T >::operator+= ( U const value )

constexprnoexcept

Definition at line 33 of file vecn.inl.

operator-=() [1/2]

template<size_t L, Primitive T>
requires (size == U::size)

template<AnyVec U>
requires (size == U::size)

vec< L, T > & mal_math::vec< L, T >::operator-= ( U const & other )

constexprnoexcept

Definition at line 93 of file vecn.inl.

operator-=() [2/2]

template<size_t L, Primitive T>

template<Primitive U>

vec< L, T > & mal_math::vec< L, T >::operator-= ( U const value )

constexprnoexcept

Definition at line 43 of file vecn.inl.

operator/=() [1/2]

template<size_t L, Primitive T>
requires (size == U::size)

template<AnyVec U>
requires (size == U::size)

vec< L, T > & mal_math::vec< L, T >::operator/= ( U const & other )

constexprnoexcept

Definition at line 113 of file vecn.inl.

operator/=() [2/2]

template<size_t L, Primitive T>

template<Primitive U>

vec< L, T > & mal_math::vec< L, T >::operator/= ( U const value )

constexprnoexcept

Definition at line 63 of file vecn.inl.

operator=()

template<size_t L, Primitive T>

template<typename U >

vec< size, T > & mal_math::vec< L, T >::operator= ( vec< size, U > const & b )

inlineconstexpr

Overloaded assignment operator.

Definition at line 65 of file vecn.hpp.

operator[]() [1/2]

template<size_t L, Primitive T>

T & mal_math::vec< L, T >::operator[] ( size_t i )

nodiscardconstexpr

Overloaded subscript operator for non-const rvec.

Definition at line 133 of file vecn.inl.

operator[]() [2/2]

template<size_t L, Primitive T>

T const & mal_math::vec< L, T >::operator[] ( size_t i ) const

nodiscardconstexpr

Overloaded subscript operator for const rvec.

Definition at line 139 of file vecn.inl.

reset()

template<size_t L, Primitive T>

void mal_math::vec< L, T >::reset ( )

constexprnoexcept

Resets the vector to the zero vector.

Definition at line 23 of file vecn.inl.

unpack_data() [1/3]

template<size_t L, Primitive T>

template<typename A , typename B , typename... C>

void mal_math::vec< L, T >::unpack_data ( size_t offset, A a, B b, C... c )

inlineconstexprprivate

Recursively unpacks multiple values into the vector data.

Parameters

offset	The position to start unpacking in the vector data.
first	The first value to unpack.
second	The second value to unpack.
rest	The remaining values to unpack.

Definition at line 161 of file vecn.hpp.

Here is the call graph for this function:

unpack_data() [2/3]

template<size_t L, Primitive T>

template<Primitive U>

void mal_math::vec< L, T >::unpack_data ( size_t offset, U u )

inlineconstexprprivate

Unpacks a single primitive value into the vector data.

Parameters

offset	The position to start unpacking in the vector data.
u	The primitive value to unpack.

Definition at line 134 of file vecn.hpp.

Here is the caller graph for this function:

unpack_data() [3/3]

template<size_t L, Primitive T>

template<class V >

void mal_math::vec< L, T >::unpack_data ( size_t offset, V vec )

inlineconstexprprivate

Unpacks a vector into the matrix data.

Parameters

offset	The position to start unpacking in the vector data.
vec	The vector to unpack.

Definition at line 145 of file vecn.hpp.

Member Data Documentation

data

template<size_t L, Primitive T>

std::array<T, size> mal_math::vec< L, T >::data

The underlying data of the vector.

Definition at line 101 of file vecn.hpp.

size

template<size_t L, Primitive T>

size_t mal_math::vec< L, T >::size = L

staticconstexpr

Number of elements in the vector.

Definition at line 27 of file vecn.hpp.

---

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

• include/math/math-common.hpp
• include/math/vecn.hpp
• include/math/vecn.inl