Skip to content

Commit 53e3e33

Browse files
Improved documentation for issue ARM-software#156
1 parent 0d49aa6 commit 53e3e33

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

Source/FastMathFunctions/arm_atan2_f16.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ __STATIC_FORCEINLINE float16_t arm_atan_f16(float16_t x)
113113
114114
@par Compute the Arc tangent of y/x:
115115
The sign of y and x are used to determine the right quadrant
116-
and compute the right angle.
116+
and compute the right angle. Returned value is between -Pi and Pi.
117117
118118
*/
119119
arm_status arm_atan2_f16(float16_t y,float16_t x,float16_t *result)

Source/FastMathFunctions/arm_atan2_f32.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ __STATIC_FORCEINLINE float32_t arm_atan_f32(float32_t x)
125125
126126
@par Compute the Arc tangent of y/x:
127127
The sign of y and x are used to determine the right quadrant
128-
and compute the right angle.
128+
and compute the right angle. Returned value is between -Pi and Pi.
129129
*/
130130

131131

Source/FastMathFunctions/arm_atan2_q15.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ __STATIC_FORCEINLINE q15_t arm_atan_q15(q15_t y,q15_t x)
178178
179179
@par Compute the Arc tangent of y/x:
180180
The sign of y and x are used to determine the right quadrant
181-
and compute the right angle.
181+
and compute the right angle. Returned value is between -Pi and Pi.
182182
*/
183183

184184

Source/FastMathFunctions/arm_atan2_q31.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ __STATIC_FORCEINLINE q31_t arm_atan_q31(q31_t y,q31_t x)
178178
179179
@par Compute the Arc tangent of y/x:
180180
The sign of y and x are used to determine the right quadrant
181-
and compute the right angle.
181+
and compute the right angle. Returned value is between -Pi and Pi.
182182
*/
183183

184184

0 commit comments

Comments
 (0)