diff --git a/lib/node_modules/@stdlib/random/array/pareto-type1/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/pareto-type1/docs/types/index.d.ts index f871b991c89b..0354264f559f 100644 --- a/lib/node_modules/@stdlib/random/array/pareto-type1/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/array/pareto-type1/docs/types/index.d.ts @@ -207,6 +207,8 @@ interface Random extends PRNG { * @param alpha - shape parameter * @param beta - scale parameter * @param options - function options + * @throws `alpha` must be a positive number + * @throws `beta` must be a positive number * @throws must provide a valid state * @returns function for creating arrays * diff --git a/lib/node_modules/@stdlib/random/array/weibull/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/array/weibull/docs/types/index.d.ts index b0b7cf7c14f5..b4b769209e49 100644 --- a/lib/node_modules/@stdlib/random/array/weibull/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/array/weibull/docs/types/index.d.ts @@ -207,6 +207,8 @@ interface Random extends PRNG { * @param k - shape parameter * @param lambda - scale parameter * @param options - function options + * @throws `k` must be a positive number + * @throws `lambda` must be a positive number * @throws must provide a valid state * @returns function for creating arrays * diff --git a/lib/node_modules/@stdlib/random/base/cosine/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/base/cosine/docs/types/index.d.ts index 218fb1ce20c8..36e011fbe7ea 100644 --- a/lib/node_modules/@stdlib/random/base/cosine/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/base/cosine/docs/types/index.d.ts @@ -152,7 +152,7 @@ interface Random extends PRNG { * * - When provided `mu` and `s`, the returned PRNG returns random variates drawn from the specified distribution. * - * @param mu - mean parameter + * @param mu - mean * @param s - scale parameter * @param options - function options * @param options.prng - pseudorandom number generator which generates uniformly distributed pseudorandom numbers diff --git a/lib/node_modules/@stdlib/random/base/frechet/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/base/frechet/docs/types/index.d.ts index 3cee1fb3bdca..eb6a254ea8a0 100644 --- a/lib/node_modules/@stdlib/random/base/frechet/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/base/frechet/docs/types/index.d.ts @@ -144,7 +144,7 @@ interface Random extends PRNG { * * @example * var v = frechet( 1.0, 1.0, 0.8 ); - * // returns NaN + * // returns */ ( alpha: number, s: number, m: number ): number; diff --git a/lib/node_modules/@stdlib/random/base/gumbel/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/base/gumbel/docs/types/index.d.ts index debaa44a3ba8..8845064e1761 100644 --- a/lib/node_modules/@stdlib/random/base/gumbel/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/base/gumbel/docs/types/index.d.ts @@ -152,7 +152,7 @@ interface Random extends PRNG { * * - When provided `mu` and `beta`, the returned PRNG returns random variates drawn from the specified distribution. * - * @param mu - mean parameter + * @param mu - mean * @param beta - scale parameter * @param options - function options * @param options.prng - pseudorandom number generator which generates uniformly distributed pseudorandom numbers diff --git a/lib/node_modules/@stdlib/random/base/invgamma/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/base/invgamma/docs/types/index.d.ts index 5c47a05d6d29..14c89050f6db 100644 --- a/lib/node_modules/@stdlib/random/base/invgamma/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/base/invgamma/docs/types/index.d.ts @@ -156,6 +156,8 @@ interface Random extends PRNG { * @param options.seed - pseudorandom number generator seed * @param options.state - pseudorandom number generator state * @param options.copy - boolean indicating whether to copy a provided pseudorandom number generator state (default: true) + * @throws `alpha` must be a positive number + * @throws `beta` must be a positive number * @throws must provide a valid state * @returns pseudorandom number generator * diff --git a/lib/node_modules/@stdlib/random/base/kumaraswamy/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/base/kumaraswamy/docs/types/index.d.ts index dc8aab99299c..63ae2b704296 100644 --- a/lib/node_modules/@stdlib/random/base/kumaraswamy/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/base/kumaraswamy/docs/types/index.d.ts @@ -156,6 +156,8 @@ interface Random extends PRNG { * @param options.seed - pseudorandom number generator seed * @param options.state - pseudorandom number generator state * @param options.copy - boolean indicating whether to copy a provided pseudorandom number generator state (default: true) + * @throws `a` must be a positive number + * @throws `b` must be a positive number * @throws must provide a valid state * @returns pseudorandom number generator * diff --git a/lib/node_modules/@stdlib/random/base/logistic/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/base/logistic/docs/types/index.d.ts index 4db1dd8a039f..c25fa89fab03 100644 --- a/lib/node_modules/@stdlib/random/base/logistic/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/base/logistic/docs/types/index.d.ts @@ -152,7 +152,7 @@ interface Random extends PRNG { * * - When provided `mu` and `s`, the returned PRNG returns random variates drawn from the specified distribution. * - * @param mu - mean parameter + * @param mu - mean * @param s - scale parameter * @param options - function options * @param options.prng - pseudorandom number generator which generates uniformly distributed pseudorandom numbers @@ -194,7 +194,7 @@ interface Random extends PRNG { * @returns pseudorandom number generator * * @example - * var mylogistic = factory(); + * var mylogistic = logistic.factory(); * * var v = mylogistic( 0.0, 1.0 ); * // returns diff --git a/lib/node_modules/@stdlib/random/base/poisson/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/base/poisson/docs/types/index.d.ts index 525b92c1fcfd..448fea62ec52 100644 --- a/lib/node_modules/@stdlib/random/base/poisson/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/base/poisson/docs/types/index.d.ts @@ -153,6 +153,7 @@ interface Random extends PRNG { * @param options.seed - pseudorandom number generator seed * @param options.state - pseudorandom number generator state * @param options.copy - boolean indicating whether to copy a provided pseudorandom number generator state (default: true) + * @throws `lambda` must be a positive number * @throws must provide a valid state * @returns pseudorandom number generator * diff --git a/lib/node_modules/@stdlib/random/base/randn/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/base/randn/docs/types/index.d.ts index b704d7660a1d..d7503952d514 100644 --- a/lib/node_modules/@stdlib/random/base/randn/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/base/randn/docs/types/index.d.ts @@ -131,7 +131,7 @@ interface Random extends PRNG { (): number; /** - * Returns a pseudorandom number generator for generating exponential distributed random numbers. + * Returns a pseudorandom number generator for generating standard normally distributed random numbers. * * @param options - function options * @param options.name - name of pseudorandom number generator (default: 'improved-ziggurat') @@ -139,6 +139,8 @@ interface Random extends PRNG { * @param options.seed - pseudorandom number generator seed * @param options.state - pseudorandom number generator state * @param options.copy - boolean indicating whether to copy a provided pseudorandom number generator state (default: true) + * @throws must provide valid options + * @throws must provide the name of a supported pseudorandom number generator * @throws must provide a valid state * @returns pseudorandom number generator * diff --git a/lib/node_modules/@stdlib/random/base/rayleigh/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/base/rayleigh/docs/types/index.d.ts index fcfc83535f6d..6f472e256332 100644 --- a/lib/node_modules/@stdlib/random/base/rayleigh/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/base/rayleigh/docs/types/index.d.ts @@ -153,6 +153,7 @@ interface Random extends PRNG { * @param options.seed - pseudorandom number generator seed * @param options.state - pseudorandom number generator state * @param options.copy - boolean indicating whether to copy a provided pseudorandom number generator state (default: true) + * @throws `sigma` must be a positive number * @throws must provide a valid state * @returns pseudorandom number generator * diff --git a/lib/node_modules/@stdlib/random/base/t/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/base/t/docs/types/index.d.ts index 781b3e72f8ce..70c7f99e00dd 100644 --- a/lib/node_modules/@stdlib/random/base/t/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/base/t/docs/types/index.d.ts @@ -153,6 +153,7 @@ interface Random extends PRNG { * @param options.seed - pseudorandom number generator seed * @param options.state - pseudorandom number generator state * @param options.copy - boolean indicating whether to copy a provided pseudorandom number generator state (default: true) + * @throws `v` must be a positive number * @throws must provide a valid state * @returns pseudorandom number generator * diff --git a/lib/node_modules/@stdlib/random/base/triangular/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/base/triangular/docs/types/index.d.ts index dc80cb694fb1..678786e8e64a 100644 --- a/lib/node_modules/@stdlib/random/base/triangular/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/base/triangular/docs/types/index.d.ts @@ -126,7 +126,7 @@ interface TernaryFunction extends PRNG { */ interface Random extends PRNG { /** - * Returns pseudorandom number drawn from a triangular distribution. + * Returns a pseudorandom number drawn from a triangular distribution. * * ## Notes * @@ -212,7 +212,7 @@ interface Random extends PRNG { } /** -* Returns pseudorandom number drawn from a triangular distribution. +* Returns a pseudorandom number drawn from a triangular distribution. * * ## Notes * diff --git a/lib/node_modules/@stdlib/random/base/weibull/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/base/weibull/docs/types/index.d.ts index 2989d1256352..06cc86dc05f5 100644 --- a/lib/node_modules/@stdlib/random/base/weibull/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/base/weibull/docs/types/index.d.ts @@ -156,6 +156,8 @@ interface Random extends PRNG { * @param options.seed - pseudorandom number generator seed * @param options.state - pseudorandom number generator state * @param options.copy - boolean indicating whether to copy a provided pseudorandom number generator state (default: true) + * @throws `k` must be a positive number + * @throws `lambda` must be a positive number * @throws must provide a valid state * @returns pseudorandom number generator * diff --git a/lib/node_modules/@stdlib/random/iter/discrete-uniform/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/iter/discrete-uniform/docs/types/index.d.ts index 81759e2cdb9b..999ee819a3ff 100644 --- a/lib/node_modules/@stdlib/random/iter/discrete-uniform/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/iter/discrete-uniform/docs/types/index.d.ts @@ -43,7 +43,7 @@ interface Options { state?: random.PRNGStateMT19937; /** - * Specifies whether to copy a provided pseudorandom number generator state (default: true). + * Specifies whether to copy a provided pseudorandom number generator state (default: `true`). */ copy?: boolean; @@ -54,7 +54,7 @@ interface Options { } /** -* Interface for iterators of pseudorandom numbers drawn from a continuous uniform distribution. +* Interface for iterators of pseudorandom numbers drawn from a discrete uniform distribution. */ interface Iterator extends TypedIterator { /** @@ -103,6 +103,7 @@ interface Iterator extends TypedIterator { * @throws `b` must be an integer * @throws `a` must be less than or equal to `b` * @throws must provide valid options +* @throws must provide a valid state * @returns iterator * * @example diff --git a/lib/node_modules/@stdlib/random/iter/erlang/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/iter/erlang/docs/types/index.d.ts index af553816f1b9..3933b6682761 100644 --- a/lib/node_modules/@stdlib/random/iter/erlang/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/iter/erlang/docs/types/index.d.ts @@ -92,7 +92,7 @@ interface Iterator extends TypedIterator { * Returns an iterator for generating pseudorandom numbers drawn from an Erlang distribution. * * @param k - shape parameter -* @param lambda - rate parameter +* @param lambda - rate parameter * @param options - function options * @throws `k` must be a positive integer * @throws `lambda` must be a positive number diff --git a/lib/node_modules/@stdlib/random/iter/frechet/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/iter/frechet/docs/types/index.d.ts index c3600087f7dc..2ae7fbbd102b 100644 --- a/lib/node_modules/@stdlib/random/iter/frechet/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/iter/frechet/docs/types/index.d.ts @@ -92,7 +92,7 @@ interface Iterator extends TypedIterator { * Returns an iterator for generating pseudorandom numbers drawn from a Fréchet distribution. * * @param alpha - shape parameter -* @param s - rate parameter +* @param s - scale parameter * @param m - location parameter * @param options - function options * @throws `alpha` must be a positive number diff --git a/lib/node_modules/@stdlib/random/iter/hypergeometric/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/iter/hypergeometric/docs/types/index.d.ts index eb6fe37610a4..e27ec38f574d 100644 --- a/lib/node_modules/@stdlib/random/iter/hypergeometric/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/iter/hypergeometric/docs/types/index.d.ts @@ -54,7 +54,7 @@ interface Options { } /** -* Interface for iterators of pseudorandom numbers drawn from a logistic distribution. +* Interface for iterators of pseudorandom numbers drawn from a hypergeometric distribution. */ interface Iterator extends TypedIterator { /** @@ -106,6 +106,7 @@ interface Iterator extends TypedIterator { * @throws `n` must be less than or equal to `N` * @throws `K` must be less than or equal to `N` * @throws must provide valid options +* @throws must provide a valid state * @returns iterator * * @example diff --git a/lib/node_modules/@stdlib/random/iter/randn/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/iter/randn/docs/types/index.d.ts index 04c6961a4339..4cad5dfb0262 100644 --- a/lib/node_modules/@stdlib/random/iter/randn/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/iter/randn/docs/types/index.d.ts @@ -59,7 +59,7 @@ interface Options { } /** -* Interface for iterators of pseudorandom numbers having integer values. +* Interface for iterators of pseudorandom numbers drawn from a standard normal distribution. */ interface Iterator extends TypedIterator { /** diff --git a/lib/node_modules/@stdlib/random/iter/triangular/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/iter/triangular/docs/types/index.d.ts index 746d0d3ba91f..e9b1b252e6b0 100644 --- a/lib/node_modules/@stdlib/random/iter/triangular/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/iter/triangular/docs/types/index.d.ts @@ -54,7 +54,7 @@ interface Options { } /** -* Interface for iterators of pseudorandom numbers drawn from a logistic distribution. +* Interface for iterators of pseudorandom numbers drawn from a triangular distribution. */ interface Iterator extends TypedIterator { /** @@ -102,6 +102,7 @@ interface Iterator extends TypedIterator { * @param options.iter - number of iterations * @throws arguments must satisfy `a <= c <= b` * @throws must provide valid options +* @throws must provide a valid state * @returns iterator * * @example diff --git a/lib/node_modules/@stdlib/random/iter/weibull/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/iter/weibull/docs/types/index.d.ts index 1e2c332e08d9..207a11c35b3a 100644 --- a/lib/node_modules/@stdlib/random/iter/weibull/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/iter/weibull/docs/types/index.d.ts @@ -91,8 +91,8 @@ interface Iterator extends TypedIterator { /** * Returns an iterator for generating pseudorandom numbers drawn from a Weibull distribution. * -* @param k - scale parameter -* @param lambda - shape parameter +* @param k - shape parameter +* @param lambda - scale parameter * @param options - function options * @throws `k` must be a positive number * @throws `lambda` must be a positive number diff --git a/lib/node_modules/@stdlib/random/streams/frechet/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/streams/frechet/docs/types/index.d.ts index a92a23738937..08375cbb2608 100644 --- a/lib/node_modules/@stdlib/random/streams/frechet/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/streams/frechet/docs/types/index.d.ts @@ -321,7 +321,6 @@ interface Constructor { /** * Returns an "objectMode" readable stream for generating a stream of pseudorandom numbers drawn from a Fréchet distribution. * - * * @param alpha - shape parameter * @param s - scale parameter * @param m - location parameter diff --git a/lib/node_modules/@stdlib/random/streams/hypergeometric/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/streams/hypergeometric/docs/types/index.d.ts index 0feccc60d322..38caa7944425 100644 --- a/lib/node_modules/@stdlib/random/streams/hypergeometric/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/streams/hypergeometric/docs/types/index.d.ts @@ -330,7 +330,6 @@ interface Constructor { /** * Returns an "objectMode" readable stream for generating a stream of pseudorandom numbers drawn from a hypergeometric distribution. * - * * @param N - population size * @param K - subpopulation size * @param n - number of draws diff --git a/lib/node_modules/@stdlib/random/streams/improved-ziggurat/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/streams/improved-ziggurat/docs/types/index.d.ts index 8ea760bd1172..f74f183da8cd 100644 --- a/lib/node_modules/@stdlib/random/streams/improved-ziggurat/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/streams/improved-ziggurat/docs/types/index.d.ts @@ -216,7 +216,7 @@ interface Constructor { * @param options.siter - number of iterations after which to emit the PRNG state * @throws must provide valid options * @throws must provide a valid state - * @returns Stream instance + * @returns stream instance * * @example * var inspectStream = require( '@stdlib/streams/node/inspect-sink' ); @@ -252,7 +252,7 @@ interface Constructor { * @param options.siter - number of iterations after which to emit the PRNG state * @throws must provide valid options * @throws must provide a valid state - * @returns Stream instance + * @returns stream instance * * @example * var inspectStream = require( '@stdlib/streams/node/inspect-sink' ); @@ -320,7 +320,7 @@ interface Constructor { * @param options.siter - number of iterations after which to emit the PRNG state * @throws must provide valid options * @throws must provide a valid state - * @returns Stream instance + * @returns stream instance * * @example * var inspectStream = require( '@stdlib/streams/node/inspect-sink' ); diff --git a/lib/node_modules/@stdlib/random/streams/minstd-shuffle/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/streams/minstd-shuffle/docs/types/index.d.ts index 0e679ea30f62..c4055d2a5fa5 100644 --- a/lib/node_modules/@stdlib/random/streams/minstd-shuffle/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/streams/minstd-shuffle/docs/types/index.d.ts @@ -140,7 +140,7 @@ declare class RandomStream extends Readable { private _i: number; /** - * Pseudorandom number generator for generating standard normally distributed pseudorandom numbers. + * Pseudorandom number generator for generating pseudorandom numbers via a linear congruential pseudorandom number generator (LCG) whose output is shuffled. */ private readonly _prng: random.PRNG; diff --git a/lib/node_modules/@stdlib/random/streams/minstd/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/streams/minstd/docs/types/index.d.ts index 834a92aeaa01..a71264456831 100644 --- a/lib/node_modules/@stdlib/random/streams/minstd/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/streams/minstd/docs/types/index.d.ts @@ -140,7 +140,7 @@ declare class RandomStream extends Readable { private _i: number; /** - * Pseudorandom number generator for generating standard normally distributed pseudorandom numbers. + * Pseudorandom number generator for generating pseudorandom numbers via a linear congruential pseudorandom number generator (LCG) based on Park and Miller. */ private readonly _prng: random.PRNG; diff --git a/lib/node_modules/@stdlib/random/streams/mt19937/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/streams/mt19937/docs/types/index.d.ts index 70752508cbb9..d8a04ef1e24c 100644 --- a/lib/node_modules/@stdlib/random/streams/mt19937/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/streams/mt19937/docs/types/index.d.ts @@ -140,7 +140,7 @@ declare class RandomStream extends Readable { private _i: number; /** - * Pseudorandom number generator for generating standard normally distributed pseudorandom numbers. + * Pseudorandom number generator for generating pseudorandom numbers via a 32-bit Mersenne Twister pseudorandom number generator. */ private readonly _prng: random.PRNG; diff --git a/lib/node_modules/@stdlib/random/streams/randi/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/streams/randi/docs/types/index.d.ts index 546fbdef009e..5bee7c610fc4 100644 --- a/lib/node_modules/@stdlib/random/streams/randi/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/streams/randi/docs/types/index.d.ts @@ -140,7 +140,7 @@ declare class RandomStream extends Readable { private _i: number; /** - * Pseudorandom number generator for generating standard normally distributed pseudorandom numbers. + * Pseudorandom number generator for generating pseudorandom numbers having integer values. */ private readonly _prng: random.PRNG; diff --git a/lib/node_modules/@stdlib/random/streams/randn/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/streams/randn/docs/types/index.d.ts index 0d40bb3fb5bb..ded17bf721df 100644 --- a/lib/node_modules/@stdlib/random/streams/randn/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/streams/randn/docs/types/index.d.ts @@ -283,7 +283,7 @@ interface Constructor { * @param options.highWaterMark - specifies the maximum number of bytes to store in an internal buffer before ceasing to generate additional pseudorandom numbers * @param options.sep - separator used to join streamed data (default: '\n') * @param options.iter - number of iterations - * @param options.name='improved-ziggurat' - name of a supported pseudorandom number generator (PRNG), which will serve as the underlying source of pseudorandom numbers + * @param options.name - name of a supported pseudorandom number generator (PRNG), which will serve as the underlying source of pseudorandom numbers (default: 'improved-ziggurat') * @param options.prng - pseudorandom number generator which generates uniformly distributed pseudorandom numbers * @param options.seed - pseudorandom number generator seed * @param options.state - pseudorandom number generator state diff --git a/lib/node_modules/@stdlib/random/streams/randu/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/streams/randu/docs/types/index.d.ts index 31e627769aca..bb5ab63c4c47 100644 --- a/lib/node_modules/@stdlib/random/streams/randu/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/streams/randu/docs/types/index.d.ts @@ -140,7 +140,7 @@ declare class RandomStream extends Readable { private _i: number; /** - * Pseudorandom number generator for generating standard normally distributed pseudorandom numbers. + * Pseudorandom number generator for generating uniformly distributed pseudorandom numbers between `0` and `1`. */ private readonly _prng: random.PRNG; diff --git a/lib/node_modules/@stdlib/random/strided/bernoulli/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/strided/bernoulli/docs/types/index.d.ts index 2f7d8e1e5ba1..7873a9a68a91 100644 --- a/lib/node_modules/@stdlib/random/strided/bernoulli/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/strided/bernoulli/docs/types/index.d.ts @@ -92,7 +92,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param p - success probability - * @param sp - `p` strided length + * @param sp - `p` stride length * @param out - output array * @param so - `out` stride length * @returns output array @@ -113,7 +113,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param p - success probability - * @param sp - `p` strided length + * @param sp - `p` stride length * @param op - starting index for `p` * @param out - output array * @param so - `out` stride length diff --git a/lib/node_modules/@stdlib/random/strided/chi/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/strided/chi/docs/types/index.d.ts index 7270260d2498..16a1d9aae223 100644 --- a/lib/node_modules/@stdlib/random/strided/chi/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/strided/chi/docs/types/index.d.ts @@ -92,7 +92,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param k - degrees of freedom - * @param sk - `k` strided length + * @param sk - `k` stride length * @param out - output array * @param so - `out` stride length * @returns output array @@ -113,7 +113,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param k - degrees of freedom - * @param sk - `k` strided length + * @param sk - `k` stride length * @param ok - starting index for `k` * @param out - output array * @param so - `out` stride length diff --git a/lib/node_modules/@stdlib/random/strided/chisquare/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/strided/chisquare/docs/types/index.d.ts index 88dffba56b0f..3bc275388c57 100644 --- a/lib/node_modules/@stdlib/random/strided/chisquare/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/strided/chisquare/docs/types/index.d.ts @@ -92,7 +92,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param k - degrees of freedom - * @param sk - `k` strided length + * @param sk - `k` stride length * @param out - output array * @param so - `out` stride length * @returns output array @@ -113,7 +113,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param k - degrees of freedom - * @param sk - `k` strided length + * @param sk - `k` stride length * @param ok - starting index for `k` * @param out - output array * @param so - `out` stride length diff --git a/lib/node_modules/@stdlib/random/strided/exponential/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/strided/exponential/docs/types/index.d.ts index 9ebc9ab3fe21..fc1c98ac0551 100644 --- a/lib/node_modules/@stdlib/random/strided/exponential/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/strided/exponential/docs/types/index.d.ts @@ -92,7 +92,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param lambda - rate parameter - * @param sl - `lambda` strided length + * @param sl - `lambda` stride length * @param out - output array * @param so - `out` stride length * @returns output array @@ -113,7 +113,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param lambda - rate parameter - * @param sl - `lambda` strided length + * @param sl - `lambda` stride length * @param ol - starting index for `lambda` * @param out - output array * @param so - `out` stride length diff --git a/lib/node_modules/@stdlib/random/strided/geometric/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/strided/geometric/docs/types/index.d.ts index 632943ea05f2..4beef420985e 100644 --- a/lib/node_modules/@stdlib/random/strided/geometric/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/strided/geometric/docs/types/index.d.ts @@ -92,7 +92,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param p - success probability - * @param sp - `p` strided length + * @param sp - `p` stride length * @param out - output array * @param so - `out` stride length * @returns output array @@ -113,7 +113,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param p - success probability - * @param sp - `p` strided length + * @param sp - `p` stride length * @param op - starting index for `p` * @param out - output array * @param so - `out` stride length diff --git a/lib/node_modules/@stdlib/random/strided/poisson/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/strided/poisson/docs/types/index.d.ts index 5fb9194eb48b..7ef8b1f46b9b 100644 --- a/lib/node_modules/@stdlib/random/strided/poisson/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/strided/poisson/docs/types/index.d.ts @@ -92,7 +92,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param lambda - mean parameter - * @param sl - `lambda` strided length + * @param sl - `lambda` stride length * @param out - output array * @param so - `out` stride length * @returns output array @@ -113,7 +113,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param lambda - mean parameter - * @param sl - `lambda` strided length + * @param sl - `lambda` stride length * @param ol - starting index for `lambda` * @param out - output array * @param so - `out` stride length diff --git a/lib/node_modules/@stdlib/random/strided/rayleigh/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/strided/rayleigh/docs/types/index.d.ts index 40c480fb4c60..289f3e1e1246 100644 --- a/lib/node_modules/@stdlib/random/strided/rayleigh/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/strided/rayleigh/docs/types/index.d.ts @@ -92,7 +92,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param sigma - scale parameter - * @param ss - `sigma` strided length + * @param ss - `sigma` stride length * @param out - output array * @param so - `out` stride length * @returns output array @@ -113,7 +113,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param sigma - scale parameter - * @param ss - `sigma` strided length + * @param ss - `sigma` stride length * @param os - starting index for `sigma` * @param out - output array * @param so - `out` stride length diff --git a/lib/node_modules/@stdlib/random/strided/scripts/scaffolds/unary/data/docs/types/index__d__ts.txt b/lib/node_modules/@stdlib/random/strided/scripts/scaffolds/unary/data/docs/types/index__d__ts.txt index 71ddd000f0d4..f79d89895722 100644 --- a/lib/node_modules/@stdlib/random/strided/scripts/scaffolds/unary/data/docs/types/index__d__ts.txt +++ b/lib/node_modules/@stdlib/random/strided/scripts/scaffolds/unary/data/docs/types/index__d__ts.txt @@ -92,7 +92,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param {{PARAM_1}} - {{PARAM_1_DESC}} - * @param {{PARAM_1_STRIDE}} - `{{PARAM_1}}` strided length + * @param {{PARAM_1_STRIDE}} - `{{PARAM_1}}` stride length * @param out - output array * @param so - `out` stride length * @returns output array @@ -113,7 +113,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param {{PARAM_1}} - {{PARAM_1_DESC}} - * @param {{PARAM_1_STRIDE}} - `{{PARAM_1}}` strided length + * @param {{PARAM_1_STRIDE}} - `{{PARAM_1}}` stride length * @param {{PARAM_1_OFFSET}} - starting index for `{{PARAM_1}}` * @param out - output array * @param so - `out` stride length diff --git a/lib/node_modules/@stdlib/random/strided/t/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/strided/t/docs/types/index.d.ts index 1b02e6402369..3b38e494548e 100644 --- a/lib/node_modules/@stdlib/random/strided/t/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/strided/t/docs/types/index.d.ts @@ -92,7 +92,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param v - degrees of freedom - * @param sv - `v` strided length + * @param sv - `v` stride length * @param out - output array * @param so - `out` stride length * @returns output array @@ -113,7 +113,7 @@ interface Random extends PRNG { * * @param N - number of indexed elements * @param v - degrees of freedom - * @param sv - `v` strided length + * @param sv - `v` stride length * @param ov - starting index for `v` * @param out - output array * @param so - `out` stride length diff --git a/lib/node_modules/@stdlib/random/strided/weibull/docs/types/index.d.ts b/lib/node_modules/@stdlib/random/strided/weibull/docs/types/index.d.ts index b5d6536187ac..61094cc4f22c 100644 --- a/lib/node_modules/@stdlib/random/strided/weibull/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/random/strided/weibull/docs/types/index.d.ts @@ -56,9 +56,9 @@ interface Routine { * Fills a strided array with pseudorandom numbers drawn from a Weibull distribution. * * @param N - number of indexed elements - * @param k - scale parameter + * @param k - shape parameter * @param sk - `k` stride length - * @param lambda - shape parameter + * @param lambda - scale parameter * @param sl - `lambda` stride length * @param out - output array * @param so - `out` stride length @@ -83,10 +83,10 @@ interface Routine { * Fills a strided array with pseudorandom numbers drawn from a Weibull distribution using alternative indexing semantics. * * @param N - number of indexed elements - * @param k - scale parameter + * @param k - shape parameter * @param sk - `k` stride length * @param ok - starting index for `k` - * @param lambda - shape parameter + * @param lambda - scale parameter * @param sl - `lambda` stride length * @param ol - starting index for `lambda` * @param out - output array @@ -114,9 +114,9 @@ interface Routine { * Fills a strided array with pseudorandom numbers drawn from a Weibull distribution. * * @param N - number of indexed elements -* @param k - scale parameter +* @param k - shape parameter * @param sk - `k` stride length -* @param lambda - shape parameter +* @param lambda - scale parameter * @param sl - `lambda` stride length * @param out - output array * @param so - `out` stride length