Packages > pkl

pkl.math0.26.2

Overview
Properties
Methods

module pkl.math

Basic mathematical constants and functions.

Module URI:: pkl:math
Pkl version:: 0.26.1 or higher
Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

minInt: Int

The minimum Int value: -9223372036854775808.
link

minInt8: Int8

The minimum Int8 value: -128.
link

minInt16: Int16

The minimum Int16 value: -32768.
link

minInt32: Int32

The minimum Int32 value: -2147483648.
link

maxInt: Int

The maximum Int value: 9223372036854775807.
link

maxInt8: Int8

The maximum Int8 value: 127.
link

maxInt16: Int16

The maximum Int16 value: 32767.
link

maxInt32: Int32

The maximum Int32 value: 2147483647.
link

maxUInt: UInt

The maximum UInt value: 9223372036854775807.

Note that maxUInt is equal to maxInt, not maxInt * 2 + 1 as one might expect. That is, UInt has half the range of Int.
link

maxUInt8: UInt8

The maximum UInt8 value: 255.
link

maxUInt16: UInt16

The maximum UInt16 value: 65535.
link

maxUInt32: UInt32

The maximum UInt32 value: 4294967295.
link

minFiniteFloat: Float

The minimum finite Float value: -1.7976931348623157e308.

Operations whose value is less than minFiniteFloat return -infinity.
link

maxFiniteFloat: Float

The maximum finite Float value: 1.7976931348623157e308.

Operations whose value is greater than maxFiniteFloat return infinity.
link

minPositiveFloat: Float

The minimum positive Float value that is greater than zero: 4.9e-324.
link

e: Float

The number e.
link

pi: Float

The number π.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```
link

function

exp(exponent: Number): Float

Returns e raised to the power of exponent.
link

function

sqrt(x: Number): Float

Returns the square root of x.
link

function

cbrt(x: Number): Float

Returns the cube root of x.
link

function

log(x: Number): Float

Returns the natural logarithm (base e logarithm) of x.
link

function

log2(x: Number): Float

Returns the base 2 logarithm of x.
link

function

log10(x: Number): Float

Returns the base 10 logarithm of x.
link

function

sin(angle: Number): Float

Returns the sine of angle given in radians.
link

function

cos(angle: Number): Float

Returns the cosine of angle given in radians.
link

function

tan(angle: Number): Float

Returns the tangent of angle given in radians.
link

function

asin(x: Number): Float

Returns the arcsine of x.
link

function

acos(x: Number): Float

Returns the arccosine of x.
link

function

atan(x: Number): Float

Returns the arctangent of x.
link

function

gcd(x: Int, y: Int): Int

Returns the greatest common divisor of x and y.
link

function

lcm(x: Int, y: Int): Int

Returns the least common multiple of x and y.
link

function

isPowerOfTwo(x: Number): Boolean

Returns true if x is a power of two.
link

function

min(x: Number, y: Number): Number

Returns the minimum of x and y.
link

function

max(x: Number, y: Number): Number

Returns the maximum of x and y.