Arc Tangent 2

Collaboration diagram for Arc Tangent 2:

Functions
f32_t	tpt_atan2_f32 (f32_t y, f32_t x)
	Arc tangent in radian of y/x using sign of x and y to determine right quadrant. More...
f64_t	tpt_atan2_f64 (f64_t y, f64_t x)
	Arc tangent in radian of y/x using sign of x and y to determine right quadrant. More...
q15_t	tpt_atan2_q15 (q15_t y, q15_t x)
	Arc tangent in radian of y/x using sign of x and y to determine right quadrant. More...
q31_t	tpt_atan2_q31 (q31_t y, q31_t x)
	Arc tangent in radian of y/x using sign of x and y to determine right quadrant. More...

Detailed Description

Arc tangent 2 functions are similar to arc tangent functions but accept two inputs y and x to compute the inverse tangent value. Normally, the output results are all in radians and always in the range [-pi, pi]. For convenient calculation, they are mapped to [-1, 1) in Q number functions, but you can use conversion formulas to convert them to their single-precision floating-point counterparts.

TPT DSP library supports distinct arc tangent 2 functions for single-precision floating-point, Q31 and Q15 data types. These functions are introduced in the subsections below.

Function Documentation

tpt_atan2_f32()

f32_t tpt_atan2_f32	(	f32_t	y,
		f32_t	x
	)

Arc tangent in radian of y/x using sign of x and y to determine right quadrant.

Parameters

[in]	y	input value y
[in]	x	input value x

Returns

f32_t Radian value

tpt_atan2_f64()

f64_t tpt_atan2_f64	(	f64_t	y,
		f64_t	x
	)

Arc tangent in radian of y/x using sign of x and y to determine right quadrant.

Parameters

[in]	y	input value y
[in]	x	input value x

Returns

f32_t Radian value

tpt_atan2_q15()

q15_t tpt_atan2_q15	(	q15_t	y,
		q15_t	x
	)

Arc tangent in radian of y/x using sign of x and y to determine right quadrant.

Parameters

[in]	y	input value y
[in]	x	input value x

Returns

q15_t Radian value

tpt_atan2_q31()

q31_t tpt_atan2_q31	(	q31_t	y,
		q31_t	x
	)

Arc tangent in radian of y/x using sign of x and y to determine right quadrant.

Parameters

[in]	y	input value y
[in]	x	input value x

Returns

q31_t Radian value