pMath is a small set of math functions.
Dependencies: None.
local pMath = require("p_math")
print(pMath.clamp(100, 1, 50)) --> 50API
pMath.clamp
Clamps a number to a range.
local clamped = pMath.clamp(n, a, b)-
n: The number to clamp. -
a: The minimum value. -
b: The maximum value.
Returns: The clamped value.
Notes
If the minimum is greater than the maximum, then this function will return the minimum.
pMath.dist
Gets the distance between two points.
local dist = pMath.dist(x1, y1, x2, y2)-
x1,y1: The first point. -
x2,y2: The second point.
Returns: The distance.
Notes
Taken from lume.
pMath.distSq
Gets the squared distance between two points.
local dist_sq = pMath.distSq(x1, y1, x2, y2)-
x1,y1: The first point. -
x2,y2: The second point.
Returns: The squared distance.
Notes
Taken from lume.
This function skips pMath.dist's call to math.sqrt. It may be faster when comparing the distances of two sets of points.
pMath.lerp
Gets a value between two numbers, using linear interpolation.
local lerped = pMath.lerp(a, b, v)-
a: The first point. -
b: The second point. -
v: The input value, between 0.0 and 1.0.
Returns: The interpolated value.
Notes
This function does not clamp the input value.
pMath.roundInf
Rounds a number toward infinity. 0.5 rounds to 1.0; -0.5 rounds to -1.0.
local rounded = pMath.roundInf(n)-
n: The number to round.
Returns: The rounded number.
Notes
See Module Notes: Rounding Error.
pMath.roundInfIncrement
Rounds a number toward infinity. Like pMath.roundInf, but with support for increments other than 1.
local rounded = roundInfIncrement(n, incr)-
n: The number to round. -
incr: The increment.
Returns: The rounded number.
Notes
Taken from lume.
See Module Notes: Rounding Error.
pMath.sign
Gets the sign of a number.
local s = pMath.sign(n)-
n: The number to check.
Returns: -1 if the number is less than zero, 1 if the number is greater than zero, or 0 if the number is zero.
pMath.signN
Gets the sign of a number, treating zero as negative.
local sign = pMath.signN(n)-
n: The number to check.
Returns: -1 if the number is zero or less, 1 if the number is greater than zero.
pMath.signP
Gets the sign of a number, treating zero as positive.
local s = pMath.signP(n)-
n: The number to check.
Returns: -1 if the number is less than zero, 1 if the number is zero or greater.
pMath.wrap1
Wraps a one-indexed number using the modulo operator.
local wrapped = pMath.wrap1(n, max)-
n: The number to wrap. -
max: The maximum to use with modulo. Should be 1 or greater.
Returns: The wrapped number.
Notes
Intended for Lua array indices.
A max of zero will produce NaN.
Module Notes
Rounding Error
pMath.roundInf and pMath.roundInfIncrement are susceptible to floating point rounding error when the input is extremely close to, but not exactly 0.5 or -0.5:
print(pMath.roundInf(0.49999999999999994)) --> 1
print(pMath.roundInf(-0.49999999999999994)) --> -1VERSION: 2.106