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

Template parameters
T the number type
N the number of rows
M the number of columns

Contents

Static matrix class. Memory layout is based on rows

Public static variables

static const Matrix Zero

Constructors, destructors, conversion operators

Matrix()
Matrix(const T val) explicit
Matrix(const std::initializer_list<T>& lst)
Matrix(const Matrix<T, N, M>& other)
Matrix(Matrix<T, N, M>&& other) noexcept
template<typename T>
Matrix(const fsize n, const fsize m)
template<typename T>
Matrix(const fsize n, const fsize m, const T val)
template<typename T>
Matrix(const fsize n, const fsize m, const std::initializer_list<T>& lst)
template<typename T>
Matrix(const Matrix<T>& other)
template<typename T>
Matrix(Matrix<T>&& other) noexcept

Public functions

auto operator=(const Matrix<T, N, M>& other) -> Matrix<T, N, M>&
auto operator=(Matrix<T, N, M>&& other) -> Matrix<T, N, M>& noexcept
auto operator()(const fsize l, const fsize c) -> T&
auto operator()(const fsize l, const fsize c) const -> T
auto operator*() const -> const T* noexcept
auto operator*() -> T* noexcept
auto operator==(const Matrix<T, N, M>& other) const -> bool
auto operator!=(const Matrix<T, N, M>& other) const -> bool
template<fsize P>
auto operator*(const Matrix<T, M, P>& other) const -> Matrix<T, N, P>
auto operator+(const Matrix<T, N, M>& other) const -> Matrix<T, N, M>
auto operator*(const Vector<T, N>& other) const -> Vector<T, N>
auto operator*(const T& other) const -> Matrix<T, N, M>
auto Transpose() const -> Matrix<T, M, N>
void SwapRows(fsize rowa, fsize rowb)
void SwapColumns(fsize cola, fsize colb)
template<typename T>
auto operator*(const Matrix<T>& other) const -> Matrix<T>
template<typename T>
auto operator*(const Vector<T>& other) const -> Vector<T>

Function documentation

template<typename T, fsize N, fsize M>
bpf::math::Matrix<T, N, M>::Matrix()

Constructs an empty matrix

template<typename T, fsize N, fsize M>
bpf::math::Matrix<T, N, M>::Matrix(const T val) explicit

Parameters
val the value to initialize all cells

Constructs a matrix from a single value

template<typename T, fsize N, fsize M>
bpf::math::Matrix<T, N, M>::Matrix(const std::initializer_list<T>& lst)

Parameters
lst the list to copy values from

Constructs a matrix from an initializer list

template<typename T, fsize N, fsize M>
bpf::math::Matrix<T, N, M>::Matrix(const Matrix<T, N, M>& other)

Copy constructor

template<typename T, fsize N, fsize M>
bpf::math::Matrix<T, N, M>::Matrix(Matrix<T, N, M>&& other) noexcept

Move constructor

#include <Base/include/Framework/Math/Matrix.impl.hpp>
template<typename T, fsize N, fsize M> template<typename T>
bpf::math::Matrix<T, N, M>::Matrix(const fsize n, const fsize m)

#include <Base/include/Framework/Math/Matrix.impl.hpp>
template<typename T, fsize N, fsize M> template<typename T>
bpf::math::Matrix<T, N, M>::Matrix(const fsize n, const fsize m, const T val)

#include <Base/include/Framework/Math/Matrix.impl.hpp>
template<typename T, fsize N, fsize M> template<typename T>
bpf::math::Matrix<T, N, M>::Matrix(const fsize n, const fsize m, const std::initializer_list<T>& lst)

#include <Base/include/Framework/Math/Matrix.impl.hpp>
template<typename T, fsize N, fsize M> template<typename T>
bpf::math::Matrix<T, N, M>::Matrix(const Matrix<T>& other)

#include <Base/include/Framework/Math/Matrix.impl.hpp>
template<typename T, fsize N, fsize M> template<typename T>
bpf::math::Matrix<T, N, M>::Matrix(Matrix<T>&& other) noexcept

template<typename T, fsize N, fsize M>
Matrix<T, N, M>& bpf::math::Matrix<T, N, M>::operator=(const Matrix<T, N, M>& other)

Copy assignment operator

template<typename T, fsize N, fsize M>
Matrix<T, N, M>& bpf::math::Matrix<T, N, M>::operator=(Matrix<T, N, M>&& other) noexcept

Move assignment operator

template<typename T, fsize N, fsize M>
T& bpf::math::Matrix<T, N, M>::operator()(const fsize l, const fsize c)

Parameters
l the row number
c the column number
Returns mutable cell value

Obtains the value of a cell for modification

template<typename T, fsize N, fsize M>
T bpf::math::Matrix<T, N, M>::operator()(const fsize l, const fsize c) const

Parameters
l the row number
c the column number
Returns immutable cell value

Obtains the value of a cell for reading

template<typename T, fsize N, fsize M>
const T* bpf::math::Matrix<T, N, M>::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 N, fsize M>
T* bpf::math::Matrix<T, N, M>::operator*() noexcept

Returns mutable low-level C array

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

template<typename T, fsize N, fsize M>
bool bpf::math::Matrix<T, N, M>::operator==(const Matrix<T, N, M>& other) const

Parameters
other matrix to compare with
Returns true if the two matrices are equal, false otherwise

Compare two matrices

template<typename T, fsize N, fsize M>
bool bpf::math::Matrix<T, N, M>::operator!=(const Matrix<T, N, M>& other) const

Parameters
other matrix to compare with
Returns true if the two matrices are not equal, false otherwise

Compare two matrices

template<typename T, fsize N, fsize M> template<fsize P>
Matrix<T, N, P> bpf::math::Matrix<T, N, M>::operator*(const Matrix<T, M, P>& other) const

Template parameters
P number of columns of the other matrix
Parameters
other operand
Returns new matrix

Performs matrix-matrix multiplication

template<typename T, fsize N, fsize M>
Matrix<T, N, M> bpf::math::Matrix<T, N, M>::operator+(const Matrix<T, N, M>& other) const

Parameters
other operand
Returns new matrix

Performs matrix addition

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

Parameters
other operand
Returns new vector

Performs matrix-vector multiplication

template<typename T, fsize N, fsize M>
Matrix<T, N, M> bpf::math::Matrix<T, N, M>::operator*(const T& other) const

Parameters
other operand
Returns new matrix

Performs matrix-scalar multiplication

template<typename T, fsize N, fsize M>
Matrix<T, M, N> bpf::math::Matrix<T, N, M>::Transpose() const

Returns new matrix transpose of this

Computes the transpose

template<typename T, fsize N, fsize M>
void bpf::math::Matrix<T, N, M>::SwapRows(fsize rowa, fsize rowb)

Parameters
rowa first row number
rowb second row number

Swaps two rows of this matrix

template<typename T, fsize N, fsize M>
void bpf::math::Matrix<T, N, M>::SwapColumns(fsize cola, fsize colb)

Parameters
cola first column number
colb second column number

Swaps two columns of this matrix

#include <Base/include/Framework/Math/Matrix.impl.hpp>
template<typename T, fsize N, fsize M> template<typename T>
Matrix<T> bpf::math::Matrix<T, N, M>::operator*(const Matrix<T>& other) const

#include <Base/include/Framework/Math/Matrix.impl.hpp>
template<typename T, fsize N, fsize M> template<typename T>
Vector<T> bpf::math::Matrix<T, N, M>::operator*(const Vector<T>& other) const

Variable documentation

template<typename T, fsize N, fsize M>
static const Matrix bpf::math::Matrix<T, N, M>::Zero

Zero-matrix constant