Date: Tue, 28 Jul 2020 11:24:49 +0100 Subject: Official ARM version: v5.6.0 --- docs/DSP/html/group__mean.html | 97 ++++++++++++++++++------------------------ 1 file changed, 42 insertions(+), 55 deletions(-) (limited to 'docs/DSP/html/group__mean.html') diff --git a/docs/DSP/html/group__mean.html b/docs/DSP/html/group__mean.html index 07b2ebd..2c621e5 100644 --- a/docs/DSP/html/group__mean.html +++ b/docs/DSP/html/group__mean.html @@ -32,7 +32,7 @@ Logo

CMSIS-DSP - Version 1.5.2 + Version 1.7.0

CMSIS DSP Software Library

@@ -116,33 +116,33 @@ $(document).ready(function(){initNavTree('group__mean.html','');}); - - - - - - - - - - - - + + + + + + + + + + + +

Functions
void	arm_mean_f32 (float32_t pSrc, uint32_t blockSize, float32_t pResult)
	Mean value of a floating-point vector. More...

void	arm_mean_q15 (q15_t pSrc, uint32_t blockSize, q15_t pResult)
	Mean value of a Q15 vector. More...

void	arm_mean_q31 (q31_t pSrc, uint32_t blockSize, q31_t pResult)
	Mean value of a Q31 vector. More...

void	arm_mean_q7 (q7_t pSrc, uint32_t blockSize, q7_t pResult)
	Mean value of a Q7 vector. More...

void	arm_mean_f32 (const float32_t pSrc, uint32_t blockSize, float32_t pResult)
	Mean value of a floating-point vector. More...

void	arm_mean_q15 (const q15_t pSrc, uint32_t blockSize, q15_t pResult)
	Mean value of a Q15 vector. More...

void	arm_mean_q31 (const q31_t pSrc, uint32_t blockSize, q31_t pResult)
	Mean value of a Q31 vector. More...

void	arm_mean_q7 (const q7_t pSrc, uint32_t blockSize, q7_t pResult)
	Mean value of a Q7 vector. More...

Description

Calculates the mean of the input vector. Mean is defined as the average of the elements in the vector. The underlying algorithm is used:

-        Result = (pSrc[0] + pSrc[1] + pSrc[2] + ... + pSrc[blockSize-1]) / blockSize;
+    Result = (pSrc[0] + pSrc[1] + pSrc[2] + ... + pSrc[blockSize-1]) / blockSize;

There are separate functions for floating-point, Q31, Q15, and Q7 data types.

Function Documentation

- +

- + @@ -166,28 +166,24 @@ Functions

Parameters

void arm_mean_f32 ( float32_t * const float32_t * pSrc,

- - - + + +

[in]	*pSrc	points to the input vector
[in]	blockSize	length of the input vector
[out]	*pResult	mean value returned here
[in]	pSrc	points to the input vector.
[in]	blockSize	number of samples in input vector.
[out]	pResult	mean value returned here.

Returns: none.

- -

References blockSize.

- -

Referenced by main().

Returns: none

- +

- + @@ -211,28 +207,25 @@ Functions

Parameters

void arm_mean_q15 ( q15_t * const q15_t * pSrc,

- - - + + +

[in]	*pSrc	points to the input vector
[in]	blockSize	length of the input vector
[out]	*pResult	mean value returned here
[in]	pSrc	points to the input vector
[in]	blockSize	number of samples in input vector
[out]	pResult	mean value returned here

Returns: none.

Scaling and Overflow Behavior:

: The function is implemented using a 32-bit internal accumulator. The input is represented in 1.15 format and is accumulated in a 32-bit accumulator in 17.15 format. There is no risk of internal overflow with this approach, and the full precision of intermediate result is preserved. Finally, the accumulator is saturated and truncated to yield a result of 1.15 format.

- -

References __SIMD32, and blockSize.

Returns: none

Scaling and Overflow Behavior: The function is implemented using a 32-bit internal accumulator. The input is represented in 1.15 format and is accumulated in a 32-bit accumulator in 17.15 format. There is no risk of internal overflow with this approach, and the full precision of intermediate result is preserved. Finally, the accumulator is truncated to yield a result of 1.15 format.

- +

- + @@ -256,28 +249,25 @@ Functions

Parameters

void arm_mean_q31 ( q31_t * const q31_t * pSrc,

- - - + + +

[in]	*pSrc	points to the input vector
[in]	blockSize	length of the input vector
[out]	*pResult	mean value returned here
[in]	pSrc	points to the input vector
[in]	blockSize	number of samples in input vector
[out]	pResult	mean value returned here

Returns: none.

Scaling and Overflow Behavior:

: The function is implemented using a 64-bit internal accumulator. The input is represented in 1.31 format and is accumulated in a 64-bit accumulator in 33.31 format. There is no risk of internal overflow with this approach, and the full precision of intermediate result is preserved. Finally, the accumulator is truncated to yield a result of 1.31 format.

- -

References blockSize.

Returns: none

Scaling and Overflow Behavior: The function is implemented using a 64-bit internal accumulator. The input is represented in 1.31 format and is accumulated in a 64-bit accumulator in 33.31 format. There is no risk of internal overflow with this approach, and the full precision of intermediate result is preserved. Finally, the accumulator is truncated to yield a result of 1.31 format.

- +

- + @@ -301,17 +291,14 @@ Functions

Parameters

void arm_mean_q7 ( q7_t * const q7_t * pSrc,

- - - + + +

[in]	*pSrc	points to the input vector
[in]	blockSize	length of the input vector
[out]	*pResult	mean value returned here
[in]	pSrc	points to the input vector
[in]	blockSize	number of samples in input vector
[out]	pResult	mean value returned here

Returns: none.

Scaling and Overflow Behavior:

: The function is implemented using a 32-bit internal accumulator. The input is represented in 1.7 format and is accumulated in a 32-bit accumulator in 25.7 format. There is no risk of internal overflow with this approach, and the full precision of intermediate result is preserved. Finally, the accumulator is truncated to yield a result of 1.7 format.

- -

References __SIMD32, and blockSize.

Returns: none

Scaling and Overflow Behavior: The function is implemented using a 32-bit internal accumulator. The input is represented in 1.7 format and is accumulated in a 32-bit accumulator in 25.7 format. There is no risk of internal overflow with this approach, and the full precision of intermediate result is preserved. Finally, the accumulator is truncated to yield a result of 1.7 format.

@@ -320,7 +307,7 @@ Functions