Utils.math module

Extends Lua 5.2 math.

See also

Usage

local math = require('__stdlib__/stdlib/utils/math')

Functions

Math.round(x)	Round a number.
Math.sum(...)	Calculates the sum of a sequence of values.
Math.arithmetic_mean(x)	Calculates the arithmetic mean of a set of values.
Math.geometric_mean(x)	Calculates the geometric mean of a set of values.
Math.harmonic_mean(...)	Calculates the harmonic mean of a set of values.
Math.quadratic_mean(...)	Calculates the quadratic mean of a set of values.
Math.generalized_mean(p, ...)	Calculates the generalized mean (to a specified power) of a set of values.
Math.weighted_mean(x, w)	Calculates the weighted mean of a set of values.
Math.midrange_mean(x)	Calculates the midrange mean of a set of values.
Math.energetic_mean(x)	Calculates the energetic mean of a set of values.
Math.clamp(x[, min=0][, max=1])	Returns the number x clamped between the numbers min and max.
Math.lerp(a, b, amount)	Linear interpolation or 2 numbers.
Math.smooth(a, b, amount)	Smooth.
Math.approximately(a, b)	Approximately the same
Math.is_number(x)	Is x a number.
Math.is_integer(x)	Is x an integer.
Math.is_unsigned(x)	Is x unsigned.

Functions

# Math.round(x)

Round a number.

Parameters:

• x : (number)

Returns:

• (number) the rounded number

# Math.sum(...)

Calculates the sum of a sequence of values.

Parameters:

• ... : (tuple) a tuple of numbers

Returns:

• (the) sum

# Math.arithmetic_mean(x)

Calculates the arithmetic mean of a set of values.

Parameters:

• x : (array) an array of numbers

Returns:

• (number) the arithmetic mean

# Math.geometric_mean(x)

Calculates the geometric mean of a set of values.

Parameters:

• x : (array) an array of numbers

Returns:

• (number) the geometric mean

# Math.harmonic_mean(...)

Calculates the harmonic mean of a set of values.

Parameters:

• ... : (tuple) an array of numbers

Returns:

• (number) the harmonic mean

# Math.quadratic_mean(...)

Calculates the quadratic mean of a set of values.

Parameters:

• ... : (tuple) an array of numbers

Returns:

• (number) the quadratic mean

# Math.generalized_mean(p, ...)

Calculates the generalized mean (to a specified power) of a set of values.

Parameters:

• p : (number) power
• ... : (tuple) an array of numbers

Returns:

• (number) the generalized mean

# Math.weighted_mean(x, w)

Calculates the weighted mean of a set of values.

Parameters:

• x : (array) an array of numbers
• w : (array) an array of number weights for each value

Returns:

• (number) the weighted mean

# Math.midrange_mean(x)

Calculates the midrange mean of a set of values.

Parameters:

• x : (array) an array of numbers

Returns:

• (number) the midrange mean

# Math.energetic_mean(x)

Calculates the energetic mean of a set of values.

Parameters:

• x : (array) an array of numbers

Returns:

• (number) the energetic mean

# Math.clamp(x[, min=0][, max=1])

Returns the number x clamped between the numbers min and max.

Parameters:

• x : (number)
• min : (number) (default: 0)
• max : (number) (default: 1)

Returns:

• (number) clamped between min and max

# Math.lerp(a, b, amount)

Linear interpolation or 2 numbers.

Parameters:

• a : (number)
• b : (number)
• amount : (float)

Returns:

• (number)

# Math.smooth(a, b, amount)

Smooth.

Parameters:

• a : (number)
• b : (number)
• amount : (float)

Returns:

• (number)

# Math.approximately(a, b)

Approximately the same

Parameters:

• a : (number)
• b : (number)

Returns:

• (boolean)

# Math.is_number(x)

Is x a number.

Parameters:

• x : (number)

Returns:

• (boolean)

# Math.is_integer(x)

Is x an integer.

Parameters:

• x : (number)

Returns:

• (boolean)

# Math.is_unsigned(x)

Is x unsigned.

Parameters:

• x : (number)

Returns:

• (boolean)