Arc Tangent

Collaboration diagram for Arc Tangent:

Functions
f32_t	tpt_atan_f32 (f32_t aInData)
	Calculate the arctangent value of a given number. More...
f64_t	tpt_atan_f64 (f64_t aInData)
	Calculate the arctangent value of a given number. More...
q15_t	tpt_atan_q15 (q15_t aInData)
	Calculate the arctangent value of a given number. More...
q31_t	tpt_atan_q31 (q31_t aInData)
	Calculate the arctangent value of a given number. More...

Detailed Description

Arc tangent functions are the inverse 0f trigonometric functions which return the inverse of tangent given an input value. The input values and output results of arc tangent functions are in radians and the output results are always in the range [-pi/2, pi/2]

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

Function Documentation

tpt_atan_f32()

f32_t tpt_atan_f32

(

f32_t

aInData

)

Calculate the arctangent value of a given number.

Parameters

[in]

aInData

the input value.

Returns

f32_t arctan value of the input.

tpt_atan_f64()

f64_t tpt_atan_f64

(

f64_t

aInData

)

Calculate the arctangent value of a given number.

Parameters

[in]

aInData

the input value.

Returns

f32_t arctan value of the input.

tpt_atan_q15()

q15_t tpt_atan_q15

(

q15_t

aInData

)

Calculate the arctangent value of a given number.

Parameters

[in]

aInData

the input value.

Returns

q15_t arctan value of the input.

Calculate the arctangent value of a given number.

Parameters

[in]

src

the input value.

Returns

arctan value of the input.

Function notes: The input argument is tangent of the radian to be returned. It is scaled as Q(RES_LOGN).15-(RES_LOGN). For example, it is Q8.7 if RES_N = 256. The returned value falls in the range of [-PI / 2, PI / 2) scaled as depending on global symbol FOUR_PI_RANGE: 1> defined: [-0.25, 0.25) 2> otherwise: [-0.5, 0.5)

tpt_atan_q31()

q31_t tpt_atan_q31

(

q31_t

aInData

)

Calculate the arctangent value of a given number.

Parameters

[in]

aInData

the input value.

Returns

q31_t arctan value of the input.

Calculate the arctangent value of a given number.

Parameters

[in]

src

the input value.

Returns

arctan value of the input.

Function notes: The input argument is tangent of the radian to be returned. It is scaled as Q(RES_LOGN).31-(RES_LOGN). For example, it is Q8.23 if RES_N = 256. The returned value falls in the range of [-PI / 2, PI / 2) scaled as depending on global symbol FOUR_PI_RANGE: 1> defined: [-0.25, 0.25) 2> otherwise: [-0.5, 0.5)