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