time-to-botec/squiggle/node_modules/@stdlib/math/iter/sequences/README.md

<!--

@license Apache-2.0

Copyright (c) 2020 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# Sequences

> Standard library math iterators for generating sequences.

<section class="usage">

## Usage

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

#### ns

Standard library math iterators for generating sequences.

```javascript
var iterators = ns;
// returns {...}
```

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

<!-- <toc pattern="*"> -->

<div class="namespace-toc">

-   <span class="signature">[`iterCompositesSeq( [options] )`][@stdlib/math/iter/sequences/composites]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of composite numbers.</span>
-   <span class="signature">[`iterCubesSeq( [options] )`][@stdlib/math/iter/sequences/cubes]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of cubes.</span>
-   <span class="signature">[`iterEvenIntegersSeq( [options] )`][@stdlib/math/iter/sequences/even-integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates an interleaved sequence of even integers.</span>
-   <span class="signature">[`iterFactorialsSeq( [options] )`][@stdlib/math/iter/sequences/factorials]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of factorials.</span>
-   <span class="signature">[`iterFibonacciSeq( [options] )`][@stdlib/math/iter/sequences/fibonacci]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a Fibonacci sequence.</span>
-   <span class="signature">[`iterFifthPowersSeq( [options] )`][@stdlib/math/iter/sequences/fifth-powers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of fifth powers.</span>
-   <span class="signature">[`iterFourthPowersSeq( [options] )`][@stdlib/math/iter/sequences/fourth-powers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of fourth powers.</span>
-   <span class="signature">[`iterIntegersSeq( [options] )`][@stdlib/math/iter/sequences/integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates an interleaved integer sequence.</span>
-   <span class="signature">[`iterLucasSeq( [options] )`][@stdlib/math/iter/sequences/lucas]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a Lucas sequence.</span>
-   <span class="signature">[`iterNegaFibonacciSeq( [options] )`][@stdlib/math/iter/sequences/negafibonacci]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a negaFibonacci sequence.</span>
-   <span class="signature">[`iterNegaLucasSeq( [options] )`][@stdlib/math/iter/sequences/negalucas]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a negaLucas sequence.</span>
-   <span class="signature">[`iterNegativeEvenIntegersSeq( [options] )`][@stdlib/math/iter/sequences/negative-even-integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of negative even integers.</span>
-   <span class="signature">[`iterNegativeIntegersSeq( [options] )`][@stdlib/math/iter/sequences/negative-integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a negative integer sequence.</span>
-   <span class="signature">[`iterNegativeOddIntegersSeq( [options] )`][@stdlib/math/iter/sequences/negative-odd-integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of negative odd integers.</span>
-   <span class="signature">[`iterNonFibonacciSeq( [options] )`][@stdlib/math/iter/sequences/nonfibonacci]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a non-Fibonacci integer sequence.</span>
-   <span class="signature">[`iterNonNegativeEvenIntegersSeq( [options] )`][@stdlib/math/iter/sequences/nonnegative-even-integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of nonnegative even integers.</span>
-   <span class="signature">[`iterNonNegativeIntegersSeq( [options] )`][@stdlib/math/iter/sequences/nonnegative-integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a nonnegative integer sequence.</span>
-   <span class="signature">[`iterNonPositiveEvenIntegersSeq( [options] )`][@stdlib/math/iter/sequences/nonpositive-even-integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of nonpositive even integers.</span>
-   <span class="signature">[`iterNonPositiveIntegersSeq( [options] )`][@stdlib/math/iter/sequences/nonpositive-integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a nonpositive integer sequence.</span>
-   <span class="signature">[`iterNonSquaresSeq( [options] )`][@stdlib/math/iter/sequences/nonsquares]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of nonsquares.</span>
-   <span class="signature">[`iterOddIntegersSeq( [options] )`][@stdlib/math/iter/sequences/odd-integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates an interleaved sequence of odd integers.</span>
-   <span class="signature">[`iterPositiveEvenIntegersSeq( [options] )`][@stdlib/math/iter/sequences/positive-even-integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of positive even integers.</span>
-   <span class="signature">[`iterPositiveIntegersSeq( [options] )`][@stdlib/math/iter/sequences/positive-integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a positive integer sequence.</span>
-   <span class="signature">[`iterPositiveOddIntegersSeq( [options] )`][@stdlib/math/iter/sequences/positive-odd-integers]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of positive odd integers.</span>
-   <span class="signature">[`iterPrimesSeq( [options] )`][@stdlib/math/iter/sequences/primes]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of prime numbers.</span>
-   <span class="signature">[`iterSquaredTriangularSeq( [options] )`][@stdlib/math/iter/sequences/squared-triangular]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of squared triangular numbers.</span>
-   <span class="signature">[`iterSquaresSeq( [options] )`][@stdlib/math/iter/sequences/squares]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of squares.</span>
-   <span class="signature">[`iterTriangularSeq( [options] )`][@stdlib/math/iter/sequences/triangular]</span><span class="delimiter">: </span><span class="description">create an iterator which generates a sequence of triangular numbers.</span>

</div>

<!-- </toc> -->

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better examples -->

<!-- eslint no-undef: "error" -->

```javascript
var objectKeys = require( '@stdlib/utils/keys' );
var ns = require( '@stdlib/math/iter/sequences' );

console.log( objectKeys( ns ) );
```

</section>

<!-- /.examples -->

<section class="links">

<!-- <toc-links> -->

[@stdlib/math/iter/sequences/composites]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/composites

[@stdlib/math/iter/sequences/cubes]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/cubes

[@stdlib/math/iter/sequences/even-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/even-integers

[@stdlib/math/iter/sequences/factorials]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/factorials

[@stdlib/math/iter/sequences/fibonacci]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/fibonacci

[@stdlib/math/iter/sequences/fifth-powers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/fifth-powers

[@stdlib/math/iter/sequences/fourth-powers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/fourth-powers

[@stdlib/math/iter/sequences/integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/integers

[@stdlib/math/iter/sequences/lucas]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/lucas

[@stdlib/math/iter/sequences/negafibonacci]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/negafibonacci

[@stdlib/math/iter/sequences/negalucas]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/negalucas

[@stdlib/math/iter/sequences/negative-even-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/negative-even-integers

[@stdlib/math/iter/sequences/negative-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/negative-integers

[@stdlib/math/iter/sequences/negative-odd-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/negative-odd-integers

[@stdlib/math/iter/sequences/nonfibonacci]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/nonfibonacci

[@stdlib/math/iter/sequences/nonnegative-even-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/nonnegative-even-integers

[@stdlib/math/iter/sequences/nonnegative-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/nonnegative-integers

[@stdlib/math/iter/sequences/nonpositive-even-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/nonpositive-even-integers

[@stdlib/math/iter/sequences/nonpositive-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/nonpositive-integers

[@stdlib/math/iter/sequences/nonsquares]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/nonsquares

[@stdlib/math/iter/sequences/odd-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/odd-integers

[@stdlib/math/iter/sequences/positive-even-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/positive-even-integers

[@stdlib/math/iter/sequences/positive-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/positive-integers

[@stdlib/math/iter/sequences/positive-odd-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/positive-odd-integers

[@stdlib/math/iter/sequences/primes]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/primes

[@stdlib/math/iter/sequences/squared-triangular]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/squared-triangular

[@stdlib/math/iter/sequences/squares]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/squares

[@stdlib/math/iter/sequences/triangular]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/triangular

<!-- </toc-links> -->

</section>

<!-- /.links -->