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

Export assignment wrapIndex

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

• Wraps an index on the interval [0,max].

  Parameters

  • idx: number

    index

  • max: number

    maximum index

  Returns number

  index

  Example

  var idx = wrapIndex( -1, 10 );
  // returns 10
  
  idx = wrapIndex( 13, 10 );
  // returns 2
  
  idx = wrapIndex( 6, 10 );
  // returns 6