General matrix and vectors class, meant for classic math manipulation such as additions, multiplications, and linear systems of equations solving. More...
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. More... | |
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. More... | |
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. More... | |
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). More... | |
const ElementType * | getRawDataPointer () const noexcept |
Returns a pointer to the raw data of the matrix object, ordered in row-major order (for reading). More... | |
Matrix & | operator+= (const Matrix &other) noexcept |
Addition of two matrices. More... | |
Matrix & | operator-= (const Matrix &other) noexcept |
Subtraction of two matrices. More... | |
Matrix & | operator*= (ElementType scalar) noexcept |
Scalar multiplication. More... | |
Matrix | operator+ (const Matrix &other) const |
Addition of two matrices. More... | |
Matrix | operator- (const Matrix &other) const |
Addition of two matrices. More... | |
Matrix | operator* (ElementType scalar) const |
Scalar multiplication. More... | |
Matrix | operator* (const Matrix &other) const |
Matrix multiplication. More... | |
Matrix & | hadarmard (const Matrix &other) noexcept |
Does a hadarmard product with the receiver and other and stores the result in the receiver. More... | |
bool | operator== (const Matrix &other) const noexcept |
bool | isSquare () const noexcept |
Tells if the matrix is a square matrix. More... | |
bool | isVector () const noexcept |
Tells if the matrix is a vector. More... | |
bool | isOneColumnVector () const noexcept |
Tells if the matrix is a one column vector. More... | |
bool | isOneRowVector () const noexcept |
Tells if the matrix is a one row vector. More... | |
bool | isNullMatrix () const noexcept |
Tells if the matrix is a null matrix. More... | |
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. More... | |
static Matrix | toeplitz (const Matrix &vector, size_t size) |
Creates a Toeplitz Matrix from a vector with a given squared size. More... | |
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. More... | |
General matrix and vectors class, meant for classic math manipulation such as additions, multiplications, and linear systems of equations solving.
dsp::Matrix< ElementType >::Matrix | ( | size_t | numRows, |
size_t | numColumns | ||
) |
Creates a new matrix with a given number of rows and columns.
References dsp::Matrix< ElementType >::clear().
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.
References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getRawDataPointer().
|
default |
Creates a copy of another matrix.
|
defaultnoexcept |
Moves a copy of another matrix.
|
default |
Creates a copy of another matrix.
|
defaultnoexcept |
Moves another matrix into this one.
|
static |
Creates the identity matrix.
|
static |
Creates a Toeplitz Matrix from a vector with a given squared size.
|
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. |
|
noexcept |
Returns the number of rows in the matrix.
|
noexcept |
Returns the number of columns in the matrix.
|
noexcept |
Returns an Array of 2 integers with the number of rows and columns in the matrix.
|
noexcept |
Fills the contents of the matrix with zeroes.
References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::begin(), Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::size(), and zeromem().
Referenced by dsp::Matrix< ElementType >::Matrix().
|
noexcept |
Swaps the contents of two rows in the matrix and returns a reference to itself.
|
noexcept |
Swaps the contents of two columns in the matrix and returns a reference to itself.
|
noexcept |
Returns the value of the matrix at a given row and column (for reading).
References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference(), and jassert.
|
noexcept |
Returns the value of the matrix at a given row and column (for modifying).
References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getReference(), and jassert.
|
noexcept |
Returns a pointer to the raw data of the matrix object, ordered in row-major order (for modifying).
References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::getRawDataPointer().
|
noexcept |
Returns a pointer to the raw data of the matrix object, ordered in row-major order (for reading).
References Array< ElementType, TypeOfCriticalSectionToUse, minimumAllocatedSize >::begin().
|
noexcept |
|
noexcept |
|
noexcept |
Scalar multiplication.
References dsp::Matrix< ElementType >::begin(), dsp::Matrix< ElementType >::end(), and gl::x.
Matrix dsp::Matrix< ElementType >::operator+ | ( | const Matrix< ElementType > & | other | ) | const |
Addition of two matrices.
References gl::result.
Matrix dsp::Matrix< ElementType >::operator- | ( | const Matrix< ElementType > & | other | ) | const |
Addition of two matrices.
References gl::result.
Matrix dsp::Matrix< ElementType >::operator* | ( | ElementType | scalar | ) | const |
Scalar multiplication.
References gl::result.
Matrix dsp::Matrix< ElementType >::operator* | ( | const Matrix< ElementType > & | other | ) | const |
Matrix multiplication.
|
noexcept |
|
static |
Does a hadarmard product with a and b returns the result.
References gl::a, gl::b, and gl::result.
|
staticnoexcept |
Compare to matrices with a given tolerance.
Referenced by dsp::Matrix< ElementType >::operator==().
|
noexcept |
References dsp::Matrix< ElementType >::compare().
|
noexcept |
Tells if the matrix is a square matrix.
|
noexcept |
Tells if the matrix is a vector.
References dsp::Matrix< ElementType >::isOneColumnVector(), and dsp::Matrix< ElementType >::isOneRowVector().
|
noexcept |
Tells if the matrix is a one column vector.
Referenced by dsp::Matrix< ElementType >::isVector().
|
noexcept |
Tells if the matrix is a one row vector.
Referenced by dsp::Matrix< ElementType >::isVector().
|
noexcept |
Tells if the matrix is a null matrix.
|
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.
String dsp::Matrix< ElementType >::toString | ( | ) | const |
Returns a String displaying in a convenient way the matrix contents.
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |