math (slug)

slug.math

slug.math — numeric utilities

Mathematical functions for common numeric operations including rounding, extrema, statistics, and random number generation.

TOC

• ceil(n)
• clampZero(n)
• floor(n)
• max(nil)
• mean(xs)
• min(a, b)
• percentileSorted(xs, p)
• rndRange(min, max)
• sqrt(n)
• stdev(xs, mean)

Functions

ceil(n)

fn slug.math#ceil(@num n) -> @num

returns the least integer greater than or equal to n.

Examples

ceil(1)  // => 1
ceil(1.2)  // => 2
ceil(-1.2)  // => -1

clampZero(n)

fn slug.math#clampZero(@num n) -> @num

returns n if it is >= 0, otherwise returns 0.

Useful for ensuring subtracted values never go negative.

floor(n)

fn slug.math#floor(@num n) -> @num

returns the greatest integer less than or equal to n.

Examples

floor(1)  // => 1
floor(1.2)  // => 1
floor(-1.2)  // => -2

max(nil)

fn slug.math#max(nil) -> @num

returns the largest of two or more numbers.

Accepts a variadic list of additional values beyond the required first two. nil

Examples

max(1, 2, 3)  // => 3
max(7, 9, 8)  // => 9
max(4, 5, 3)  // => 5

mean(xs)

fn slug.math#mean(xs) -> @num

returns the arithmetic mean of a list of numbers.

Returns 0 for an empty list.

min(a, b)

fn slug.math#min(@num a, ...b) -> @num

returns the smallest of two or more numbers.

Examples

min(1, 2, 3)  // => 1
min(4, 3, 5)  // => 3
min(6, 5, 4)  // => 4

percentileSorted(xs, p)

fn slug.math#percentileSorted(xs, p) -> @num

returns the pth percentile of a pre-sorted ascending list.

Uses linear interpolation between adjacent values. The list must be sorted in ascending order before calling — use slug.list#sort or slug.benchmark’s internal sortAsc if needed.

Returns 0 for an empty list and the single element for a one-element list.

rndRange(min, max)

fn slug.math#rndRange(@num min, @num max) -> @num

returns a random integer in the range [min, max) (exclusive upper bound).

@effects(‘random’)

Effects: random

sqrt(n)

fn slug.math#sqrt(@num n) -> @num

returns the square root of n.

Returns NaN for negative values.

Examples

sqrt(0)  // => 0
sqrt(4)  // => 2
sqrt(9)  // => 3

stdev(xs, mean)

fn slug.math#stdev(xs, mean) -> @num

returns the sample standard deviation of a list of numbers.

Uses Bessel’s correction (divides by n - 1). Returns 0 for lists with fewer than two elements. Requires the precomputed mean as a second argument to avoid recomputing it internally.