Files
modeling-app/docs/kcl/std-math-log.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

77 KiB

title, excerpt, layout
title excerpt layout
std::math::log Compute the logarithm of the number with respect to an arbitrary base. manual

Compute the logarithm of the number with respect to an arbitrary base.

The result might not be correctly rounded owing to implementation details; log2 can produce more accurate results for base 2, and log10 can produce more accurate results for base 10.

log(
  @input: [number](/docs/kcl/types/number),
  base: [number](/docs/kcl/types/number)(_),
): [number](/docs/kcl/types/number)

Arguments

Name Type Description Required
input number The number to compute the logarithm of. Yes
base number(_) The base of the logarithm. Yes

Returns

number

Examples

exampleSketch = startSketchOn(XZ)
  |> startProfile(at = [0, 0])
  |> line(end = [log(100, base = 5), 0])
  |> line(end = [5, 8])
  |> line(end = [-10, 0])
  |> close()

example = extrude(exampleSketch, length = 5)

Rendered example of std::math::log 0