CMSIS-DSP  
CMSIS DSP Software Library
Functions
Matrix Subtraction
Matrix Functions

Functions

arm_status arm_mat_sub_f16 (const arm_matrix_instance_f16 *pSrcA, const arm_matrix_instance_f16 *pSrcB, arm_matrix_instance_f16 *pDst)
 Floating-point matrix subtraction. More...
 
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. More...
 
arm_status arm_mat_sub_f64 (const arm_matrix_instance_f64 *pSrcA, const arm_matrix_instance_f64 *pSrcB, arm_matrix_instance_f64 *pDst)
 Floating-point matrix subtraction. More...
 
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. More...
 
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. More...
 

Description

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.

Function Documentation

◆ arm_mat_sub_f16()

arm_status arm_mat_sub_f16 ( const arm_matrix_instance_f16 *  pSrcA,
const arm_matrix_instance_f16 *  pSrcB,
arm_matrix_instance_f16 *  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
execution status

◆ arm_mat_sub_f32()

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
execution status

◆ arm_mat_sub_f64()

arm_status arm_mat_sub_f64 ( const arm_matrix_instance_f64 *  pSrcA,
const arm_matrix_instance_f64 *  pSrcB,
arm_matrix_instance_f64 *  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
execution status

◆ arm_mat_sub_q15()

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
execution status
Scaling and Overflow Behavior
The function uses saturating arithmetic. Results outside of the allowable Q15 range [0x8000 0x7FFF] are saturated.

◆ arm_mat_sub_q31()

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
execution status
Scaling and Overflow Behavior
The function uses saturating arithmetic. Results outside of the allowable Q31 range [0x80000000 0x7FFFFFFF] are saturated.