index.js (8926B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 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 arcsine 41 * @memberof ns 42 * @readonly 43 * @type {Function} 44 * @see {@link module:@stdlib/random/streams/arcsine} 45 */ 46 setReadOnly( ns, 'arcsine', require( './../../streams/arcsine' ) ); 47 48 /** 49 * @name bernoulli 50 * @memberof ns 51 * @readonly 52 * @type {Function} 53 * @see {@link module:@stdlib/random/streams/bernoulli} 54 */ 55 setReadOnly( ns, 'bernoulli', require( './../../streams/bernoulli' ) ); 56 57 /** 58 * @name beta 59 * @memberof ns 60 * @readonly 61 * @type {Function} 62 * @see {@link module:@stdlib/random/streams/beta} 63 */ 64 setReadOnly( ns, 'beta', require( './../../streams/beta' ) ); 65 66 /** 67 * @name betaprime 68 * @memberof ns 69 * @readonly 70 * @type {Function} 71 * @see {@link module:@stdlib/random/streams/betaprime} 72 */ 73 setReadOnly( ns, 'betaprime', require( './../../streams/betaprime' ) ); 74 75 /** 76 * @name binomial 77 * @memberof ns 78 * @readonly 79 * @type {Function} 80 * @see {@link module:@stdlib/random/streams/binomial} 81 */ 82 setReadOnly( ns, 'binomial', require( './../../streams/binomial' ) ); 83 84 /** 85 * @name boxMuller 86 * @memberof ns 87 * @readonly 88 * @type {Function} 89 * @see {@link module:@stdlib/random/streams/box-muller} 90 */ 91 setReadOnly( ns, 'boxMuller', require( './../../streams/box-muller' ) ); 92 93 /** 94 * @name cauchy 95 * @memberof ns 96 * @readonly 97 * @type {Function} 98 * @see {@link module:@stdlib/random/streams/cauchy} 99 */ 100 setReadOnly( ns, 'cauchy', require( './../../streams/cauchy' ) ); 101 102 /** 103 * @name chi 104 * @memberof ns 105 * @readonly 106 * @type {Function} 107 * @see {@link module:@stdlib/random/streams/chi} 108 */ 109 setReadOnly( ns, 'chi', require( './../../streams/chi' ) ); 110 111 /** 112 * @name chisquare 113 * @memberof ns 114 * @readonly 115 * @type {Function} 116 * @see {@link module:@stdlib/random/streams/chisquare} 117 */ 118 setReadOnly( ns, 'chisquare', require( './../../streams/chisquare' ) ); 119 120 /** 121 * @name cosine 122 * @memberof ns 123 * @readonly 124 * @type {Function} 125 * @see {@link module:@stdlib/random/streams/cosine} 126 */ 127 setReadOnly( ns, 'cosine', require( './../../streams/cosine' ) ); 128 129 /** 130 * @name discreteUniform 131 * @memberof ns 132 * @readonly 133 * @type {Function} 134 * @see {@link module:@stdlib/random/streams/discrete-uniform} 135 */ 136 setReadOnly( ns, 'discreteUniform', require( './../../streams/discrete-uniform' ) ); 137 138 /** 139 * @name erlang 140 * @memberof ns 141 * @readonly 142 * @type {Function} 143 * @see {@link module:@stdlib/random/streams/erlang} 144 */ 145 setReadOnly( ns, 'erlang', require( './../../streams/erlang' ) ); 146 147 /** 148 * @name exponential 149 * @memberof ns 150 * @readonly 151 * @type {Function} 152 * @see {@link module:@stdlib/random/streams/exponential} 153 */ 154 setReadOnly( ns, 'exponential', require( './../../streams/exponential' ) ); 155 156 /** 157 * @name f 158 * @memberof ns 159 * @readonly 160 * @type {Function} 161 * @see {@link module:@stdlib/random/streams/f} 162 */ 163 setReadOnly( ns, 'f', require( './../../streams/f' ) ); 164 165 /** 166 * @name frechet 167 * @memberof ns 168 * @readonly 169 * @type {Function} 170 * @see {@link module:@stdlib/random/streams/frechet} 171 */ 172 setReadOnly( ns, 'frechet', require( './../../streams/frechet' ) ); 173 174 /** 175 * @name gamma 176 * @memberof ns 177 * @readonly 178 * @type {Function} 179 * @see {@link module:@stdlib/random/streams/gamma} 180 */ 181 setReadOnly( ns, 'gamma', require( './../../streams/gamma' ) ); 182 183 /** 184 * @name geometric 185 * @memberof ns 186 * @readonly 187 * @type {Function} 188 * @see {@link module:@stdlib/random/streams/geometric} 189 */ 190 setReadOnly( ns, 'geometric', require( './../../streams/geometric' ) ); 191 192 /** 193 * @name gumbel 194 * @memberof ns 195 * @readonly 196 * @type {Function} 197 * @see {@link module:@stdlib/random/streams/gumbel} 198 */ 199 setReadOnly( ns, 'gumbel', require( './../../streams/gumbel' ) ); 200 201 /** 202 * @name hypergeometric 203 * @memberof ns 204 * @readonly 205 * @type {Function} 206 * @see {@link module:@stdlib/random/streams/hypergeometric} 207 */ 208 setReadOnly( ns, 'hypergeometric', require( './../../streams/hypergeometric' ) ); 209 210 /** 211 * @name improvedZiggurat 212 * @memberof ns 213 * @readonly 214 * @type {Function} 215 * @see {@link module:@stdlib/random/streams/improved-ziggurat} 216 */ 217 setReadOnly( ns, 'improvedZiggurat', require( './../../streams/improved-ziggurat' ) ); 218 219 /** 220 * @name invgamma 221 * @memberof ns 222 * @readonly 223 * @type {Function} 224 * @see {@link module:@stdlib/random/streams/invgamma} 225 */ 226 setReadOnly( ns, 'invgamma', require( './../../streams/invgamma' ) ); 227 228 /** 229 * @name kumaraswamy 230 * @memberof ns 231 * @readonly 232 * @type {Function} 233 * @see {@link module:@stdlib/random/streams/kumaraswamy} 234 */ 235 setReadOnly( ns, 'kumaraswamy', require( './../../streams/kumaraswamy' ) ); 236 237 /** 238 * @name laplace 239 * @memberof ns 240 * @readonly 241 * @type {Function} 242 * @see {@link module:@stdlib/random/streams/laplace} 243 */ 244 setReadOnly( ns, 'laplace', require( './../../streams/laplace' ) ); 245 246 /** 247 * @name levy 248 * @memberof ns 249 * @readonly 250 * @type {Function} 251 * @see {@link module:@stdlib/random/streams/levy} 252 */ 253 setReadOnly( ns, 'levy', require( './../../streams/levy' ) ); 254 255 /** 256 * @name logistic 257 * @memberof ns 258 * @readonly 259 * @type {Function} 260 * @see {@link module:@stdlib/random/streams/logistic} 261 */ 262 setReadOnly( ns, 'logistic', require( './../../streams/logistic' ) ); 263 264 /** 265 * @name lognormal 266 * @memberof ns 267 * @readonly 268 * @type {Function} 269 * @see {@link module:@stdlib/random/streams/lognormal} 270 */ 271 setReadOnly( ns, 'lognormal', require( './../../streams/lognormal' ) ); 272 273 /** 274 * @name minstd 275 * @memberof ns 276 * @readonly 277 * @type {Function} 278 * @see {@link module:@stdlib/random/streams/minstd} 279 */ 280 setReadOnly( ns, 'minstd', require( './../../streams/minstd' ) ); 281 282 /** 283 * @name minstdShuffle 284 * @memberof ns 285 * @readonly 286 * @type {Function} 287 * @see {@link module:@stdlib/random/streams/minstd-shuffle} 288 */ 289 setReadOnly( ns, 'minstdShuffle', require( './../../streams/minstd-shuffle' ) ); 290 291 /** 292 * @name mt19937 293 * @memberof ns 294 * @readonly 295 * @type {Function} 296 * @see {@link module:@stdlib/random/streams/mt19937} 297 */ 298 setReadOnly( ns, 'mt19937', require( './../../streams/mt19937' ) ); 299 300 /** 301 * @name negativeBinomial 302 * @memberof ns 303 * @readonly 304 * @type {Function} 305 * @see {@link module:@stdlib/random/streams/negative-binomial} 306 */ 307 setReadOnly( ns, 'negativeBinomial', require( './../../streams/negative-binomial' ) ); 308 309 /** 310 * @name normal 311 * @memberof ns 312 * @readonly 313 * @type {Function} 314 * @see {@link module:@stdlib/random/streams/normal} 315 */ 316 setReadOnly( ns, 'normal', require( './../../streams/normal' ) ); 317 318 /** 319 * @name pareto1 320 * @memberof ns 321 * @readonly 322 * @type {Function} 323 * @see {@link module:@stdlib/random/streams/pareto-type1} 324 */ 325 setReadOnly( ns, 'pareto1', require( './../../streams/pareto-type1' ) ); 326 327 /** 328 * @name poisson 329 * @memberof ns 330 * @readonly 331 * @type {Function} 332 * @see {@link module:@stdlib/random/streams/poisson} 333 */ 334 setReadOnly( ns, 'poisson', require( './../../streams/poisson' ) ); 335 336 /** 337 * @name randi 338 * @memberof ns 339 * @readonly 340 * @type {Function} 341 * @see {@link module:@stdlib/random/streams/randi} 342 */ 343 setReadOnly( ns, 'randi', require( './../../streams/randi' ) ); 344 345 /** 346 * @name randn 347 * @memberof ns 348 * @readonly 349 * @type {Function} 350 * @see {@link module:@stdlib/random/streams/randn} 351 */ 352 setReadOnly( ns, 'randn', require( './../../streams/randn' ) ); 353 354 /** 355 * @name randu 356 * @memberof ns 357 * @readonly 358 * @type {Function} 359 * @see {@link module:@stdlib/random/streams/randu} 360 */ 361 setReadOnly( ns, 'randu', require( './../../streams/randu' ) ); 362 363 /** 364 * @name rayleigh 365 * @memberof ns 366 * @readonly 367 * @type {Function} 368 * @see {@link module:@stdlib/random/streams/rayleigh} 369 */ 370 setReadOnly( ns, 'rayleigh', require( './../../streams/rayleigh' ) ); 371 372 /** 373 * @name t 374 * @memberof ns 375 * @readonly 376 * @type {Function} 377 * @see {@link module:@stdlib/random/streams/t} 378 */ 379 setReadOnly( ns, 't', require( './../../streams/t' ) ); 380 381 /** 382 * @name triangular 383 * @memberof ns 384 * @readonly 385 * @type {Function} 386 * @see {@link module:@stdlib/random/streams/triangular} 387 */ 388 setReadOnly( ns, 'triangular', require( './../../streams/triangular' ) ); 389 390 /** 391 * @name uniform 392 * @memberof ns 393 * @readonly 394 * @type {Function} 395 * @see {@link module:@stdlib/random/streams/uniform} 396 */ 397 setReadOnly( ns, 'uniform', require( './../../streams/uniform' ) ); 398 399 /** 400 * @name weibull 401 * @memberof ns 402 * @readonly 403 * @type {Function} 404 * @see {@link module:@stdlib/random/streams/weibull} 405 */ 406 setReadOnly( ns, 'weibull', require( './../../streams/weibull' ) ); 407 408 409 // EXPORTS // 410 411 module.exports = ns;