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

wrap

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

• Wraps a value on the half-open interval [min,max).

  Parameters

  • v: number

    input value

  • min: number

    minimum value

  • max: number

    maximum value

  Returns number

  wrapped value

  Example

  var v = wrap( 3.14, 0.0, 5.0 );
  // returns 3.14
  
  v = wrap( -3.14, 0.0, 5.0 );
  // returns ~1.86
  
  v = wrap( 10.0, 0.0, 5.0 );
  // returns 0.0
  
  v = wrap( -0.0, 0.0, 5.0 );
  // returns 0.0
  
  v = wrap( 0.0, -0.0, 5.0 );
  // returns 0.0
  
  v = wrap( NaN, 0.0, 5.0 );
  // returns NaN
  
  v = wrap( 0.0, NaN, 5.0 );
  // returns NaN
  
  v = wrap( 3.14, 0.0, NaN );
  // returns NaN
  
  v = wrap( 3.14, 5.0, 0.0 );
  // returns NaN