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)
arm_status	arm_mat_sub_q31 (const arm_matrix_instance_q31 *pSrcA, const arm_matrix_instance_q31 *pSrcB, arm_matrix_instance_q31 *pDst)
arm_status	arm_mat_sub_q15 (const arm_matrix_instance_q15 *pSrcA, const arm_matrix_instance_q15 *pSrcB, arm_matrix_instance_q15 *pDst)

---

Detailed Description

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.

---

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
	)

Floating-point matrix subtraction.

Parameters:

[in]	*pSrcA	points to the first input matrix structure
[in]	*pSrcB	points to the second input matrix structure
[out]	*pDst	points to output matrix structure

Returns:

The function returns either ARM_MATH_SIZE_MISMATCH or ARM_MATH_SUCCESS based on the outcome of size checking.

Definition at line 56 of file arm_mat_sub_f32.c.

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.

Parameters:

[in]	*pSrcA	points to the first input matrix structure
[in]	*pSrcB	points to the second input matrix structure
[out]	*pDst	points 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.

Definition at line 51 of file arm_mat_sub_q31.c.

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.

Parameters:

[in]	*pSrcA	points to the first input matrix structure
[in]	*pSrcB	points to the second input matrix structure
[out]	*pDst	points to output matrix structure

Returns:

The function returns either ARM_MATH_SIZE_MISMATCH or ARM_MATH_SUCCESS based on the outcome of size checking.

Conditions for optimum performance

Input and output buffers should be aligned by 32-bit

Scaling and Overflow Behavior:

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

Definition at line 53 of file arm_mat_sub_q15.c.