#include <include/linalg/Matrix.hpp>

Detailed Description

A column vector (n×1 matrix).

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

Definition at line 278 of file Matrix.hpp.

Inheritance diagram for Vector:

Collaboration diagram for Vector:

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

	Vector (size_t size)
	Create a column vector of the given size. More...

	Vector (std::initializer_list< double > init)
	Create a column vector from the given list of values. More...

Vector &	operator= (std::initializer_list< double > init)
	Assign a list of values to the column vector. More...

	Vector (const Matrix &matrix)
	Convert an m×n matrix to a mn column vector. More...

	Vector (Matrix &&matrix)
	Convert an m×n matrix to a mn column vector. More...

Vector size
void	resize (size_t size)
	Resize the vector. More...

size_t	size () const
	Get the number of elements in the vector. More...

void	reshape (size_t, size_t)=delete
	Reshaping a vector to a matrix requires an explicit cast. More...

Matrix	reshaped (size_t, size_t)=delete
	Reshaping a vector to a matrix requires an explicit cast. More...

Dot products
double	dot (const Vector &b) const &
	Compute the dot product of this vector with another vector. More...

double	dot (const Vector &b) &&
	Compute the dot product of this vector with another vector. More...

double	dot (Vector &&b) const &
	Compute the dot product of this vector with another vector. More...

double	dot (Vector &&b) &&
	Compute the dot product of this vector with another vector. More...

static double	dot_unchecked (const Matrix &a, const Matrix &b)
	Compute the dot product of two vectors. More...

static double	dot_unchecked (Matrix &&a, const Matrix &b)
	Compute the dot product of two vectors. More...

static double	dot_unchecked (const Matrix &a, Matrix &&b)
	Compute the dot product of two vectors. More...

static double	dot_unchecked (Matrix &&a, Matrix &&b)
	Compute the dot product of two vectors. More...

static double	dot (const Vector &a, const Vector &b)
	Compute the dot product of two vectors. More...

static double	dot (Vector &&a, const Vector &b)
	Compute the dot product of two vectors. More...

static double	dot (const Vector &a, Vector &&b)
	Compute the dot product of two vectors. More...

static double	dot (Vector &&a, Vector &&b)
	Compute the dot product of two vectors. More...

Cross products
Vector	cross (const Vector &b) const &
	Compute the cross product of this 3-vector with another 3-vector. More...

Vector &&	cross (const Vector &b) &&
	Compute the cross product of this 3-vector with another 3-vector,. More...

Vector &&	cross (Vector &&b) const &
	Compute the cross product of this 3-vector with another 3-vector,. More...

Vector &&	cross (Vector &&b) &&
	Compute the cross product of this 3-vector with another 3-vector,. More...

static void	cross_inplace_unchecked (Matrix &a, const Matrix &b)
	Compute the cross product of two 3-vectors, overwriting the first vector with the result. More...

static void	cross_inplace_unchecked_neg (Matrix &a, const Matrix &b)
	Compute the opposite of the cross product of two 3-vectors, overwriting the first vector with the result. More...

static void	cross_inplace (Vector &a, const Vector &b)
	Compute the cross product of two 3-vectors, overwriting the first vector with the result. More...

static void	cross_inplace (Vector &a, Vector &&b)
	Compute the cross product of two 3-vectors, overwriting the first vector with the result. More...

static void	cross_inplace_neg (Vector &a, const Vector &b)
	Compute the opposite of the cross product of two 3-vectors, overwriting the first vector with the result. More...

static void	cross_inplace_neg (Vector &a, Vector &&b)
	Compute the opposite of the cross product of two 3-vectors, overwriting the first vector with the result. More...

static Vector	cross (const Vector &a, const Vector &b)
	Compute the cross product of two 3-vectors. More...

static Vector &&	cross (Vector &&a, const Vector &b)
	Compute the cross product of two 3-vectors. More...

static Vector &&	cross (const Vector &a, Vector &&b)
	Compute the cross product of two 3-vectors. More...

static Vector &&	cross (Vector &&a, Vector &&b)
	Compute the cross product of two 3-vectors. More...

Vector norms
double	norm2 () const &
	Compute the 2-norm of the vector. More...

double	norm2 () &&
	Compute the 2-norm of the vector. 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...

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...

Creating special vectors
static Vector	ones (size_t size)
	Create a vector filled with ones. More...

static Vector	zeros (size_t size)
	Create a vector filled with zeros. More...

static Vector	constant (size_t size, double value)
	Create a vector filled with a constant value. More...

static Vector	random (size_t size, double min=0, double max=1, std::default_random_engine::result_type seed=std::default_random_engine::default_seed)
	Create a vector with uniformly distributed random values. 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 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>

privateinherited

Container to store the elements of the matrix internally.

Definition at line 40 of file Matrix.hpp.

Constructor & Destructor Documentation

◆ Vector() [1/5]

Vector ( )

default

Default constructor.

◆ Vector() [2/5]

Vector ( size_t size )

inline

Create a column vector of the given size.

Definition at line 287 of file Matrix.hpp.

◆ Vector() [3/5]

Vector ( std::initializer_list< double > init )

inline

Create a column vector from the given list of values.

Definition at line 290 of file Matrix.hpp.

◆ Vector() [4/5]

Vector ( const Matrix & matrix )

explicit

Convert an m×n matrix to a mn column vector.

Definition at line 269 of file Matrix.cpp.

◆ Vector() [5/5]

Vector ( Matrix && matrix )

explicit

Convert an m×n matrix to a mn column vector.

Definition at line 272 of file Matrix.cpp.

Member Function Documentation

◆ operator=()

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

Assign a list of values to the column vector.

Definition at line 275 of file Matrix.cpp.

◆ resize()

void resize ( size_t size )

inline

Resize the vector.

Definition at line 307 of file Matrix.hpp.

◆ size()

size_t size ( ) const

inline

Get the number of elements in the vector.

Definition at line 310 of file Matrix.hpp.

◆ reshape()

void reshape	(	size_t	,
		size_t
	)

delete

Reshaping a vector to a matrix requires an explicit cast.

◆ reshaped() [1/2]

Matrix reshaped	(	size_t	,
		size_t
	)

delete

Reshaping a vector to a matrix requires an explicit cast.

◆ ones() [1/2]

Vector ones ( size_t size )

static

Create a vector filled with ones.

Examples: Basic-matrix-operations-no-iostream.ino, and Basic-matrix-operations.ino.

Definition at line 287 of file Matrix.cpp.

◆ zeros() [1/2]

Vector zeros ( size_t size )

static

Create a vector filled with zeros.

Definition at line 289 of file Matrix.cpp.

◆ constant() [1/2]

Vector constant	(	size_t	size,
		double	value
	)

static

Create a vector filled with a constant value.

Definition at line 291 of file Matrix.cpp.

◆ random() [1/2]

Vector random	(	size_t	size,
		double	min = `0`,
		double	max = `1`,
		std::default_random_engine::result_type	seed = `std::default_random_engine::default_seed`
	)

static

Create a vector with uniformly distributed random values.

Definition at line 296 of file Matrix.cpp.