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 --- ...arm__convolution__example_2math__helper_8h.html | 709 +++++++++++++++++++++ 1 file changed, 709 insertions(+) create mode 100644 docs/DSP/html/arm__convolution__example_2math__helper_8h.html (limited to 'docs/DSP/html/arm__convolution__example_2math__helper_8h.html') diff --git a/docs/DSP/html/arm__convolution__example_2math__helper_8h.html b/docs/DSP/html/arm__convolution__example_2math__helper_8h.html new file mode 100644 index 0000000..ecfc5c4 --- /dev/null +++ b/docs/DSP/html/arm__convolution__example_2math__helper_8h.html @@ -0,0 +1,709 @@ + + + + + +math_helper.h File Reference +CMSIS-DSP: math_helper.h File Reference + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-DSP +  Version 1.5.2 +
+
CMSIS DSP Software Library
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
arm_convolution_example/math_helper.h File Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

float arm_snr_f32 (float *pRef, float *pTest, uint32_t buffSize)
 Caluclation of SNR. More...
 
void arm_float_to_q12_20 (float *pIn, q31_t *pOut, uint32_t numSamples)
 Converts float to fixed in q12.20 format. More...
 
void arm_provide_guard_bits_q15 (q15_t *input_buf, uint32_t blockSize, uint32_t guard_bits)
 Provide guard bits for Input buffer. More...
 
void arm_provide_guard_bits_q31 (q31_t *input_buf, uint32_t blockSize, uint32_t guard_bits)
 Provide guard bits for Input buffer. More...
 
void arm_float_to_q14 (float *pIn, q15_t *pOut, uint32_t numSamples)
 Converts float to fixed q14. More...
 
void arm_float_to_q29 (float *pIn, q31_t *pOut, uint32_t numSamples)
 Converts float to fixed q30 format. More...
 
void arm_float_to_q28 (float *pIn, q31_t *pOut, uint32_t numSamples)
 Converts float to fixed q28 format. More...
 
void arm_float_to_q30 (float *pIn, q31_t *pOut, uint32_t numSamples)
 Converts float to fixed q30 format. More...
 
void arm_clip_f32 (float *pIn, uint32_t numSamples)
 Clip the float values to +/- 1. More...
 
uint32_t arm_calc_guard_bits (uint32_t num_adds)
 Caluclates number of guard bits. More...
 
void arm_apply_guard_bits (float32_t *pIn, uint32_t numSamples, uint32_t guard_bits)
 Apply guard bits to buffer. More...
 
uint32_t arm_compare_fixed_q15 (q15_t *pIn, q15_t *pOut, uint32_t numSamples)
 Compare MATLAB Reference Output and ARM Test output. More...
 
uint32_t arm_compare_fixed_q31 (q31_t *pIn, q31_t *pOut, uint32_t numSamples)
 Compare MATLAB Reference Output and ARM Test output. More...
 
uint32_t arm_calc_2pow (uint32_t guard_bits)
 Calculates pow(2, numShifts) More...
 
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_apply_guard_bits (float32_t * pIn,
uint32_t numSamples,
uint32_t guard_bits 
)
+
+
Parameters
+ + + + +
[in,out]pInpointer to input buffer
[in]numSamplesnumber of samples in the input buffer
[in]guard_bitsguard bits
+
+
+
Returns
none
+ +
+
+ +
+
+ + + + + + + + +
uint32_t arm_calc_2pow (uint32_t numShifts)
+
+
Parameters
+ + +
[in]numShiftsnumber of shifts
+
+
+
Returns
pow(2, numShifts)
+ +
+
+ +
+
+ + + + + + + + +
uint32_t arm_calc_guard_bits (uint32_t num_adds)
+
+
Parameters
+ + +
[in]num_addsnumber of additions
+
+
+
Returns
guard bits The function Caluclates the number of guard bits depending on the numtaps
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void arm_clip_f32 (float * pIn,
uint32_t numSamples 
)
+
+
Parameters
+ + + +
[in,out]pIninput buffer
[in]numSamplesnumber of samples in the buffer
+
+
+
Returns
none The function converts floating point values to fixed point values
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
uint32_t arm_compare_fixed_q15 (q15_t * pIn,
q15_t * pOut,
uint32_t numSamples 
)
+
+
Parameters
+ + + + +
[in]pInPointer to Ref buffer
[in]pOutPointer to Test buffer
[in]numSamplesnumber of samples in the buffer
+
+
+
Returns
maximum difference
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
uint32_t arm_compare_fixed_q31 (q31_t * pIn,
q31_t * pOut,
uint32_t numSamples 
)
+
+
Parameters
+ + + + +
[in]pInPointer to Ref buffer
[in]pOutPointer to Test buffer
[in]numSamplesnumber of samples in the buffer
+
+
+
Returns
maximum difference
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_float_to_q12_20 (float * pIn,
q31_t * pOut,
uint32_t numSamples 
)
+
+
Parameters
+ + + + +
[in]pInpointer to input buffer
[out]pOutpointer to outputbuffer
[in]numSamplesnumber of samples in the input buffer
+
+
+
Returns
none The function converts floating point values to fixed point(q12.20) values
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_float_to_q14 (float * pIn,
q15_t * pOut,
uint32_t numSamples 
)
+
+
Parameters
+ + + + +
[in]pInpointer to input buffer
[out]pOutpointer to output buffer
[in]numSamplesnumber of samples in the buffer
+
+
+
Returns
none The function converts floating point values to fixed point values
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_float_to_q28 (float * pIn,
q31_t * pOut,
uint32_t numSamples 
)
+
+
Parameters
+ + + + +
[in]pInpointer to input buffer
[out]pOutpointer to output buffer
[in]numSamplesnumber of samples in the buffer
+
+
+
Returns
none The function converts floating point values to fixed point values
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_float_to_q29 (float * pIn,
q31_t * pOut,
uint32_t numSamples 
)
+
+
Parameters
+ + + + +
[in]pInpointer to input buffer
[out]pOutpointer to output buffer
[in]numSamplesnumber of samples in the buffer
+
+
+
Returns
none The function converts floating point values to fixed point values
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_float_to_q30 (float * pIn,
q31_t * pOut,
uint32_t numSamples 
)
+
+
Parameters
+ + + + +
[in]pInpointer to input buffer
[out]pOutpointer to output buffer
[in]numSamplesnumber of samples in the buffer
+
+
+
Returns
none The function converts floating point values to fixed point values
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_provide_guard_bits_q15 (q15_t * input_buf,
uint32_t blockSize,
uint32_t guard_bits 
)
+
+
Parameters
+ + + + +
[in,out]input_bufPointer to input buffer
[in]blockSizeblock Size
[in]guard_bitsguard bits
+
+
+
Returns
none The function Provides the guard bits for the buffer to avoid overflow
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void arm_provide_guard_bits_q31 (q31_t * input_buf,
uint32_t blockSize,
uint32_t guard_bits 
)
+
+
Parameters
+ + + + +
[in,out]input_bufPointer to input buffer
[in]blockSizeblock Size
[in]guard_bitsguard bits
+
+
+
Returns
none The function Provides the guard bits for the buffer to avoid overflow
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
float arm_snr_f32 (float * pRef,
float * pTest,
uint32_t buffSize 
)
+
+
Parameters
+ + + + +
[in]pRefPointer to the reference buffer
[in]pTestPointer to the test buffer
[in]buffSizetotal number of samples
+
+
+
Returns
SNR The function Caluclates signal to noise ratio for the reference output and test output
+ +
+
+
+
+ + + + -- cgit