https://github.com/stdlib-js/math-iter-sequences

Standard library math iterators for generating sequences.
https://github.com/stdlib-js/math-iter-sequences
integer iter iterable iteration iterator javascript lib library math mathematics node node-js nodejs seq sequence sequences standard stdlib
Last synced: about 1 year ago
JSON representation
Standard library math iterators for generating sequences.
Host: GitHub
URL: https://github.com/stdlib-js/math-iter-sequences
Owner: stdlib-js
License: apache-2.0
Created: 2021-06-15T17:31:49.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2024-12-30T05:06:17.000Z (about 1 year ago)
Last Synced: 2025-01-30T16:39:57.143Z (about 1 year ago)
Topics: integer, iter, iterable, iteration, iterator, javascript, lib, library, math, mathematics, node, node-js, nodejs, seq, sequence, sequences, standard, stdlib
Language: JavaScript
Homepage: https://github.com/stdlib-js/stdlib
Size: 2.38 MB
Stars: 2
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project

README

          

  

    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!


# Sequences

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 

> Math iterators for generating sequences.

## Installation

```bash

npm install @stdlib/math-iter-sequences

```

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 ns = require( '@stdlib/math-iter-sequences' );

```

#### ns

Namespace containing math iterators for generating sequences.

```javascript

var iterators = ns;

// returns {...}

```

The namespace contains the following functions for creating iterator protocol-compliant iterators:



-   [`iterCompositesSeq( [options] )`][@stdlib/math/iter/sequences/composites]: create an iterator which generates a sequence of composite numbers.

-   [`iterContinuedFractionSeq( x, [options] )`][@stdlib/math/iter/sequences/continued-fraction]: create an iterator which generates a list of all continued fraction terms which can be obtained given the precision of a provided number.

-   [`iterCubesSeq( [options] )`][@stdlib/math/iter/sequences/cubes]: create an iterator which generates a sequence of cubes.

-   [`iterEvenIntegersSeq( [options] )`][@stdlib/math/iter/sequences/even-integers]: create an iterator which generates an interleaved sequence of even integers.

-   [`iterFactorialsSeq( [options] )`][@stdlib/math/iter/sequences/factorials]: create an iterator which generates a sequence of factorials.

-   [`iterFibonacciSeq( [options] )`][@stdlib/math/iter/sequences/fibonacci]: create an iterator which generates a Fibonacci sequence.

-   [`iterFifthPowersSeq( [options] )`][@stdlib/math/iter/sequences/fifth-powers]: create an iterator which generates a sequence of fifth powers.

-   [`iterFourthPowersSeq( [options] )`][@stdlib/math/iter/sequences/fourth-powers]: create an iterator which generates a sequence of fourth powers.

-   [`iterIntegersSeq( [options] )`][@stdlib/math/iter/sequences/integers]: create an iterator which generates an interleaved integer sequence.

-   [`iterLucasSeq( [options] )`][@stdlib/math/iter/sequences/lucas]: create an iterator which generates a Lucas sequence.

-   [`iterNegaFibonacciSeq( [options] )`][@stdlib/math/iter/sequences/negafibonacci]: create an iterator which generates a negaFibonacci sequence.

-   [`iterNegaLucasSeq( [options] )`][@stdlib/math/iter/sequences/negalucas]: create an iterator which generates a negaLucas sequence.

-   [`iterNegativeEvenIntegersSeq( [options] )`][@stdlib/math/iter/sequences/negative-even-integers]: create an iterator which generates a sequence of negative even integers.

-   [`iterNegativeIntegersSeq( [options] )`][@stdlib/math/iter/sequences/negative-integers]: create an iterator which generates a negative integer sequence.

-   [`iterNegativeOddIntegersSeq( [options] )`][@stdlib/math/iter/sequences/negative-odd-integers]: create an iterator which generates a sequence of negative odd integers.

-   [`iterNonFibonacciSeq( [options] )`][@stdlib/math/iter/sequences/nonfibonacci]: create an iterator which generates a non-Fibonacci integer sequence.

-   [`iterNonNegativeEvenIntegersSeq( [options] )`][@stdlib/math/iter/sequences/nonnegative-even-integers]: create an iterator which generates a sequence of nonnegative even integers.

-   [`iterNonNegativeIntegersSeq( [options] )`][@stdlib/math/iter/sequences/nonnegative-integers]: create an iterator which generates a nonnegative integer sequence.

-   [`iterNonPositiveEvenIntegersSeq( [options] )`][@stdlib/math/iter/sequences/nonpositive-even-integers]: create an iterator which generates a sequence of nonpositive even integers.

-   [`iterNonPositiveIntegersSeq( [options] )`][@stdlib/math/iter/sequences/nonpositive-integers]: create an iterator which generates a nonpositive integer sequence.

-   [`iterNonSquaresSeq( [options] )`][@stdlib/math/iter/sequences/nonsquares]: create an iterator which generates a sequence of nonsquares.

-   [`iterOddIntegersSeq( [options] )`][@stdlib/math/iter/sequences/odd-integers]: create an iterator which generates an interleaved sequence of odd integers.

-   [`iterPositiveEvenIntegersSeq( [options] )`][@stdlib/math/iter/sequences/positive-even-integers]: create an iterator which generates a sequence of positive even integers.

-   [`iterPositiveIntegersSeq( [options] )`][@stdlib/math/iter/sequences/positive-integers]: create an iterator which generates a positive integer sequence.

-   [`iterPositiveOddIntegersSeq( [options] )`][@stdlib/math/iter/sequences/positive-odd-integers]: create an iterator which generates a sequence of positive odd integers.

-   [`iterPrimesSeq( [options] )`][@stdlib/math/iter/sequences/primes]: create an iterator which generates a sequence of prime numbers.

-   [`iterSquaredTriangularSeq( [options] )`][@stdlib/math/iter/sequences/squared-triangular]: create an iterator which generates a sequence of squared triangular numbers.

-   [`iterSquaresSeq( [options] )`][@stdlib/math/iter/sequences/squares]: create an iterator which generates a sequence of squares.

-   [`iterTriangularSeq( [options] )`][@stdlib/math/iter/sequences/triangular]: create an iterator which generates a sequence of triangular numbers.



## Examples

```javascript

var ns = require( '@stdlib/math-iter-sequences' );

// Create iterators for generating square and cube numbers:

var squares = ns.iterSquaresSeq();

var cubes = ns.iterCubesSeq();

// Iterate over both sequences and log the first five pairs:

var i;

for ( i = 0; i < 5; i++ ) {

    console.log( 'Square: %d, Cube: %d', squares.next().value, cubes.next().value );

}

// Calculate the sum of the first ten Fibonacci numbers:

var fibonacci = ns.iterFibonacciSeq({

    'iter': 10

});

var sum = 0;

var v = fibonacci.next();

while ( v.done === false ) {

    sum += v.value;

    v = fibonacci.next();

}

console.log( 'Sum of first ten Fibonacci numbers: %d', sum );

// Generate prime numbers:

var primes = ns.iterPrimesSeq({

    'iter': 10

});

console.log( 'First ten prime numbers:' );

v = primes.next();

while ( v.done === false ) {

    console.log( v.value );

    v = primes.next();

}

```

* * *

## 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-2024. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/math-iter-sequences.svg

[npm-url]: https://npmjs.org/package/@stdlib/math-iter-sequences

[test-image]: https://github.com/stdlib-js/math-iter-sequences/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/math-iter-sequences/actions/workflows/test.yml?query=branch:main

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-iter-sequences/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/math-iter-sequences?branch=main

[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im

[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/math-iter-sequences/tree/deno

[deno-readme]: https://github.com/stdlib-js/math-iter-sequences/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/math-iter-sequences/tree/umd

[umd-readme]: https://github.com/stdlib-js/math-iter-sequences/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/math-iter-sequences/tree/esm

[esm-readme]: https://github.com/stdlib-js/math-iter-sequences/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/math-iter-sequences/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-iter-sequences/main/LICENSE

[@stdlib/math/iter/sequences/composites]: https://github.com/stdlib-js/math-iter-sequences-composites

[@stdlib/math/iter/sequences/continued-fraction]: https://github.com/stdlib-js/math-iter-sequences-continued-fraction

[@stdlib/math/iter/sequences/cubes]: https://github.com/stdlib-js/math-iter-sequences-cubes

[@stdlib/math/iter/sequences/even-integers]: https://github.com/stdlib-js/math-iter-sequences-even-integers

[@stdlib/math/iter/sequences/factorials]: https://github.com/stdlib-js/math-iter-sequences-factorials

[@stdlib/math/iter/sequences/fibonacci]: https://github.com/stdlib-js/math-iter-sequences-fibonacci

[@stdlib/math/iter/sequences/fifth-powers]: https://github.com/stdlib-js/math-iter-sequences-fifth-powers

[@stdlib/math/iter/sequences/fourth-powers]: https://github.com/stdlib-js/math-iter-sequences-fourth-powers

[@stdlib/math/iter/sequences/integers]: https://github.com/stdlib-js/math-iter-sequences-integers

[@stdlib/math/iter/sequences/lucas]: https://github.com/stdlib-js/math-iter-sequences-lucas

[@stdlib/math/iter/sequences/negafibonacci]: https://github.com/stdlib-js/math-iter-sequences-negafibonacci

[@stdlib/math/iter/sequences/negalucas]: https://github.com/stdlib-js/math-iter-sequences-negalucas

[@stdlib/math/iter/sequences/negative-even-integers]: https://github.com/stdlib-js/math-iter-sequences-negative-even-integers

[@stdlib/math/iter/sequences/negative-integers]: https://github.com/stdlib-js/math-iter-sequences-negative-integers

[@stdlib/math/iter/sequences/negative-odd-integers]: https://github.com/stdlib-js/math-iter-sequences-negative-odd-integers

[@stdlib/math/iter/sequences/nonfibonacci]: https://github.com/stdlib-js/math-iter-sequences-nonfibonacci

[@stdlib/math/iter/sequences/nonnegative-even-integers]: https://github.com/stdlib-js/math-iter-sequences-nonnegative-even-integers

[@stdlib/math/iter/sequences/nonnegative-integers]: https://github.com/stdlib-js/math-iter-sequences-nonnegative-integers

[@stdlib/math/iter/sequences/nonpositive-even-integers]: https://github.com/stdlib-js/math-iter-sequences-nonpositive-even-integers

[@stdlib/math/iter/sequences/nonpositive-integers]: https://github.com/stdlib-js/math-iter-sequences-nonpositive-integers

[@stdlib/math/iter/sequences/nonsquares]: https://github.com/stdlib-js/math-iter-sequences-nonsquares

[@stdlib/math/iter/sequences/odd-integers]: https://github.com/stdlib-js/math-iter-sequences-odd-integers

[@stdlib/math/iter/sequences/positive-even-integers]: https://github.com/stdlib-js/math-iter-sequences-positive-even-integers

[@stdlib/math/iter/sequences/positive-integers]: https://github.com/stdlib-js/math-iter-sequences-positive-integers

[@stdlib/math/iter/sequences/positive-odd-integers]: https://github.com/stdlib-js/math-iter-sequences-positive-odd-integers

[@stdlib/math/iter/sequences/primes]: https://github.com/stdlib-js/math-iter-sequences-primes

[@stdlib/math/iter/sequences/squared-triangular]: https://github.com/stdlib-js/math-iter-sequences-squared-triangular

[@stdlib/math/iter/sequences/squares]: https://github.com/stdlib-js/math-iter-sequences-squares

[@stdlib/math/iter/sequences/triangular]: https://github.com/stdlib-js/math-iter-sequences-triangular
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/stdlib-js/math-iter-sequences

Awesome Lists containing this project

README
