External module "ndarray/base/ind/docs/types/index.d"

Export assignment ind

• ind(idx: number, max: number, mode: Mode): number

• Returns an index given an index mode.

  throws

  index out-of-bounds

  Parameters

  • idx: number

    index

  • max: number

    maximum index

  • mode: Mode

    specifies how to handle an index outside the interval [0,max]

  Returns number

  index

  Example

  var idx = ind( 2, 9, 'clamp' );
  // returns 2
  
  idx = ind( 10, 9, 'clamp' );
  // returns 9
  
  idx = ind( -1, 9, 'clamp' );
  // returns 0

  Example

  var idx = ind( 2, 9, 'wrap' );
  // returns 2
  
  idx = ind( 10, 9, 'wrap' );
  // returns 0
  
  idx = ind( -1, 9, 'wrap' );
  // returns 9

  Example

  var idx = ind( 2, 9, 'throw' );
  // returns 2
  
  idx = ind( 10, 9, 'throw' );
  // throws <RangeError>
  
  idx = ind( -1, 9, 'throw' );
  // throws <RangeError>