From 76177aa280494bb36d7a0bcbda1078d4db717020 Mon Sep 17 00:00:00 2001 From: Ali Labbene Date: Mon, 9 Dec 2019 11:25:19 +0100 Subject: Official ARM version: v4.5 --- Documentation/DSP/html/group__offset.html | 358 ++++++++++++++++++++++++++++++ 1 file changed, 358 insertions(+) create mode 100644 Documentation/DSP/html/group__offset.html (limited to 'Documentation/DSP/html/group__offset.html') diff --git a/Documentation/DSP/html/group__offset.html b/Documentation/DSP/html/group__offset.html new file mode 100644 index 0000000..c20dcea --- /dev/null +++ b/Documentation/DSP/html/group__offset.html @@ -0,0 +1,358 @@ + + + + + +Vector Offset +CMSIS-DSP: Vector Offset + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-DSP +  Version 1.4.7 +
+
CMSIS DSP Software Library
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions
+
+
Vector Offset
+
Basic Math Functions
+
+ + + + + + + + + + + + + + +

+Functions

void arm_offset_f32 (float32_t *pSrc, float32_t offset, float32_t *pDst, uint32_t blockSize)
 Adds a constant offset to a floating-point vector.
 
void arm_offset_q15 (q15_t *pSrc, q15_t offset, q15_t *pDst, uint32_t blockSize)
 Adds a constant offset to a Q15 vector.
 
void arm_offset_q31 (q31_t *pSrc, q31_t offset, q31_t *pDst, uint32_t blockSize)
 Adds a constant offset to a Q31 vector.
 
void arm_offset_q7 (q7_t *pSrc, q7_t offset, q7_t *pDst, uint32_t blockSize)
 Adds a constant offset to a Q7 vector.
 
+

Description

+

Adds a constant offset to each element of a vector.

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

The functions support in-place computation allowing the source and destination pointers to reference the same memory buffer. There are separate functions for floating-point, Q7, Q15, and Q31 data types.

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void arm_offset_f32 (float32_t * pSrc,
float32_t offset,
float32_t * pDst,
uint32_t blockSize 
)
+
+
Parameters
+ + + + + +
[in]*pSrcpoints to the input vector
[in]offsetis the offset to be added
[out]*pDstpoints to the output vector
[in]blockSizenumber of samples in the vector
+
+
+
Returns
none.
+ +

References blockSize.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void arm_offset_q15 (q15_t * pSrc,
q15_t offset,
q15_t * pDst,
uint32_t blockSize 
)
+
+
Parameters
+ + + + + +
[in]*pSrcpoints to the input vector
[in]offsetis the offset to be added
[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 Q15 range [0x8000 0x7FFF] are saturated.
+ +

References __SIMD32, and blockSize.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void arm_offset_q31 (q31_t * pSrc,
q31_t offset,
q31_t * pDst,
uint32_t blockSize 
)
+
+
Parameters
+ + + + + +
[in]*pSrcpoints to the input vector
[in]offsetis the offset to be added
[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.
+ +

References blockSize, and clip_q63_to_q31().

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void arm_offset_q7 (q7_t * pSrc,
q7_t offset,
q7_t * pDst,
uint32_t blockSize 
)
+
+
Parameters
+ + + + + +
[in]*pSrcpoints to the input vector
[in]offsetis the offset to be added
[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 Q7 range [0x80 0x7F] are saturated.
+ +

References __PACKq7, __SIMD32, and blockSize.

+ +
+
+
+
+ + + + -- cgit