57 lines
1.1 KiB
Markdown
57 lines
1.1 KiB
Markdown
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
|
|
|
# Function atan2
|
|
|
|
Calculate the inverse tangent function with two arguments, y/x.
|
|
By providing two arguments, the right quadrant of the computed angle can be
|
|
determined.
|
|
|
|
For matrices, the function is evaluated element wise.
|
|
|
|
|
|
## Syntax
|
|
|
|
```js
|
|
math.atan2(y, x)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Parameter | Type | Description
|
|
--------- | ---- | -----------
|
|
`y` | number | Array | Matrix | Second dimension
|
|
`x` | number | Array | Matrix | First dimension
|
|
|
|
### Returns
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
number | Array | Matrix | Four-quadrant inverse tangent
|
|
|
|
|
|
### Throws
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
|
|
|
|
## Examples
|
|
|
|
```js
|
|
math.atan2(2, 2) / math.pi // returns number 0.25
|
|
|
|
const angle = math.unit(60, 'deg') // returns Unit 60 deg
|
|
const x = math.cos(angle)
|
|
const y = math.sin(angle)
|
|
|
|
math.atan(2) // returns Complex 1.5707963267948966 -1.3169578969248166 i
|
|
```
|
|
|
|
|
|
## See also
|
|
|
|
[tan](tan.md),
|
|
[atan](atan.md),
|
|
[sin](sin.md),
|
|
[cos](cos.md)
|