@pawells/math-extended 1.0.5 → 2.0.0

package/build/interpolation.d.ts

@@ -9,166 +9,543 @@
  * @returns `a + (b - a) * t`
  *
  * @example
- * LinearInterpolation(0, 100, 0.5)  // 50
- * LinearInterpolation(0, 100, 0)    // 0
- * LinearInterpolation(0, 100, 1)    // 100
- * LinearInterpolation(0, 100, 1.5)  // 150 (extrapolation)
+     * ```typescript
+     * LinearInterpolation(0, 100, 0.5)  // 50
+     * LinearInterpolation(0, 100, 0)    // 0
+     * LinearInterpolation(0, 100, 1)    // 100
+     * LinearInterpolation(0, 100, 1.5)  // 150 (extrapolation)
+     * ```
  */
 export declare function LinearInterpolation(a: number, b: number, t: number): number;
 /**
- * Smooth step interpolation (3t² - 2t³)
- * Provides smooth acceleration and deceleration with zero derivatives at endpoints
+ * Smooth step interpolation (3t² − 2t³).
+ * Provides smooth acceleration and deceleration with zero first derivatives at both endpoints.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value using cubic smooth-step curve
+ *
+ * @example
+     * ```typescript
+     * SmoothStep(0, 10, 0)    // 0
+     * SmoothStep(0, 10, 1)    // 10
+     * SmoothStep(0, 10, 0.25) // 1.5625 (slower start than LinearInterpolation's 2.5)
+     * ```
  */
 export declare function SmoothStep(a: number, b: number, t: number): number;
 /**
- * Smoother step interpolation (6t⁵ - 15t⁴ + 10t³)
- * Even smoother than SmoothStep with zero first and second derivatives at endpoints
+ * Smoother step interpolation (6t⁵ − 15t⁴ + 10t³).
+ * Even smoother than SmoothStep with zero first and second derivatives at both endpoints
+ * (Ken Perlin's improvement).
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value using quintic smoother-step curve
+ *
+ * @example
+     * ```typescript
+     * SmootherStep(0, 10, 0)    // 0
+     * SmootherStep(0, 10, 1)    // 10
+     * SmootherStep(0, 10, 0.25) // ~1.04 (smoother start than SmoothStep)
+     * ```
  */
 export declare function SmootherStep(a: number, b: number, t: number): number;
 /**
- * Quadratic ease-in interpolation (t²)
- * Accelerates slowly at the beginning
+ * Quadratic ease-in interpolation (t²).
+ * Accelerates from rest — starts slowly and gains speed toward the end.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with quadratic acceleration from start
+ *
+ * @example
+     * ```typescript
+     * QuadraticEaseIn(0, 10, 0)    // 0
+     * QuadraticEaseIn(0, 10, 1)    // 10
+     * QuadraticEaseIn(0, 10, 0.5)  // 2.5 (only 25% progress at the midpoint)
+     * ```
  */
 export declare function QuadraticEaseIn(a: number, b: number, t: number): number;
 /**
- * Quadratic ease-out interpolation (1 - (1-t)²)
- * Decelerates slowly at the end
+ * Quadratic ease-out interpolation (1 − (1−t)²).
+ * Decelerates to rest — starts quickly and slows toward the end.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with quadratic deceleration toward end
+ *
+ * @example
+     * ```typescript
+     * QuadraticEaseOut(0, 10, 0)   // 0
+     * QuadraticEaseOut(0, 10, 1)   // 10
+     * QuadraticEaseOut(0, 10, 0.5) // 7.5 (already 75% progress at the midpoint)
+     * ```
  */
 export declare function QuadraticEaseOut(a: number, b: number, t: number): number;
 /**
- * Cubic ease-in interpolation (t³)
- * More pronounced acceleration than quadratic
+ * Cubic ease-in interpolation (t³).
+ * More pronounced acceleration than quadratic — starts very slowly.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with cubic acceleration from start
+ *
+ * @example
+     * ```typescript
+     * CubicEaseIn(0, 10, 0)    // 0
+     * CubicEaseIn(0, 10, 1)    // 10
+     * CubicEaseIn(0, 10, 0.5)  // 1.25 (only 12.5% progress at the midpoint)
+     * ```
  */
 export declare function CubicEaseIn(a: number, b: number, t: number): number;
 /**
- * Cubic ease-out interpolation (1 - (1-t)³)
- * More pronounced deceleration than quadratic
+ * Cubic ease-out interpolation (1 − (1−t)³).
+ * More pronounced deceleration than quadratic — slows very gradually at the end.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with cubic deceleration toward end
+ *
+ * @example
+     * ```typescript
+     * CubicEaseOut(0, 10, 0)   // 0
+     * CubicEaseOut(0, 10, 1)   // 10
+     * CubicEaseOut(0, 10, 0.5) // 8.75 (already 87.5% progress at the midpoint)
+     * ```
  */
 export declare function CubicEaseOut(a: number, b: number, t: number): number;
 /**
- * Cosine interpolation - smooth curve using cosine function
- * Provides natural easing similar to SmoothStep but using trigonometry
+ * Cosine interpolation — smooth curve using the cosine function.
+ * Provides natural easing similar to SmoothStep but using trigonometry.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value using cosine-based easing curve
+ *
+ * @example
+     * ```typescript
+     * CosineInterpolation(0, 10, 0)   // 0
+     * CosineInterpolation(0, 10, 1)   // 10
+     * CosineInterpolation(0, 10, 0.5) // 5 (same as LERP at midpoint; smooth near endpoints)
+     * ```
  */
 export declare function CosineInterpolation(a: number, b: number, t: number): number;
 /**
- * Sine ease-in interpolation
- * Slow start with smooth acceleration
+ * Sine ease-in interpolation.
+ * Slow start with smooth sinusoidal acceleration.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with sine-based acceleration from start
+ *
+ * @example
+     * ```typescript
+     * SineEaseIn(0, 10, 0)   // 0
+     * SineEaseIn(0, 10, 1)   // 10
+     * SineEaseIn(0, 10, 0.5) // ~2.93 (slower than LinearInterpolation's 5 at midpoint)
+     * ```
  */
 export declare function SineEaseIn(a: number, b: number, t: number): number;
 /**
- * Sine ease-out interpolation
- * Smooth deceleration to the end
+ * Sine ease-out interpolation.
+ * Fast start with smooth sinusoidal deceleration to the end.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with sine-based deceleration toward end
+ *
+ * @example
+     * ```typescript
+     * SineEaseOut(0, 10, 0)   // 0
+     * SineEaseOut(0, 10, 1)   // 10
+     * SineEaseOut(0, 10, 0.5) // ~7.07 (faster than LinearInterpolation's 5 at midpoint)
+     * ```
  */
 export declare function SineEaseOut(a: number, b: number, t: number): number;
 /**
- * Exponential ease-in interpolation
- * Very slow start, then rapid acceleration
+ * Exponential ease-in interpolation (2^(10t−10)).
+ * Very slow start, then rapid exponential acceleration.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with exponential acceleration from start
+ *
+ * @example
+     * ```typescript
+     * ExponentialEaseIn(0, 10, 0)    // 0
+     * ExponentialEaseIn(0, 10, 1)    // 10
+     * ExponentialEaseIn(0, 10, 0.5)  // ~0.31 (barely moved at midpoint)
+     * ```
  */
 export declare function ExponentialEaseIn(a: number, b: number, t: number): number;
 /**
- * Exponential ease-out interpolation
- * Rapid start, then very slow deceleration
+ * Exponential ease-out interpolation (1 − 2^(−10t)).
+ * Rapid start, then very slow exponential deceleration.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with exponential deceleration toward end
+ *
+ * @example
+     * ```typescript
+     * ExponentialEaseOut(0, 10, 0)   // 0
+     * ExponentialEaseOut(0, 10, 1)   // 10
+     * ExponentialEaseOut(0, 10, 0.5) // ~9.69 (nearly done at midpoint)
+     * ```
  */
 export declare function ExponentialEaseOut(a: number, b: number, t: number): number;
 /**
- * Elastic ease-out - bouncy spring-like motion
- * Creates an overshoot effect that bounces back
+ * Elastic ease-out — bouncy spring-like motion.
+ * Creates an overshoot effect that oscillates before settling at the endpoint.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — clamped to [0, 1] at t=0 and t=1 boundaries
+ * @returns Interpolated value with elastic overshoot effect toward end
+ *
+ * @example
+     * ```typescript
+     * ElasticEaseOut(0, 10, 0)   // 0
+     * ElasticEaseOut(0, 10, 1)   // 10
+     * ElasticEaseOut(0, 10, 0.8) // ~10.86 (overshoots target before settling)
+     * ```
  */
 export declare function ElasticEaseOut(a: number, b: number, t: number): number;
 /**
- * Back ease-out - overshoots then settles
- * Creates a slight overshoot before settling at the target
+ * Back ease-out — overshoots then settles.
+ * Creates a slight overshoot beyond the target before settling into place.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with back overshoot effect toward end
+ *
+ * @example
+     * ```typescript
+     * BackEaseOut(0, 10, 0)    // 0
+     * BackEaseOut(0, 10, 1)    // 10
+     * BackEaseOut(0, 10, 0.75) // ~10.88 (overshoots before settling)
+     * ```
  */
 export declare function BackEaseOut(a: number, b: number, t: number): number;
 /**
- * Bounce ease-out - bouncing ball effect
- * Simulates a ball bouncing to rest
+ * Bounce ease-out — simulates a ball bouncing to rest.
+ * Produces a series of bounces with decreasing amplitude before settling at the endpoint.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with bouncing effect toward end
+ *
+ * @example
+     * ```typescript
+     * BounceEaseOut(0, 10, 0)   // 0
+     * BounceEaseOut(0, 10, 1)   // 10
+     * BounceEaseOut(0, 10, 0.5) // ~7.65 (mid-bounce)
+     * ```
  */
 export declare function BounceEaseOut(a: number, b: number, t: number): number;
 /**
- * Catmull-Rom spline interpolation between 4 points
- * Useful for smooth curves through multiple points
+ * Catmull-Rom spline interpolation between four control points.
+ * Produces a smooth curve that passes through p1 and p2 with tangents influenced by p0 and p3.
+ *
+ * @param p0 - Previous control point (influences the tangent at p1)
+ * @param p1 - Start point (result when t = 0)
+ * @param p2 - End point (result when t = 1)
+ * @param p3 - Next control point (influences the tangent at p2)
+ * @param t - Interpolation parameter (typically [0, 1], supports extrapolation)
+ * @returns Smoothly interpolated value along the Catmull-Rom spline
+ *
+ * @example
+     * ```typescript
+     * CatmullRomInterpolation(0, 5, 10, 15, 0)   // 5  (at p1)
+     * CatmullRomInterpolation(0, 5, 10, 15, 1)   // 10 (at p2)
+     * CatmullRomInterpolation(0, 5, 10, 15, 0.5) // 7.5
+     * ```
  */
 export declare function CatmullRomInterpolation(p0: number, p1: number, p2: number, p3: number, t: number): number;
 /**
- * Hermite interpolation with tangent control
- * Provides precise control over curve tangents at endpoints
+ * Hermite spline interpolation with explicit tangent control.
+ * Provides precise control over the curve's tangent at both the start and end points.
+ *
+ * @param p0 - Start point (result when t = 0)
+ * @param p1 - End point (result when t = 1)
+ * @param t0 - Tangent (velocity) at the start point
+ * @param t1 - Tangent (velocity) at the end point
+ * @param t - Interpolation parameter (typically [0, 1], supports extrapolation)
+ * @returns Interpolated value along the Hermite spline
+ *
+ * @example
+     * ```typescript
+     * HermiteInterpolation(0, 10, 0, 0, 0)   // 0  (at start)
+     * HermiteInterpolation(0, 10, 0, 0, 1)   // 10 (at end)
+     * HermiteInterpolation(0, 10, 0, 0, 0.5) // 5  (flat tangents → same as LERP at midpoint)
+     * ```
  */
 export declare function HermiteInterpolation(p0: number, p1: number, t0: number, t1: number, t: number): number;
 /**
- * Circular ease-in interpolation
- * Creates an accelerating curve based on quarter circle
+ * Circular ease-in interpolation (1 − √(1−t²)).
+ * Creates an accelerating curve based on the first quarter of a circle.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — clamped to [0, 1] for a valid circular arc
+ * @returns Interpolated value with circular acceleration from start
+ *
+ * @example
+     * ```typescript
+     * CircularEaseIn(0, 10, 0)   // 0
+     * CircularEaseIn(0, 10, 1)   // 10
+     * CircularEaseIn(0, 10, 0.5) // ~1.34 (very slow start along circular arc)
+     * ```
  */
 export declare function CircularEaseIn(a: number, b: number, t: number): number;
 /**
- * Circular ease-out interpolation
- * Creates a decelerating curve based on quarter circle
+ * Circular ease-out interpolation (√(1−(t−1)²)).
+ * Creates a decelerating curve based on the first quarter of a circle.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — clamped to [0, 1] for a valid circular arc
+ * @returns Interpolated value with circular deceleration toward end
+ *
+ * @example
+     * ```typescript
+     * CircularEaseOut(0, 10, 0)   // 0
+     * CircularEaseOut(0, 10, 1)   // 10
+     * CircularEaseOut(0, 10, 0.5) // ~8.66 (very fast start along circular arc)
+     * ```
  */
 export declare function CircularEaseOut(a: number, b: number, t: number): number;
 /**
- * Quadratic ease-in-out interpolation (2t² for t<0.5, 1−(−2t+2)²/2 for t≥0.5)
- * Symmetrically accelerates at the start and decelerates at the end
+ * Quadratic ease-in-out interpolation (2t² for t < 0.5, 1 − (−2t+2)²/2 for t ≥ 0.5).
+ * Symmetrically accelerates at the start and decelerates at the end.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter (typically [0, 1])
+ * @returns Interpolated value with quadratic symmetric easing
+ *
+ * @example
+     * ```typescript
+     * QuadraticEaseInOut(0, 10, 0)    // 0
+     * QuadraticEaseInOut(0, 10, 1)    // 10
+     * QuadraticEaseInOut(0, 10, 0.25) // 1.25 (slow start)
+     * QuadraticEaseInOut(0, 10, 0.75) // 8.75 (slow end)
+     * ```
  */
 export declare function QuadraticEaseInOut(a: number, b: number, t: number): number;
 /**
- * Cubic ease-in-out interpolation (4t³ for t<0.5, 1−(−2t+2)³/2 for t≥0.5)
- * More pronounced symmetrical acceleration/deceleration than quadratic
+ * Cubic ease-in-out interpolation (4t³ for t < 0.5, 1 − (−2t+2)³/2 for t ≥ 0.5).
+ * More pronounced symmetrical acceleration/deceleration than quadratic ease-in-out.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter (typically [0, 1])
+ * @returns Interpolated value with cubic symmetric easing
+ *
+ * @example
+     * ```typescript
+     * CubicEaseInOut(0, 10, 0)    // 0
+     * CubicEaseInOut(0, 10, 1)    // 10
+     * CubicEaseInOut(0, 10, 0.25) // 0.625 (very slow start)
+     * CubicEaseInOut(0, 10, 0.75) // 9.375 (very slow end)
+     * ```
  */
 export declare function CubicEaseInOut(a: number, b: number, t: number): number;
 /**
- * Sine ease-in-out interpolation (−(cos(πt)−1)/2)
- * Smooth symmetric easing using cosine — gentle and natural feeling
+ * Sine ease-in-out interpolation (−(cos(πt) − 1) / 2).
+ * Smooth symmetric easing using cosine — gentle and natural feeling.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter (typically [0, 1])
+ * @returns Interpolated value with sine-based symmetric easing
+ *
+ * @example
+     * ```typescript
+     * SineEaseInOut(0, 10, 0)   // 0
+     * SineEaseInOut(0, 10, 1)   // 10
+     * SineEaseInOut(0, 10, 0.5) // 5 (symmetric midpoint)
+     * ```
  */
 export declare function SineEaseInOut(a: number, b: number, t: number): number;
 /**
- * Exponential ease-in-out interpolation
- * Very slow at both ends, extremely rapid in the middle
+ * Exponential ease-in-out interpolation.
+ * Very slow at both ends with an extremely rapid transition in the middle.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter (typically [0, 1])
+ * @returns Interpolated value with exponential symmetric easing
+ *
+ * @example
+     * ```typescript
+     * ExponentialEaseInOut(0, 10, 0)    // 0
+     * ExponentialEaseInOut(0, 10, 1)    // 10
+     * ExponentialEaseInOut(0, 10, 0.25) // ~0.16 (barely moving in the first quarter)
+     * ```
  */
 export declare function ExponentialEaseInOut(a: number, b: number, t: number): number;
 /**
- * Circular ease-in-out interpolation
- * Smooth symmetric arc-based easing
+ * Circular ease-in-out interpolation.
+ * Smooth symmetric arc-based easing using a circular curve.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter (typically [0, 1])
+ * @returns Interpolated value with circular symmetric easing
+ *
+ * @example
+     * ```typescript
+     * CircularEaseInOut(0, 10, 0)    // 0
+     * CircularEaseInOut(0, 10, 1)    // 10
+     * CircularEaseInOut(0, 10, 0.25) // ~0.67 (very slow circular start)
+     * ```
  */
 export declare function CircularEaseInOut(a: number, b: number, t: number): number;
 /**
- * Elastic ease-in interpolation
- * Spring-like acceleration from rest — starts with a bounce-back then launches forward
+ * Elastic ease-in interpolation.
+ * Spring-like acceleration from rest — starts with a backward oscillation then launches forward.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — clamped to [0, 1] at t=0 and t=1 boundaries
+ * @returns Interpolated value with elastic spring acceleration from start
+ *
+ * @example
+     * ```typescript
+     * ElasticEaseIn(0, 10, 0)   // 0
+     * ElasticEaseIn(0, 10, 1)   // 10
+     * ElasticEaseIn(0, 10, 0.5) // ~-0.16 (backward oscillation at midpoint before launching)
+     * ```
  */
 export declare function ElasticEaseIn(a: number, b: number, t: number): number;
 /**
- * Elastic ease-in-out interpolation
- * Spring-like oscillation at both the start and end
+ * Elastic ease-in-out interpolation.
+ * Spring-like oscillation at both the start and end of the motion.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — clamped to [0, 1] at t=0 and t=1 boundaries
+ * @returns Interpolated value with elastic oscillation at both ends
+ *
+ * @example
+     * ```typescript
+     * ElasticEaseInOut(0, 10, 0)   // 0
+     * ElasticEaseInOut(0, 10, 1)   // 10
+     * ElasticEaseInOut(0, 10, 0.4) // ~-1.17 (backward oscillation before midpoint)
+     * ```
  */
 export declare function ElasticEaseInOut(a: number, b: number, t: number): number;
 /**
- * Back ease-in interpolation (c3t³ − c1t²)
- * Slight backward pull before launching forward
+ * Back ease-in interpolation (c3t³ − c1t²).
+ * Slight backward pull before launching forward — like winding up before a throw.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with back overshoot at start
+ *
+ * @example
+     * ```typescript
+     * BackEaseIn(0, 10, 0)    // 0
+     * BackEaseIn(0, 10, 1)    // 10
+     * BackEaseIn(0, 10, 0.25) // ~-0.64 (dips below start before accelerating forward)
+     * ```
  */
 export declare function BackEaseIn(a: number, b: number, t: number): number;
 /**
- * Back ease-in-out interpolation
- * Slight backward pull at both ends before and after the main motion
+ * Back ease-in-out interpolation.
+ * Slight backward pull at both ends before and after the main forward motion.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with back overshoot at both start and end
+ *
+ * @example
+     * ```typescript
+     * BackEaseInOut(0, 10, 0)    // 0
+     * BackEaseInOut(0, 10, 1)    // 10
+     * BackEaseInOut(0, 10, 0.25) // ~-1.00 (dips backward at start)
+     * ```
  */
 export declare function BackEaseInOut(a: number, b: number, t: number): number;
 /**
- * Bounce ease-in interpolation
- * Bouncing ball effect with bounces at the start before settling at the target
+ * Bounce ease-in interpolation.
+ * Bouncing ball effect at the start — multiple bounces before launching toward the target.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with bounce effect at start
+ *
+ * @example
+     * ```typescript
+     * BounceEaseIn(0, 10, 0)   // 0
+     * BounceEaseIn(0, 10, 1)   // 10
+     * BounceEaseIn(0, 10, 0.5) // ~2.34 (still bouncing at midpoint)
+     * ```
  */
 export declare function BounceEaseIn(a: number, b: number, t: number): number;
 /**
- * Bounce ease-in-out interpolation
- * Bouncing ball effect at both the start and the end
+ * Bounce ease-in-out interpolation.
+ * Bouncing ball effect at both the start and end of the motion.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Interpolated value with bounce effect at both start and end
+ *
+ * @example
+     * ```typescript
+     * BounceEaseInOut(0, 10, 0)    // 0
+     * BounceEaseInOut(0, 10, 1)    // 10
+     * BounceEaseInOut(0, 10, 0.25) // ~1.17 (bouncing at start quarter)
+     * ```
  */
 export declare function BounceEaseInOut(a: number, b: number, t: number): number;
 /**
- * Step interpolation - instant transition at threshold
- * Useful for discrete state changes
+ * Step interpolation — instant transition at a configurable threshold.
+ * Returns `a` when `t` is below the threshold, and `b` at or above it.
+ * Useful for discrete state changes and on/off animations.
+ *
+ * @param a - Start value (returned when t < threshold)
+ * @param b - End value (returned when t ≥ threshold)
+ * @param t - Interpolation parameter (clamped to [0, 1])
+ * @param threshold - Normalized transition point (default: 0.5; clamped to [0, 1])
+ * @returns Either `a` or `b` depending on `t` relative to `threshold`
+ *
+ * @example
+     * ```typescript
+     * StepInterpolation(0, 10, 0.3)        // 0  (below default threshold of 0.5)
+     * StepInterpolation(0, 10, 0.7)        // 10 (at or above default threshold of 0.5)
+     * StepInterpolation(0, 10, 0.3, 0.25)  // 10 (above custom threshold of 0.25)
+     * ```
  */
 export declare function StepInterpolation(a: number, b: number, t: number, threshold?: number): number;
 /**
- * Spherical linear interpolation for scalar values
- * Provides smooth interpolation along a spherical arc
- * Note: For true SLERP with vectors, use VectorSphericalLinearInterpolation
+ * Spherical linear interpolation for scalar values.
+ * For scalar inputs, this is mathematically equivalent to {@link LinearInterpolation}.
+ * For true spherical rotation interpolation, use `QuaternionSLERP` from the quaternions module.
+ *
+ * @param a - Start value (result when t = 0)
+ * @param b - End value (result when t = 1)
+ * @param t - Interpolation parameter — unclamped, allowing extrapolation
+ * @returns Linearly interpolated value (identical to `LinearInterpolation(a, b, t)`)
+ *
  * @deprecated This function is identical to LinearInterpolation and is not a true spherical interpolation. For quaternion spherical interpolation, use QuaternionSLERP from the quaternions module.
  */
 export declare function SphericalLinearInterpolation(a: number, b: number, t: number): number;

package/build/interpolation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interpolation.d.ts","sourceRoot":"","sources":["../src/interpolation.ts"],"names":[],"mappings":"AAiCA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAG3E;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKlE;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKpE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGvE;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGxE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGnE;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGpE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAK3E;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGlE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGnE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKzE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAK1E;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAUtE;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAOnE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAqBrE;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAQzG;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAWtG;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGtE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGvE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAK1E;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKtE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGrE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAO5E;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKzE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKrE;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAOxE;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKlE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAOrE;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAEpE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKvE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,GAAE,MAAY,GAAG,MAAM,CAKlG;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKpF"}
+{"version":3,"file":"interpolation.d.ts","sourceRoot":"","sources":["../src/interpolation.ts"],"names":[],"mappings":"AAiCA;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAG3E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKlE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKpE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGvE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGxE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGnE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGpE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAK3E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGlE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGnE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKzE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAK1E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAUtE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAOnE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAqBrE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAQzG;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAWtG;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGtE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGvE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAK1E;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKtE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAGrE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAO5E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKzE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKrE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAOxE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKlE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAOrE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAEpE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKvE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,GAAE,MAAY,GAAG,MAAM,CAKlG;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,4BAA4B,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAKpF"}