{"id":20321342,"url":"https://github.com/stdlib-js/simulate-iter-cosine-wave","last_synced_at":"2025-10-19T04:39:43.921Z","repository":{"id":57162736,"uuid":"377238890","full_name":"stdlib-js/simulate-iter-cosine-wave","owner":"stdlib-js","description":"Create an iterator which generates a cosine wave.","archived":false,"fork":false,"pushed_at":"2024-12-01T12:30:43.000Z","size":1429,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-07T01:04:05.401Z","etag":null,"topics":["cos","cosine","iterate","iteration","iterator","javascript","node","node-js","nodejs","periodic","processing","signal","simulate","simulation","sin","sine","sinusoid","stdlib","wave","waveform"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-06-15T17:11:33.000Z","updated_at":"2024-12-01T06:24:56.000Z","dependencies_parsed_at":"2024-01-01T05:29:49.184Z","dependency_job_id":"af820c0f-1ca8-43a5-afe2-33336a01b08f","html_url":"https://github.com/stdlib-js/simulate-iter-cosine-wave","commit_stats":{"total_commits":51,"total_committers":1,"mean_commits":51.0,"dds":0.0,"last_synced_commit":"e0da89470c9cd9fbd88ca6566561e65fab5298c7"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fsimulate-iter-cosine-wave","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fsimulate-iter-cosine-wave/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fsimulate-iter-cosine-wave/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fsimulate-iter-cosine-wave/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/simulate-iter-cosine-wave/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248465341,"owners_count":21108244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cos","cosine","iterate","iteration","iterator","javascript","node","node-js","nodejs","periodic","processing","signal","simulate","simulation","sin","sine","sinusoid","stdlib","wave","waveform"],"created_at":"2024-11-14T19:14:07.771Z","updated_at":"2025-10-19T04:39:43.901Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2019 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# iterCosineWave\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Create an iterator which generates a cosine wave.\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\nA cosine waveform is represented by the following equation\n\n\u003c!-- \u003cequation class=\"equation\" label=\"eq:cosine_waveform\" align=\"center\" raw=\"f(t; \\tau, a, \\varphi) = a \\cos \\frac{2\\pi(t-\\varphi)}{\\tau}\" alt=\"Equation for a cosine waveform.\"\u003e --\u003e\n\n```math\nf(t; \\tau, a, \\varphi) = a \\cos \\frac{2\\pi(t-\\varphi)}{\\tau}\n```\n\n\u003c!-- \u003cdiv class=\"equation\" align=\"center\" data-raw-text=\"f(t; \\tau, a, \\varphi) = a \\cos \\frac{2\\pi(t-\\varphi)}{\\tau}\" data-equation=\"eq:cosine_waveform\"\u003e\n    \u003cimg src=\"https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@5827c258000edcb03496265cdfd372d686b4c656/lib/node_modules/@stdlib/simulate/iter/cosine-wave/docs/img/equation_cosine_waveform.svg\" alt=\"Equation for a cosine waveform.\"\u003e\n    \u003cbr\u003e\n\u003c/div\u003e --\u003e\n\n\u003c!-- \u003c/equation\u003e --\u003e\n\nwhere `τ` is the period, `a` is the peak amplitude, and `φ` is the phase offset.\n\n\u003c!-- TODO: add a figure showing a sine wave --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- Package usage documentation. --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/simulate-iter-cosine-wave\n```\n\nAlternatively,\n\n-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar iterCosineWave = require( '@stdlib/simulate-iter-cosine-wave' );\n```\n\n#### iterCosineWave( \\[options] )\n\nReturns an iterator which generates a cosine wave.\n\n```javascript\nvar it = iterCosineWave();\n// returns \u003cObject\u003e\n\nvar v = it.next().value;\n// returns \u003cnumber\u003e\n\nv = it.next().value;\n// returns \u003cnumber\u003e\n\nv = it.next().value;\n// returns \u003cnumber\u003e\n\n// ...\n```\n\nThe returned iterator protocol-compliant object has the following properties:\n\n-   **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.\n-   **return**: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.\n\nThe function supports the following `options`:\n\n-   **period**: period (i.e., the number of iterations before a cosine wave repeats). Default: `10`.\n-   **amplitude**: peak amplitude. Default: `1.0`.\n-   **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: `0`.\n-   **iter**: number of iterations. Default: `1e308`.\n\nBy default, the function returns an iterator which generates a cosine wave that repeats every `10` iterations. To specify an alternative period, set the `period` option.\n\n```javascript\nvar opts = {\n    'period': 4\n};\n\nvar it = iterCosineWave( opts );\n// returns \u003cObject\u003e\n\nvar v = it.next().value;\n// returns 1.0\n\nv = it.next().value;\n// returns 0.0\n\nv = it.next().value;\n// returns -1.0\n\nv = it.next().value;\n// returns 0.0\n\nv = it.next().value;\n// returns 1.0\n\n// ...\n```\n\nTo 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,\n\n```javascript\nvar opts = {\n    'period': 4,\n    'offset': -1\n};\n\nvar it = iterCosineWave( opts );\n// returns \u003cObject\u003e\n\nvar v = it.next().value;\n// returns 0.0\n\nv = it.next().value;\n// returns -1.0\n\nv = it.next().value;\n// returns 0.0\n\nv = it.next().value;\n// returns 1.0\n\nv = it.next().value;\n// returns 0.0\n\n// ...\n```\n\nTo translate the waveform to the right,\n\n```javascript\nvar opts = {\n    'period': 4,\n    'offset': 1\n};\n\nvar it = iterCosineWave( opts );\n// returns \u003cObject\u003e\n\nvar v = it.next().value;\n// returns 0.0\n\nv = it.next().value;\n// returns 1.0\n\nv = it.next().value;\n// returns 0.0\n\nv = it.next().value;\n// returns -1.0\n\nv = it.next().value;\n// returns 0.0\n\n// ...\n```\n\nBy default, the function returns an infinite iterator (i.e., an iterator which never ends). To limit the number of iterations, set the `iter` option.\n\n```javascript\nvar opts = {\n    'iter': 2\n};\nvar it = iterCosineWave( opts );\n// returns \u003cObject\u003e\n\nvar v = it.next().value;\n// returns \u003cnumber\u003e\n\nv = it.next().value;\n// returns \u003cnumber\u003e\n\nvar bool = it.next().done;\n// returns true\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   If an environment supports `Symbol.iterator`, the returned iterator is iterable.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- Package usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar iterCosineWave = require( '@stdlib/simulate-iter-cosine-wave' );\n\n// Create an iterator:\nvar opts = {\n    'period': 10,\n    'amplitude': 10.0,\n    'offset': -5,\n    'iter': 100\n};\nvar it = iterCosineWave( opts );\n\n// Perform manual iteration...\nvar v;\nwhile ( true ) {\n    v = it.next();\n    if ( v.done ) {\n        break;\n    }\n    console.log( v.value );\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"references\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/simulate-iter/pulse`][@stdlib/simulate/iter/pulse]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an iterator which generates a pulse waveform.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/simulate-iter/sawtooth-wave`][@stdlib/simulate/iter/sawtooth-wave]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an iterator which generates a sawtooth wave.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/simulate-iter/sine-wave`][@stdlib/simulate/iter/sine-wave]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an iterator which generates a sine wave.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/simulate-iter/square-wave`][@stdlib/simulate/iter/square-wave]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an iterator which generates a square wave.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/simulate-iter/triangle-wave`][@stdlib/simulate/iter/triangle-wave]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecreate an iterator which generates a triangle wave.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/simulate-iter-cosine-wave.svg\n[npm-url]: https://npmjs.org/package/@stdlib/simulate-iter-cosine-wave\n\n[test-image]: https://github.com/stdlib-js/simulate-iter-cosine-wave/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/simulate-iter-cosine-wave/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/simulate-iter-cosine-wave/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/simulate-iter-cosine-wave?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/simulate-iter-cosine-wave.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/simulate-iter-cosine-wave/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/simulate-iter-cosine-wave/tree/deno\n[deno-readme]: https://github.com/stdlib-js/simulate-iter-cosine-wave/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/simulate-iter-cosine-wave/tree/umd\n[umd-readme]: https://github.com/stdlib-js/simulate-iter-cosine-wave/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/simulate-iter-cosine-wave/tree/esm\n[esm-readme]: https://github.com/stdlib-js/simulate-iter-cosine-wave/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/simulate-iter-cosine-wave/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/simulate-iter-cosine-wave/main/LICENSE\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/simulate/iter/pulse]: https://github.com/stdlib-js/simulate-iter-pulse\n\n[@stdlib/simulate/iter/sawtooth-wave]: https://github.com/stdlib-js/simulate-iter-sawtooth-wave\n\n[@stdlib/simulate/iter/sine-wave]: https://github.com/stdlib-js/simulate-iter-sine-wave\n\n[@stdlib/simulate/iter/square-wave]: https://github.com/stdlib-js/simulate-iter-square-wave\n\n[@stdlib/simulate/iter/triangle-wave]: https://github.com/stdlib-js/simulate-iter-triangle-wave\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fsimulate-iter-cosine-wave","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fsimulate-iter-cosine-wave","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fsimulate-iter-cosine-wave/lists"}