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__BasicShift.html | 298 +++++++++++++++++++++++++++++++++++ 1 file changed, 298 insertions(+) create mode 100644 docs/DSP/html/group__BasicShift.html (limited to 'docs/DSP/html/group__BasicShift.html') diff --git a/docs/DSP/html/group__BasicShift.html b/docs/DSP/html/group__BasicShift.html new file mode 100644 index 0000000..e8829d8 --- /dev/null +++ b/docs/DSP/html/group__BasicShift.html @@ -0,0 +1,298 @@ + + + + + +Vector Shift +CMSIS-DSP: Vector Shift + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-DSP +  Version 1.7.0 +
+
CMSIS DSP Software Library
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
Vector Shift
Basic Math Functions
+
+
+ + + + + + + + + + + +

+Functions

void arm_shift_q15 (const q15_t *pSrc, int8_t shiftBits, q15_t *pDst, uint32_t blockSize)
 Shifts the elements of a Q15 vector a specified number of bits. More...
 
void arm_shift_q31 (const q31_t *pSrc, int8_t shiftBits, q31_t *pDst, uint32_t blockSize)
 Shifts the elements of a Q31 vector a specified number of bits. More...
 
void arm_shift_q7 (const q7_t *pSrc, int8_t shiftBits, q7_t *pDst, uint32_t blockSize)
 Shifts the elements of a Q7 vector a specified number of bits. More...
 
+

Description

+

Shifts the elements of a fixed-point vector by a specified number of bits. There are separate functions for Q7, Q15, and Q31 data types. The underlying algorithm used is:

+
+    pDst[n] = pSrc[n] << shift,   0 <= n < blockSize.
+

If shift is positive then the elements of the vector are shifted to the left. If shift is negative then the elements of the vector are shifted to the right.

+

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

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void arm_shift_q15 (const q15_t * pSrc,
int8_t shiftBits,
q15_t * pDst,
uint32_t blockSize 
)
+
+
Parameters
+ + + + + +
[in]pSrcpoints to the input vector
[in]shiftBitsnumber of bits to shift. A positive value shifts left; a negative value shifts right.
[out]pDstpoints to the output vector
[in]blockSizenumber 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] are saturated.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void arm_shift_q31 (const q31_t * pSrc,
int8_t shiftBits,
q31_t * pDst,
uint32_t blockSize 
)
+
+
Parameters
+ + + + + +
[in]pSrcpoints to the input vector
[in]shiftBitsnumber of bits to shift. A positive value shifts left; a negative value shifts right.
[out]pDstpoints to the output vector
[in]blockSizenumber of samples in the vector
+
+
+
Returns
none
+
Scaling and Overflow Behavior
The function uses saturating arithmetic. Results outside of the allowable Q31 range [0x80000000 0x7FFFFFFF] are saturated.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void arm_shift_q7 (const q7_t * pSrc,
int8_t shiftBits,
q7_t * pDst,
uint32_t blockSize 
)
+
+
Parameters
+ + + + + +
[in]pSrcpoints to the input vector
[in]shiftBitsnumber of bits to shift. A positive value shifts left; a negative value shifts right.
[out]pDstpoints to the output vector
[in]blockSizenumber of samples in each vector
+
+
+
Returns
none
+
onditions for optimum performance
Input and output buffers should be aligned by 32-bit
+
Scaling and Overflow Behavior
The function uses saturating arithmetic. Results outside of the allowable Q7 range [0x80 0x7F] are saturated.
+ +
+
+
+
+ + + + -- cgit