2fee3a424c
* Fix various docs errors around std module Signed-off-by: Nick Cameron <nrc@ncameron.org> * remove KCL from lang docs titles and move settings docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Include functions declared in Rust in module docs Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
44 lines
671 B
Markdown
44 lines
671 B
Markdown
---
|
|
title: "atan"
|
|
subtitle: "Function in std::math"
|
|
excerpt: "Compute the arctangent of a number."
|
|
layout: manual
|
|
---
|
|
|
|
Compute the arctangent of a number.
|
|
|
|
```kcl
|
|
atan(@num: number(_)): number(rad)
|
|
```
|
|
|
|
Consider using `atan2()` instead for the true inverse of tangent.
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `num` | `number(_)` | | Yes |
|
|
|
|
### Returns
|
|
|
|
`number(rad)`
|
|
|
|
|
|
### Examples
|
|
|
|
```kcl
|
|
sketch001 = startSketchOn(XZ)
|
|
|> startProfile(at = [0, 0])
|
|
|> angledLine(
|
|
angle = atan(1.25),
|
|
length = 20,
|
|
)
|
|
|> yLine(endAbsolute = 0)
|
|
|> close()
|
|
|
|
extrude001 = extrude(sketch001, length = 5)
|
|
```
|
|
|
|
|
|
|