math

Calculates the angle between two points.

Returns the difference between two angles.

Returns the normalised angle between two points.

Gradually approaches the target value by the specified amount.

Returns the arc tangent of y/x.

Returns the arithmetic mean of the given numbers.

Returns a function that bucketizes a number.

Returns the cube root of the given number.

Clamps a number between a minimum and maximum value.

Returns x with the same sign as y.

Returns the cotangent of the given angle.

Calculates the direction between two points.

Calculates the euclidean modulus.

Returns the floor division of two numbers.

Returns m and e such that x = m2e, e is an integer and the absolute value of m is in the range ((0.5, 1) (or zero when x is zero).

Used to split the number value into a normalized fraction and an exponent. Two values are returned: the first is a multiplier in the range 1/2 (inclusive) to 1 (exclusive) and the second is an integer exponent.

The result is such that x = m*2^e.

Returns the square root of the sum of squares of its arguments.

Performs an inverse linear interpolation from the start number to the end number.

Checks if a number is in a range.

Checks if a number is divisible by another number without remainder.

Checks if a number is even.

Checks if a number is finite.

Checks if a number is a float point number.

Checks if a number is positive or negative infinity.

Checks if a number is an signed integer.

Checks if a number is NaN.

Checks if a number is negative.

Checks if a number is odd.

Checks if a number is positive.

Check if a value is a power-of-two.

Checks if a number is an unsigned integer.

Takes a normalised number and returns the floating point representation.

Effectively it returns the result of normalizedFraction * 2.0 ^ exponent.

Returns the length of the integer.

Performs a linear interpolation from the start number to the end number.

Returns the natural logarithm of the given number.

Returns x if its absolute value is equal to or greater than size, otherwise returns 0.

Calculates the magnitude (distance) between two points.

Returns a random floating point number in the range [a, b).

Normalizes a start_position/end_position pair against length, same rules as string.sub.

Negative positions count back from the end, start_position is clamped to >= 1 and end_position to [0, length].

An empty range is returned as start_position > end_position.

Translate a relative position, negative means back from end.

Remaps a number from one range to another.

Returns the root of a given number with a given base.

Rounds the given value to the nearest whole number or to the given decimal places.

Performs a smooth interpolation from the start number to the end number.

Returns the smallest integer greater than or equal to the given number.

Check if value is equal or greater than threshold.

NOTE: This is useful to mitigate accuracy issues in floating point numbers.

Examples:

local a = 10
local b = 13.3

if math.threshold( a - b, 4 ) then
    print( "yes" )
else
    print( "no" )
end

-- print: `no` because difference between a and b is not so far from 4

Converts a number to a float32.

Converts an signed integer with a sign to an integer.

Converts a number to a 32-bit signed integer.

Check if value is equal or less than threshold.

NOTE: This is useful to mitigate accuracy issues in floating point numbers.

Examples:

local a = 10
local b = 13.3

if math.tolerance( a - b, 4 ) then
    print( "yes" )
else
    print( "no" )
end

-- print: `yes` because difference between a and b is near of 4

Converts an integer with a sign to an unsigned integer.

Converts a number to a 32-bit unsigned integer.

Returns the integer part of the given number, rounding towards zero.

NOTE: Same result as (math.modf( x )), but math.modf is ~10x slower under JIT.

Returns x if its absolute value is equal to or less than size, otherwise returns 0.

Useful for ignoring extreme spikes or outliers in values.

Wraps a number to keep it within a specific minimum and maximum range.