Vector Offset

Collaboration diagram for Vector Offset:

Functions
void	tpt_offset_f32 (f32_t *__restrict aOutData, const f32_t *__restrict aInData, f32_t aOffset, uint32_t aCount)
	Adds a constant offset to a floating-point vector. More...
void	tpt_offset_f64 (f64_t *__restrict aOutData, const f64_t *__restrict aInData, f64_t aOffset, uint32_t aCount)
	Adds a constant offset to a floating-point vector. More...
void	tpt_offset_q15 (q15_t *__restrict aOutData, const q15_t *__restrict aInData, q15_t aOffset, uint32_t aCount)
	Adds a constant offset to a Q15 vector. More...
void	tpt_offset_q31 (q31_t *__restrict aOutData, const q31_t *__restrict aInData, q31_t aOffset, uint32_t aCount)
	Adds a constant offset to a Q31 vector. More...
void	tpt_offset_q7 (q7_t *__restrict aOutData, const q7_t *__restrict aInData, q7_t aOffset, uint32_t aCount)
	Adds a constant offset to a Q7 vector. More...
static uint32_t	sat_u32_to_u8 (q31_t src)
	Adds a constant offset to a U8 vector. More...
void	tpt_offset_u8 (uint8_t *__restrict aOutData, const uint8_t *__restrict aInData, q7_t aOffset, uint32_t aCount)
	Adds a constant offset to a U8 vector. More...
void	tpt_scale_u8 (uint8_t *__restrict aOutData, const uint8_t *__restrict aInData, q7_t aScaleFract, int8_t aShift, uint32_t aCount)
	To multiply a u8 vectors by a q7 scale. More...
void	tpt_shift_u8 (uint8_t *__restrict aOutData, const uint8_t *__restrict aInData, int8_t aShiftBits, uint32_t aCount)
	Shifts the elements of a U8 vector a specified number of bits. More...

Detailed Description

Adds a constant offset to each element of a vector.

    aOutData[n] = aInData[n] + aOffset,   0 <= n < aCount.
  

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

sat_u32_to_u8()

static uint32_t sat_u32_to_u8 ( q31_t  src )

inlinestatic

Adds a constant offset to a U8 vector.

Parameters

[out]	aOutData	points to the output vector
[in]	aInData	points to the input vector
[in]	aOffset	is the offset to be added
[in]	aCount	number of samples in the vector

Returns

none

Output results are saturated in U8 range [0x00 0xFF]

tpt_offset_f32()

void tpt_offset_f32	(	f32_t *__restrict	aOutData,
		const f32_t *__restrict	aInData,
		f32_t	aOffset,
		uint32_t	aCount
	)

Adds a constant offset to a floating-point vector.

Parameters

[out]	aOutData	points to the output vector
[in]	aInData	points to the input vector
[in]	aOffset	is the offset to be added
[in]	aCount	number of samples in the vector

Returns

none

tpt_offset_f64()

void tpt_offset_f64	(	f64_t *__restrict	aOutData,
		const f64_t *__restrict	aInData,
		f64_t	aOffset,
		uint32_t	aCount
	)

Adds a constant offset to a floating-point vector.

Parameters

[out]	aOutData	points to the output vector
[in]	aInData	points to the input vector
[in]	aOffset	is the offset to be added
[in]	aCount	number of samples in the vector

Returns

none

tpt_offset_q15()

void tpt_offset_q15	(	q15_t *__restrict	aOutData,
		const q15_t *__restrict	aInData,
		q15_t	aOffset,
		uint32_t	aCount
	)

Adds a constant offset to a Q15 vector.

Parameters

[out]	aOutData	points to the output vector
[in]	aInData	points to the input vector
[in]	aOffset	is the offset to be added
[in]	aCount	number 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.

tpt_offset_q31()

void tpt_offset_q31	(	q31_t *__restrict	aOutData,
		const q31_t *__restrict	aInData,
		q31_t	aOffset,
		uint32_t	aCount
	)

Adds a constant offset to a Q31 vector.

Parameters

[out]	aOutData	points to the output vector
[in]	aInData	points to the input vector
[in]	aOffset	is the offset to be added
[in]	aCount	number 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.

tpt_offset_q7()

void tpt_offset_q7	(	q7_t *__restrict	aOutData,
		const q7_t *__restrict	aInData,
		q7_t	aOffset,
		uint32_t	aCount
	)

Adds a constant offset to a Q7 vector.

Parameters

[out]	aOutData	points to the output vector
[in]	aInData	points to the input vector
[in]	aOffset	is the offset to be added
[in]	aCount	number 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.

tpt_offset_u8()

void tpt_offset_u8	(	uint8_t *__restrict	aOutData,
		const uint8_t *__restrict	aInData,
		q7_t	aOffset,
		uint32_t	aCount
	)

Adds a constant offset to a U8 vector.

Parameters

[out]	aOutData	points to the output vector
[in]	aInData	points to the input vector
[in]	aOffset	is the offset to be added
[in]	aCount	number of samples in the vector

Returns

none

tpt_scale_u8()

void tpt_scale_u8	(	uint8_t *__restrict	aOutData,
		const uint8_t *__restrict	aInData,
		q7_t	aScaleFract,
		int8_t	aShift,
		uint32_t	aCount
	)

To multiply a u8 vectors by a q7 scale.

Parameters

[out]	aOutData	points to the output vector
[in]	aInData	points to the input vector
[in]	aScaleFract	fractional portion of the scale value
[in]	aShift	number of bits to shift
[in]	aCount	number of samples in the vector

Returns

none

tpt_shift_u8()

void tpt_shift_u8	(	uint8_t *__restrict	aOutData,
		const uint8_t *__restrict	aInData,
		int8_t	aShiftBits,
		uint32_t	aCount
	)

Shifts the elements of a U8 vector a specified number of bits.

Parameters

[out]	aOutData	points to the output vector
[in]	aInData	points to the input vector
[in]	aShiftBits	number of bits to shift. A positive value shifts left; a negative value shifts right
[in]	aCount	number of samples in each vector

Returns

none