juce::dsp::Matrix< ElementType > Class Template Reference

#include <juce_Matrix.h>

Public Member Functions
	Matrix (size_t numRows, size_t numColumns)
	Matrix (size_t numRows, size_t numColumns, const ElementType *dataPointer)
	Matrix (const Matrix &)=default
	Matrix (Matrix &&) noexcept=default
Matrix &	operator= (const Matrix &)=default
Matrix &	operator= (Matrix &&) noexcept=default
size_t	getNumRows () const noexcept
size_t	getNumColumns () const noexcept
Array< size_t >	getSize () const noexcept
void	clear () noexcept
Matrix &	swapRows (size_t rowOne, size_t rowTwo) noexcept
Matrix &	swapColumns (size_t columnOne, size_t columnTwo) noexcept
ElementType	operator() (size_t row, size_t column) const noexcept
ElementType &	operator() (size_t row, size_t column) noexcept
ElementType *	getRawDataPointer () noexcept
const ElementType *	getRawDataPointer () const noexcept
Matrix &	operator+= (const Matrix &other) noexcept
Matrix &	operator-= (const Matrix &other) noexcept
Matrix &	operator*= (ElementType scalar) noexcept
Matrix	operator+ (const Matrix &other) const
Matrix	operator- (const Matrix &other) const
Matrix	operator* (ElementType scalar) const
Matrix	operator* (const Matrix &other) const
Matrix &	hadarmard (const Matrix &other) noexcept
bool	operator== (const Matrix &other) const noexcept
bool	isSquare () const noexcept
bool	isVector () const noexcept
bool	isOneColumnVector () const noexcept
bool	isOneRowVector () const noexcept
bool	isNullMatrix () const noexcept
bool	solve (Matrix &b) const noexcept
String	toString () const
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)
static Matrix	toeplitz (const Matrix &vector, size_t size)
static Matrix	hankel (const Matrix &vector, size_t size, size_t offset=0)
static Matrix	hadarmard (const Matrix &a, const Matrix &b)
static bool	compare (const Matrix &a, const Matrix &b, ElementType tolerance=0) noexcept

Private Member Functions
void	resize ()
template<typename BinaryOperation>
Matrix &	apply (const Matrix &other, BinaryOperation binaryOp)

Private Attributes
Array< ElementType >	data
Array< size_t >	dataAcceleration
size_t	rows
size_t	columns

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}

Constructor & Destructor Documentation

Matrix() [1/4]

template<typename ElementType>

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

inline

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

Matrix() [2/4]

template<typename ElementType>

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

inline

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() [3/4]

template<typename ElementType>

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

default

Creates a copy of another matrix.

Matrix() [4/4]

template<typename ElementType>

juce::dsp::Matrix< ElementType >::Matrix ( Matrix< ElementType > && )

defaultnoexcept

Moves a copy of another matrix.

Member Function Documentation

apply()

template<typename ElementType>

template<typename BinaryOperation>

Matrix & juce::dsp::Matrix< ElementType >::apply ( const Matrix< ElementType > & other, BinaryOperation binaryOp )

inlineprivate

begin() [1/2]

template<typename ElementType>

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

inlinenoexcept

begin() [2/2]

template<typename ElementType>

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

inlinenoexcept

clear()

template<typename ElementType>

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

inlinenoexcept

Fills the contents of the matrix with zeroes.

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

end() [1/2]

template<typename ElementType>

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

inlinenoexcept

end() [2/2]

template<typename ElementType>

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

inlinenoexcept

getNumColumns()

template<typename ElementType>

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

inlinenoexcept

Returns the number of columns in the matrix.

getNumRows()

template<typename ElementType>

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

inlinenoexcept

Returns the number of rows in the matrix.

getRawDataPointer() [1/2]

template<typename ElementType>

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

inlinenoexcept

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

getRawDataPointer() [2/2]

template<typename ElementType>

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

inlinenoexcept

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

getSize()

template<typename ElementType>

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

inlinenoexcept

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

hadarmard() [1/2]

template<typename ElementType>

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

inlinestatic

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

hadarmard() [2/2]

template<typename ElementType>

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

inlinenoexcept

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

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.

identity()

template<typename ElementType>

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

static

Creates the identity matrix

isNullMatrix()

template<typename ElementType>

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

inlinenoexcept

Tells if the matrix is a null matrix

isOneColumnVector()

template<typename ElementType>

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

inlinenoexcept

Tells if the matrix is a one column vector

isOneRowVector()

template<typename ElementType>

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

inlinenoexcept

Tells if the matrix is a one row vector

isSquare()

template<typename ElementType>

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

inlinenoexcept

Tells if the matrix is a square matrix

isVector()

template<typename ElementType>

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

inlinenoexcept

Tells if the matrix is a vector

operator()() [1/2]

template<typename ElementType>

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

inlinenoexcept

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

operator()() [2/2]

template<typename ElementType>

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

inlinenoexcept

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

operator*() [1/2]

template<typename ElementType>

Matrix< ElementType > juce::dsp::Matrix< ElementType >::operator*

(

const Matrix< ElementType > &

other

)

const

Matrix multiplication

operator*() [2/2]

template<typename ElementType>

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

inline

Scalar multiplication

operator*=()

template<typename ElementType>

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

inlinenoexcept

Scalar multiplication

operator+()

template<typename ElementType>

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

inline

Addition of two matrices

operator+=()

template<typename ElementType>

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

inlinenoexcept

Addition of two matrices

operator-()

template<typename ElementType>

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

inline

Addition of two matrices

operator-=()

template<typename ElementType>

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

inlinenoexcept

Subtraction of two matrices

operator=() [1/2]

template<typename ElementType>

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

default

Creates a copy of another matrix.

operator=() [2/2]

template<typename ElementType>

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

defaultnoexcept

Moves another matrix into this one

operator==()

template<typename ElementType>

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

inlinenoexcept

resize()

template<typename ElementType>

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

inlineprivate

Resizes the matrix.

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.

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.

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.

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

toString()

template<typename ElementType>

String juce::dsp::Matrix< ElementType >::toString

(

)

const

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

Member Data Documentation

columns

template<typename ElementType>

size_t juce::dsp::Matrix< ElementType >::columns

private

data

template<typename ElementType>

Array<ElementType> juce::dsp::Matrix< ElementType >::data

private

dataAcceleration

template<typename ElementType>

Array<size_t> juce::dsp::Matrix< ElementType >::dataAcceleration

private

rows

template<typename ElementType>

size_t juce::dsp::Matrix< ElementType >::rows

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_dsp/maths/juce_Matrix.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_dsp/maths/juce_Matrix.cpp