External module "simulate/iter/periodic-sinc/docs/types/index.d"

Export assignment iterPeriodicSinc

• iterPeriodicSinc(n: number, options?: Options): Iterator

• Returns an iterator which generates a periodic sinc waveform.

  Notes

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

  throws

  first argument must be a positive integer

  throws

  period option must be a positive integer

  throws

  amplitude must be a nonnegative number

  throws

  offset option must be an integer

  throws

  iter option must be a nonnegative integer

  Parameters

  • n: number

    order

  • Optional options: Options

    function options

  Returns Iterator

  iterator

  Example

  var opts = {
      'period': 1000
  };
  
  var iter = iterPeriodicSinc( 7, opts );
  
  var v = iter.next().value;
  // returns <number>
  
  v = iter.next().value;
  // returns <number>
  
  v = iter.next().value;
  // returns <number>
  
  // ...