Vector Clipping

Functions
void	zdsp_clip_f32 (const float32_t *src, float32_t *dst, float32_t low, float32_t high, uint32_t num_samples)
	Elementwise floating-point clipping.
void	zdsp_clip_q31 (const q31_t *src, q31_t *dst, q31_t low, q31_t high, uint32_t num_samples)
	Elementwise fixed-point clipping.
void	zdsp_clip_q15 (const q15_t *src, q15_t *dst, q15_t low, q15_t high, uint32_t num_samples)
	Elementwise fixed-point clipping.
void	zdsp_clip_q7 (const q7_t *src, q7_t *dst, q7_t low, q7_t high, uint32_t num_samples)
	Elementwise fixed-point clipping.
DSP_FUNC_SCOPE void	zdsp_clip_f16 (const float16_t *src, float16_t *dst, float16_t low, float16_t high, uint32_t num_samples)
	Elementwise floating-point clipping.

Detailed Description

Element-by-element clipping of a value.

The value is constrained between 2 bounds.

There are separate functions for floating-point, Q7, Q15, and Q31 data types.

Function Documentation

zdsp_clip_f16()

DSP_FUNC_SCOPE void zdsp_clip_f16	(	const float16_t *	src,
		float16_t *	dst,
		float16_t	low,
		float16_t	high,
		uint32_t	num_samples )

#include <zephyr/dsp/basicmath_f16.h>

Elementwise floating-point clipping.

Parameters

[in]	src	points to input values
[out]	dst	points to output clipped values
[in]	low	lower bound
[in]	high	higher bound
[in]	num_samples	number of samples to clip

zdsp_clip_f32()

void zdsp_clip_f32	(	const float32_t *	src,
		float32_t *	dst,
		float32_t	low,
		float32_t	high,
		uint32_t	num_samples )

#include <zephyr/dsp/basicmath.h>

Elementwise floating-point clipping.

Parameters

[in]	src	points to input values
[out]	dst	points to output clipped values
[in]	low	lower bound
[in]	high	higher bound
[in]	num_samples	number of samples to clip

zdsp_clip_q15()

void zdsp_clip_q15	(	const q15_t *	src,
		q15_t *	dst,
		q15_t	low,
		q15_t	high,
		uint32_t	num_samples )

#include <zephyr/dsp/basicmath.h>

Elementwise fixed-point clipping.

Parameters

[in]	src	points to input values
[out]	dst	points to output clipped values
[in]	low	lower bound
[in]	high	higher bound
[in]	num_samples	number of samples to clip

zdsp_clip_q31()

void zdsp_clip_q31	(	const q31_t *	src,
		q31_t *	dst,
		q31_t	low,
		q31_t	high,
		uint32_t	num_samples )

#include <zephyr/dsp/basicmath.h>

Elementwise fixed-point clipping.

Parameters

[in]	src	points to input values
[out]	dst	points to output clipped values
[in]	low	lower bound
[in]	high	higher bound
[in]	num_samples	number of samples to clip

zdsp_clip_q7()

void zdsp_clip_q7	(	const q7_t *	src,
		q7_t *	dst,
		q7_t	low,
		q7_t	high,
		uint32_t	num_samples )

#include <zephyr/dsp/basicmath.h>

Elementwise fixed-point clipping.

Parameters

[in]	src	points to input values
[out]	dst	points to output clipped values
[in]	low	lower bound
[in]	high	higher bound
[in]	num_samples	number of samples to clip