curvy 1.0.9 → 2.0.0-alpha.2

package/dist/utils.d.ts

@@ -1,205 +0,0 @@
-/**
- * @since 1.0.0
- */
-declare const PRECISION = 8;
-/**
- * Rounding function that rounds a number to a specified precision.
- *
- * @param value - The number to round.
- * @param precision - The number of decimal places to round to (default is 8).
- * @returns The rounded number.
- * @example
- * ```ts
- * import { round } from 'curvy/utils'
- *
- * const roundedValue = round(1.23456789, 4) // 1.2346
- * const roundedValue2 = round(1.23456789) // 1.23456789
- * ```
- * @since 1.0.0
- */
-declare function round(value: number, precision?: number): number;
-/**
- * Rounding function that rounds a number down to a specified precision.
- *
- * @param value - The number to round down.
- * @param precision - The number of decimal places to round down to (default is 8).
- * @returns The rounded down number.
- * @example
- * ```ts
- * import { roundDown } from 'curvy/utils'
- *
- * const roundedDownValue = roundDown(1.23456789, 4) // 1.2345
- * const roundedDownValue2 = roundDown(1.23456789) // 1.23456789
- * ```
- * @since 1.0.0
- */
-declare function roundDown(value: number, precision?: number): number;
-/**
- * Rounding function that rounds a number up to a specified precision.
- *
- * @param value - The number to round up.
- * @param precision - The number of decimal places to round up to (default is 8).
- * @returns The rounded up number.
- * @example
- * ```ts
- * import { roundUp } from 'curvy/utils'
- *
- * const roundedUpValue = roundUp(1.23456789, 4) // 1.2346
- * const roundedUpValue2 = roundUp(1.23456789) // 1.23456789
- * ```
- * @since 1.0.0
- */
-declare function roundUp(value: number, precision?: number): number;
-/**
- * Linear interpolation function.
- *
- * @param t - The interpolation factor (between 0 and 1).
- * @param a - The start value.
- * @param b - The end value.
- * @returns The interpolated value.
- * @example
- * ```ts
- * import { lerp } from 'curvy/utils'
- *
- * const interpolatedValue = lerp(0.5, 10, 20) // 15
- * const interpolatedValue2 = lerp(0.5)(10, 20) // 15
- * ```
- * @since 1.0.0
- */
-declare const lerp: {
-    (t: number, a: number, b: number): number;
-    (a: number, b: number): (t: number) => number;
-};
-/**
- * Normalizes a value between two bounds.
- *
- * @param x - The value to normalize.
- * @param a - The lower bound.
- * @param b - The upper bound.
- * @returns The normalized value.
- * @example
- * ```ts
- * import { normalize } from 'curvy/utils'
- *
- * const normalizedValue = normalize(15, 10, 20) // 0.5
- * const normalizedValue2 = normalize(10, 20)(15) // 0.5
- * ```
- * @since 1.0.0
- */
-declare const normalize: {
-    (x: number, a: number, b: number): number;
-    (a: number, b: number): (x: number) => number;
-};
-/**
- * Remaps a value from one range to another.
- *
- * @param x - The value to remap.
- * @param x1 - The lower bound of the original range.
- * @param x2 - The upper bound of the original range.
- * @param y1 - The lower bound of the new range.
- * @param y2 - The upper bound of the new range.
- * @returns The remapped value.
- * @example
- * ```ts
- * import { remap } from 'curvy/utils'
- *
- * const remappedValue = remap(15, 10, 20, 0, 100) // 50
- * const remappedValue2 = remap(10, 20, 0, 100)(15) // 50
- * ```
- * @since 1.0.0
- */
-declare const remap: {
-    (x: number, x1: number, x2: number, y1: number, y2: number): number;
-    (x1: number, x2: number, y1: number, y2: number): (x: number) => number;
-};
-/**
- * Clamps a value between two bounds.
- *
- * @param value - The value to clamp.
- * @param min - The lower bound.
- * @param max - The upper bound.
- * @returns The clamped value.
- * @example
- * ```ts
- * import { clamp } from 'curvy/utils'
- *
- * const clampedValue = clamp(25, 10, 20) // 20
- * const clampedValue2 = clamp(10, 20)(25) // 20
- * ```
- * @since 1.0.0
- */
-declare const clamp: {
-    (value: number, min: number, max: number): number;
-    (min: number, max: number): (value: number) => number;
-};
-/**
- * Clips a value to a specified range, returning a fallback value if the value is outside the range.
- *
- * @param value - The value to clip.
- * @param min - The lower bound.
- * @param max - The upper bound.
- * @param onClip - The fallback value to return if the value is outside the range.
- * @returns The clipped value or the fallback value.
- * @example
- * ```ts
- * import { clip } from 'curvy/utils'
- *
- * const clippedValue = clip(25, 10, 20, 15) // 15
- * const clippedValue2 = clip(10, 20, 15)(25) // 15
- * ```
- * @since 1.0.0
- */
-declare const clip: {
-    <T>(value: number, min: number, max: number, onClip: T): T | number;
-    <T>(min: number, max: number, onClip: T): (value: number) => T | number;
-};
-/**
- * Returns the minimum and maximum of two numbers.
- *
- * @param a - The first number.
- * @param b - The second number.
- * @returns A tuple containing the minimum and maximum values.
- * @example
- * ```ts
- * import { minMax } from 'curvy/utils'
- *
- * const [minValue, maxValue] = minMax(10, 20) // [10, 20]
- * const [minValue2, maxValue2] = minMax(20, 10) // [10, 20]
- * ```
- * @since 1.0.0
- */
-declare function minMax(a: number, b: number): [number, number];
-/**
- * Calculates the modulus of a number.
- *
- * @param n - The number to calculate the modulus of.
- * @param m - The modulus.
- * @returns The modulus of the number.
- * @example
- * ```ts
- * import { mod } from 'curvy/utils'
- *
- * const modulus = mod(10, 3) // 1
- * const modulus2 = mod(-10, 3) // 2
- * ```
- * @since 1.0.0
- */
-declare function mod(n: number, m: number): number;
-/**
- * Asserts that a condition is true, throwing an error with the provided message if it is not.
- *
- * @param condition - The condition to assert.
- * @param message - The error message to throw if the condition is false.
- * @throws An error with the provided message if the condition is false.
- * @example
- * ```ts
- * import { invariant } from 'curvy/utils'
- *
- * invariant(1 + 1 === 2, 'Math is broken!') // No error
- * invariant(1 + 1 === 3, 'Math is broken!') // Throws: Math is broken!
- * ```
- * @since 1.0.0
- */
-declare function invariant(condition: boolean, message: string): asserts condition;
-
-export { PRECISION, clamp, clip, invariant, lerp, minMax, mod, normalize, remap, round, roundDown, roundUp };

package/dist/vector/vector2.d.mts

@@ -1,324 +0,0 @@
-import { T as TwoDimensional } from '../shared/curvy.Bf5TIk31.mjs';
-import { Pipeable } from '../pipe.mjs';
-
-declare const Vector2TypeId: unique symbol;
-type Vector2TypeId = typeof Vector2TypeId;
-
-/**
- * A 2D vector.
- *
- * All fields are readonly and immutable, and all operations create new instances.
- *
- * @since 1.0.0
- */
-interface Vector2 extends Pipeable, TwoDimensional<number> {
-    readonly [Vector2TypeId]: Vector2TypeId;
-}
-/**
- * Checks if a value is a `Vector2`.
- *
- * @param v - The value to check.
- * @returns `true` if the value is a `Vector2`, `false` otherwise.
- * @since 1.0.0
- */
-declare const isVector2: (v: unknown) => v is Vector2;
-declare const make: {
-    /**
-     * Creates a new `Vector2` instance.
-     *
-     * @param xy - The x and y components of the vector.
-     * @returns A new `Vector2` instance.
-     * @since 1.0.0
-     */
-    (xy: number): Vector2;
-    /**
-     * Creates a new `Vector2` instance.
-     *
-     * @param x - The x component of the vector.
-     * @param y - The y component of the vector.
-     * @returns A new `Vector2` instance.
-     * @since 1.0.0
-     */
-    (x: number, y: number): Vector2;
-};
-/**
- * Creates a new `Vector2` instance from polar coordinates.
- *
- * @param r - The radius.
- * @param theta - The angle, in radians.
- * @returns A new `Vector2` instance.
- * @since 1.0.0
- */
-declare const fromPolar: (r: number, theta: number) => Vector2;
-/**
- * Calculates the magnitude of a `Vector2`.
- *
- * @param vector - The vector to calculate the magnitude of.
- * @returns The magnitude of the vector.
- * @since 1.0.0
- */
-declare const magnitude: (vector: Vector2) => number;
-/**
- * Normalizes a `Vector2`.
- *
- * @param vector - The vector to normalize.
- * @returns A new `Vector2` instance with the same direction and a magnitude of 1.
- * @since 1.0.0
- */
-declare const normalize: (vector: Vector2) => Vector2;
-declare const dot: {
-    /**
-     * Calculates the dot product of two `Vector2` instances.
-     *
-     * @param a - The first vector.
-     * @param b - The second vector.
-     * @returns The dot product of the two vectors.
-     * @since 1.0.0
-     */
-    (a: Vector2, b: Vector2): number;
-    /**
-     * Calculates the dot product of two `Vector2` instances.
-     *
-     * @param b - The second vector.
-     * @returns A function that takes the first vector and returns the dot product.
-     * @since 1.0.0
-     */
-    (b: Vector2): (a: Vector2) => number;
-};
-declare const cross: {
-    /**
-     * Calculates the cross product of two `Vector2` instances.
-     *
-     * @param a - The first vector.
-     * @param b - The second vector.
-     * @returns The cross product of the two vectors.
-     * @since 1.0.0
-     */
-    (a: Vector2, b: Vector2): number;
-    /**
-     * Calculates the cross product of two `Vector2` instances.
-     *
-     * @param b - The second vector.
-     * @returns A function that takes the first vector and returns the cross product.
-     * @since 1.0.0
-     */
-    (b: Vector2): (a: Vector2) => number;
-};
-/**
- * Returns the components of a `Vector2` as an array.
- *
- * @param r - The radius.
- * @param theta - The angle, in radians.
- * @returns A new `Vector2` instance.
- * @since 1.0.0
- */
-declare const components: (v: Vector2) => [number, number];
-/**
- * Applies the softmax function to a `Vector2`.
- *
- * @param v - The vector to apply the softmax function to.
- * @returns A new `Vector2` instance with the softmax applied.
- * @since 1.0.0
- */
-declare const softmax: (v: Vector2) => Vector2;
-/**
- * Creates a zero vector.
- *
- * @returns A new `Vector2` instance with both components set to 0.
- * @since 1.0.0
- */
-declare const zero: Vector2;
-/**
- * Creates a unit vector.
- *
- * @returns A new `Vector2` instance with both components set to 1.
- * @since 1.0.0
- */
-declare const unit: Vector2;
-declare const add: {
-    /**
-     * Adds two `Vector2` instances together.
-     *
-     * @param a - The first vector.
-     * @param b - The second vector.
-     * @returns A new `Vector2` instance representing the sum of the two vectors.
-     * @since 1.0.0
-     */
-    (a: Vector2, b: Vector2): Vector2;
-    /**
-     * Adds two `Vector2` instances together.
-     *
-     * @param b - The second vector.
-     * @returns A function that takes the first vector and returns the sum.
-     * @since 1.0.0
-     */
-    (b: Vector2): (a: Vector2) => Vector2;
-};
-declare const subtract: {
-    /**
-     * Subtracts one `Vector2` instance from another.
-     *
-     * @param a - The first vector.
-     * @param b - The second vector.
-     * @returns A new `Vector2` instance representing the difference of the two vectors.
-     * @since 1.0.0
-     */
-    (a: Vector2, b: Vector2): Vector2;
-    /**
-     * Subtracts one `Vector2` instance from another.
-     *
-     * @param b - The second vector.
-     * @returns A function that takes the first vector and returns the difference.
-     * @since 1.0.0
-     */
-    (b: Vector2): (a: Vector2) => Vector2;
-};
-declare const hadamard: {
-    /**
-     * Performs the Hadamard product of two `Vector2` instances.
-     *
-     * @param a - The first vector.
-     * @param b - The second vector.
-     * @returns A new `Vector2` instance representing the Hadamard product of the two vectors.
-     * @since 1.0.0
-     */
-    (a: Vector2, b: Vector2): Vector2;
-    /**
-     * Performs the Hadamard product of two `Vector2` instances.
-     *
-     * @param b - The second vector.
-     * @returns A function that takes the first vector and returns the Hadamard product.
-     * @since 1.0.0
-     */
-    (b: Vector2): (a: Vector2) => Vector2;
-};
-declare const scale: {
-    /**
-     * Scales a `Vector2` by a scalar value.
-     *
-     * @param s - The scalar value to scale by.
-     * @returns A function that takes a vector and returns the scaled vector.
-     * @since 1.0.0
-     */
-    (s: number): (v: Vector2) => Vector2;
-    /**
-     * Scales a `Vector2` by a scalar value.
-     *
-     * @param v - The vector to scale.
-     * @param s - The scalar value to scale by.
-     * @returns A new `Vector2` instance representing the scaled vector.
-     * @since 1.0.0
-     */
-    (v: Vector2, s: number): Vector2;
-};
-/**
- * Gets the x component of a `Vector2`.
- *
- * @param v - The vector to get the x component from.
- * @returns The x component of the vector.
- * @since 1.0.0
- */
-declare const getX: (v: Vector2) => number;
-declare const setX: {
-    /**
-     * Sets the x component of a `Vector2`.
-     *
-     * @param v - The vector to set the x component of.
-     * @param x - The new x component.
-     * @returns A new `Vector2` instance with the updated x component.
-     * @since 1.0.0
-     */
-    (v: Vector2, x: number): Vector2;
-    /**
-     * Sets the x component of a `Vector2`.
-     *
-     * @param x - The new x component.
-     * @returns A function that takes a vector and returns the updated vector.
-     * @since 1.0.0
-     */
-    (x: number): (v: Vector2) => Vector2;
-};
-/**
- * Gets the y component of a `Vector2`.
- *
- * @param v - The vector to get the y component from.
- * @returns The y component of the vector.
- * @since 1.0.0
- */
-declare const getY: (v: Vector2) => number;
-declare const setY: {
-    /**
-     * Sets the y component of a `Vector2`.
-     *
-     * @param v - The vector to set the y component of.
-     * @param y - The new y component.
-     * @returns A new `Vector2` instance with the updated y component.
-     * @since 1.0.0
-     */
-    (v: Vector2, y: number): Vector2;
-    /**
-     * Sets the y component of a `Vector2`.
-     *
-     * @param y - The new y component.
-     * @returns A function that takes a vector and returns the updated vector.
-     * @since 1.0.0
-     */
-    (y: number): (v: Vector2) => Vector2;
-};
-/**
- * Gets the radius of a `Vector2`.
- *
- * @param v - The vector to get the radius from.
- * @returns The radius of the vector.
- * @since 1.0.0
- */
-declare const getR: (v: Vector2) => number;
-declare const setR: {
-    /**
-     * Sets the radius of a `Vector2`.
-     *
-     * @param v - The vector to set the radius of.
-     * @param r - The new radius.
-     * @returns A new `Vector2` instance with the updated radius.
-     * @since 1.0.0
-     */
-    (v: Vector2, r: number): Vector2;
-    /**
-     * Sets the radius of a `Vector2`.
-     *
-     * @param r - The new radius.
-     * @returns A function that takes a vector and returns the updated vector.
-     * @since 1.0.0
-     */
-    (r: number): (v: Vector2) => Vector2;
-};
-/**
- * Gets the angle of a `Vector2`.
- *
- * @param v - The vector to get the angle from.
- * @returns The angle of the vector in radians.
- * @since 1.0.0
- */
-declare const getTheta: (v: Vector2) => number;
-declare const setTheta: {
-    /**
-     * Sets the angle of a `Vector2`.
-     *
-     * @param v - The vector to set the angle of.
-     * @param theta - The new angle, in radians.
-     * @returns A new `Vector2` instance with the updated angle.
-     * @since 1.0.0
-     */
-    (v: Vector2, theta: number): Vector2;
-    /**
-     * Sets the angle of a `Vector2`.
-     *
-     * @param theta - The new angle, in radians.
-     * @returns A function that takes a vector and returns the updated vector.
-     * @since 1.0.0
-     */
-    (theta: number): (v: Vector2) => Vector2;
-};
-
-export { add, components, cross, dot, fromPolar, getR, getTheta, getX, getY, hadamard, isVector2, magnitude, make, normalize, scale, setR, setTheta, setX, setY, softmax, subtract, unit, zero };
-export type { Vector2 };