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 --- .../DSP/html/group__cmplx__dot__prod.html | 325 --------------------- 1 file changed, 325 deletions(-) delete mode 100644 Documentation/DSP/html/group__cmplx__dot__prod.html (limited to 'Documentation/DSP/html/group__cmplx__dot__prod.html') diff --git a/Documentation/DSP/html/group__cmplx__dot__prod.html b/Documentation/DSP/html/group__cmplx__dot__prod.html deleted file mode 100644 index ad70f91..0000000 --- a/Documentation/DSP/html/group__cmplx__dot__prod.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - -Complex Dot Product -CMSIS-DSP: Complex Dot Product - - - - - - - - - - - - - - - -
-
- - - - - - - -
-
CMSIS-DSP -  Version 1.4.7 -
-
CMSIS DSP Software Library
-
-
- -
-
    - -
-
- - - -
-
- -
-
-
- -
- - - - -
- -
- -
-
-Functions
-
-
Complex Dot Product
-
Complex Math Functions
-
- - - - - - - - - - - -

-Functions

void arm_cmplx_dot_prod_f32 (float32_t *pSrcA, float32_t *pSrcB, uint32_t numSamples, float32_t *realResult, float32_t *imagResult)
 Floating-point complex dot product.
 
void arm_cmplx_dot_prod_q15 (q15_t *pSrcA, q15_t *pSrcB, uint32_t numSamples, q31_t *realResult, q31_t *imagResult)
 Q15 complex dot product.
 
void arm_cmplx_dot_prod_q31 (q31_t *pSrcA, q31_t *pSrcB, uint32_t numSamples, q63_t *realResult, q63_t *imagResult)
 Q31 complex dot product.
 
-

Description

-

Computes the dot product of two complex vectors. The vectors are multiplied element-by-element and then summed.

-

The pSrcA points to the first complex input vector and pSrcB points to the second complex input vector. numSamples specifies the number of complex samples and the data in each array is stored in an interleaved fashion (real, imag, real, imag, ...). Each array has a total of 2*numSamples values.

-

The underlying algorithm is used:

-
    
-realResult=0;    
-imagResult=0;    
-for(n=0; n<numSamples; n++) {    
-    realResult += pSrcA[(2*n)+0]*pSrcB[(2*n)+0] - pSrcA[(2*n)+1]*pSrcB[(2*n)+1];    
-    imagResult += pSrcA[(2*n)+0]*pSrcB[(2*n)+1] + pSrcA[(2*n)+1]*pSrcB[(2*n)+0];    
-}    
-

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

-

Function Documentation

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void arm_cmplx_dot_prod_f32 (float32_t * pSrcA,
float32_t * pSrcB,
uint32_t numSamples,
float32_t * realResult,
float32_t * imagResult 
)
-
-
Parameters
- - - - - - -
*pSrcApoints to the first input vector
*pSrcBpoints to the second input vector
numSamplesnumber of complex samples in each vector
*realResultreal part of the result returned here
*imagResultimaginary part of the result returned here
-
-
-
Returns
none.
- -
-
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void arm_cmplx_dot_prod_q15 (q15_t * pSrcA,
q15_t * pSrcB,
uint32_t numSamples,
q31_t * realResult,
q31_t * imagResult 
)
-
-
Parameters
- - - - - - -
*pSrcApoints to the first input vector
*pSrcBpoints to the second input vector
numSamplesnumber of complex samples in each vector
*realResultreal part of the result returned here
*imagResultimaginary part of the result returned here
-
-
-
Returns
none.
-

Scaling and Overflow Behavior:

-
The function is implemented using an internal 64-bit accumulator. The intermediate 1.15 by 1.15 multiplications are performed with full precision and yield a 2.30 result. These are accumulated in a 64-bit accumulator with 34.30 precision. As a final step, the accumulators are converted to 8.24 format. The return results realResult and imagResult are in 8.24 format.
- -
-
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void arm_cmplx_dot_prod_q31 (q31_t * pSrcA,
q31_t * pSrcB,
uint32_t numSamples,
q63_t * realResult,
q63_t * imagResult 
)
-
-
Parameters
- - - - - - -
*pSrcApoints to the first input vector
*pSrcBpoints to the second input vector
numSamplesnumber of complex samples in each vector
*realResultreal part of the result returned here
*imagResultimaginary part of the result returned here
-
-
-
Returns
none.
-

Scaling and Overflow Behavior:

-
The function is implemented using an internal 64-bit accumulator. The intermediate 1.31 by 1.31 multiplications are performed with 64-bit precision and then shifted to 16.48 format. The internal real and imaginary accumulators are in 16.48 format and provide 15 guard bits. Additions are nonsaturating and no overflow will occur as long as numSamples is less than 32768. The return results realResult and imagResult are in 16.48 format. Input down scaling is not required.
- -
-
-
-
- - - - -- cgit