math.atan2() function

Warning! This page documents an earlier version of Flux, which is no longer actively developed. Flux v0.50 is the most recent stable version of Flux.

The math.atan2() function returns the arc tangent of y/x, using the signs of the two to determine the quadrant of the return value.

Output data type: Float

import "math"

math.atan2(y: 1.22, x: 3.14)

// Returns 0.3705838802763881

Parameters

y

The y coordinate used in the operation.

Data type: Float

x

The x coordinate used in the operation.

Data type: Float

Special cases

math.atan2(y:y, x:NaN)        // Returns NaN
math.atan2(y: NaN, x:x)       // Returns NaN
math.atan2(y: +0, x: >=0)     // Returns +0
math.atan2(y: -0, x: >=0)     // Returns -0
math.atan2(y: +0, x: <=-0)    // Returns +Pi
math.atan2(y: -0, x: <=-0)    // Returns -Pi
math.atan2(y: >0, x: 0)       // Returns +Pi/2
math.atan2(y: <0, x: 0)       // Returns -Pi/2
math.atan2(y: +Inf, x: +Inf)  // Returns +Pi/4
math.atan2(y: -Inf, x: +Inf)  // Returns -Pi/4
math.atan2(y: +Inf, x: -Inf)  // Returns 3Pi/4
math.atan2(y: -Inf, x: -Inf)  // Returns -3Pi/4
math.atan2(y:y, x: +Inf)      // Returns 0
math.atan2(y: >0, x: -Inf)    // Returns +Pi
math.atan2(y: <0, x: -Inf)    // Returns -Pi
math.atan2(y: +Inf, x:x)      // Returns +Pi/2
math.atan2(y: -Inf, x:x)      // Returns -Pi/2