Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/simulate-iter-sawtooth-wave

Create an iterator which generates a sawtooth wave.

https://github.com/stdlib-js/simulate-iter-sawtooth-wave

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.3%) to scientific vocabulary

Keywords

iter iterate iteration iterator javascript node node-js nodejs periodic processing saw sawtooth signal simulate simulation stdlib wave waveform
Last synced: 4 months ago · JSON representation ·

Repository

Create an iterator which generates a sawtooth wave.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
iter iterate iteration iterator javascript node node-js nodejs periodic processing saw sawtooth signal simulate simulation stdlib wave waveform
Created over 4 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

We 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!

iterSawtoothWave

NPM version Build Status Coverage Status <!-- dependencies -->

Create an iterator which generates a sawtooth wave.

A sawtooth waveform is represented by the following equation ```math f(t; \tau, a, \varphi) = \frac{2a}{\pi} \mathop{\mathrm{arctan}} \tan \frac{\pi(t-\varphi)}{\tau} ``` where `τ` is the period, `a` is the peak amplitude, and `φ` is the phase offset.
## Installation ```bash npm install @stdlib/simulate-iter-sawtooth-wave ``` Alternatively, - 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]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - 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]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To 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.
## Usage ```javascript var iterSawtoothWave = require( '@stdlib/simulate-iter-sawtooth-wave' ); ``` #### iterSawtoothWave( \[options] ) Returns an iterator which generates a sawtooth wave. ```javascript var it = iterSawtoothWave(); // returns var v = it.next().value; // returns v = it.next().value; // returns v = it.next().value; // returns // ... ``` 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`. - **amplitude**: peak amplitude. Default: `1.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: `0`. - **iter**: number of iterations. Default: `1e308`. By default, the function returns an iterator which generates a sawtooth wave that repeats every `10` iterations. To specify an alternative period, set the `period` option. ```javascript var opts = { 'period': 4 }; var it = iterSawtoothWave( opts ); // returns var v = it.next().value; // returns 0.0 v = it.next().value; // returns ~0.5 v = it.next().value; // returns ~1.0 v = it.next().value; // returns ~-0.5 v = it.next().value; // returns 0.0 // ... ``` 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 = iterSawtoothWave( opts ); // returns var v = it.next().value; // returns ~0.5 v = it.next().value; // returns ~1.0 v = it.next().value; // returns ~-0.5 v = it.next().value; // returns 0.0 v = it.next().value; // returns ~0.5 // ... ``` To translate the waveform to the right, ```javascript var opts = { 'period': 4, 'offset': 1 }; var it = iterSawtoothWave( opts ); // returns var v = it.next().value; // returns ~-0.5 v = it.next().value; // returns 0.0 v = it.next().value; // returns ~0.5 v = it.next().value; // returns ~1.0 v = it.next().value; // returns ~-0.5 // ... ``` 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 = iterSawtoothWave( opts ); // returns var v = it.next().value; // returns v = it.next().value; // returns var bool = it.next().done; // returns true ```
## Notes - If an environment supports `Symbol.iterator`, the returned iterator is iterable.
## Examples ```javascript var iterSawtoothWave = require( '@stdlib/simulate-iter-sawtooth-wave' ); // Create an iterator: var opts = { 'period': 10, 'amplitude': 10.0, 'offset': -5, 'iter': 100 }; var it = iterSawtoothWave( 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. - [`@stdlib/simulate-iter/sine-wave`][@stdlib/simulate/iter/sine-wave]: create an iterator which generates a sine wave. - [`@stdlib/simulate-iter/square-wave`][@stdlib/simulate/iter/square-wave]: create an iterator which generates a square wave. - [`@stdlib/simulate-iter/triangle-wave`][@stdlib/simulate/iter/triangle-wave]: create an iterator which generates a triangle wave.
* * * ## 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-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 20
Last Year
  • Push event: 20

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 56
  • Total Committers: 1
  • Avg Commits per committer: 56.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 9
  • Committers: 1
  • Avg Commits per committer: 9.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 56
Committer Domains (Top 20 + Academic)
stdlib.io: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 35 last-month
  • Total dependent packages: 3
  • Total dependent repositories: 1
  • Total versions: 10
  • Total maintainers: 4
npmjs.org: @stdlib/simulate-iter-sawtooth-wave

Create an iterator which generates a sawtooth wave.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 10
  • Dependent Packages: 3
  • Dependent Repositories: 1
  • Downloads: 35 Last month
Rankings
Dependent packages count: 5.9%
Dependent repos count: 10.3%
Average: 13.1%
Forks count: 15.4%
Stargazers count: 16.7%
Downloads: 17.2%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 4 months ago

Dependencies

package.json npm
  • @stdlib/assert-is-iterator-like ^0.0.x development
  • @stdlib/bench ^0.0.x development
  • @stdlib/constants-float64-eps ^0.0.x development
  • @stdlib/math-base-assert-is-nan ^0.0.x development
  • @stdlib/math-base-special-abs ^0.0.x development
  • istanbul ^0.4.1 development
  • proxyquire ^2.0.0 development
  • tap-spec 5.x.x development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/assert-has-own-property ^0.0.x
  • @stdlib/assert-is-integer ^0.0.x
  • @stdlib/assert-is-nonnegative-integer ^0.0.x
  • @stdlib/assert-is-nonnegative-number ^0.0.x
  • @stdlib/assert-is-plain-object ^0.0.x
  • @stdlib/assert-is-positive-integer ^0.0.x
  • @stdlib/constants-float64-half-pi ^0.0.x
  • @stdlib/constants-float64-pi ^0.0.x
  • @stdlib/math-base-special-atan ^0.0.x
  • @stdlib/math-base-special-tan ^0.0.x
  • @stdlib/string-format ^0.0.x
  • @stdlib/symbol-iterator ^0.0.x
  • @stdlib/types ^0.0.x
  • @stdlib/utils-define-nonenumerable-read-only-property ^0.0.x
.github/workflows/benchmark.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request v3 composite
.github/workflows/examples.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/productionize.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish v1 composite
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/test.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/test_bundles.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • denoland/setup-deno v1 composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • codecov/codecov-action v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/test_install.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite