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

2D vector template class. More...

#include "vec2.hpp"

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

Public Types
using	type = T
	Type of the vector's components.

Public Member Functions
constexpr	vec ()=default
	Default constructor.
template<Primitive U>
constexpr	vec (U value)
	Constructs a vec with both components set to value.
template<Primitive A, Primitive B>
constexpr	vec (A a, B b)
	Constructs a vec with given values for x and y components.
template<typename... U>
constexpr	vec (U... data)
	Constructs a vec from a variadic list of values.
constexpr	vec (std::array< T, size > const &arr)
	Constructs a vec from a given array.
constexpr	vec (std::array< T, size > &&arr)
	Constructs a vec by moving data from a given array.
constexpr void	reset () noexcept
	Resets the vec to zeroes.
template<typename U >
constexpr vec< size, T > &	operator= (_detail::rvec< size, U > const &b)
	Assignment operator from a rvec.
template<typename U >
constexpr vec< size, T > &	operator= (vec< size, U > const &b)
	Assignment operator from another vec.
constexpr vec< 2, T > const &	operator+ () const noexcept
	Unary plus operator.
constexpr vec< 2, T >	operator- () const noexcept
	Unary minus operator.
template<Primitive U>
constexpr vec< 2, T > &	operator+= (U const value) noexcept
template<Primitive U>
constexpr vec< 2, T > &	operator-= (U const value) noexcept
template<Primitive U>
constexpr vec< 2, T > &	operator*= (U const value) noexcept
template<Primitive U>
constexpr vec< 2, T > &	operator/= (U const value) noexcept
template<Primitive U>
constexpr vec< 2, T > &	operator%= (U const value) noexcept
template<AnyVec U> requires (size == U::size)
constexpr vec< 2, T > &	operator+= (U const &other) noexcept
template<AnyVec U> requires (size == U::size)
constexpr vec< 2, T > &	operator-= (U const &other) noexcept
template<AnyVec U> requires (size == U::size)
constexpr vec< 2, T > &	operator*= (U const &other) noexcept
template<AnyVec U> requires (size == U::size)
constexpr vec< 2, T > &	operator/= (U const &other) noexcept
template<AnyVec U> requires (size == U::size)
constexpr vec< 2, T > &	operator%= (U const &other) noexcept
constexpr T &	operator[] (size_t i)
	Indexing operator (non-const version).
constexpr T const &	operator[] (size_t i) const
	Indexing operator (const version).

Static Public Member Functions
static constexpr vec< 2, T >	zero () noexcept
	Returns a new zero-initialized vec.

Public Attributes
union mal_math::vec< 2, T >:: { ... }
	Union providing various ways to access the data.

Static Public Attributes
static constexpr size_t	size = 2

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<Primitive T>
struct mal_math::vec< 2, T >

2D vector template class.

Template Parameters

T	Primitive type used for the vector's components.

Definition at line 22 of file vec2.hpp.

Member Typedef Documentation

type

template<Primitive T>

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

Type of the vector's components.

Definition at line 25 of file vec2.hpp.

Constructor & Destructor Documentation

vec() [1/6]

template<Primitive T>

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

constexprdefault

Default constructor.

vec() [2/6]

template<Primitive T>

template<Primitive U>

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

constexpr

Constructs a vec with both components set to value.

Definition at line 7 of file vec2.inl.

vec() [3/6]

template<Primitive T>

template<Primitive A, Primitive B>

mal_math::vec< 2, T >::vec ( A a, B b )

constexpr

Constructs a vec with given values for x and y components.

Definition at line 10 of file vec2.inl.

vec() [4/6]

template<Primitive T>

template<typename... U>

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

constexpr

Constructs a vec from a variadic list of values.

Definition at line 17 of file vec2.inl.

vec() [5/6]

template<Primitive T>

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

inlineconstexpr

Constructs a vec from a given array.

Definition at line 39 of file vec2.hpp.

vec() [6/6]

template<Primitive T>

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

inlineconstexpr

Constructs a vec by moving data from a given array.

Definition at line 41 of file vec2.hpp.

Member Function Documentation

get_parameter_pack_size() [1/3]

template<Primitive T>

template<class V >

size_t mal_math::vec< 2, 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 133 of file vec2.inl.

get_parameter_pack_size() [2/3]

template<Primitive T>

template<class V >

static constexpr size_t mal_math::vec< 2, 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<Primitive T>

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

size_t mal_math::vec< 2, 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 145 of file vec2.inl.

operator%=() [1/2]

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

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

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

constexprnoexcept

Definition at line 112 of file vec2.inl.

operator%=() [2/2]

template<Primitive T>

template<Primitive U>

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

constexprnoexcept

Definition at line 72 of file vec2.inl.

operator*=() [1/2]

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

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

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

constexprnoexcept

Definition at line 96 of file vec2.inl.

operator*=() [2/2]

template<Primitive T>

template<Primitive U>

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

constexprnoexcept

Definition at line 56 of file vec2.inl.

operator+()

template<Primitive T>

vec< 2, T > const & mal_math::vec< 2, T >::operator+ ( ) const

nodiscardconstexprnoexcept

Unary plus operator.

Definition at line 27 of file vec2.inl.

operator+=() [1/2]

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

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

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

constexprnoexcept

Definition at line 80 of file vec2.inl.

operator+=() [2/2]

template<Primitive T>

template<Primitive U>

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

constexprnoexcept

Definition at line 40 of file vec2.inl.

operator-()

template<Primitive T>

vec< 2, T > mal_math::vec< 2, T >::operator- ( ) const

nodiscardconstexprnoexcept

Unary minus operator.

Definition at line 33 of file vec2.inl.

operator-=() [1/2]

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

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

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

constexprnoexcept

Definition at line 88 of file vec2.inl.

operator-=() [2/2]

template<Primitive T>

template<Primitive U>

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

constexprnoexcept

Definition at line 48 of file vec2.inl.

operator/=() [1/2]

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

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

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

constexprnoexcept

Definition at line 104 of file vec2.inl.

operator/=() [2/2]

template<Primitive T>

template<Primitive U>

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

constexprnoexcept

Definition at line 64 of file vec2.inl.

operator=() [1/2]

template<Primitive T>

template<typename U >

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

inlineconstexpr

Assignment operator from a rvec.

Definition at line 49 of file vec2.hpp.

operator=() [2/2]

template<Primitive T>

template<typename U >

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

inlineconstexpr

Assignment operator from another vec.

Definition at line 59 of file vec2.hpp.

operator[]() [1/2]

template<Primitive T>

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

nodiscardconstexpr

Indexing operator (non-const version).

Definition at line 119 of file vec2.inl.

operator[]() [2/2]

template<Primitive T>

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

nodiscardconstexpr

Indexing operator (const version).

Definition at line 125 of file vec2.inl.

reset()

template<Primitive T>

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

constexprnoexcept

Resets the vec to zeroes.

Definition at line 24 of file vec2.inl.

unpack_data() [1/3]

template<Primitive T>

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

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

constexprprivate

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 167 of file vec2.inl.

unpack_data() [2/3]

template<Primitive T>

template<class V >

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

constexprprivate

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 152 of file vec2.inl.

unpack_data() [3/3]

template<Primitive T>

template<class V >

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

constexprprivate

Unpacks a vector into the matrix data.

Parameters

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

zero()

template<Primitive T>

static constexpr vec< 2, T > mal_math::vec< 2, T >::zero ( )

inlinestaticconstexprnoexcept

Returns a new zero-initialized vec.

Definition at line 43 of file vec2.hpp.

Member Data Documentation

[]

union mal_math::vec< 2, T > { ... } mal_math::vec< 2, T >

Union providing various ways to access the data.

data

template<Primitive T>

std::array<T, 2> mal_math::vec< 2, T >::data

Array access to the elements.

Definition at line 112 of file vec2.hpp.

g

template<Primitive T>

T mal_math::vec< 2, T >::g

Definition at line 109 of file vec2.hpp.

r

template<Primitive T>

T mal_math::vec< 2, T >::r

Definition at line 105 of file vec2.hpp.

s

template<Primitive T>

T mal_math::vec< 2, T >::s

Definition at line 105 of file vec2.hpp.

size

template<Primitive T>

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

staticconstexpr

Size of the vector.

Definition at line 26 of file vec2.hpp.

t

template<Primitive T>

T mal_math::vec< 2, T >::t

Definition at line 109 of file vec2.hpp.

u

template<Primitive T>

T mal_math::vec< 2, T >::u

Definition at line 105 of file vec2.hpp.

v

template<Primitive T>

T mal_math::vec< 2, T >::v

Definition at line 109 of file vec2.hpp.

x

template<Primitive T>

T mal_math::vec< 2, T >::x

Definition at line 105 of file vec2.hpp.

y

template<Primitive T>

T mal_math::vec< 2, T >::y

Definition at line 109 of file vec2.hpp.

---

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

• include/math/vec2.hpp
• include/math/vec2.inl