OpenShot Library | OpenShotAudio
0.2.2
|
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. More... | |
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. More... | |
Matrix (Matrix &&) noexcept=default | |
Moves a copy of another matrix. More... | |
Matrix & | operator= (const Matrix &)=default |
Creates a copy of another matrix. More... | |
Matrix & | operator= (Matrix &&) noexcept=default |
Moves another matrix into this one. | |
size_t | getNumRows () const noexcept |
Returns the number of rows in the matrix. More... | |
size_t | getNumColumns () const noexcept |
Returns the number of columns in the matrix. More... | |
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. More... | |
Matrix & | swapRows (size_t rowOne, size_t rowTwo) noexcept |
Swaps the contents of two rows in the matrix and returns a reference to itself. More... | |
Matrix & | swapColumns (size_t columnOne, size_t columnTwo) noexcept |
Swaps the contents of two columns in the matrix and returns a reference to itself. More... | |
ElementType | operator() (size_t row, size_t column) const noexcept |
Returns the value of the matrix at a given row and column (for reading). More... | |
ElementType & | operator() (size_t row, size_t column) noexcept |
Returns the value of the matrix at a given row and column (for modifying). More... | |
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. More... | |
String | toString () const |
Returns a String displaying in a convenient way the matrix contents. More... | |
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. More... | |
static Matrix | hadarmard (const Matrix &a, const Matrix &b) |
Does a hadarmard product with a and b returns the result. More... | |
static bool | compare (const Matrix &a, const Matrix &b, ElementType tolerance=0) noexcept |
Compare to matrices with a given tolerance. | |
General matrix and vectors class, meant for classic math manipulation such as additions, multiplications, and linear systems of equations solving.
Definition at line 45 of file juce_Matrix.h.
|
inline |
Creates a new matrix with a given number of rows and columns.
Definition at line 50 of file juce_Matrix.h.
References juce::dsp::Matrix< ElementType >::clear().
Referenced by juce::dsp::Matrix< ElementType >::Matrix().
|
default |
Creates a copy of another matrix.
|
defaultnoexcept |
Moves a copy of another matrix.
|
default |
Creates a copy of another matrix.
Referenced by juce::dsp::Matrix< ElementType >::Matrix().
|
static |
Creates a squared size x size Hankel Matrix from a vector with an optional offset.
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 62 of file juce_Matrix.cpp.
References juce::dsp::Matrix< ElementType >::isOneColumnVector().
Referenced by juce::dsp::FilterDesign< FloatType >::designFIRLowpassLeastSquaresMethod(), and juce::dsp::Matrix< ElementType >::Matrix().
|
inlinenoexcept |
Returns the number of rows in the matrix.
Definition at line 97 of file juce_Matrix.h.
Referenced by juce::dsp::Matrix< ElementType >::operator*().
|
inlinenoexcept |
Returns the number of columns in the matrix.
Definition at line 100 of file juce_Matrix.h.
Referenced by juce::dsp::Matrix< ElementType >::operator*().
|
inlinenoexcept |
Fills the contents of the matrix with zeroes.
Definition at line 108 of file juce_Matrix.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::begin(), juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size(), juce::dsp::Matrix< ElementType >::swapColumns(), and juce::dsp::Matrix< ElementType >::swapRows().
Referenced by juce::dsp::Matrix< ElementType >::Matrix().
|
noexcept |
Swaps the contents of two rows in the matrix and returns a reference to itself.
Definition at line 97 of file juce_Matrix.cpp.
Referenced by juce::dsp::Matrix< ElementType >::clear().
|
noexcept |
Swaps the contents of two columns in the matrix and returns a reference to itself.
Definition at line 81 of file juce_Matrix.cpp.
Referenced by juce::dsp::Matrix< ElementType >::clear().
|
inlinenoexcept |
Returns the value of the matrix at a given row and column (for reading).
Definition at line 119 of file juce_Matrix.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference().
|
inlinenoexcept |
Returns the value of the matrix at a given row and column (for modifying).
Definition at line 126 of file juce_Matrix.h.
References juce::Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference().
|
inlinestatic |
Does a hadarmard product with a and b returns the result.
Definition at line 172 of file juce_Matrix.h.
References juce::dsp::Matrix< ElementType >::compare(), and juce::dsp::Matrix< ElementType >::hadarmard().
|
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 166 of file juce_Matrix.cpp.
Referenced by juce::dsp::Matrix< ElementType >::isNullMatrix().
String juce::dsp::Matrix< ElementType >::toString | ( | ) | const |
Returns a String displaying in a convenient way the matrix contents.
Definition at line 279 of file juce_Matrix.cpp.
References juce::StringArray::add(), juce::StringArray::begin(), juce::String::length(), juce::StringArray::size(), and juce::MemoryOutputStream::toString().
Referenced by juce::dsp::Matrix< ElementType >::isNullMatrix().