The sparse filter instant structure contains an array of tap indices pTapDelay which specifies the locations of the non-zero coefficients. This is in addition to the coefficient array b. The implementation essentially skips the multiplications by zero and leads to an efficient realization.
diff --git a/main/group__MatrixAdd.html b/main/group__MatrixAdd.html
index 9a6fa079..70ae1e3f 100644
--- a/main/group__MatrixAdd.html
+++ b/main/group__MatrixAdd.html
@@ -142,10 +142,10 @@ Functions
| |
-Adds two matrices.
-
-
-Addition of two 3 x 3 matrices
Adds two matrices.
- Addition of two 3 x 3 matrices
+
+\[ \begin{pmatrix} a_{1,1} & a_{1,2} & a_{1,3} \\ a_{2,1} & a_{2,2} & a_{2,3} \\ a_{3,1} & a_{3,2} & a_{3,3} \\ \end{pmatrix} + \begin{pmatrix} b_{1,1} & b_{1,2} & b_{1,3} \\ b_{2,1} & b_{2,2} & b_{2,3} \\ b_{3,1} & b_{3,2} & b_{3,3} \\ \end{pmatrix} = \begin{pmatrix} a_{1,1}+b_{1,1} & a_{1,2}+b_{1,2} & a_{1,3}+b_{1,3} \\ a_{2,1}+b_{2,1} & a_{2,2}+b_{2,2} & a_{2,3}+b_{2,3} \\ a_{3,1}+b_{3,1} & a_{3,2}+b_{3,2} & a_{3,3}+b_{3,3} \\ \end{pmatrix} \]
+
The functions check to make sure that pSrcA, pSrcB, and pDst have the same number of rows and columns.
diff --git a/main/group__MatrixComplexTrans.html b/main/group__MatrixComplexTrans.html
index b0a9bfad..6a8c4f05 100644
--- a/main/group__MatrixComplexTrans.html
+++ b/main/group__MatrixComplexTrans.html
@@ -143,10 +143,11 @@ Functions
Tranposes a complex matrix.
-Transposing an M x N matrix flips it around the center diagonal and results in an N x M matrix.
-
-
-Transpose of a 3 x 3 matrix
Transposing an M x N matrix flips it around the center diagonal and results in an N x M matrix.
+- Transpose of a 3 x 3 matrix
+
+\[ \begin{pmatrix} a_{1,1} & a_{1,2} & a_{1,3} \\ a_{2,1} & a_{2,2} & a_{2,3} \\ a_{3,1} & a_{3,2} & a_{3,3} \\ \end{pmatrix}^T = \begin{pmatrix} a_{1,1} & a_{2,1} & a_{3,1} \\ a_{1,2} & a_{2,2} & a_{3,2} \\ a_{1,3} & a_{2,3} & a_{3,3} \\ \end{pmatrix} \]
+
◆ arm_mat_cmplx_trans_f16()
diff --git a/main/group__MatrixInv.html b/main/group__MatrixInv.html
index d9df086d..5806034b 100644
--- a/main/group__MatrixInv.html
+++ b/main/group__MatrixInv.html
@@ -160,12 +160,12 @@ Functions
Computes the inverse of a matrix.
The inverse is defined only if the input matrix is square and non-singular (the determinant is non-zero). The function checks that the input and output matrices are square and of the same size.
Matrix inversion is numerically sensitive and the CMSIS DSP library only supports matrix inversion of floating-point matrices.
-- Algorithm
- The Gauss-Jordan method is used to find the inverse. The algorithm performs a sequence of elementary row-operations until it reduces the input matrix to an identity matrix. Applying the same sequence of elementary row-operations to an identity matrix yields the inverse matrix. If the input matrix is singular, then the algorithm terminates and returns error status
ARM_MATH_SINGULAR.
-
-
-Matrix Inverse of a 3 x 3 matrix using Gauss-Jordan Method
-
+- Algorithm
- The Gauss-Jordan method is used to find the inverse. The algorithm performs a sequence of elementary row-operations until it reduces the input matrix to an identity matrix. Applying the same sequence of elementary row-operations to an identity matrix yields the inverse matrix. If the input matrix is singular, then the algorithm terminates and returns error status
ARM_MATH_SINGULAR.
+- Matrix Inverse of a 3 x 3 matrix using Gauss-Jordan Method
+
+\[ \begin{pmatrix} a_{1,1} & a_{1,2} & a_{1,3} & | & 1 & 0 & 0\\ a_{2,1} & a_{2,2} & a_{2,3} & | & 0 & 1 & 0\\ a_{3,1} & a_{3,2} & a_{3,3} & | & 0 & 0 & 1\\ \end{pmatrix} \rightarrow \begin{pmatrix} 1 & 0 & 0 & | & x_{1,1} & x_{2,1} & x_{3,1} \\ 0 & 1 & 0 & | & x_{1,2} & x_{2,2} & x_{3,2} \\ 0 & 0 & 1 & | & x_{1,3} & x_{2,3} & x_{3,3} \\ \end{pmatrix} \]
+
+
◆ arm_mat_inverse_f16()
diff --git a/main/group__MatrixScale.html b/main/group__MatrixScale.html
index c2a7de51..b3ae1a33 100644
--- a/main/group__MatrixScale.html
+++ b/main/group__MatrixScale.html
@@ -142,10 +142,11 @@ Functions
| |
-Multiplies a matrix by a scalar. This is accomplished by multiplying each element in the matrix by the scalar. For example:
-
-
-Matrix Scaling of a 3 x 3 matrix
Multiplies a matrix by a scalar. This is accomplished by multiplying each element in the matrix by the scalar. For example:
+- Matrix Scaling of a 3 x 3 matrix
+
+\[ \begin{pmatrix} a_{1,1} & a_{1,2} & a_{1,3} \\ a_{2,1} & a_{2,2} & a_{2,3} \\ a_{3,1} & a_{3,2} & a_{3,3} \\ \end{pmatrix} K = \begin{pmatrix} K a_{1,1} & K a_{1,2} & K a_{1,3} \\ K a_{2,1} & K a_{2,2} & K a_{2,3} \\ K a_{3,1} & K a_{3,2} & K a_{3,3} \\ \end{pmatrix} \]
+
The function checks to make sure that the input and output matrices are of the same size.
In the fixed-point Q15 and Q31 functions, scale is represented by a fractional multiplication scaleFract and an arithmetic shift shift. The shift allows the gain of the scaling operation to exceed 1.0. The overall scale factor applied to the fixed-point data is
scale = scaleFract * 2^shift.
diff --git a/main/group__MatrixSub.html b/main/group__MatrixSub.html
index 4561800f..599a899e 100644
--- a/main/group__MatrixSub.html
+++ b/main/group__MatrixSub.html
@@ -145,11 +145,11 @@ Functions
| |
-Subtract two matrices.
-
-
-Subraction of two 3 x 3 matrices
The functions check to make sure that pSrcA, pSrcB, and pDst have the same number of rows and columns.
+Subtract two matrices.
- Subraction of two 3 x 3 matrices
+
+\[ \begin{pmatrix} a_{1,1} & a_{1,2} & a_{1,3} \\ a_{2,1} & a_{2,2} & a_{2,3} \\ a_{3,1} & a_{3,2} & a_{3,3} \\ \end{pmatrix} - \begin{pmatrix} b_{1,1} & b_{1,2} & b_{1,3} \\ b_{2,1} & b_{2,2} & b_{2,3} \\ b_{3,1} & b_{3,2} & b_{3,3} \\ \end{pmatrix} = \begin{pmatrix} a_{1,1}-b_{1,1} & a_{1,2}-b_{1,2} & a_{1,3}-b_{1,3} \\ a_{2,1}-b_{2,1} & a_{2,2}-b_{2,2} & a_{2,3}-b_{2,3} \\ a_{3,1}-b_{3,1} & a_{3,2}-b_{3,2} & a_{3,3}-b_{3,3} \\ \end{pmatrix} \]
+
+ The functions check to make sure that pSrcA, pSrcB, and pDst have the same number of rows and columns.
◆ arm_mat_sub_f16()
diff --git a/main/group__MatrixTrans.html b/main/group__MatrixTrans.html
index 6ab7f291..79485e6b 100644
--- a/main/group__MatrixTrans.html
+++ b/main/group__MatrixTrans.html
@@ -149,10 +149,11 @@ Functions
Tranposes a matrix.
-Transposing an M x N matrix flips it around the center diagonal and results in an N x M matrix.
-
-
-Transpose of a 3 x 3 matrix
Transposing an M x N matrix flips it around the center diagonal and results in an N x M matrix.
+- Transpose of a 3 x 3 matrix
+
+\[ \begin{pmatrix} a_{1,1} & a_{1,2} & a_{1,3} \\ a_{2,1} & a_{2,2} & a_{2,3} \\ a_{3,1} & a_{3,2} & a_{3,3} \\ \end{pmatrix}^T = \begin{pmatrix} a_{1,1} & a_{2,1} & a_{3,1} \\ a_{1,2} & a_{2,2} & a_{3,2} \\ a_{1,3} & a_{2,3} & a_{3,3} \\ \end{pmatrix} \]
+
◆ arm_mat_trans_f16()
diff --git a/main/group__RealFFT.html b/main/group__RealFFT.html
index 2b7ec13a..ef591a2c 100644
--- a/main/group__RealFFT.html
+++ b/main/group__RealFFT.html
@@ -240,7 +240,7 @@ Real Inverse Fast Fourier Transform
--Input and Output Formats for Q15 CFFT--
--Input and Output Formats for Q15 CIFFT
-
-
-
-
-
-
-
-
-
-
-
diff --git a/main/group__FIR__Sparse.html b/main/group__FIR__Sparse.html
index 9564a0b9..4d922ce0 100644
--- a/main/group__FIR__Sparse.html
+++ b/main/group__FIR__Sparse.html
@@ -154,6 +154,7 @@ Functions