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__power.html | 330 +++++++++++++++++++++++++++++++ 1 file changed, 330 insertions(+) create mode 100644 Documentation/DSP/html/group__power.html (limited to 'Documentation/DSP/html/group__power.html') diff --git a/Documentation/DSP/html/group__power.html b/Documentation/DSP/html/group__power.html new file mode 100644 index 0000000..7c058d5 --- /dev/null +++ b/Documentation/DSP/html/group__power.html @@ -0,0 +1,330 @@ + + + + + +Power +CMSIS-DSP: Power + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-DSP +  Version 1.4.7 +
+
CMSIS DSP Software Library
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
Power
+
Statistics Functions
+
+ + + + + + + + + + + + + + +

+Functions

void arm_power_f32 (float32_t *pSrc, uint32_t blockSize, float32_t *pResult)
 Sum of the squares of the elements of a floating-point vector.
 
void arm_power_q15 (q15_t *pSrc, uint32_t blockSize, q63_t *pResult)
 Sum of the squares of the elements of a Q15 vector.
 
void arm_power_q31 (q31_t *pSrc, uint32_t blockSize, q63_t *pResult)
 Sum of the squares of the elements of a Q31 vector.
 
void arm_power_q7 (q7_t *pSrc, uint32_t blockSize, q31_t *pResult)
 Sum of the squares of the elements of a Q7 vector.
 
+

Description

+

Calculates the sum of the squares of the elements in the input vector. The underlying algorithm is used:

+
    
+        Result = pSrc[0] * pSrc[0] + pSrc[1] * pSrc[1] + pSrc[2] * pSrc[2] + ... + pSrc[blockSize-1] * pSrc[blockSize-1];    
+

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

+

Function Documentation

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

References blockSize.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_power_q15 (q15_t * pSrc,
uint32_t blockSize,
q63_t * pResult 
)
+
+
Parameters
+ + + + +
[in]*pSrcpoints to the input vector
[in]blockSizelength of the input vector
[out]*pResultsum of the squares 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 return result is in 34.30 format.
+ +

References __SIMD32, and blockSize.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_power_q31 (q31_t * pSrc,
uint32_t blockSize,
q63_t * pResult 
)
+
+
Parameters
+ + + + +
[in]*pSrcpoints to the input vector
[in]blockSizelength of the input vector
[out]*pResultsum of the squares 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. Intermediate multiplication yields a 2.62 format, and this result is truncated to 2.48 format by discarding the lower 14 bits. The 2.48 result is then added without saturation to a 64-bit accumulator in 16.48 format. With 15 guard bits in the accumulator, there is no risk of overflow, and the full precision of the intermediate multiplication is preserved. Finally, the return result is in 16.48 format.
+ +

References blockSize.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_power_q7 (q7_t * pSrc,
uint32_t blockSize,
q31_t * pResult 
)
+
+
Parameters
+ + + + +
[in]*pSrcpoints to the input vector
[in]blockSizelength of the input vector
[out]*pResultsum of the squares 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. Intermediate multiplication yields a 2.14 format, and this result is added without saturation to an accumulator in 18.14 format. With 17 guard bits in the accumulator, there is no risk of overflow, and the full precision of the intermediate multiplication is preserved. Finally, the return result is in 18.14 format.
+ +

References __SIMD32, and blockSize.

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