External module "iter/logspace/docs/types/index.d"

Export assignment iterLogspace

• iterLogspace(start: number, stop: number, N?: undefined | number, options?: Options): Iterator
• iterLogspace(start: number, stop: number, options?: Options): Iterator

• Returns an iterator which returns evenly spaced numbers on a log scale.

  Notes

  • If an environment supports Symbol.iterator, the returned iterator is iterable.

  throws

  N must be a nonnegative integer

  throws

  base option must be a positive number

  Parameters

  • start: number

    exponent of starting value (inclusive)

  • stop: number

    exponent of stopping value (inclusive)

  • Optional N: undefined | number

    number of values (default: 100)

  • Optional options: Options

    function options

  Returns Iterator

  iterator

  Example

  var iter = iterLogspace( 0, 1000, 4 );
  
  var v = iter.next().value;
  // returns 1
  
  v = iter.next().value;
  // returns 10
  
  v = iter.next().value;
  // returns 100
  
  // ...

• Returns an iterator which returns evenly spaced numbers on a log scale.

  Notes

  • If an environment supports Symbol.iterator, the returned iterator is iterable.

  throws

  base option must be a positive number

  Parameters

  • start: number

    exponent of starting value (inclusive)

  • stop: number

    exponent of stopping value (inclusive)

  • Optional options: Options

    function options

  Returns Iterator

  iterator

  Example

  var opts = {
      'base': 2
  };
  var iter = iterLogspace( 0, 99, opts );
  
  var v = iter.next().value;
  // returns 1
  
  v = iter.next().value;
  // returns 2
  
  v = iter.next().value;
  // returns 4
  
  // ...