#include <include/linalg/Matrix.hpp>

Detailed Description

General matrix class.

Examples: Basic-matrix-operations-no-iostream.ino, Basic-matrix-operations.ino, Basics.cpp, and QR-PerfTest.cpp.

Definition at line 34 of file Matrix.hpp.

Inheritance diagram for Matrix:

Collaboration diagram for Matrix:

Constructors and assignment
	Matrix ()=default
	Default constructor. More...

	Matrix (size_t rows, size_t cols)
	Create a matrix of zeros with the given dimensions. More...

	Matrix (std::initializer_list< std::initializer_list< double >> init)
	Create a matrix with the given values. More...

Matrix &	operator= (std::initializer_list< std::initializer_list< double >> init)
	Assign the given values to the matrix. More...

	Matrix (const Matrix &)=default
	Default copy constructor. More...

	Matrix (Matrix &&)
	Move constructor. More...

Matrix &	operator= (const Matrix &)=default
	Default copy assignment. More...

Matrix &	operator= (Matrix &&)
	Move assignment. More...

Matrix size
size_t	rows () const
	Get the number of rows of the matrix. More...

size_t	cols () const
	Get the number of columns of the matrix. More...

size_t	num_elems () const
	Get the number of elements in the matrix: More...

void	reshape (size_t newrows, size_t newcols)
	Reshape the matrix. More...

Matrix	reshaped (size_t newrows, size_t newcols) const
	Create a reshaped copy of the matrix. More...

Element access
double &	operator() (size_t row, size_t col)
	Get the element at the given position in the matrix. More...

const double &	operator() (size_t row, size_t col) const
	Get the element at the given position in the matrix. More...

double &	operator() (size_t index)
	Get the element at the given position in the linearized matrix. More...

const double &	operator() (size_t index) const
	Get the element at the given position in the linearized matrix. More...

Memory management
void	clear_and_deallocate ()
	Set the number of rows and columns to zero, and deallocate the storage. More...

Filling matrices
void	fill (double value)
	Fill the matrix with a constant value. More...

void	fill_identity ()
	Fill the matrix as an identity matrix (all zeros except the diagonal which is one). More...

void	fill_random (double min=0, double max=1, std::default_random_engine::result_type seed=std::default_random_engine::default_seed)
	Fill the matrix with uniformly distributed random values. More...

Swapping rows and columns
void	swap_rows (size_t a, size_t b)
	Swap two rows of the matrix. More...

void	swap_columns (size_t a, size_t b)
	Swap two columns of the matrix. More...

Comparison
bool	operator== (const Matrix &other) const
	Check for equality of two matrices. More...

bool	operator!= (const Matrix &other) const
	Check for inequality of two matrices. More...

Matrix norms
double	normFro () const &
	Compute the Frobenius norm of the matrix. More...

double	normFro () &&
	Compute the Frobenius norm of the matrix. More...

Iterators
storage_t::iterator	begin ()
	Get the iterator to the first element of the matrix. More...

storage_t::const_iterator	begin () const
	Get the iterator to the first element of the matrix. More...

storage_t::const_iterator	cbegin () const
	Get the iterator to the first element of the matrix. More...

storage_t::iterator	end ()
	Get the iterator to the element past the end of the matrix. More...

storage_t::const_iterator	end () const
	Get the iterator to the element past the end of the matrix. More...

storage_t::const_iterator	cend () const
	Get the iterator to the element past the end of the matrix. More...

Printing
void	print (std::ostream &os, uint8_t precision=0, uint8_t width=0) const
	Print a matrix. More...

void	print (Print &print, uint8_t precision=0, uint8_t width=0) const
	Print a matrix. More...

size_t	printTo (Print &print) const override
	Implements the Arduino Printable interface. More...

Create special matrices
static Matrix	ones (size_t rows, size_t cols)
	Create a matrix filled with ones. More...

static Matrix	zeros (size_t rows, size_t cols)
	Create a matrix filled with zeros. More...

static Matrix	constant (size_t rows, size_t cols, double value)
	Create a matrix filled with a constant value. More...

static Matrix	identity (size_t rows, size_t cols)
	Create an identity matrix. More...

static Matrix	identity (size_t rows)
	Create a square identity matrix. More...

static Matrix	random (size_t rows, size_t cols, double min=0, double max=1, std::default_random_engine::result_type seed=std::default_random_engine::default_seed)
	Create a matrix with uniformly distributed random values. More...

Protected Member Functions
	Matrix (storage_t &&storage, size_t rows, size_t cols)
	Convert raw storage to a matrix. More...

	Matrix (const storage_t &storage, size_t rows, size_t cols)
	Convert raw storage to a matrix. More...

Protected Attributes
size_t	rows_ = 0

size_t	cols_ = 0

storage_t	storage

Private Types
using	storage_t = util::storage_t< double >
	Container to store the elements of the matrix internally. More...

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &os, const Matrix &M)
	Print a matrix. More...

Print &	operator<< (Print &p, const Matrix &M)
	Print a matrix. More...

Member Typedef Documentation

◆ storage_t

using storage_t = util::storage_t<double>

private

Container to store the elements of the matrix internally.

Definition at line 40 of file Matrix.hpp.

Constructor & Destructor Documentation

◆ Matrix() [1/7]

Matrix	(	storage_t &&	storage,
		size_t	rows,
		size_t	cols
	)

explicitprotected

Convert raw storage to a matrix.

Definition at line 9 of file Matrix.cpp.

◆ Matrix() [2/7]

Matrix	(	const storage_t &	storage,
		size_t	rows,
		size_t	cols
	)

explicitprotected

Convert raw storage to a matrix.

Definition at line 14 of file Matrix.cpp.

◆ Matrix() [3/7]

Matrix ( )

default

Default constructor.

◆ Matrix() [4/7]

Matrix	(	size_t	rows,
		size_t	cols
	)

Create a matrix of zeros with the given dimensions.

Definition at line 19 of file Matrix.cpp.

◆ Matrix() [5/7]

Matrix ( std::initializer_list< std::initializer_list< double >> init )

Create a matrix with the given values.

Definition at line 26 of file Matrix.cpp.

◆ Matrix() [6/7]

Matrix ( const Matrix & )

default

Default copy constructor.

◆ Matrix() [7/7]

Matrix ( Matrix && other )

Move constructor.

Definition at line 24 of file Matrix.cpp.

Member Function Documentation

◆ operator=() [1/3]

Matrix & operator= ( std::initializer_list< std::initializer_list< double >> init )

Assign the given values to the matrix.

Definition at line 45 of file Matrix.cpp.

◆ operator=() [2/3]

Matrix& operator= ( const Matrix & )

default

Default copy assignment.

◆ operator=() [3/3]

Matrix & operator= ( Matrix && other )

Move assignment.

Definition at line 34 of file Matrix.cpp.

◆ rows()

size_t rows ( ) const

inline

Get the number of rows of the matrix.

Examples: Basics.cpp.

Definition at line 81 of file Matrix.hpp.

◆ cols()

size_t cols ( ) const

inline

Get the number of columns of the matrix.

Examples: Basics.cpp.

Definition at line 83 of file Matrix.hpp.

◆ num_elems()

size_t num_elems ( ) const

inline

Get the number of elements in the matrix:

Examples: Basics.cpp.

Definition at line 85 of file Matrix.hpp.

◆ reshape()

void reshape	(	size_t	newrows,
		size_t	newcols
	)

Reshape the matrix.

The new size must have the same number of elements, and the result depends on the storage order (column major order or row major order).

Definition at line 78 of file Matrix.cpp.

◆ reshaped()

Matrix reshaped	(	size_t	newrows,
		size_t	newcols
	)		const

Create a reshaped copy of the matrix.

See also: reshape

Definition at line 84 of file Matrix.cpp.

◆ operator()() [1/4]

double & operator()	(	size_t	row,
		size_t	col
	)

Get the element at the given position in the matrix.

Definition at line 94 of file Matrix.cpp.

◆ operator()() [2/4]

const double & operator()	(	size_t	row,
		size_t	col
	)		const

Get the element at the given position in the matrix.

Definition at line 102 of file Matrix.cpp.

◆ operator()() [3/4]

double& operator() ( size_t index )

inline

Get the element at the given position in the linearized matrix.

Definition at line 107 of file Matrix.hpp.

◆ operator()() [4/4]

const double& operator() ( size_t index ) const

inline

Get the element at the given position in the linearized matrix.

Definition at line 109 of file Matrix.hpp.

◆ clear_and_deallocate()

void clear_and_deallocate ( )

Set the number of rows and columns to zero, and deallocate the storage.

Definition at line 114 of file Matrix.cpp.

◆ fill()

void fill ( double value )

Fill the matrix with a constant value.

Definition at line 125 of file Matrix.cpp.

◆ fill_identity()

void fill_identity ( )

Fill the matrix as an identity matrix (all zeros except the diagonal which is one).

Definition at line 129 of file Matrix.cpp.

◆ fill_random()

void fill_random	(	double	min = `0`,
		double	max = `1`,
		std::default_random_engine::result_type	seed = `std::default_random_engine::default_seed`
	)

Fill the matrix with uniformly distributed random values.

Definition at line 136 of file Matrix.cpp.

◆ ones()

Matrix ones	(	size_t	rows,
		size_t	cols
	)

static

Create a matrix filled with ones.

Examples: Basics.cpp.

Definition at line 148 of file Matrix.cpp.

◆ zeros()

Matrix zeros	(	size_t	rows,
		size_t	cols
	)

static

Create a matrix filled with zeros.

Examples: Basics.cpp.

Definition at line 152 of file Matrix.cpp.

◆ constant()

Matrix constant	(	size_t	rows,
		size_t	cols,
		double	value
	)

static

Create a matrix filled with a constant value.

Examples: Basics.cpp.

Definition at line 157 of file Matrix.cpp.

◆ identity() [1/2]

Matrix identity	(	size_t	rows,
		size_t	cols
	)

static

Create an identity matrix.

Examples: Basics.cpp.

Definition at line 163 of file Matrix.cpp.

◆ identity() [2/2]

Matrix identity ( size_t rows )

static

Create a square identity matrix.

Definition at line 169 of file Matrix.cpp.

◆ random()

Matrix random	(	size_t	rows,
		size_t	cols,
		double	min = `0`,
		double	max = `1`,
		std::default_random_engine::result_type	seed = `std::default_random_engine::default_seed`
	)

static

Create a matrix with uniformly distributed random values.

Examples: Basics.cpp, and QR-PerfTest.cpp.

Definition at line 172 of file Matrix.cpp.

◆ swap_rows()

void swap_rows	(	size_t	a,
		size_t	b
	)

Swap two rows of the matrix.

Definition at line 189 of file Matrix.cpp.

◆ swap_columns()

void swap_columns	(	size_t	a,
		size_t	b
	)

Swap two columns of the matrix.

Definition at line 184 of file Matrix.cpp.

◆ operator==()

bool operator== ( const Matrix & other ) const

Check for equality of two matrices.

Warning: Uses exact comparison, which is often not appropriate for floating point numbers.

Definition at line 198 of file Matrix.cpp.

◆ operator!=()

bool operator!= ( const Matrix & other ) const

inline

Check for inequality of two matrices.

Warning: Uses exact comparison, which is often not appropriate for floating point numbers.

Definition at line 193 of file Matrix.hpp.

◆ normFro() [1/2]

double normFro ( ) const &

Compute the Frobenius norm of the matrix.

Implementation

double Matrix::normFro() const & {
    // Reinterpret the matrix as one big vector, and compute the dot product
    // with itself. This is the 2-norm of the vector squared, so the Frobenius
    // norm of the matrix is the square root of this dot product.
    // ‖A‖f = ‖vec(A)‖₂ = √(vec(A)ᵀvec(A))
    return std::sqrt(Vector::dot_unchecked(*this, *this));
}

Definition at line 219 of file Matrix.cpp.

◆ normFro() [2/2]

double normFro ( ) &&

Compute the Frobenius norm of the matrix.

Definition at line 228 of file Matrix.cpp.

◆ begin() [1/2]

storage_t::iterator begin ( )

inline

Get the iterator to the first element of the matrix.

Examples: QR-PerfTest.cpp.

Definition at line 213 of file Matrix.hpp.

◆ begin() [2/2]

storage_t::const_iterator begin ( ) const

inline

Get the iterator to the first element of the matrix.

Definition at line 215 of file Matrix.hpp.

◆ cbegin()

storage_t::const_iterator cbegin ( ) const

inline

Get the iterator to the first element of the matrix.

Definition at line 217 of file Matrix.hpp.

◆ end() [1/2]

storage_t::iterator end ( )

inline

Get the iterator to the element past the end of the matrix.

Examples: QR-PerfTest.cpp.

Definition at line 220 of file Matrix.hpp.

◆ end() [2/2]

storage_t::const_iterator end ( ) const

inline

Get the iterator to the element past the end of the matrix.

Definition at line 222 of file Matrix.hpp.

◆ cend()

storage_t::const_iterator cend ( ) const

inline

Get the iterator to the element past the end of the matrix.

Definition at line 224 of file Matrix.hpp.

◆ print() [1/2]

void print	(	std::ostream &	os,
		uint8_t	precision = `0`,
		uint8_t	width = `0`
	)		const

Print a matrix.

Parameters

os	The stream to print to.
precision	The number of significant figures to print. (0 = auto)
width	The width of each element (number of characters). (0 = auto)

Definition at line 242 of file Matrix.cpp.

◆ print() [2/2]

void print	(	Print &	print,
		uint8_t	precision = `0`,
		uint8_t	width = `0`
	)		const

Print a matrix.

Parameters

print	The printer to print to.
precision	The number of significant figures to print. (0 = auto)
width	The width of each element (number of characters). (0 = auto)

Definition at line 48 of file ArduinoMatrixPrinter.cpp.

◆ printTo()

size_t printTo ( Print & print ) const

inlineoverride

Implements the Arduino Printable interface.

Definition at line 259 of file Matrix.hpp.

Friends And Related Function Documentation

◆ operator<<() [1/2]

std::ostream & operator<<	(	std::ostream &	os,
		const Matrix &	M
	)

Definition at line 255 of file Matrix.cpp.

◆ operator<<() [2/2]

Print & operator<<	(	Print &	p,
		const Matrix &	M
	)

Definition at line 62 of file ArduinoMatrixPrinter.cpp.

Member Data Documentation

◆ rows_

size_t rows_ = 0

protected

Definition at line 268 of file Matrix.hpp.

◆ cols_

size_t cols_ = 0

protected

Definition at line 268 of file Matrix.hpp.

◆ storage

storage_t storage

protected

Definition at line 269 of file Matrix.hpp.

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

Detailed Description

Constructors and assignment

Matrix size

Element access

Memory management

Filling matrices

Swapping rows and columns

Comparison

Matrix norms

Iterators

Printing

Create special matrices

Protected Member Functions

Protected Attributes

Private Types

Related Functions

Member Typedef Documentation

◆ storage_t

Constructor & Destructor Documentation

◆ Matrix() [1/7]

◆ Matrix() [2/7]

◆ Matrix() [3/7]

◆ Matrix() [4/7]

◆ Matrix() [5/7]

◆ Matrix() [6/7]

◆ Matrix() [7/7]

Member Function Documentation

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ rows()

◆ cols()

◆ num_elems()

◆ reshape()

◆ reshaped()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ clear_and_deallocate()

◆ fill()

◆ fill_identity()

◆ fill_random()

◆ ones()

◆ zeros()

◆ constant()

◆ identity() [1/2]

◆ identity() [2/2]

◆ random()

◆ swap_rows()

◆ swap_columns()

◆ operator==()

◆ operator!=()

◆ normFro() [1/2]

Implementation

◆ normFro() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ end() [1/2]

◆ end() [2/2]

◆ cend()

◆ print() [1/2]

◆ print() [2/2]

◆ printTo()

Friends And Related Function Documentation

◆ operator<<() [1/2]

◆ operator<<() [2/2]

Member Data Documentation

◆ rows_

◆ cols_

◆ storage