dastal/lib/src/math/numberUtils.d.ts

Data Structures & Algorithms implementations

/**
 * Limits a number to be within a given range.
 *
 * f(x, min, max) = y, where min <= y <= max
 *
 * @param num - The number to clamp
 * @param min - The minimum result value, inclusive
 * @param max - The maximum result value, inclusive
 *
 * @returns The clamped number
 */
export declare function clamp(num: number, min: number, max: number): number;
/**
 * Wraps a number if below a given range
 *
 * f(x, min, max) = {
 *    x, where x >= min
 *    max - (min - x), where x < min
 * }
 *
 * @param num - The number to wrap
 * @param min - The minimum result value, inclusive
 * @param max - The maximum result value, inclusive
 *
 * @returns - The wrapped number
 */
export declare function wrapLeft(num: number, min: number, max: number): number;
/**
 * Wraps a number if above a given range
 *
 * f(x, min, max) = {
 *    x, where x <= max
 *    min + (x - max), where x > max
 * }
 *
 * @param num - The number to wrap
 * @param min - The minimum result value, inclusive
 * @param max - The maximum result value, inclusive
 *
 * @returns - The wrapped number
 */
export declare function wrapRight(num: number, min: number, max: number): number;
/**
 * Wraps a number if outside a given range
 *
 * @param num - The number to wrap
 * @param min - The minimum result value, inclusive
 * @param max - The maximum result value, inclusive
 *
 * @returns - The wrapped number
 */
export declare function wrap(num: number, min: number, max: number): number;