42 lines
760 B
Markdown
42 lines
760 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(_)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
|
|
|
|
### Returns
|
|
|
|
[`number(rad)`](/docs/kcl-std/types/std-types-number) - A number.
|
|
|
|
|
|
### 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)
|
|
|
|
```
|
|
|
|
|
|
|