External module "ndarray/base/clamp-index/docs/types/index.d"

Export assignment clampIndex

• clampIndex(idx: number, max: number): number

• Restricts an index to the interval [0,max].

  Parameters

  • idx: number

    index

  • max: number

    maximum index

  Returns number

  index

  Example

  var idx = clampIndex( -1, 10 );
  // returns 0
  
  idx = clampIndex( 15, 10 );
  // returns 10
  
  idx = clampIndex( 5, 10 );
  // returns 5