README.md (12112B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2020 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # Sequences 22 23 > Standard library math iterators for generating sequences. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var ns = require( '@stdlib/math/iter/sequences' ); 31 ``` 32 33 #### ns 34 35 Standard library math iterators for generating sequences. 36 37 ```javascript 38 var iterators = ns; 39 // returns {...} 40 ``` 41 42 The namespace contains the following functions for creating iterator protocol-compliant iterators: 43 44 <!-- <toc pattern="*"> --> 45 46 <div class="namespace-toc"> 47 48 - <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> 49 - <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> 50 - <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> 51 - <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> 52 - <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> 53 - <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> 54 - <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> 55 - <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> 56 - <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> 57 - <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> 58 - <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> 59 - <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> 60 - <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> 61 - <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> 62 - <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> 63 - <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> 64 - <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> 65 - <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> 66 - <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> 67 - <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> 68 - <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> 69 - <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> 70 - <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> 71 - <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> 72 - <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> 73 - <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> 74 - <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> 75 - <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> 76 77 </div> 78 79 <!-- </toc> --> 80 81 </section> 82 83 <!-- /.usage --> 84 85 <section class="examples"> 86 87 ## Examples 88 89 <!-- TODO: better examples --> 90 91 <!-- eslint no-undef: "error" --> 92 93 ```javascript 94 var objectKeys = require( '@stdlib/utils/keys' ); 95 var ns = require( '@stdlib/math/iter/sequences' ); 96 97 console.log( objectKeys( ns ) ); 98 ``` 99 100 </section> 101 102 <!-- /.examples --> 103 104 <section class="links"> 105 106 <!-- <toc-links> --> 107 108 [@stdlib/math/iter/sequences/composites]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/composites 109 110 [@stdlib/math/iter/sequences/cubes]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/cubes 111 112 [@stdlib/math/iter/sequences/even-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/even-integers 113 114 [@stdlib/math/iter/sequences/factorials]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/factorials 115 116 [@stdlib/math/iter/sequences/fibonacci]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/fibonacci 117 118 [@stdlib/math/iter/sequences/fifth-powers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/fifth-powers 119 120 [@stdlib/math/iter/sequences/fourth-powers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/fourth-powers 121 122 [@stdlib/math/iter/sequences/integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/integers 123 124 [@stdlib/math/iter/sequences/lucas]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/lucas 125 126 [@stdlib/math/iter/sequences/negafibonacci]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/negafibonacci 127 128 [@stdlib/math/iter/sequences/negalucas]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/negalucas 129 130 [@stdlib/math/iter/sequences/negative-even-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/negative-even-integers 131 132 [@stdlib/math/iter/sequences/negative-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/negative-integers 133 134 [@stdlib/math/iter/sequences/negative-odd-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/negative-odd-integers 135 136 [@stdlib/math/iter/sequences/nonfibonacci]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/nonfibonacci 137 138 [@stdlib/math/iter/sequences/nonnegative-even-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/nonnegative-even-integers 139 140 [@stdlib/math/iter/sequences/nonnegative-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/nonnegative-integers 141 142 [@stdlib/math/iter/sequences/nonpositive-even-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/nonpositive-even-integers 143 144 [@stdlib/math/iter/sequences/nonpositive-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/nonpositive-integers 145 146 [@stdlib/math/iter/sequences/nonsquares]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/nonsquares 147 148 [@stdlib/math/iter/sequences/odd-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/odd-integers 149 150 [@stdlib/math/iter/sequences/positive-even-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/positive-even-integers 151 152 [@stdlib/math/iter/sequences/positive-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/positive-integers 153 154 [@stdlib/math/iter/sequences/positive-odd-integers]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/positive-odd-integers 155 156 [@stdlib/math/iter/sequences/primes]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/primes 157 158 [@stdlib/math/iter/sequences/squared-triangular]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/squared-triangular 159 160 [@stdlib/math/iter/sequences/squares]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/squares 161 162 [@stdlib/math/iter/sequences/triangular]: https://www.npmjs.com/package/@stdlib/math/tree/main/iter/sequences/triangular 163 164 <!-- </toc-links> --> 165 166 </section> 167 168 <!-- /.links -->