Files
modeling-app/docs/kcl/std-math-max.md
Nick Cameron c050739f41 Some improvements to the boxed signatures in the docs (#6593)
* 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>
2025-04-30 16:03:22 +00:00

60 KiB

title, excerpt, layout
title excerpt layout
std::math::max Compute the maximum of the given arguments. manual

Compute the maximum of the given arguments.

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

Examples

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)

Rendered example of std::math::max 0