External module "math/iter/tools/map/docs/types/index.d"

iterMap

• iterMap(iterator: Iterator, fcn: Unary, options?: Options): Iterator

• Returns an iterator which invokes a unary function accepting a single numeric argument for each iterated value.

  Notes

  • When invoked, the input function is provided one argument:

    • value: iterated value

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

  throws

  must provide valid options

  Parameters

  • iterator: Iterator

    input iterator

  • fcn: Unary

    function which transforms an iterated value

  • Optional options: Options

    options

  Returns Iterator

  iterator

  Example

  var randu = require( `@stdlib/random/iter/randu` );
  var sin = require( `@stdlib/math/base/special/sin` );
  
  var iter = iterMap( randu(), sin );
  
  var r = iter.next().value;
  // returns <number>
  
  r = iter.next().value;
  // returns <number>
  
  r = iter.next().value;
  // returns <number>
  
  // ...