@stdlib/simulate-iter-dirac-comb
v0.2.3TypeScript
Create an iterator which generates a Dirac comb.
0/weekUpdated yesterdayApache-2.0Unpacked: 51.6 KB
Published by The Stdlib Authors
npm install @stdlib/simulate-iter-dirac-combWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js. The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases. When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
iterDiracComb
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create an iterator which generates a Dirac comb.
A Dirac comb is represented by the following equation
where δ is the Dirac delta function, T is the period, and φ is the phase offset.
Installation
``bash`
npm install @stdlib/simulate-iter-dirac-comb
Usage
`javascript`
var iterDiracComb = require( '@stdlib/simulate-iter-dirac-comb' );
#### iterDiracComb( \[options] )
Returns an iterator which generates a Dirac comb.
`javascript
var it = iterDiracComb();
// returns
var v = it.next().value;
// returns Infinity
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
// ...
`
The returned iterator protocol-compliant object has the following properties:
- next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a value property and a done property having a boolean value indicating whether the iterator is finished.
- return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
The function supports the following options:
- period: period (i.e., the number of iterations before a waveform repeats). Default: 10.0
- offset: phase offset (in units of iterations; zero-based). A negative offset translates a waveform to the left. A positive offset translates a waveform to the right. Default: .1e308
- iter: number of iterations. Default: .
By default, the function returns an iterator which generates a Dirac delta function that repeats every 10 iterations. To specify an alternative period, set the period option.
`javascript
var opts = {
'period': 4
};
var it = iterDiracComb( opts );
// returns
var v = it.next().value;
// returns Infinity
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns Infinity
// ...
`
To adjust at what point the iterator begins in the waveform cycle, set the phase offset option. For example, to translate the waveform to the left,
`javascript
var opts = {
'period': 4,
'offset': -1
};
var it = iterDiracComb( opts );
// returns
var v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns Infinity
v = it.next().value;
// returns 0.0
// ...
`
To translate the waveform to the right,
`javascript
var opts = {
'period': 4,
'offset': 1
};
var it = iterDiracComb( opts );
// returns
var v = it.next().value;
// returns 0.0
v = it.next().value;
// returns Infinity
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
v = it.next().value;
// returns 0.0
// ...
`
By default, the function returns an infinite iterator (i.e., an iterator which never ends). To limit the number of iterations, set the iter option.
`javascript
var opts = {
'iter': 2
};
var it = iterDiracComb( opts );
// returns
var v = it.next().value;
// returns Infinity
v = it.next().value;
// returns 0.0
var bool = it.next().done;
// returns true
`
Notes
- If an environment supports Symbol.iterator, the returned iterator is iterable.
Examples
`javascript
var iterDiracComb = require( '@stdlib/simulate-iter-dirac-comb' );
// Create an iterator:
var opts = {
'period': 10,
'offset': -5,
'iter': 100
};
var it = iterDiracComb( opts );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( v.value );
}
`
*
See Also
- [@stdlib/simulate-iter/pulse][@stdlib/simulate/iter/pulse]: create an iterator which generates a pulse waveform.
*
Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
License
See [LICENSE][stdlib-license].
Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/simulate-iter-dirac-comb.svg
[npm-url]: https://npmjs.org/package/@stdlib/simulate-iter-dirac-comb
[test-image]: https://github.com/stdlib-js/simulate-iter-dirac-comb/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/simulate-iter-dirac-comb/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/simulate-iter-dirac-comb/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/simulate-iter-dirac-comb?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/simulate-iter-dirac-comb/tree/deno
[deno-readme]: https://github.com/stdlib-js/simulate-iter-dirac-comb/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/simulate-iter-dirac-comb/tree/umd
[umd-readme]: https://github.com/stdlib-js/simulate-iter-dirac-comb/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/simulate-iter-dirac-comb/tree/esm
[esm-readme]: https://github.com/stdlib-js/simulate-iter-dirac-comb/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/simulate-iter-dirac-comb/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/simulate-iter-dirac-comb/main/LICENSE
[@stdlib/simulate/iter/pulse]: https://www.npmjs.com/package/@stdlib/simulate-iter-pulse