c050739f41
* Show a more reasonable name in function docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix buggy docs for union types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Make types in the docs signatures into links Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
45 lines
60 KiB
Markdown
45 lines
60 KiB
Markdown
---
|
|
title: "std::math::max"
|
|
excerpt: "Compute the maximum of the given arguments."
|
|
layout: manual
|
|
---
|
|
|
|
Compute the maximum of the given arguments.
|
|
|
|
|
|
|
|
```kcl
|
|
max(@input: [[number](/docs/kcl/types/number); 1+]): [number](/docs/kcl/types/number)
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `input` | `[number; 1+]` | An array of numbers to compute the maximum of. | Yes |
|
|
|
|
### Returns
|
|
|
|
[`number`](/docs/kcl/types/number)
|
|
|
|
|
|
### Examples
|
|
|
|
```kcl
|
|
exampleSketch = startSketchOn(XZ)
|
|
|> startProfile(at = [0, 0])
|
|
|> angledLine(
|
|
angle = 70,
|
|
length = max([15, 31, 4, 13, 22])
|
|
)
|
|
|> line(end = [20, 0])
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 5)
|
|
```
|
|
|
|
|
|
|
|
|