From 76177aa280494bb36d7a0bcbda1078d4db717020 Mon Sep 17 00:00:00 2001 From: Ali Labbene Date: Mon, 9 Dec 2019 11:25:19 +0100 Subject: Official ARM version: v4.5 --- Documentation/DSP/html/group___matrix_sub.html | 284 +++++++++++++++++++++++++ 1 file changed, 284 insertions(+) create mode 100644 Documentation/DSP/html/group___matrix_sub.html (limited to 'Documentation/DSP/html/group___matrix_sub.html') diff --git a/Documentation/DSP/html/group___matrix_sub.html b/Documentation/DSP/html/group___matrix_sub.html new file mode 100644 index 0000000..724518a --- /dev/null +++ b/Documentation/DSP/html/group___matrix_sub.html @@ -0,0 +1,284 @@ + + + + + +Matrix Subtraction +CMSIS-DSP: Matrix Subtraction + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-DSP +  Version 1.4.7 +
+
CMSIS DSP Software Library
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
Matrix Subtraction
+
Matrix Functions
+
+ + + + + + + + + + + +

+Functions

arm_status arm_mat_sub_f32 (const arm_matrix_instance_f32 *pSrcA, const arm_matrix_instance_f32 *pSrcB, arm_matrix_instance_f32 *pDst)
 Floating-point matrix subtraction.
 
arm_status arm_mat_sub_q15 (const arm_matrix_instance_q15 *pSrcA, const arm_matrix_instance_q15 *pSrcB, arm_matrix_instance_q15 *pDst)
 Q15 matrix subtraction.
 
arm_status arm_mat_sub_q31 (const arm_matrix_instance_q31 *pSrcA, const arm_matrix_instance_q31 *pSrcB, arm_matrix_instance_q31 *pDst)
 Q31 matrix subtraction.
 
+

Description

+

Subtract two matrices.

+
+MatrixSubtraction.gif +
+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.

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
arm_status arm_mat_sub_f32 (const arm_matrix_instance_f32 * pSrcA,
const arm_matrix_instance_f32 * pSrcB,
arm_matrix_instance_f32 * pDst 
)
+
+
Parameters
+ + + + +
[in]*pSrcApoints to the first input matrix structure
[in]*pSrcBpoints to the second input matrix structure
[out]*pDstpoints to output matrix structure
+
+
+
Returns
The function returns either ARM_MATH_SIZE_MISMATCH or ARM_MATH_SUCCESS based on the outcome of size checking.
+ +

References ARM_MATH_SIZE_MISMATCH, ARM_MATH_SUCCESS, arm_matrix_instance_f32::numCols, arm_matrix_instance_f32::numRows, arm_matrix_instance_f32::pData, and status.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
arm_status arm_mat_sub_q15 (const arm_matrix_instance_q15 * pSrcA,
const arm_matrix_instance_q15 * pSrcB,
arm_matrix_instance_q15 * pDst 
)
+
+
Parameters
+ + + + +
[in]*pSrcApoints to the first input matrix structure
[in]*pSrcBpoints to the second input matrix structure
[out]*pDstpoints to output matrix structure
+
+
+
Returns
The function returns either ARM_MATH_SIZE_MISMATCH or ARM_MATH_SUCCESS based on the outcome of size checking.
+

Scaling and Overflow Behavior:

+
The function uses saturating arithmetic. Results outside of the allowable Q15 range [0x8000 0x7FFF] will be saturated.
+ +

References __SIMD32, ARM_MATH_SIZE_MISMATCH, ARM_MATH_SUCCESS, arm_matrix_instance_q15::numCols, arm_matrix_instance_q15::numRows, arm_matrix_instance_q15::pData, and status.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
arm_status arm_mat_sub_q31 (const arm_matrix_instance_q31 * pSrcA,
const arm_matrix_instance_q31 * pSrcB,
arm_matrix_instance_q31 * pDst 
)
+
+
Parameters
+ + + + +
[in]*pSrcApoints to the first input matrix structure
[in]*pSrcBpoints to the second input matrix structure
[out]*pDstpoints to output matrix structure
+
+
+
Returns
The function returns either ARM_MATH_SIZE_MISMATCH or ARM_MATH_SUCCESS based on the outcome of size checking.
+

Scaling and Overflow Behavior:

+
The function uses saturating arithmetic. Results outside of the allowable Q31 range [0x80000000 0x7FFFFFFF] will be saturated.
+ +

References ARM_MATH_SIZE_MISMATCH, ARM_MATH_SUCCESS, arm_matrix_instance_q31::numCols, arm_matrix_instance_q31::numRows, arm_matrix_instance_q31::pData, and status.

+ +
+
+
+
+ + + + -- cgit