#include <Base/include/Framework/Math/Vector.hpp>
template<typename T, fsize I = 0>
bpf::math::Vector class

Template parameters
T the number type
I the dimension

Contents

Static vector class

Public static variables

static const Vector Zero
static const Vector Identity

Public static functions

static auto Lerp(const Vector& v, const Vector& v1, T t) -> Vector

Constructors, destructors, conversion operators

Vector()
Vector(const T val) explicit
Vector(const Vector<T, I - 1>& other, const T val)
Vector(const std::initializer_list<T>& lst)
Vector(const Vector& other)
Vector(Vector&& other) noexcept

Public functions

auto Dim() const -> fsize constexpr noexcept
auto operator()(const fsize l) -> T&
auto operator()(const fsize l) const -> const T&
auto operator=(const Vector& other) -> Vector&
auto operator=(Vector&& other) -> Vector& noexcept
auto operator+(const Vector& other) const -> Vector
auto operator-(const Vector& other) const -> Vector
auto operator*(const Vector& other) const -> Vector
auto operator/(const Vector& other) const -> Vector
auto operator*(T other) const -> Vector
auto operator/(T other) const -> Vector
void operator+=(const Vector& other)
void operator-=(const Vector& other)
void operator*=(const Vector& other)
void operator/=(const Vector& other)
void operator*=(T other)
void operator/=(T other)
auto operator-() const -> Vector
auto operator==(const Vector& other) const -> bool
auto operator!=(const Vector& other) const -> bool
auto operator<(const Vector& other) const -> bool
auto operator>(const Vector& other) const -> bool
auto operator<=(const Vector& other) const -> bool
auto operator>=(const Vector& other) const -> bool
auto Dot(const Vector& other) const -> T
auto Distance(const Vector& other) const -> T
auto DistanceSquared(const Vector& other) const -> T
auto Norm() const -> T
auto NormSquared() const -> T
auto Normalize() const -> Vector
auto operator*() const -> const T* noexcept
auto operator*() -> T* noexcept

Function documentation

template<typename T, fsize I>
static Vector bpf::math::Vector<T, I>::Lerp(const Vector& v, const Vector& v1, T t)

Parameters
v first vector
v1 second vector
t interpolation factor
Returns new interpolated vector

Performs linear interpolation

template<typename T, fsize I>
bpf::math::Vector<T, I>::Vector()

Constructs a empty vector

template<typename T, fsize I>
bpf::math::Vector<T, I>::Vector(const T val) explicit

Parameters
val number to copy from

Constructs a vector from a scalar

template<typename T, fsize I>
bpf::math::Vector<T, I>::Vector(const Vector<T, I - 1>& other, const T val)

Parameters
other the lower dimension vector
val the additional scalar

Constructs a vector by extension of a lower-dimension vector

template<typename T, fsize I>
bpf::math::Vector<T, I>::Vector(const std::initializer_list<T>& lst)

Parameters
lst the list to copy values from

Constructs a vector from an initializer list

template<typename T, fsize I>
bpf::math::Vector<T, I>::Vector(const Vector& other)

Copy constructor

template<typename T, fsize I>
bpf::math::Vector<T, I>::Vector(Vector&& other) noexcept

Move constructor

template<typename T, fsize I>
fsize bpf::math::Vector<T, I>::Dim() const constexpr noexcept

Returns unsigned constant expression

Returns the dimension of this vector

template<typename T, fsize I>
T& bpf::math::Vector<T, I>::operator()(const fsize l)

Parameters
l the row number
Returns mutable cell value
Exceptions
IndexException if out of bounds

Obtains the value of a cell for modification

template<typename T, fsize I>
const T& bpf::math::Vector<T, I>::operator()(const fsize l) const

Parameters
l the row number
Returns immutable cell value
Exceptions
IndexException if out of bounds

Obtains the value of a cell for reading

template<typename T, fsize I>
Vector& bpf::math::Vector<T, I>::operator=(const Vector& other)

Copy assignment operator

template<typename T, fsize I>
Vector& bpf::math::Vector<T, I>::operator=(Vector&& other) noexcept

Move assignment operator

template<typename T, fsize I>
Vector bpf::math::Vector<T, I>::operator+(const Vector& other) const

Parameters
other operand
Returns new vector

Performs element-wise addition

template<typename T, fsize I>
Vector bpf::math::Vector<T, I>::operator-(const Vector& other) const

Parameters
other operand
Returns new vector

Performs element-wise subtraction

template<typename T, fsize I>
Vector bpf::math::Vector<T, I>::operator*(const Vector& other) const

Parameters
other operand
Returns new vector

Performs element-wise multiplication

template<typename T, fsize I>
Vector bpf::math::Vector<T, I>::operator/(const Vector& other) const

Parameters
other operand
Returns new vector

Performs element-wise division

template<typename T, fsize I>
Vector bpf::math::Vector<T, I>::operator*(T other) const

Parameters
other operand
Returns new vector

Performs vector-scalar multiplication

template<typename T, fsize I>
Vector bpf::math::Vector<T, I>::operator/(T other) const

Parameters
other operand
Returns new vector

Performs vector-scalar division

template<typename T, fsize I>
void bpf::math::Vector<T, I>::operator+=(const Vector& other)

Parameters
other operand

Performs element-wise addition

template<typename T, fsize I>
void bpf::math::Vector<T, I>::operator-=(const Vector& other)

Parameters
other operand

Performs element-wise subtraction

template<typename T, fsize I>
void bpf::math::Vector<T, I>::operator*=(const Vector& other)

Parameters
other operand

Performs element-wise multiplication

template<typename T, fsize I>
void bpf::math::Vector<T, I>::operator/=(const Vector& other)

Parameters
other operand

Performs element-wise division

template<typename T, fsize I>
void bpf::math::Vector<T, I>::operator*=(T other)

Parameters
other operand

Performs vector-scalar multiplication

template<typename T, fsize I>
void bpf::math::Vector<T, I>::operator/=(T other)

Parameters
other operand

Performs vector-scalar division

template<typename T, fsize I>
Vector bpf::math::Vector<T, I>::operator-() const

Returns negated vector

Negates this vector

template<typename T, fsize I>
bool bpf::math::Vector<T, I>::operator==(const Vector& other) const

Parameters
other vector to compare with
Returns true if the two vectors are equal, false otherwise

Compare two vectors

template<typename T, fsize I>
bool bpf::math::Vector<T, I>::operator!=(const Vector& other) const

Parameters
other vector to compare with
Returns false if the two vectors are equal, true otherwise

Compare two vectors

template<typename T, fsize I>
bool bpf::math::Vector<T, I>::operator<(const Vector& other) const

Parameters
other vector to compare with
Returns true if this is less than other, false otherwise

Compare two vectors

template<typename T, fsize I>
bool bpf::math::Vector<T, I>::operator>(const Vector& other) const

Parameters
other vector to compare with
Returns true if this is greater than other, false otherwise

Compare two vectors

template<typename T, fsize I>
bool bpf::math::Vector<T, I>::operator<=(const Vector& other) const

Parameters
other vector to compare with
Returns true if this is less than or equal to other, false otherwise

Compare two vectors

template<typename T, fsize I>
bool bpf::math::Vector<T, I>::operator>=(const Vector& other) const

Parameters
other vector to compare with
Returns true if this is greater than or equal to other, false otherwise

Compare two vectors

template<typename T, fsize I>
T bpf::math::Vector<T, I>::Dot(const Vector& other) const

Parameters
other operand
Returns number

Computes the dot product

template<typename T, fsize I>
T bpf::math::Vector<T, I>::Distance(const Vector& other) const

Parameters
other operand
Returns number

Computes the distance between two vectors

template<typename T, fsize I>
T bpf::math::Vector<T, I>::DistanceSquared(const Vector& other) const

Parameters
other operand
Returns number

Computes the squared distance between two vectors

template<typename T, fsize I>
T bpf::math::Vector<T, I>::Norm() const

Returns number

Computes the norm of this vector

template<typename T, fsize I>
T bpf::math::Vector<T, I>::NormSquared() const

Returns number

Computes the squared norm of this vector

template<typename T, fsize I>
Vector bpf::math::Vector<T, I>::Normalize() const

Returns normalized vector

Normalizes this vector (by dividing each component by Norm())

template<typename T, fsize I>
const T* bpf::math::Vector<T, I>::operator*() const noexcept

Returns immutable low-level C array

Returns a low-level C array, used to transfer to lower-level APIs

template<typename T, fsize I>
T* bpf::math::Vector<T, I>::operator*() noexcept

Returns mutable low-level C array

Returns a low-level C array, used to transfer to lower-level APIs

Variable documentation

template<typename T, fsize I>
static const Vector bpf::math::Vector<T, I>::Zero

Zero vector constant

template<typename T, fsize I>
static const Vector bpf::math::Vector<T, I>::Identity

Identity vector constant (1, ...)