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__CmplxByRealMult.html | 76 ++++++++++++++----------------- 1 file changed, 35 insertions(+), 41 deletions(-) (limited to 'docs/DSP/html/group__CmplxByRealMult.html') diff --git a/docs/DSP/html/group__CmplxByRealMult.html b/docs/DSP/html/group__CmplxByRealMult.html index 07b3a1b..8cc9882 100644 --- a/docs/DSP/html/group__CmplxByRealMult.html +++ b/docs/DSP/html/group__CmplxByRealMult.html @@ -32,7 +32,7 @@ Logo
CMSIS-DSP -  Version 1.5.2 +  Version 1.7.0
CMSIS DSP Software Library
@@ -116,40 +116,40 @@ $(document).ready(function(){initNavTree('group__CmplxByRealMult.html','');}); - - - - - - - - - + + + + + + + + +

Functions

void arm_cmplx_mult_real_f32 (float32_t *pSrcCmplx, float32_t *pSrcReal, float32_t *pCmplxDst, uint32_t numSamples)
 Floating-point complex-by-real multiplication. More...
 
void arm_cmplx_mult_real_q15 (q15_t *pSrcCmplx, q15_t *pSrcReal, q15_t *pCmplxDst, uint32_t numSamples)
 Q15 complex-by-real multiplication. More...
 
void arm_cmplx_mult_real_q31 (q31_t *pSrcCmplx, q31_t *pSrcReal, q31_t *pCmplxDst, uint32_t numSamples)
 Q31 complex-by-real multiplication. More...
 
void arm_cmplx_mult_real_f32 (const float32_t *pSrcCmplx, const float32_t *pSrcReal, float32_t *pCmplxDst, uint32_t numSamples)
 Floating-point complex-by-real multiplication. More...
 
void arm_cmplx_mult_real_q15 (const q15_t *pSrcCmplx, const q15_t *pSrcReal, q15_t *pCmplxDst, uint32_t numSamples)
 Q15 complex-by-real multiplication. More...
 
void arm_cmplx_mult_real_q31 (const q31_t *pSrcCmplx, const q31_t *pSrcReal, q31_t *pCmplxDst, uint32_t numSamples)
 Q31 complex-by-real multiplication. More...
 

Description

Multiplies a complex vector by a real vector and generates a complex result. The data in the complex arrays is stored in an interleaved fashion (real, imag, real, imag, ...). The parameter numSamples represents the number of complex samples processed. The complex arrays have a total of 2*numSamples real values while the real array has a total of numSamples real values.

The underlying algorithm is used:

-for(n=0; n<numSamples; n++) {
+for (n = 0; n < numSamples; n++) {
     pCmplxDst[(2*n)+0] = pSrcCmplx[(2*n)+0] * pSrcReal[n];
     pCmplxDst[(2*n)+1] = pSrcCmplx[(2*n)+1] * pSrcReal[n];
 }

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

Function Documentation

- +
- + - + @@ -173,31 +173,31 @@ for(n=0; n<numSamples; n++) {
Parameters
void arm_cmplx_mult_real_f32 (float32_t * const float32_t *  pSrcCmplx,
float32_t * const float32_t *  pSrcReal,
- - - + + +
[in]*pSrcCmplxpoints to the complex input vector
[in]*pSrcRealpoints to the real input vector
[out]*pCmplxDstpoints to the complex output vector
[in]pSrcCmplxpoints to complex input vector
[in]pSrcRealpoints to real input vector
[out]pCmplxDstpoints to complex output vector
[in]numSamplesnumber of samples in each vector
-
Returns
none.
+
Returns
none
- +
- + - + @@ -221,35 +221,32 @@ for(n=0; n<numSamples; n++) {
Parameters
void arm_cmplx_mult_real_q15 (q15_t * const q15_t *  pSrcCmplx,
q15_t * const q15_t *  pSrcReal,
- - - + + +
[in]*pSrcCmplxpoints to the complex input vector
[in]*pSrcRealpoints to the real input vector
[out]*pCmplxDstpoints to the complex output vector
[in]pSrcCmplxpoints to complex input vector
[in]pSrcRealpoints to real input vector
[out]pCmplxDstpoints to complex output vector
[in]numSamplesnumber of samples in each vector
-
Returns
none.
-

Scaling and Overflow Behavior:

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

References __PKHBT, and __SIMD32.

+
Returns
none
+
Scaling and Overflow Behavior
The function uses saturating arithmetic. Results outside of the allowable Q15 range [0x8000 0x7FFF] are saturated.
- +
- + - + @@ -273,18 +270,15 @@ for(n=0; n<numSamples; n++) {
Parameters
void arm_cmplx_mult_real_q31 (q31_t * const q31_t *  pSrcCmplx,
q31_t * const q31_t *  pSrcReal,
- - - + + +
[in]*pSrcCmplxpoints to the complex input vector
[in]*pSrcRealpoints to the real input vector
[out]*pCmplxDstpoints to the complex output vector
[in]pSrcCmplxpoints to complex input vector
[in]pSrcRealpoints to real input vector
[out]pCmplxDstpoints to complex output vector
[in]numSamplesnumber of samples in each vector
-
Returns
none.
-

Scaling and Overflow Behavior:

-
The function uses saturating arithmetic. Results outside of the allowable Q31 range[0x80000000 0x7FFFFFFF] will be saturated.
- -

References clip_q63_to_q31().

+
Returns
none
+
Scaling and Overflow Behavior
The function uses saturating arithmetic. Results outside of the allowable Q31 range[0x80000000 0x7FFFFFFF] are saturated.
@@ -293,7 +287,7 @@ for(n=0; n<numSamples; n++) {