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 --- Documentation/DSP/html/group__scale.html | 391 ------------------------------- 1 file changed, 391 deletions(-) delete mode 100644 Documentation/DSP/html/group__scale.html (limited to 'Documentation/DSP/html/group__scale.html') diff --git a/Documentation/DSP/html/group__scale.html b/Documentation/DSP/html/group__scale.html deleted file mode 100644 index ffb6abe..0000000 --- a/Documentation/DSP/html/group__scale.html +++ /dev/null @@ -1,391 +0,0 @@ - - - - - -Vector Scale -CMSIS-DSP: Vector Scale - - - - - - - - - - - - - - - -
-
- - - - - - - -
-
CMSIS-DSP -  Version 1.4.7 -
-
CMSIS DSP Software Library
-
-
- -
-
    - -
-
- - - -
-
- -
-
-
- -
- - - - -
- -
- -
-
-Functions
-
-
Vector Scale
-
Basic Math Functions
-
- - - - - - - - - - - - - - -

-Functions

void arm_scale_f32 (float32_t *pSrc, float32_t scale, float32_t *pDst, uint32_t blockSize)
 Multiplies a floating-point vector by a scalar.
 
void arm_scale_q15 (q15_t *pSrc, q15_t scaleFract, int8_t shift, q15_t *pDst, uint32_t blockSize)
 Multiplies a Q15 vector by a scalar.
 
void arm_scale_q31 (q31_t *pSrc, q31_t scaleFract, int8_t shift, q31_t *pDst, uint32_t blockSize)
 Multiplies a Q31 vector by a scalar.
 
void arm_scale_q7 (q7_t *pSrc, q7_t scaleFract, int8_t shift, q7_t *pDst, uint32_t blockSize)
 Multiplies a Q7 vector by a scalar.
 
-

Description

-

Multiply a vector by a scalar value. For floating-point data, the algorithm used is:

-
        
-    pDst[n] = pSrc[n] * scale,   0 <= n < blockSize.        
-

In the fixed-point Q7, Q15, and Q31 functions, scale is represented by a fractional multiplication scaleFract and an arithmetic shift shift. The shift allows the gain of the scaling operation to exceed 1.0. The algorithm used with fixed-point data is:

-
        
-    pDst[n] = (pSrc[n] * scaleFract) << shift,   0 <= n < blockSize.        
-

The overall scale factor applied to the fixed-point data is

-
        
-    scale = scaleFract * 2^shift.        
-

The functions support in-place computation allowing the source and destination pointers to reference the same memory buffer.

-

Function Documentation

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void arm_scale_f32 (float32_t * pSrc,
float32_t scale,
float32_t * pDst,
uint32_t blockSize 
)
-
-
Parameters
- - - - - -
[in]*pSrcpoints to the input vector
[in]scalescale factor to be applied
[out]*pDstpoints to the output vector
[in]blockSizenumber of samples in the vector
-
-
-
Returns
none.
-
Examples:
arm_graphic_equalizer_example_q31.c, and arm_signal_converge_example_f32.c.
-
-

References blockSize.

- -

Referenced by arm_dct4_f32(), and main().

- -
-
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void arm_scale_q15 (q15_t * pSrc,
q15_t scaleFract,
int8_t shift,
q15_t * pDst,
uint32_t blockSize 
)
-
-
Parameters
- - - - - - -
[in]*pSrcpoints to the input vector
[in]scaleFractfractional portion of the scale value
[in]shiftnumber of bits to shift the result by
[out]*pDstpoints to the output vector
[in]blockSizenumber of samples in the vector
-
-
-
Returns
none.
-

Scaling and Overflow Behavior:

-
The input data *pSrc and scaleFract are in 1.15 format. These are multiplied to yield a 2.30 intermediate result and this is shifted with saturation to 1.15 format.
- -

References __SIMD32, and blockSize.

- -
-
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void arm_scale_q31 (q31_t * pSrc,
q31_t scaleFract,
int8_t shift,
q31_t * pDst,
uint32_t blockSize 
)
-
-
Parameters
- - - - - - -
[in]*pSrcpoints to the input vector
[in]scaleFractfractional portion of the scale value
[in]shiftnumber of bits to shift the result by
[out]*pDstpoints to the output vector
[in]blockSizenumber of samples in the vector
-
-
-
Returns
none.
-

Scaling and Overflow Behavior:

-
The input data *pSrc and scaleFract are in 1.31 format. These are multiplied to yield a 2.62 intermediate result and this is shifted with saturation to 1.31 format.
-
Examples:
arm_graphic_equalizer_example_q31.c.
-
-

References blockSize.

- -

Referenced by main().

- -
-
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
void arm_scale_q7 (q7_t * pSrc,
q7_t scaleFract,
int8_t shift,
q7_t * pDst,
uint32_t blockSize 
)
-
-
Parameters
- - - - - - -
[in]*pSrcpoints to the input vector
[in]scaleFractfractional portion of the scale value
[in]shiftnumber of bits to shift the result by
[out]*pDstpoints to the output vector
[in]blockSizenumber of samples in the vector
-
-
-
Returns
none.
-

Scaling and Overflow Behavior:

-
The input data *pSrc and scaleFract are in 1.7 format. These are multiplied to yield a 2.14 intermediate result and this is shifted with saturation to 1.7 format.
- -

References __PACKq7, __SIMD32, and blockSize.

- -
-
-
-
- - - - -- cgit