General matrix and vectors class, meant for classic math manipulation such as additions, multiplications, and linear systems of equations solving. More...

#include "juce_Matrix.h"

Public Member Functions
	Matrix (size_t numRows, size_t numColumns)
	Creates a new matrix with a given number of rows and columns.

	Matrix (size_t numRows, size_t numColumns, const ElementType *dataPointer)
	Creates a new matrix with a given number of rows and columns, with initial data coming from an array, stored in row-major order.

	Matrix (const Matrix &)=default
	Creates a copy of another matrix.

	Matrix (Matrix &&) noexcept=default
	Moves a copy of another matrix.

Matrix &	operator= (const Matrix &)=default
	Creates a copy of another matrix.

Matrix &	operator= (Matrix &&) noexcept=default
	Moves another matrix into this one.

size_t	getNumRows () const noexcept
	Returns the number of rows in the matrix.

size_t	getNumColumns () const noexcept
	Returns the number of columns in the matrix.

Array< size_t >	getSize () const noexcept
	Returns an Array of 2 integers with the number of rows and columns in the matrix.

void	clear () noexcept
	Fills the contents of the matrix with zeroes.

Matrix &	swapRows (size_t rowOne, size_t rowTwo) noexcept
	Swaps the contents of two rows in the matrix and returns a reference to itself.

Matrix &	swapColumns (size_t columnOne, size_t columnTwo) noexcept
	Swaps the contents of two columns in the matrix and returns a reference to itself.

ElementType	operator() (size_t row, size_t column) const noexcept
	Returns the value of the matrix at a given row and column (for reading).

ElementType &	operator() (size_t row, size_t column) noexcept
	Returns the value of the matrix at a given row and column (for modifying).

ElementType *	getRawDataPointer () noexcept
	Returns a pointer to the raw data of the matrix object, ordered in row-major order (for modifying).

const ElementType *	getRawDataPointer () const noexcept
	Returns a pointer to the raw data of the matrix object, ordered in row-major order (for reading).

Matrix &	operator+= (const Matrix &other) noexcept
	Addition of two matrices.

Matrix &	operator-= (const Matrix &other) noexcept
	Subtraction of two matrices.

Matrix &	operator*= (ElementType scalar) noexcept
	Scalar multiplication.

Matrix	operator+ (const Matrix &other) const
	Addition of two matrices.

Matrix	operator- (const Matrix &other) const
	Addition of two matrices.

Matrix	operator* (ElementType scalar) const
	Scalar multiplication.

Matrix	operator* (const Matrix &other) const
	Matrix multiplication.

Matrix &	hadarmard (const Matrix &other) noexcept
	Does a hadarmard product with the receiver and other and stores the result in the receiver.

bool	operator== (const Matrix &other) const noexcept

bool	isSquare () const noexcept
	Tells if the matrix is a square matrix.

bool	isVector () const noexcept
	Tells if the matrix is a vector.

bool	isOneColumnVector () const noexcept
	Tells if the matrix is a one column vector.

bool	isOneRowVector () const noexcept
	Tells if the matrix is a one row vector.

bool	isNullMatrix () const noexcept
	Tells if the matrix is a null matrix.

bool	solve (Matrix &b) const noexcept
	Solves a linear system of equations represented by this object and the argument b, using various algorithms depending on the size of the arguments.

String	toString () const
	Returns a String displaying in a convenient way the matrix contents.

ElementType *	begin () noexcept

ElementType *	end () noexcept

const ElementType *	begin () const noexcept

const ElementType *	end () const noexcept

Static Public Member Functions
static Matrix	identity (size_t size)
	Creates the identity matrix.

static Matrix	toeplitz (const Matrix &vector, size_t size)
	Creates a Toeplitz Matrix from a vector with a given squared size.

static Matrix	hankel (const Matrix &vector, size_t size, size_t offset=0)
	Creates a squared size x size Hankel Matrix from a vector with an optional offset.

static Matrix	hadarmard (const Matrix &a, const Matrix &b)
	Does a hadarmard product with a and b returns the result.

static bool	compare (const Matrix &a, const Matrix &b, ElementType tolerance=0) noexcept
	Compare to matrices with a given tolerance.

Detailed Description

template<typename ElementType>
class juce::dsp::Matrix< ElementType >

General matrix and vectors class, meant for classic math manipulation such as additions, multiplications, and linear systems of equations solving.

See also: LinearAlgebra

@tags{DSP}

Definition at line 38 of file juce_Matrix.h.

Constructor & Destructor Documentation

◆ Matrix() [1/2]

template<typename ElementType >

juce::dsp::Matrix< ElementType >::Matrix	(	size_t	numRows,
		size_t	numColumns
	)

Creates a new matrix with a given number of rows and columns.

Definition at line 43 of file juce_Matrix.h.

◆ Matrix() [2/2]

template<typename ElementType >

juce::dsp::Matrix< ElementType >::Matrix	(	size_t	numRows,
		size_t	numColumns,
		const ElementType *	dataPointer
	)

Creates a new matrix with a given number of rows and columns, with initial data coming from an array, stored in row-major order.

Definition at line 53 of file juce_Matrix.h.

Member Function Documentation

◆ begin() [1/2]

template<typename ElementType >

const ElementType * juce::dsp::Matrix< ElementType >::begin ( ) const

noexcept

Definition at line 210 of file juce_Matrix.h.

◆ begin() [2/2]

template<typename ElementType >

ElementType * juce::dsp::Matrix< ElementType >::begin ( )

noexcept

Definition at line 207 of file juce_Matrix.h.

◆ clear()

template<typename ElementType >

void juce::dsp::Matrix< ElementType >::clear ( )

noexcept

Fills the contents of the matrix with zeroes.

Definition at line 101 of file juce_Matrix.h.

◆ compare()

template<typename ElementType >

bool juce::dsp::Matrix< ElementType >::compare	(	const Matrix< ElementType > &	a,
		const Matrix< ElementType > &	b,
		ElementType	tolerance = `0`
	)

staticnoexcept

Compare to matrices with a given tolerance.

Definition at line 146 of file juce_Matrix.cpp.

◆ end() [1/2]

template<typename ElementType >

const ElementType * juce::dsp::Matrix< ElementType >::end ( ) const

noexcept

Definition at line 211 of file juce_Matrix.h.

◆ end() [2/2]

template<typename ElementType >

ElementType * juce::dsp::Matrix< ElementType >::end ( )

noexcept

Definition at line 208 of file juce_Matrix.h.

◆ getNumColumns()

template<typename ElementType >

size_t juce::dsp::Matrix< ElementType >::getNumColumns ( ) const

noexcept

Returns the number of columns in the matrix.

Definition at line 93 of file juce_Matrix.h.

◆ getNumRows()

template<typename ElementType >

size_t juce::dsp::Matrix< ElementType >::getNumRows ( ) const

noexcept

Returns the number of rows in the matrix.

Definition at line 90 of file juce_Matrix.h.

◆ getRawDataPointer() [1/2]

template<typename ElementType >

const ElementType * juce::dsp::Matrix< ElementType >::getRawDataPointer ( ) const

noexcept

Returns a pointer to the raw data of the matrix object, ordered in row-major order (for reading).

Definition at line 133 of file juce_Matrix.h.

◆ getRawDataPointer() [2/2]

template<typename ElementType >

ElementType * juce::dsp::Matrix< ElementType >::getRawDataPointer ( )

noexcept

Returns a pointer to the raw data of the matrix object, ordered in row-major order (for modifying).

Definition at line 128 of file juce_Matrix.h.

◆ getSize()

template<typename ElementType >

Array< size_t > juce::dsp::Matrix< ElementType >::getSize ( ) const

noexcept

Returns an Array of 2 integers with the number of rows and columns in the matrix.

Definition at line 98 of file juce_Matrix.h.

◆ hadarmard() [1/2]

template<typename ElementType >

static Matrix juce::dsp::Matrix< ElementType >::hadarmard	(	const Matrix< ElementType > &	a,
		const Matrix< ElementType > &	b
	)

static

Does a hadarmard product with a and b returns the result.

Definition at line 165 of file juce_Matrix.h.

◆ hadarmard() [2/2]

template<typename ElementType >

Matrix & juce::dsp::Matrix< ElementType >::hadarmard ( const Matrix< ElementType > & other )

noexcept

Does a hadarmard product with the receiver and other and stores the result in the receiver.

Definition at line 162 of file juce_Matrix.h.

◆ hankel()

template<typename ElementType >

Matrix< ElementType > juce::dsp::Matrix< ElementType >::hankel	(	const Matrix< ElementType > &	vector,
		size_t	size,
		size_t	offset = `0`
	)

static

Creates a squared size x size Hankel Matrix from a vector with an optional offset.

Parameters

vector	The vector from which the Hankel matrix should be generated. Its number of rows should be at least 2 * (size - 1) + 1
size	The size of resulting square matrix.
offset	An optional offset into the given vector.

Definition at line 59 of file juce_Matrix.cpp.

◆ identity()

template<typename ElementType >

Matrix< ElementType > juce::dsp::Matrix< ElementType >::identity ( size_t size )

static

Creates the identity matrix.

Definition at line 30 of file juce_Matrix.cpp.

◆ isNullMatrix()

template<typename ElementType >

bool juce::dsp::Matrix< ElementType >::isNullMatrix ( ) const

noexcept

Tells if the matrix is a null matrix.

Definition at line 188 of file juce_Matrix.h.

◆ isOneColumnVector()

template<typename ElementType >

bool juce::dsp::Matrix< ElementType >::isOneColumnVector ( ) const

noexcept

Tells if the matrix is a one column vector.

Definition at line 182 of file juce_Matrix.h.

◆ isOneRowVector()

template<typename ElementType >

bool juce::dsp::Matrix< ElementType >::isOneRowVector ( ) const

noexcept

Tells if the matrix is a one row vector.

Definition at line 185 of file juce_Matrix.h.

◆ isSquare()

template<typename ElementType >

bool juce::dsp::Matrix< ElementType >::isSquare ( ) const

noexcept

Tells if the matrix is a square matrix.

Definition at line 176 of file juce_Matrix.h.

◆ isVector()

template<typename ElementType >

bool juce::dsp::Matrix< ElementType >::isVector ( ) const

noexcept

Tells if the matrix is a vector.

Definition at line 179 of file juce_Matrix.h.

◆ operator()() [1/2]

template<typename ElementType >

ElementType juce::dsp::Matrix< ElementType >::operator()	(	size_t	row,
		size_t	column
	)		const

noexcept

Returns the value of the matrix at a given row and column (for reading).

Definition at line 112 of file juce_Matrix.h.

◆ operator()() [2/2]

template<typename ElementType >

ElementType & juce::dsp::Matrix< ElementType >::operator()	(	size_t	row,
		size_t	column
	)

noexcept

Returns the value of the matrix at a given row and column (for modifying).

Definition at line 119 of file juce_Matrix.h.

◆ operator*() [1/2]

template<typename ElementType >

Matrix< ElementType > juce::dsp::Matrix< ElementType >::operator* ( const Matrix< ElementType > & other ) const

Matrix multiplication.

Definition at line 111 of file juce_Matrix.cpp.

◆ operator*() [2/2]

template<typename ElementType >

Matrix juce::dsp::Matrix< ElementType >::operator* ( ElementType scalar ) const

Scalar multiplication.

Definition at line 156 of file juce_Matrix.h.

◆ operator*=()

template<typename ElementType >

Matrix & juce::dsp::Matrix< ElementType >::operator*= ( ElementType scalar )

noexcept

Scalar multiplication.

Definition at line 143 of file juce_Matrix.h.

◆ operator+()

template<typename ElementType >

Matrix juce::dsp::Matrix< ElementType >::operator+ ( const Matrix< ElementType > & other ) const

Addition of two matrices.

Definition at line 150 of file juce_Matrix.h.

◆ operator+=()

template<typename ElementType >

Matrix & juce::dsp::Matrix< ElementType >::operator+= ( const Matrix< ElementType > & other )

noexcept

Addition of two matrices.

Definition at line 137 of file juce_Matrix.h.

◆ operator-()

template<typename ElementType >

Matrix juce::dsp::Matrix< ElementType >::operator- ( const Matrix< ElementType > & other ) const

Addition of two matrices.

Definition at line 153 of file juce_Matrix.h.

◆ operator-=()

template<typename ElementType >

Matrix & juce::dsp::Matrix< ElementType >::operator-= ( const Matrix< ElementType > & other )

noexcept

Subtraction of two matrices.

Definition at line 140 of file juce_Matrix.h.

◆ operator==()

template<typename ElementType >

bool juce::dsp::Matrix< ElementType >::operator== ( const Matrix< ElementType > & other ) const

noexcept

Definition at line 172 of file juce_Matrix.h.

◆ solve()

template<typename ElementType >

bool juce::dsp::Matrix< ElementType >::solve ( Matrix< ElementType > & b ) const

noexcept

Solves a linear system of equations represented by this object and the argument b, using various algorithms depending on the size of the arguments.

The matrix must be a square matrix N times N, and b must be a vector N times 1, with the coefficients of b. After the execution of the algorithm, the vector b will contain the solution.

Returns true if the linear system of equations was successfully solved.

Definition at line 163 of file juce_Matrix.cpp.

◆ swapColumns()

template<typename ElementType >

Matrix< ElementType > & juce::dsp::Matrix< ElementType >::swapColumns	(	size_t	columnOne,
		size_t	columnTwo
	)

noexcept

Swaps the contents of two columns in the matrix and returns a reference to itself.

Definition at line 78 of file juce_Matrix.cpp.

◆ swapRows()

template<typename ElementType >

Matrix< ElementType > & juce::dsp::Matrix< ElementType >::swapRows	(	size_t	rowOne,
		size_t	rowTwo
	)

noexcept

Swaps the contents of two rows in the matrix and returns a reference to itself.

Definition at line 94 of file juce_Matrix.cpp.

◆ toeplitz()

template<typename ElementType >

Matrix< ElementType > juce::dsp::Matrix< ElementType >::toeplitz	(	const Matrix< ElementType > &	vector,
		size_t	size
	)

static

Creates a Toeplitz Matrix from a vector with a given squared size.

Definition at line 41 of file juce_Matrix.cpp.

◆ toString()

template<typename ElementType >

String juce::dsp::Matrix< ElementType >::toString ( ) const

Returns a String displaying in a convenient way the matrix contents.

Definition at line 276 of file juce_Matrix.cpp.

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

juce_dsp/maths/juce_Matrix.h
juce_dsp/maths/juce_Matrix.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Matrix() [1/2]

◆ Matrix() [2/2]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ compare()

◆ end() [1/2]

◆ end() [2/2]

◆ getNumColumns()

◆ getNumRows()

◆ getRawDataPointer() [1/2]

◆ getRawDataPointer() [2/2]

◆ getSize()

◆ hadarmard() [1/2]

◆ hadarmard() [2/2]

◆ hankel()

◆ identity()

◆ isNullMatrix()

◆ isOneColumnVector()

◆ isOneRowVector()

◆ isSquare()

◆ isVector()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator==()

◆ solve()

◆ swapColumns()

◆ swapRows()

◆ toeplitz()

◆ toString()