Vector Offset

Functions
void	arm_offset_f16 (const float16_t *pSrc, float16_t offset, float16_t *pDst, uint32_t blockSize)
	Adds a constant offset to a floating-point vector. More...
void	arm_offset_f32 (const float32_t *pSrc, float32_t offset, float32_t *pDst, uint32_t blockSize)
	Adds a constant offset to a floating-point vector. More...
void	arm_offset_f64 (const float64_t *pSrc, float64_t offset, float64_t *pDst, uint32_t blockSize)
	Adds a constant offset to a floating-point vector. More...
void	arm_offset_q15 (const q15_t *pSrc, q15_t offset, q15_t *pDst, uint32_t blockSize)
	Adds a constant offset to a Q15 vector. More...
void	arm_offset_q31 (const q31_t *pSrc, q31_t offset, q31_t *pDst, uint32_t blockSize)
	Adds a constant offset to a Q31 vector. More...
void	arm_offset_q7 (const q7_t *pSrc, q7_t offset, q7_t *pDst, uint32_t blockSize)
	Adds a constant offset to a Q7 vector. More...

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_f16	(	const float16_t *	pSrc,
		float16_t	offset,
		float16_t *	pDst,
		uint32_t	blockSize
	)

Parameters

[in]	pSrc	points to the input vector
[in]	offset	is the offset to be added
[out]	pDst	points to the output vector
[in]	blockSize	number of samples in each vector

Returns

none

void arm_offset_f32	(	const float32_t *	pSrc,
		float32_t	offset,
		float32_t *	pDst,
		uint32_t	blockSize
	)

Parameters

[in]	pSrc	points to the input vector
[in]	offset	is the offset to be added
[out]	pDst	points to the output vector
[in]	blockSize	number of samples in each vector

Returns

none

void arm_offset_f64	(	const float64_t *	pSrc,
		float64_t	offset,
		float64_t *	pDst,
		uint32_t	blockSize
	)

Parameters

[in]	pSrc	points to the input vector
[in]	offset	is the offset to be added
[out]	pDst	points to the output vector
[in]	blockSize	number of samples in each vector

Returns

none

void arm_offset_q15	(	const q15_t *	pSrc,
		q15_t	offset,
		q15_t *	pDst,
		uint32_t	blockSize
	)

Parameters

[in]	pSrc	points to the input vector
[in]	offset	is the offset to be added
[out]	pDst	points to the output vector
[in]	blockSize	number 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_offset_q31	(	const q31_t *	pSrc,
		q31_t	offset,
		q31_t *	pDst,
		uint32_t	blockSize
	)

Parameters

[in]	pSrc	points to the input vector
[in]	offset	is the offset to be added
[out]	pDst	points to the output vector
[in]	blockSize	number of samples in each 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_offset_q7	(	const q7_t *	pSrc,
		q7_t	offset,
		q7_t *	pDst,
		uint32_t	blockSize
	)

Parameters

[in]	pSrc	points to the input vector
[in]	offset	is the offset to be added
[out]	pDst	points to the output vector
[in]	blockSize	number of samples in each vector

Returns

none

Scaling and Overflow Behavior

The function uses saturating arithmetic. Results outside of the allowable Q7 range [0x80 0x7F] are saturated.