From 96d6da4e252b06dcfdc041e7df23e86161c33007 Mon Sep 17 00:00:00 2001 From: rihab kouki Date: Tue, 28 Jul 2020 11:24:49 +0100 Subject: Official ARM version: v5.6.0 --- docs/DSP/html/group__cmplx__mag__squared.html | 68 +++++++++++++-------------- 1 file changed, 32 insertions(+), 36 deletions(-) (limited to 'docs/DSP/html/group__cmplx__mag__squared.html') diff --git a/docs/DSP/html/group__cmplx__mag__squared.html b/docs/DSP/html/group__cmplx__mag__squared.html index 838b548..de6459f 100644 --- a/docs/DSP/html/group__cmplx__mag__squared.html +++ b/docs/DSP/html/group__cmplx__mag__squared.html @@ -32,7 +32,7 @@ Logo
CMSIS-DSP -  Version 1.5.2 +  Version 1.7.0
CMSIS DSP Software Library
@@ -116,34 +116,34 @@ $(document).ready(function(){initNavTree('group__cmplx__mag__squared.html','');} - - - - - - - - - + + + + + + + + +

Functions

void arm_cmplx_mag_squared_f32 (float32_t *pSrc, float32_t *pDst, uint32_t numSamples)
 Floating-point complex magnitude squared. More...
 
void arm_cmplx_mag_squared_q15 (q15_t *pSrc, q15_t *pDst, uint32_t numSamples)
 Q15 complex magnitude squared. More...
 
void arm_cmplx_mag_squared_q31 (q31_t *pSrc, q31_t *pDst, uint32_t numSamples)
 Q31 complex magnitude squared. More...
 
void arm_cmplx_mag_squared_f32 (const float32_t *pSrc, float32_t *pDst, uint32_t numSamples)
 Floating-point complex magnitude squared. More...
 
void arm_cmplx_mag_squared_q15 (const q15_t *pSrc, q15_t *pDst, uint32_t numSamples)
 Q15 complex magnitude squared. More...
 
void arm_cmplx_mag_squared_q31 (const q31_t *pSrc, q31_t *pDst, uint32_t numSamples)
 Q31 complex magnitude squared. More...
 

Description

Computes the magnitude squared of the elements of a complex data vector.

The pSrc points to the source data and pDst points to the where the result should be written. numSamples specifies the number of complex samples in the input array and the data is stored in an interleaved fashion (real, imag, real, imag, ...). The input array has a total of 2*numSamples values; the output array has a total of numSamples values.

The underlying algorithm is used:

-for(n=0; n<numSamples; n++) {
+for (n = 0; n < numSamples; n++) {
     pDst[n] = pSrc[(2*n)+0]^2 + pSrc[(2*n)+1]^2;
 }

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

Function Documentation

- +
- + @@ -167,24 +167,24 @@ for(n=0; n<numSamples; n++) {
Parameters
void arm_cmplx_mag_squared_f32 (float32_t * const float32_t *  pSrc,
- - - + + +
[in]*pSrcpoints to the complex input vector
[out]*pDstpoints to the real output vector
[in]numSamplesnumber of complex samples in the input vector
[in]pSrcpoints to input vector
[out]pDstpoints to output vector
[in]numSamplesnumber of samples in each vector
-
Returns
none.
+
Returns
none
- +
- + @@ -208,28 +208,25 @@ for(n=0; n<numSamples; n++) {
Parameters
void arm_cmplx_mag_squared_q15 (q15_t * const q15_t *  pSrc,
- - - + + +
*pSrcpoints to the complex input vector
*pDstpoints to the real output vector
numSamplesnumber of complex samples in the input vector
[in]pSrcpoints to input vector
[out]pDstpoints to output vector
[in]numSamplesnumber of samples in each vector
-
Returns
none.
-

Scaling and Overflow Behavior:

-
The function implements 1.15 by 1.15 multiplications and finally output is converted into 3.13 format.
- -

References __SIMD32, and __SMUAD().

+
Returns
none
+
Scaling and Overflow Behavior
The function implements 1.15 by 1.15 multiplications and finally output is converted into 3.13 format.
- +
- + @@ -253,15 +250,14 @@ for(n=0; n<numSamples; n++) {
Parameters
void arm_cmplx_mag_squared_q31 (q31_t * const q31_t *  pSrc,
- - - + + +
*pSrcpoints to the complex input vector
*pDstpoints to the real output vector
numSamplesnumber of complex samples in the input vector
[in]pSrcpoints to input vector
[out]pDstpoints to output vector
[in]numSamplesnumber of samples in each vector
-
Returns
none.
-

Scaling and Overflow Behavior:

-
The function implements 1.31 by 1.31 multiplications and finally output is converted into 3.29 format. Input down scaling is not required.
+
Returns
none
+
Scaling and Overflow Behavior
The function implements 1.31 by 1.31 multiplications and finally output is converted into 3.29 format. Input down scaling is not required.
@@ -270,7 +266,7 @@ for(n=0; n<numSamples; n++) {