Skip to content

Commit 39f37ad

Browse files
kgrytekgryte
committed
Update JSDoc to use typedefs
1 parent 2f4ee98 commit 39f37ad

File tree

61 files changed

+122
-122
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+122
-122
lines changed

‎lib/node_modules/@stdlib/random/base/arcsine/lib/arcsine.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ var HALF_PI = require( '@stdlib/constants/math/float64-half-pi' );
3131
* Returns an arcsine distributed pseudorandom number with minimum support `a` and maximum support `b`.
3232
*
3333
* @private
34-
* @param {Function} rand - pseudorandom number generator
34+
* @param {PRNG} rand - pseudorandom number generator
3535
* @param {number} a - minimum support
3636
* @param {number} b - maximum support
3737
* @returns {number} pseudorandom number

‎lib/node_modules/@stdlib/random/base/arcsine/lib/factory.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,17 @@ var arcsine0 = require( './arcsine.js' );
4343
* @param {number} [a] - minimum support
4444
* @param {number} [b] - maximum support
4545
* @param {Options} [options] - function options
46-
* @param {Function} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
47-
* @param {(uinteger32|Collection<uinteger32>)} [options.seed] - pseudorandom number generator seed
48-
* @param {Uint32Array} [options.state] - pseudorandom number generator state
46+
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
47+
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
48+
* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
4949
* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
5050
* @throws {TypeError} `a` must be a number
5151
* @throws {TypeError} `b` must be a number
5252
* @throws {RangeError} `a` must be less than `b`
5353
* @throws {TypeError} options argument must be an object
5454
* @throws {TypeError} must provide valid options
5555
* @throws {Error} must provide a valid state
56-
* @returns {Function} pseudorandom number generator
56+
* @returns {PRNG} pseudorandom number generator
5757
*
5858
* @example
5959
* var arcsine = factory( 0.0, 1.0 );

‎lib/node_modules/@stdlib/random/base/arcsine/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var factory = require( './factory.js' );
2929
* Returns an arcsine distributed pseudorandom number with minimum support `a` and maximum support `b`.
3030
*
3131
* @name arcsine
32-
* @type {Function}
32+
* @type {PRNG}
3333
* @param {number} a - minimum support
3434
* @param {number} b - maximum support
3535
* @returns {number} pseudorandom number

‎lib/node_modules/@stdlib/random/base/bernoulli/lib/factory.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ var typedarray2json = require( '@stdlib/array/to-json' );
4141
*
4242
* @param {Probability} [p] - success probability
4343
* @param {Options} [options] - function options
44-
* @param {Function} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
45-
* @param {(uinteger32|Collection<uinteger32>)} [options.seed] - pseudorandom number generator seed
46-
* @param {Uint32Array} [options.state] - pseudorandom number generator state
44+
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
45+
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
46+
* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
4747
* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
4848
* @throws {TypeError} `p` must be a probability
4949
* @throws {TypeError} options argument must be an object
5050
* @throws {TypeError} must provide valid options
5151
* @throws {Error} must provide a valid state
52-
* @returns {Function} pseudorandom number generator
52+
* @returns {PRNG} pseudorandom number generator
5353
*
5454
* @example
5555
* var bernoulli = factory( 0.5 );

‎lib/node_modules/@stdlib/random/base/bernoulli/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var factory = require( './factory.js' );
2929
* Returns a pseudorandom random number drawn from a Bernoulli distribution with parameter `p`.
3030
*
3131
* @name bernoulli
32-
* @type {Function}
32+
* @type {PRNG}
3333
* @param {Probability} p - success probability
3434
* @returns {NonNegativeInteger} pseudorandom number
3535
*

‎lib/node_modules/@stdlib/random/base/beta/lib/beta.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ var sample3 = require( './sample3.js' );
3131
* Returns a random number drawn from a beta distribution.
3232
*
3333
* @private
34-
* @param {Function} randu - pseudorandom number generator for uniformly distributed numbers
35-
* @param {Function} randn - pseudorandom number generator for normally distributed numbers
34+
* @param {PRNG} randu - pseudorandom number generator for uniformly distributed numbers
35+
* @param {PRNG} randn - pseudorandom number generator for normally distributed numbers
3636
* @param {PositiveNumber} alpha - first shape parameter
3737
* @param {PositiveNumber} beta - second shape parameter
3838
* @returns {Probability} pseudorandom number

‎lib/node_modules/@stdlib/random/base/beta/lib/factory.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,16 @@ var beta0 = require( './beta.js' );
4949
* @param {PositiveNumber} [alpha] - first shape parameter
5050
* @param {PositiveNumber} [beta] - second shape parameter
5151
* @param {Options} [options] - function options
52-
* @param {Function} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
53-
* @param {(uinteger32|Collection<uinteger32>)} [options.seed] - pseudorandom number generator seed
54-
* @param {Uint32Array} [options.state] - pseudorandom number generator state
52+
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
53+
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
54+
* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
5555
* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
5656
* @throws {TypeError} `alpha` must be a positive number
5757
* @throws {TypeError} `beta` must be a positive number
5858
* @throws {TypeError} options argument must be an object
5959
* @throws {TypeError} must provide valid options
6060
* @throws {Error} must provide a valid state
61-
* @returns {Function} pseudorandom number generator
61+
* @returns {PRNG} pseudorandom number generator
6262
*
6363
* @example
6464
* var beta = factory( 2.0, 1.0 );

‎lib/node_modules/@stdlib/random/base/beta/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ var factory = require( './factory.js' );
3434
* - Jöhnk, M.D. 1964. "Erzeugung von Betaverteilten Und Gammaverteilten Zufallszahlen." _Metrika_ 8: 5–15. <http://eudml.org/doc/175224>.
3535
*
3636
* @name beta
37-
* @type {Function}
37+
* @type {PRNG}
3838
* @param {PositiveNumber} alpha - first shape parameter
3939
* @param {PositiveNumber} beta - second shape parameter
4040
* @returns {Probability} pseudorandom number

‎lib/node_modules/@stdlib/random/base/beta/lib/sample1.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ var ln = require( '@stdlib/math/base/special/ln' );
3030
* Handles case where `alpha` and `beta` are equal and greater than `1.5`.
3131
*
3232
* @private
33-
* @param {Function} randu - PRNG for uniformly distributed numbers
34-
* @param {Function} randn - PRNG for normally distributed numbers
33+
* @param {PRNG} randu - PRNG for uniformly distributed numbers
34+
* @param {PRNG} randn - PRNG for normally distributed numbers
3535
* @param {PositiveNumber} alpha - first shape parameter
3636
* @returns {Probability} pseudorandom number
3737
*/

‎lib/node_modules/@stdlib/random/base/beta/lib/sample2.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ var ln = require( '@stdlib/math/base/special/ln' );
3030
* Handles case where both `alpha` and `beta` are greater than `1.0`.
3131
*
3232
* @private
33-
* @param {Function} randu - PRNG for uniformly distributed numbers
34-
* @param {Function} randn - PRNG for normally distributed numbers
33+
* @param {PRNG} randu - PRNG for uniformly distributed numbers
34+
* @param {PRNG} randn - PRNG for normally distributed numbers
3535
* @param {PositiveNumber} alpha - first shape parameter
3636
* @param {PositiveNumber} beta - second shape parameter
3737
* @returns {Probability} pseudorandom number

‎lib/node_modules/@stdlib/random/base/beta/lib/sample3.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ var ln = require( '@stdlib/math/base/special/ln' );
3131
* Handles general case.
3232
*
3333
* @private
34-
* @param {Function} rand - PRNG for uniformly distributed numbers
34+
* @param {PRNG} rand - PRNG for uniformly distributed numbers
3535
* @param {PositiveNumber} alpha - first shape parameter
3636
* @param {PositiveNumber} beta - second shape parameter
3737
* @returns {Probability} pseudorandom number

‎lib/node_modules/@stdlib/random/base/betaprime/lib/betaprime.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
* Returns a random number drawn from a beta prime distribution.
2525
*
2626
* @private
27-
* @param {Function} rgamma - pseudorandom number generator for gamma distributed numbers
27+
* @param {PRNG} rgamma - pseudorandom number generator for gamma distributed numbers
2828
* @param {PositiveNumber} alpha - first shape parameter
2929
* @param {PositiveNumber} beta - second shape parameter
3030
* @returns {PositiveNumber} pseudorandom number

‎lib/node_modules/@stdlib/random/base/betaprime/lib/factory.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,16 @@ var betaprime0 = require( './betaprime.js' );
4141
* @param {PositiveNumber} [alpha] - first shape parameter
4242
* @param {PositiveNumber} [beta] - second shape parameter
4343
* @param {Options} [options] - function options
44-
* @param {Function} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
45-
* @param {(uinteger32|Collection<uinteger32>)} [options.seed] - pseudorandom number generator seed
46-
* @param {Uint32Array} [options.state] - pseudorandom number generator state
44+
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
45+
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
46+
* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
4747
* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
4848
* @throws {TypeError} `alpha` must be a positive number
4949
* @throws {TypeError} `beta` must be a positive number
5050
* @throws {TypeError} options argument must be an object
5151
* @throws {TypeError} must provide valid options
5252
* @throws {Error} must provide a valid state
53-
* @returns {Function} pseudorandom number generator
53+
* @returns {PRNG} pseudorandom number generator
5454
*
5555
* @example
5656
* var betaprime = factory( 2.0, 1.0 );

‎lib/node_modules/@stdlib/random/base/betaprime/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var factory = require( './factory.js' );
2929
* Generates a beta prime distributed random number.
3030
*
3131
* @name betaprime
32-
* @type {Function}
32+
* @type {PRNG}
3333
* @param {PositiveNumber} alpha - first shape parameter
3434
* @param {PositiveNumber} beta - second shape parameter
3535
* @returns {PositiveNumber} pseudorandom number

‎lib/node_modules/@stdlib/random/base/binomial/lib/binomial.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var sample2 = require( './sample2.js' );
3030
* Returns a pseudorandom number drawn from a binomial distribution.
3131
*
3232
* @private
33-
* @param {Function} rand - PRNG for uniformly distributed numbers
33+
* @param {PRNG} rand - PRNG for uniformly distributed numbers
3434
* @param {PositiveInteger} n - number of trials
3535
* @param {Probability} p - probability of success
3636
* @returns {NonNegativeInteger} pseudorandom number

‎lib/node_modules/@stdlib/random/base/binomial/lib/factory.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,16 @@ var binomial0 = require( './binomial.js' );
4545
* @param {PositiveInteger} [n] - number of trials
4646
* @param {Probability} [p] - success probability
4747
* @param {Options} [options] - function options
48-
* @param {Function} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
49-
* @param {(uinteger32|Collection<uinteger32>)} [options.seed] - pseudorandom number generator seed
50-
* @param {Uint32Array} [options.state] - pseudorandom number generator state
48+
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
49+
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
50+
* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
5151
* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
5252
* @throws {TypeError} `n` must be a positive integer
5353
* @throws {TypeError} `p` must be a probability
5454
* @throws {TypeError} options argument must be an object
5555
* @throws {TypeError} must provide valid options
5656
* @throws {Error} must provide a valid state
57-
* @returns {Function} pseudorandom number generator
57+
* @returns {PRNG} pseudorandom number generator
5858
*
5959
* @example
6060
* var binomial = factory( 17, 0.5 );

‎lib/node_modules/@stdlib/random/base/binomial/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ var factory = require( './factory.js' );
4040
* [@hormann:1993a]: http://dx.doi.org/10.1080/00949659308811496
4141
*
4242
* @name binomial
43-
* @type {Function}
43+
* @type {PRNG}
4444
* @param {PositiveInteger} n - number of trials
4545
* @param {Probability} p - success probability
4646
* @throws {TypeError} `n` must be a positive integer

‎lib/node_modules/@stdlib/random/base/binomial/lib/sample1.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* Generates a binomially distributed pseudorandom number by computing the sum of Bernoulli random variables.
2323
*
2424
* @private
25-
* @param {Function} rand - PRNG for uniformly distributed numbers
25+
* @param {PRNG} rand - PRNG for uniformly distributed numbers
2626
* @param {PositiveInteger} n - number of trials
2727
* @param {Probability} p - success probability
2828
* @returns {NonNegativeInteger} pseudorandom number

‎lib/node_modules/@stdlib/random/base/binomial/lib/sample2.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ var ONE_SIXTH = 1.0 / 6.0;
4545
* [@hormann:1993a]: http://dx.doi.org/10.1080/00949659308811496
4646
*
4747
* @private
48-
* @param {Function} rand - PRNG for uniformly distributed numbers
48+
* @param {PRNG} rand - PRNG for uniformly distributed numbers
4949
* @param {PositiveInteger} n - number of trials
5050
* @param {Probability} p - success probability
5151
* @returns {NonNegativeInteger} pseudorandom number

‎lib/node_modules/@stdlib/random/base/box-muller/lib/factory.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ var getMax = require( './max.js' );
4343
* Returns a pseudorandom number generator which implements the Box-Muller transform to generate standard normally distributed pseudorandom numbers.
4444
*
4545
* @param {Options} [options] - function options
46-
* @param {Function} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
47-
* @param {(uinteger32|Collection<uinteger32>)} [options.seed] - pseudorandom number generator seed
48-
* @param {Uint32Array} [options.state] - pseudorandom number generator state
46+
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
47+
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
48+
* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
4949
* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
5050
* @throws {TypeError} must provide an object
5151
* @throws {TypeError} must provide valid options
5252
* @throws {Error} must provide a valid state
53-
* @returns {Function} pseudorandom number generator
53+
* @returns {PRNG} pseudorandom number generator
5454
*
5555
* @example
5656
* var randn = factory();

‎lib/node_modules/@stdlib/random/base/box-muller/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ var factory = require( './factory.js' );
7171
*
7272
*
7373
* @name randn
74-
* @type {Function}
74+
* @type {PRNG}
7575
* @returns {number} pseudorandom number
7676
*
7777
* @example

‎lib/node_modules/@stdlib/random/base/box-muller/lib/randn.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ var TWO_PI = require( '@stdlib/constants/math/float64-two-pi' );
3333
* Returns a function for generating standard normally distributed pseudorandom numbers using the Box-Muller algorithm.
3434
*
3535
* @private
36-
* @param {Function} rand - PRNG which returns standard uniformly distributed numbers
37-
* @returns {Function} PRNG
36+
* @param {PRNG} rand - PRNG which returns standard uniformly distributed numbers
37+
* @returns {PRNG} PRNG
3838
*/
3939
function wrap( rand ) {
4040
var flg;

‎lib/node_modules/@stdlib/random/base/cauchy/lib/cauchy.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var PI = require( '@stdlib/constants/math/float64-pi' );
3030
* Returns a pseudorandom number drawn from a Cauchy distribution.
3131
*
3232
* @private
33-
* @param {Function} randn - PRNG for normally distributed numbers
33+
* @param {PRNG} randn - PRNG for normally distributed numbers
3434
* @param {number} x0 - location parameter
3535
* @param {PositiveNumber} gamma - scale parameter
3636
* @returns {number} pseudorandom number

‎lib/node_modules/@stdlib/random/base/cauchy/lib/factory.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,16 +43,16 @@ var cauchy0 = require( './cauchy.js' );
4343
* @param {number} [x0] - location parameter
4444
* @param {PositiveNumber} [gamma] - scale parameter
4545
* @param {Options} [options] - function options
46-
* @param {Function} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
47-
* @param {(uinteger32|Collection<uinteger32>)} [options.seed] - pseudorandom number generator seed
48-
* @param {Uint32Array} [options.state] - pseudorandom number generator state
46+
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
47+
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
48+
* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
4949
* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
5050
* @throws {TypeError} `x0` must be a number
5151
* @throws {TypeError} `gamma` argument must be a positive number
5252
* @throws {TypeError} options argument must be an object
5353
* @throws {TypeError} must provide valid options
5454
* @throws {Error} must provide a valid state
55-
* @returns {Function} pseudorandom number generator
55+
* @returns {PRNG} pseudorandom number generator
5656
*
5757
* @example
5858
* var cauchy = factory( 0.0, 1.0 );

‎lib/node_modules/@stdlib/random/base/cauchy/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var factory = require( './factory.js' );
2929
* Returns pseudorandom number drawn from a Cauchy distribution.
3030
*
3131
* @name cauchy
32-
* @type {Function}
32+
* @type {PRNG}
3333
* @param {number} x0 - location parameter
3434
* @param {PositiveNumber} gamma - scale parameter
3535
* @returns {number} pseudorandom number

‎lib/node_modules/@stdlib/random/base/chi/lib/factory.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ var sqrt = require( '@stdlib/math/base/special/sqrt' );
4242
*
4343
* @param {PositiveNumber} [k] - degrees of freedom
4444
* @param {Options} [options] - function options
45-
* @param {Function} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
46-
* @param {(uinteger32|Collection<uinteger32>)} [options.seed] - pseudorandom number generator seed
47-
* @param {Uint32Array} [options.state] - pseudorandom number generator state
45+
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
46+
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
47+
* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
4848
* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
4949
* @throws {TypeError} `k` must be a positive number
5050
* @throws {TypeError} options argument must be an object
5151
* @throws {TypeError} must provide valid options
5252
* @throws {Error} must provide a valid state
53-
* @returns {Function} pseudorandom number generator
53+
* @returns {PRNG} pseudorandom number generator
5454
*
5555
* @example
5656
* var chi = factory( 2 );

‎lib/node_modules/@stdlib/random/base/chi/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var factory = require( './factory.js' );
2929
* Returns a pseudorandom number drawn from a chi distribution with degrees of freedom `k`.
3030
*
3131
* @name chi
32-
* @type {Function}
32+
* @type {PRNG}
3333
* @param {PositiveNumber} k - degrees of freedom
3434
* @returns {number} pseudorandom number
3535
*

‎lib/node_modules/@stdlib/random/base/chisquare/lib/factory.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ var typedarray2json = require( '@stdlib/array/to-json' );
4141
*
4242
* @param {PositiveNumber} [k] - degrees of freedom
4343
* @param {Options} [options] - function options
44-
* @param {Function} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
45-
* @param {(uinteger32|Collection<uinteger32>)} [options.seed] - pseudorandom number generator seed
46-
* @param {Uint32Array} [options.state] - pseudorandom number generator state
44+
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
45+
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
46+
* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
4747
* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
4848
* @throws {TypeError} `k` must be a positive number
4949
* @throws {TypeError} options argument must be an object
5050
* @throws {TypeError} must provide valid options
5151
* @throws {Error} must provide a valid state
52-
* @returns {Function} pseudorandom number generator
52+
* @returns {PRNG} pseudorandom number generator
5353
*
5454
* @example
5555
* var chisquare = factory( 2 );

‎lib/node_modules/@stdlib/random/base/chisquare/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var factory = require( './factory.js' );
2929
* Returns a pseudorandom number drawn from a chi-square distribution with degrees of freedom `k`.
3030
*
3131
* @function chisquare
32-
* @type {Function}
32+
* @type {PRNG}
3333
* @param {PositiveNumber} k - degrees of freedom
3434
* @returns {number} pseudorandom number
3535
*

‎lib/node_modules/@stdlib/random/base/cosine/lib/cosine.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var quantile = require( '@stdlib/stats/base/dists/cosine/quantile' );
2929
* Returns pseudorandom number drawn from a raised cosine distribution using inverse transform sampling.
3030
*
3131
* @private
32-
* @param {Function} rand - PRNG for uniformly distributed numbers
32+
* @param {PRNG} rand - PRNG for uniformly distributed numbers
3333
* @param {number} mu - mean
3434
* @param {PositiveNumber} s - scale parameter
3535
* @returns {number} pseudorandom number

0 commit comments

Comments
 (0)