index.js (7857B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2020 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /* 22 * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name. 23 */ 24 25 // MODULES // 26 27 var setReadOnly = require( '@stdlib/utils/define-read-only-property' ); 28 29 30 // MAIN // 31 32 /** 33 * Top-level namespace. 34 * 35 * @namespace ns 36 */ 37 var ns = {}; 38 39 /** 40 * @name iterCompositesSeq 41 * @memberof ns 42 * @readonly 43 * @type {Function} 44 * @see {@link module:@stdlib/math/iter/sequences/composites} 45 */ 46 setReadOnly( ns, 'iterCompositesSeq', require( './../../../iter/sequences/composites' ) ); 47 48 /** 49 * @name iterCubesSeq 50 * @memberof ns 51 * @readonly 52 * @type {Function} 53 * @see {@link module:@stdlib/math/iter/sequences/cubes} 54 */ 55 setReadOnly( ns, 'iterCubesSeq', require( './../../../iter/sequences/cubes' ) ); 56 57 /** 58 * @name iterEvenIntegersSeq 59 * @memberof ns 60 * @readonly 61 * @type {Function} 62 * @see {@link module:@stdlib/math/iter/sequences/even-integers} 63 */ 64 setReadOnly( ns, 'iterEvenIntegersSeq', require( './../../../iter/sequences/even-integers' ) ); 65 66 /** 67 * @name iterFactorialsSeq 68 * @memberof ns 69 * @readonly 70 * @type {Function} 71 * @see {@link module:@stdlib/math/iter/sequences/factorials} 72 */ 73 setReadOnly( ns, 'iterFactorialsSeq', require( './../../../iter/sequences/factorials' ) ); 74 75 /** 76 * @name iterFibonacciSeq 77 * @memberof ns 78 * @readonly 79 * @type {Function} 80 * @see {@link module:@stdlib/math/iter/sequences/fibonacci} 81 */ 82 setReadOnly( ns, 'iterFibonacciSeq', require( './../../../iter/sequences/fibonacci' ) ); 83 84 /** 85 * @name iterFifthPowersSeq 86 * @memberof ns 87 * @readonly 88 * @type {Function} 89 * @see {@link module:@stdlib/math/iter/sequences/fifth-powers} 90 */ 91 setReadOnly( ns, 'iterFifthPowersSeq', require( './../../../iter/sequences/fifth-powers' ) ); 92 93 /** 94 * @name iterFourthPowersSeq 95 * @memberof ns 96 * @readonly 97 * @type {Function} 98 * @see {@link module:@stdlib/math/iter/sequences/fourth-powers} 99 */ 100 setReadOnly( ns, 'iterFourthPowersSeq', require( './../../../iter/sequences/fourth-powers' ) ); 101 102 /** 103 * @name iterIntegersSeq 104 * @memberof ns 105 * @readonly 106 * @type {Function} 107 * @see {@link module:@stdlib/math/iter/sequences/integers} 108 */ 109 setReadOnly( ns, 'iterIntegersSeq', require( './../../../iter/sequences/integers' ) ); 110 111 /** 112 * @name iterLucasSeq 113 * @memberof ns 114 * @readonly 115 * @type {Function} 116 * @see {@link module:@stdlib/math/iter/sequences/lucas} 117 */ 118 setReadOnly( ns, 'iterLucasSeq', require( './../../../iter/sequences/lucas' ) ); 119 120 /** 121 * @name iterNegaFibonacciSeq 122 * @memberof ns 123 * @readonly 124 * @type {Function} 125 * @see {@link module:@stdlib/math/iter/sequences/negafibonacci} 126 */ 127 setReadOnly( ns, 'iterNegaFibonacciSeq', require( './../../../iter/sequences/negafibonacci' ) ); 128 129 /** 130 * @name iterNegaLucasSeq 131 * @memberof ns 132 * @readonly 133 * @type {Function} 134 * @see {@link module:@stdlib/math/iter/sequences/negalucas} 135 */ 136 setReadOnly( ns, 'iterNegaLucasSeq', require( './../../../iter/sequences/negalucas' ) ); 137 138 /** 139 * @name iterNegativeEvenIntegersSeq 140 * @memberof ns 141 * @readonly 142 * @type {Function} 143 * @see {@link module:@stdlib/math/iter/sequences/negative-even-integers} 144 */ 145 setReadOnly( ns, 'iterNegativeEvenIntegersSeq', require( './../../../iter/sequences/negative-even-integers' ) ); 146 147 /** 148 * @name iterNegativeIntegersSeq 149 * @memberof ns 150 * @readonly 151 * @type {Function} 152 * @see {@link module:@stdlib/math/iter/sequences/negative-integers} 153 */ 154 setReadOnly( ns, 'iterNegativeIntegersSeq', require( './../../../iter/sequences/negative-integers' ) ); 155 156 /** 157 * @name iterNegativeOddIntegersSeq 158 * @memberof ns 159 * @readonly 160 * @type {Function} 161 * @see {@link module:@stdlib/math/iter/sequences/negative-odd-integers} 162 */ 163 setReadOnly( ns, 'iterNegativeOddIntegersSeq', require( './../../../iter/sequences/negative-odd-integers' ) ); 164 165 /** 166 * @name iterNonFibonacciSeq 167 * @memberof ns 168 * @readonly 169 * @type {Function} 170 * @see {@link module:@stdlib/math/iter/sequences/nonfibonacci} 171 */ 172 setReadOnly( ns, 'iterNonFibonacciSeq', require( './../../../iter/sequences/nonfibonacci' ) ); 173 174 /** 175 * @name iterNonNegativeEvenIntegersSeq 176 * @memberof ns 177 * @readonly 178 * @type {Function} 179 * @see {@link module:@stdlib/math/iter/sequences/nonnegative-even-integers} 180 */ 181 setReadOnly( ns, 'iterNonNegativeEvenIntegersSeq', require( './../../../iter/sequences/nonnegative-even-integers' ) ); 182 183 /** 184 * @name iterNonNegativeIntegersSeq 185 * @memberof ns 186 * @readonly 187 * @type {Function} 188 * @see {@link module:@stdlib/math/iter/sequences/nonnegative-integers} 189 */ 190 setReadOnly( ns, 'iterNonNegativeIntegersSeq', require( './../../../iter/sequences/nonnegative-integers' ) ); 191 192 /** 193 * @name iterNonPositiveEvenIntegersSeq 194 * @memberof ns 195 * @readonly 196 * @type {Function} 197 * @see {@link module:@stdlib/math/iter/sequences/nonpositive-even-integers} 198 */ 199 setReadOnly( ns, 'iterNonPositiveEvenIntegersSeq', require( './../../../iter/sequences/nonpositive-even-integers' ) ); 200 201 /** 202 * @name iterNonPositiveIntegersSeq 203 * @memberof ns 204 * @readonly 205 * @type {Function} 206 * @see {@link module:@stdlib/math/iter/sequences/nonpositive-integers} 207 */ 208 setReadOnly( ns, 'iterNonPositiveIntegersSeq', require( './../../../iter/sequences/nonpositive-integers' ) ); 209 210 /** 211 * @name iterNonSquaresSeq 212 * @memberof ns 213 * @readonly 214 * @type {Function} 215 * @see {@link module:@stdlib/math/iter/sequences/nonsquares} 216 */ 217 setReadOnly( ns, 'iterNonSquaresSeq', require( './../../../iter/sequences/nonsquares' ) ); 218 219 /** 220 * @name iterOddIntegersSeq 221 * @memberof ns 222 * @readonly 223 * @type {Function} 224 * @see {@link module:@stdlib/math/iter/sequences/odd-integers} 225 */ 226 setReadOnly( ns, 'iterOddIntegersSeq', require( './../../../iter/sequences/odd-integers' ) ); 227 228 /** 229 * @name iterPositiveEvenIntegersSeq 230 * @memberof ns 231 * @readonly 232 * @type {Function} 233 * @see {@link module:@stdlib/math/iter/sequences/positive-even-integers} 234 */ 235 setReadOnly( ns, 'iterPositiveEvenIntegersSeq', require( './../../../iter/sequences/positive-even-integers' ) ); 236 237 /** 238 * @name iterPositiveIntegersSeq 239 * @memberof ns 240 * @readonly 241 * @type {Function} 242 * @see {@link module:@stdlib/math/iter/sequences/positive-integers} 243 */ 244 setReadOnly( ns, 'iterPositiveIntegersSeq', require( './../../../iter/sequences/positive-integers' ) ); 245 246 /** 247 * @name iterPositiveOddIntegersSeq 248 * @memberof ns 249 * @readonly 250 * @type {Function} 251 * @see {@link module:@stdlib/math/iter/sequences/positive-odd-integers} 252 */ 253 setReadOnly( ns, 'iterPositiveOddIntegersSeq', require( './../../../iter/sequences/positive-odd-integers' ) ); 254 255 /** 256 * @name iterPrimesSeq 257 * @memberof ns 258 * @readonly 259 * @type {Function} 260 * @see {@link module:@stdlib/math/iter/sequences/primes} 261 */ 262 setReadOnly( ns, 'iterPrimesSeq', require( './../../../iter/sequences/primes' ) ); 263 264 /** 265 * @name iterSquaredTriangularSeq 266 * @memberof ns 267 * @readonly 268 * @type {Function} 269 * @see {@link module:@stdlib/math/iter/sequences/squared-triangular} 270 */ 271 setReadOnly( ns, 'iterSquaredTriangularSeq', require( './../../../iter/sequences/squared-triangular' ) ); 272 273 /** 274 * @name iterSquaresSeq 275 * @memberof ns 276 * @readonly 277 * @type {Function} 278 * @see {@link module:@stdlib/math/iter/sequences/squares} 279 */ 280 setReadOnly( ns, 'iterSquaresSeq', require( './../../../iter/sequences/squares' ) ); 281 282 /** 283 * @name iterTriangularSeq 284 * @memberof ns 285 * @readonly 286 * @type {Function} 287 * @see {@link module:@stdlib/math/iter/sequences/triangular} 288 */ 289 setReadOnly( ns, 'iterTriangularSeq', require( './../../../iter/sequences/triangular' ) ); 290 291 292 // EXPORTS // 293 294 module.exports = ns;