From 9f95ff5b6ba01db09552b84a0ab79607060a2666 Mon Sep 17 00:00:00 2001 From: Ali Labbene Date: Wed, 11 Dec 2019 08:59:21 +0100 Subject: Official ARM version: v5.4.0 Add CMSIS V5.4.0, please refer to index.html available under \docs folder. Note: content of \CMSIS\Core\Include has been copied under \Include to keep the same structure used in existing projects, and thus avoid projects mass update Note: the following components have been removed from ARM original delivery (as not used in ST packages) - CMSIS_EW2018.pdf - .gitattributes - .gitignore - \Device - \CMSIS - \CoreValidation - \DAP - \Documentation - \DoxyGen - \Driver - \Pack - \RTOS\CMSIS_RTOS_Tutorial.pdf - \RTOS\RTX - \RTOS\Template - \RTOS2\RTX - \Utilities - All ARM/GCC projects files are deleted from \DSP, \RTOS and \RTOS2 Change-Id: Ia026c3f0f0d016627a4fb5a9032852c33d24b4d3 --- docs/DSP/html/group__RMS.html | 282 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 282 insertions(+) create mode 100644 docs/DSP/html/group__RMS.html (limited to 'docs/DSP/html/group__RMS.html') diff --git a/docs/DSP/html/group__RMS.html b/docs/DSP/html/group__RMS.html new file mode 100644 index 0000000..fe66d89 --- /dev/null +++ b/docs/DSP/html/group__RMS.html @@ -0,0 +1,282 @@ + + + + + +Root mean square (RMS) +CMSIS-DSP: Root mean square (RMS) + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-DSP +  Version 1.5.2 +
+
CMSIS DSP Software Library
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
Root mean square (RMS)
Statistics Functions
+
+
+ + + + + + + + + + + +

+Functions

void arm_rms_f32 (float32_t *pSrc, uint32_t blockSize, float32_t *pResult)
 Root Mean Square of the elements of a floating-point vector. More...
 
void arm_rms_q15 (q15_t *pSrc, uint32_t blockSize, q15_t *pResult)
 Root Mean Square of the elements of a Q15 vector. More...
 
void arm_rms_q31 (q31_t *pSrc, uint32_t blockSize, q31_t *pResult)
 Root Mean Square of the elements of a Q31 vector. More...
 
+

Description

+

Calculates the Root Mean Sqaure of the elements in the input vector. The underlying algorithm is used:

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

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

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_rms_f32 (float32_t * pSrc,
uint32_t blockSize,
float32_t * pResult 
)
+
+
Parameters
+ + + + +
[in]*pSrcpoints to the input vector
[in]blockSizelength of the input vector
[out]*pResultrms value returned here
+
+
+
Returns
none.
+ +

References arm_sqrt_f32(), and blockSize.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_rms_q15 (q15_t * pSrc,
uint32_t blockSize,
q15_t * pResult 
)
+
+
Parameters
+ + + + +
[in]*pSrcpoints to the input vector
[in]blockSizelength of the input vector
[out]*pResultrms 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.15 format. Intermediate multiplication yields a 2.30 format, and this result is added without saturation to a 64-bit accumulator in 34.30 format. With 33 guard bits in the accumulator, there is no risk of overflow, and the full precision of the intermediate multiplication is preserved. Finally, the 34.30 result is truncated to 34.15 format by discarding the lower 15 bits, and then saturated to yield a result in 1.15 format.
+ +

References __SIMD32, __SMLALD(), arm_sqrt_q15(), and blockSize.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_rms_q31 (q31_t * pSrc,
uint32_t blockSize,
q31_t * pResult 
)
+
+
Parameters
+ + + + +
[in]*pSrcpoints to the input vector
[in]blockSizelength of the input vector
[out]*pResultrms value returned here
+
+
+
Returns
none.
+

Scaling and Overflow Behavior:

+
The function is implemented using an internal 64-bit accumulator. The input is represented in 1.31 format, and intermediate multiplication yields a 2.62 format. The accumulator maintains full precision of the intermediate multiplication results, but provides only a single guard bit. There is no saturation on intermediate additions. If the accumulator overflows, it wraps around and distorts the result. In order to avoid overflows completely, the input signal must be scaled down by log2(blockSize) bits, as a total of blockSize additions are performed internally. Finally, the 2.62 accumulator is right shifted by 31 bits to yield a 1.31 format value.
+ +

References arm_sqrt_q31(), blockSize, and clip_q63_to_q31().

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