External module "math/base/special/clamp/docs/types/index.d"

Export assignment clamp

• clamp(v: number, min: number, max: number): number

• Restricts a double-precision floating-point number to a specified range.

  Parameters

  • v: number

    input value

  • min: number

    minimum value

  • max: number

    maximum value

  Returns number

  value restricted to a specified range

  Example

  var v = clamp( 3.14, 0.0, 5.0 );
  // returns 3.14
  
  v = clamp( -3.14, 0.0, 5.0 );
  // returns 0.0
  
  v = clamp( 10.0, 0.0, 5.0 );
  // returns 5.0
  
  v = clamp( -0.0, 0.0, 5.0 );
  // returns 0.0
  
  v = clamp( 0.0, -0.0, 5.0 );
  // returns 0.0
  
  v = clamp( NaN, 0.0, 5.0 );
  // returns NaN
  
  v = clamp( 0.0, NaN, 5.0 );
  // returns NaN
  
  v = clamp( 3.14, 0.0, NaN );
  // returns NaN