External module "array/to-strided-iterator/docs/types/index.d"

Export assignment stridedarray2iterator

• stridedarray2iterator(N: number, src: ArrayLike<any>, stride: number, offset: number, mapFcn?: MapFunction, thisArg?: any): Iterator

• Returns an iterator which iterates over elements in an array-like object according to specified stride parameters.

  throws

  first argument must be a nonnegative integer

  throws

  third argument must be an integer

  throws

  fourth argument must be a nonnegative integer

  Parameters

  • N: number

    number of values to iterate

  • src: ArrayLike<any>

    input value

  • stride: number

    stride length

  • offset: number

    starting index

  • Optional mapFcn: MapFunction

    function to invoke for each iterated value

  • Optional thisArg: any

    execution context

  Returns Iterator

  iterator

  Example

  var values = [ 1, 2, 3, 4, 5, 6, 7, 8 ];
  
  var N = 4;
  var stride = -2;
  var offset = 6;
  
  var iter = stridedarray2iterator( N, values, stride, offset );
  
  var v = iter.next().value;
  // returns 7
  
  v = iter.next().value;
  // returns 5
  
  v = iter.next().value;
  // returns 3
  
  // ...