extra-math/index.d.ts

/**
 * Round down a number to specific precision.
 * [📘](https://github.com/nodef/extra-math/wiki/floor)
 * @param x a number
 * @param pre to precision (1)
 */
declare function floor(x: number, pre?: number): number;
/**
 * Round up a number to specific precision.
 * [📘](https://github.com/nodef/extra-math/wiki/ceil)
 * @param x a number
 * @param pre to precision [1]
 */
declare function ceil(x: number, pre?: number): number;
/**
 * Round a number to specific precision.
 * [📘](https://github.com/nodef/extra-math/wiki/round)
 * @param x a number
 * @param pre to precision [1]
 */
declare function round(x: number, pre?: number): number;
/**
 * Perform floor-divison of two numbers.
 * [📘](https://github.com/nodef/extra-math/wiki/floorDiv)
 * @param x divisor
 * @param y dividend
 * @returns ⌊x/y⌋
 */
declare function floorDiv(x: number, y: number): number;
/**
 * Perform ceiling-divison of two numbers.
 * [📘](https://github.com/nodef/extra-math/wiki/ceilDiv)
 * @param x divisor
 * @param y dividend
 * @returns ⌈x/y⌉
 */
declare function ceilDiv(x: number, y: number): number;
/**
 * Perform rounded-divison of two numbers.
 * [📘](https://github.com/nodef/extra-math/wiki/roundDiv)
 * @param x divisor
 * @param y dividend
 * @returns [x/y]
 */
declare function roundDiv(x: number, y: number): number;
/**
 * Find the remainder of x/y with sign of x (truncated division).
 * [📘](https://github.com/nodef/extra-math/wiki/rem)
 * @param x dividend
 * @param y divisor
 * @returns trunc(x % y)
 */
declare function rem(x: number, y: number): number;
/**
 * Find the remainder of x/y with sign of y (floored division).
 * [📘](https://github.com/nodef/extra-math/wiki/mod)
 * @param x dividend
 * @param y divisor
 * @returns floor(x % y)
 */
declare function mod(x: number, y: number): number;
/**
 * Find the remainder of x/y with +ve sign (euclidean division).
 * [📘](https://github.com/nodef/extra-math/wiki/modp)
 * @param x dividend
 * @param y divisor
 * @returns n>0: floor(x % y), n<0: ceil(x % y)
 */
declare function modp(x: number, y: number): number;
/**
 * Constrain a number within a minimum and a maximum value.
 * [📘](https://github.com/nodef/extra-math/wiki/constrain)
 * @param x a number
 * @param min minimum value
 * @param max maximum value
 * @returns x<min: min, x>max: max, x
 */
declare function constrain(x: number, min: number, max: number): number;

/**
 * Normalize a number from its current range into a value between 0 and 1.
 * [📘](https://github.com/nodef/extra-math/wiki/normalize)
 * @param x a number
 * @param r lower bound of current range
 * @param R upper bound of current range
 * @returns ∈ [0, 1]
 */
declare function normalize(x: number, r: number, R: number): number;

/**
 * Re-map a number from one range to another.
 * [📘](https://github.com/nodef/extra-math/wiki/remap)
 * @param x a number
 * @param r lower bound of current range
 * @param R upper bound of current range
 * @param t lower bound of target range
 * @param T upper bound of target range
 * @returns ∈ [ymin, ymax]
 */
declare function remap(x: number, r: number, R: number, t: number, T: number): number;

/**
 * Linearly interpolate a number between two numbers.
 * [📘](https://github.com/nodef/extra-math/wiki/lerp)
 * @param x start number
 * @param y stop number
 * @param t interpolant ∈ [0, 1]
 * @returns ∈ [x, y]
 */
declare function lerp(x: number, y: number, t: number): number;
/**
 * Check if a number is a power-of-n.
 * [📘](https://github.com/nodef/extra-math/wiki/isPow)
 * @param x a number
 * @param n base
 * @returns nⁱ = x? | i = +ve integer
 */
declare function isPow(x: number, n: number): boolean;
/**
 * Find largest power-of-n less than or equal to given number.
 * [📘](https://github.com/nodef/extra-math/wiki/prevPow)
 * @param x a number
 * @param n base
 * @returns nⁱ | nⁱ ≤ x and nⁱ > x/n
 */
declare function prevPow(x: number, n: number): number;
/**
 * Find smallest power-of-n greater than or equal to given number.
 * [📘](https://github.com/nodef/extra-math/wiki/nextPow)
 * @param x a number
 * @param n base
 * @returns nⁱ | nⁱ ≥ x and nⁱ < n*x
 */
declare function nextPow(x: number, n: number): number;
/**
 * Find the nth root of a number (ⁿ√).
 * [📘](https://github.com/nodef/extra-math/wiki/root)
 * @param x a number
 * @param n root
 * @returns ⁿ√x
 */
declare function root(x: number, n: number): number;
/**
 * Find the logarithm of a number with a given base.
 * [📘](https://github.com/nodef/extra-math/wiki/log)
 * @param x a number
 * @param b logarithm base [e]
 * @returns log_b (x)
 */
declare function log(x: number, b?: number): number;
/**
 * List all divisors of a number, except itself.
 * [📘](https://github.com/nodef/extra-math/wiki/properDivisors)
 * @param x a number
 * @returns proper divisors (factors)
 */
declare function properDivisors(x: number): number[];

/**
 * Sum all proper divisors of a number.
 * [📘](https://github.com/nodef/extra-math/wiki/aliquotSum)
 * @param x a number
 * @returns Σdᵢ | dᵢ is a divisor of x and ≠x
 */
declare function aliquotSum(x: number): number;
/**
 * Find the least prime number which divides a number.
 * [📘](https://github.com/nodef/extra-math/wiki/minPrimeFactor)
 * @param x a number
 * @returns least prime factor
 */
declare function minPrimeFactor(x: number): number;

/**
 * Find the greatest prime number which divides a number.
 * [📘](https://github.com/nodef/extra-math/wiki/maxPrimeFactor)
 * @param x a number
 * @returns greatest prime factor
 */
declare function maxPrimeFactor(x: number): number;

/**
 * Find the prime factors of a number.
 * [📘](https://github.com/nodef/extra-math/wiki/primeFactors)
 * @param x a number
 * @returns [f₀, f₁, ...] | fᵢ divides x and is prime
 */
declare function primeFactors(x: number): number[];
/**
 * Find the prime factors and respective exponents of a number.
 * [📘](https://github.com/nodef/extra-math/wiki/primeExponentials)
 * @param x a number
 * @returns [[f₀, e₀], [f₁, e₁], ...] | fᵢ is a prime factor of x and eᵢ is its exponent
 */
declare function primeExponentials(x: number): [number, number][];
/**
 * Check if number is prime.
 * [📘](https://github.com/nodef/extra-math/wiki/isPrime)
 * @param x a number
 * @returns is divisible by 1 and itself only?
 */
declare function isPrime(x: number): boolean;
/**
 * Find the greatest common divisor of numbers.
 * [📘](https://github.com/nodef/extra-math/wiki/gcd)
 * @param xs a list of numbers
 * @returns gcd(x₁, x₂, ...)
 */
declare function gcd(...xs: number[]): number;

/**
 * Find the least common multiple of numbers.
 * [📘](https://github.com/nodef/extra-math/wiki/lcm)
 * @param xs a list of numbers
 * @returns lcm(x₁, x₂, ...)
 */
declare function lcm(...xs: number[]): number;
/**
 * Find the factorial of a number.
 * [📘](https://github.com/nodef/extra-math/wiki/factorial)
 * @param n a number
 * @param k denominator factorial [0]
 * @returns P(n, k); k=0: n!, k>0: n!/k!
 */
declare function factorial(n: number, k?: number): number;
/**
 * Find the number of ways to choose k elements from a set of n elements.
 * [📘](https://github.com/nodef/extra-math/wiki/binomial)
 * @param n elements in source set
 * @param k elements in choose set
 * @returns C(n, k)
 */
declare function binomial(n: number, k: number): number;
/**
 * Find the number of ways to put n objects in m bins (n=sum(kᵢ)).
 * [📘](https://github.com/nodef/extra-math/wiki/multinomial)
 * @param ks objects per bin (kᵢ)
 * @returns n!/(k₁!k₂!...) | n=sum(kᵢ)
 */
declare function multinomial(...ks: number[]): number;
/**
 * Convert radians to degrees.
 * [📘](https://github.com/nodef/extra-math/wiki/degrees)
 * @param x radians
 * @returns 2π → 360
 */
declare function degrees(x: number): number;
/**
 * Convert degrees to radians.
 * [📘](https://github.com/nodef/extra-math/wiki/radians)
 * @param x degrees
 * @returns 360 → 2π
 */
declare function radians(x: number): number;
/**
 * Find the sum of numbers (Σ).
 * [📘](https://github.com/nodef/extra-math/wiki/sum)
 * @param xs a list of numbers
 * @returns Σxᵢ
 */
declare function sum(...xs: number[]): number;
/**
 * Find the product of numbers (∏).
 * [📘](https://github.com/nodef/extra-math/wiki/product)
 * @param xs a list of numbers
 * @returns ∏xᵢ
 */
declare function product(...xs: number[]): number;
/**
 * Find the value separating the higher and lower halves of numbers.
 * [📘](https://github.com/nodef/extra-math/wiki/median)
 * @param xs a list of numbers
 * @returns xₘ | sort(xs) = [..., xₘ, ...]
 */
declare function median(...xs: number[]): number;
/**
 * Find the values that appear most often.
 * [📘](https://github.com/nodef/extra-math/wiki/modes)
 * @param xs a list of numbers
 * @returns [xₘ₁, xₘ₂, ...] | count(xₘᵢ) ≥ count(xᵢ) ∀ xᵢ ∈ xs
 */
declare function modes(...xs: number[]): number[];
/**
 * Find the smallest and largest values.
 * [📘](https://github.com/nodef/extra-math/wiki/range)
 * @param xs a list of numbers
 * @returns [min(xs), max(xs)]
 */
declare function range(...xs: number[]): [number, number];
/**
 * Find the mean of squared deviation of numbers from its mean.
 * [📘](https://github.com/nodef/extra-math/wiki/variance)
 * @param xs a list of numbers
 * @returns σ² = E[(xs - µ)²] | µ = mean(xs)
 */
declare function variance(...xs: number[]): number;
/**
 * Find the average of numbers.
 * [📘](https://github.com/nodef/extra-math/wiki/arithmeticMean)
 * @param xs a list of numbers
 * @returns Σxᵢ/n | n = size(xs)
 */
declare function arithmeticMean(...xs: number[]): number;

/**
 * Find the geometric mean of numbers.
 * [📘](https://github.com/nodef/extra-math/wiki/geometricMean)
 * @param xs a list of numbers
 * @returns ⁿ√(∏xᵢ) | n = size(xs)
 */
declare function geometricMean(...xs: number[]): number;
/**
 * Find the harmonic mean of numbers.
 * [📘](https://github.com/nodef/extra-math/wiki/harmonicMean)
 * @param xs a list of numbers
 * @returns n/Σ(1/xᵢ) | n = size(xs)
 */
declare function harmonicMean(...xs: number[]): number;
/**
 * Find the quadriatic mean of numbers.
 * [📘](https://github.com/nodef/extra-math/wiki/quadriaticMean)
 * @param xs a list of numbers
 * @returns √(Σxᵢ²)/n | n = size(xs)
 */
declare function quadriaticMean(...xs: number[]): number;

/**
 * Find the cubic mean of numbers.
 * [📘](https://github.com/nodef/extra-math/wiki/cubicMean)
 * @param xs a list of numbers
 * @returns ³√(Σxᵢ³)/n | n = size(xs)
 */
declare function cubicMean(...xs: number[]): number;

/**
 * Calculate the magnitude (length) of a vector.
 * [📘](https://github.com/nodef/extra-math/wiki/magnitude)
 * @param xs vector ([x, y, z, ...])
 * @returns √(x² + y² + z²)
 */
declare function magnitude(xs: number[]): number;
/**
 * Calculate the distance between two points.
 * [📘](https://github.com/nodef/extra-math/wiki/distance)
 * @param xs first point ([x, y, z, ...])
 * @param ys second point ([x, y, z, ...])
 * @returns √(Δx² + Δy² + Δz²)
 */
declare function distance(xs: number[], ys: number[]): number;

export { properDivisors as aliquotParts, aliquotSum, arithmeticMean, binomial, ceil, ceilDiv, constrain as clamp, constrain, cubicMean, degrees, distance, factorial, floor, floorDiv, gcd, geometricMean, maxPrimeFactor as greatestPrimeFactor, harmonicMean, gcd as hcf, isPow, isPrime, lcm, minPrimeFactor as leastPrimeFactor, lerp, log, magnitude, remap as map, maxPrimeFactor, arithmeticMean as mean, median, minPrimeFactor, mod, modes, modp, multinomial, nextPow, normalize as norm, normalize, prevPow, primeExponentials, primeFactors, product, properDivisors, quadriaticMean, radians, range, rem, remap, root, quadriaticMean as rootMeanSquare, round, roundDiv, sum, variance };