Auto-generated commit

array/bernoulli/benchmark/benchmark.float32.factory.js

@@ -24,7 +24,7 @@ var bench = require( '@stdlib/bench' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var pkg = require( './../package.json' ).name;
-var random = require('./../lib');
+var random = require( './../lib' );
 
 
 // FUNCTIONS //

array/bernoulli/benchmark/benchmark.float32.js

@@ -24,7 +24,7 @@ var bench = require( '@stdlib/bench' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var pkg = require( './../package.json' ).name;
-var random = require('./../lib');
+var random = require( './../lib' );
 
 
 // FUNCTIONS //

array/bernoulli/docs/repl.txt

@@ -9,7 +9,7 @@
         Output array length.
 
     p: number
-        Success probability (i.e., a value on the interval [0,1]).
+        Success probability.
 
     options: Object (optional)
         Options.
@@ -35,7 +35,7 @@
     Parameters
     ----------
     p: number
-        Success probability (i.e., a value on the interval [0,1]).
+        Success probability.
 
     out: Array<number>|TypedArray
         Output array.
@@ -58,11 +58,11 @@
     Returns a function for creating arrays containing pseudorandom numbers drawn
     from a Bernoulli distribution.
 
-    If provided `p`, the returned function returns random variates drawn from
-    the specified distribution.
+    If provided a distribution parameter, the returned function returns random
+    variates drawn from the specified distribution.
 
-    If not provided `p`, the returned function requires that `p` be provided at
-    each invocation.
+    If not provided a distribution parameter, the returned function requires
+    that distribution parameters be provided at each invocation.
 
     The returned function accepts the following options:
 
@@ -72,7 +72,7 @@
     Parameters
     ----------
     p: number (optional)
-        Success probability (i.e., a value on the interval [0,1]).
+        Success probability.
 
     options: Object (optional)
         Options.

array/bernoulli/docs/types/index.d.ts

@@ -167,7 +167,7 @@ interface Random extends PRNG {
 	* @returns output array
 	*
 	* @example
-	* var out = bernoulli 10, 0.5 );
+	* var out = bernoulli( 10, 0.5 );
 	* // returns <Float64Array>
 	*/
 	( len: number, p: number, options?: Options ): RandomArray;
@@ -185,7 +185,7 @@ interface Random extends PRNG {
 	* var x = zeros( 10, 'float64' );
 	* // returns <Float64Array>
 	*
-	* var out = bernoulli 0.5, out );
+	* var out = bernoulli( 0.5, out );
 	* // returns <Float64Array>
 	*
 	* var bool = ( out === x );
@@ -202,7 +202,7 @@ interface Random extends PRNG {
 	*
 	* @param p - success probability
 	* @param options - function options
-	* @throws `p` must be a probability
+	* @throws `p` must be a probability (i.e., a number on the interval [0,1])
 	* @throws must provide a valid state
 	* @returns function for creating arrays
 	*
@@ -257,7 +257,7 @@ interface Random extends PRNG {
 * @returns output array
 *
 * @example
-* var out = bernoulli 10, 0.5 );
+* var out = bernoulli( 10, 0.5 );
 * // returns <Float64Array>
 *
 * @example

array/bernoulli/lib/factory.js

@@ -38,28 +38,28 @@ var DTYPES = dtypes( 'real_and_generic' );
 *
 * @name factory
 * @type {Function}
-* @param {Probability} [p] - success probability
+* @param {PositiveNumber} [p] - success probability
 * @param {Options} [options] - function options
 * @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
 * @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
 * @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
 * @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
 * @param {string} [options.dtype="float64"] - default data type
-* @throws {TypeError} `p` must be a probability
+* @throws {TypeError} `p` must be a probability (i.e., a number on the interval [0,1])
 * @throws {TypeError} options argument must be an object
 * @throws {TypeError} must provide valid options
 * @throws {Error} must provide a valid state
 * @returns {Function} function for creating arrays
 *
 * @example
-* var bernoulli = factory( 0.3 );
+* var bernoulli = factory( 0.5 );
 * // returns <Function>
 *
 * var arr = bernoulli( 10 );
 * // returns <Float64Array>
 *
 * @example
-* var bernoulli = factory( 0.3 );
+* var bernoulli = factory( 0.5 );
 * // returns <Function>
 *
 * var arr = bernoulli( 10, {

array/chi/docs/repl.txt

@@ -57,11 +57,11 @@
     Returns a function for creating arrays containing pseudorandom numbers drawn
     from a chi distribution.
 
-    If provided `k`, the returned function returns random variates drawn from
-    the specified distribution.
+    If provided a distribution parameter, the returned function returns random
+    variates drawn from the specified distribution.
 
-    If not provided `k`, the returned function requires that `k` be provided at
-    each invocation.
+    If not provided a distribution parameter, the returned function requires
+    that distribution parameters be provided at each invocation.
 
     The returned function accepts the following options:
 

array/chi/docs/types/test.ts

@@ -25,8 +25,7 @@ import random = require( './index' );
 // The function returns an array...
 {
 	random( 10, 2.0 ); // $ExpectType RandomArray
-	random( 10, 1.0 ); // $ExpectType RandomArray
-	random( 10, 1.0, {} ); // $ExpectType RandomArray
+	random( 10, 2.0, {} ); // $ExpectType RandomArray
 }
 
 // The compiler throws an error if the function is provided a first argument which is not a number...

array/chi/test/test.factory.js

@@ -736,7 +736,7 @@ tape( 'the function returns a function for creating arrays containing pseudorand
 	t.strictEqual( actual.length, 10, 'returns expected value' );
 
 	for ( i = 0; i < actual.length; i++ ) {
-		t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i );
+		t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i );
 	}
 
 	random = factory();
@@ -746,7 +746,7 @@ tape( 'the function returns a function for creating arrays containing pseudorand
 	t.strictEqual( actual.length, 10, 'returns expected value' );
 
 	for ( i = 0; i < actual.length; i++ ) {
-		t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i );
+		t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i );
 	}
 	t.end();
 });

array/chi/test/test.main.js

@@ -161,7 +161,7 @@ tape( 'the function returns an array containing pseudorandom numbers (default)',
 	t.strictEqual( actual.length, 10, 'returns expected value' );
 
 	for ( i = 0; i < actual.length; i++ ) {
-		t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i );
+		t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i );
 	}
 	t.end();
 });

array/exponential/docs/repl.txt

@@ -58,11 +58,11 @@
     Returns a function for creating arrays containing pseudorandom numbers drawn
     from an exponential distribution.
 
-    If provided `lambda`, the returned function returns random variates drawn
-    from the specified distribution.
+    If provided a distribution parameter, the returned function returns random
+    variates drawn from the specified distribution.
 
-    If not provided `lambda`, the returned function requires that `lambda` be
-    provided at each invocation.
+    If not provided a distribution parameter, the returned function requires
+    that distribution parameters be provided at each invocation.
 
     The returned function accepts the following options:
 

array/exponential/test/test.factory.js

@@ -736,7 +736,7 @@ tape( 'the function returns a function for creating arrays containing pseudorand
 	t.strictEqual( actual.length, 10, 'returns expected value' );
 
 	for ( i = 0; i < actual.length; i++ ) {
-		t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i );
+		t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i );
 	}
 
 	random = factory();
@@ -746,7 +746,7 @@ tape( 'the function returns a function for creating arrays containing pseudorand
 	t.strictEqual( actual.length, 10, 'returns expected value' );
 
 	for ( i = 0; i < actual.length; i++ ) {
-		t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i );
+		t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i );
 	}
 	t.end();
 });

array/exponential/test/test.main.js

@@ -161,7 +161,7 @@ tape( 'the function returns an array containing pseudorandom numbers (default)',
 	t.strictEqual( actual.length, 10, 'returns expected value' );
 
 	for ( i = 0; i < actual.length; i++ ) {
-		t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i );
+		t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i );
 	}
 	t.end();
 });

array/geometric/benchmark/benchmark.float32.factory.js

@@ -24,7 +24,7 @@ var bench = require( '@stdlib/bench' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var pkg = require( './../package.json' ).name;
-var random = require('./../lib');
+var random = require( './../lib' );
 
 
 // FUNCTIONS //

array/geometric/benchmark/benchmark.float32.js

@@ -24,7 +24,7 @@ var bench = require( '@stdlib/bench' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var pkg = require( './../package.json' ).name;
-var random = require('./../lib');
+var random = require( './../lib' );
 
 
 // FUNCTIONS //

array/geometric/docs/repl.txt

@@ -9,7 +9,7 @@
         Output array length.
 
     p: number
-        Success probability (i.e., a value on the interval [0,1]).
+        Success probability.
 
     options: Object (optional)
         Options.
@@ -35,7 +35,7 @@
     Parameters
     ----------
     p: number
-        Success probability (i.e., a value on the interval [0,1]).
+        Success probability.
 
     out: Array<number>|TypedArray
         Output array.
@@ -58,11 +58,11 @@
     Returns a function for creating arrays containing pseudorandom numbers drawn
     from a geometric distribution.
 
-    If provided `p`, the returned function returns random variates drawn from
-    the specified distribution.
+    If provided a distribution parameter, the returned function returns random
+    variates drawn from the specified distribution.
 
-    If not provided `p`, the returned function requires that `p` be provided at
-    each invocation.
+    If not provided a distribution parameter, the returned function requires
+    that distribution parameters be provided at each invocation.
 
     The returned function accepts the following options:
 
@@ -72,7 +72,7 @@
     Parameters
     ----------
     p: number (optional)
-        Success probability (i.e., a value on the interval [0,1]).
+        Success probability.
 
     options: Object (optional)
         Options.

array/geometric/docs/types/index.d.ts

@@ -202,7 +202,7 @@ interface Random extends PRNG {
 	*
 	* @param p - success probability
 	* @param options - function options
-	* @throws `p` must be a probability
+	* @throws `p` must be a probability (i.e., a number on the interval [0,1])
 	* @throws must provide a valid state
 	* @returns function for creating arrays
 	*

array/geometric/lib/factory.js

@@ -38,28 +38,28 @@ var DTYPES = dtypes( 'real_and_generic' );
 *
 * @name factory
 * @type {Function}
-* @param {Probability} [p] - success probability
+* @param {PositiveNumber} [p] - success probability
 * @param {Options} [options] - function options
 * @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
 * @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
 * @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
 * @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
 * @param {string} [options.dtype="float64"] - default data type
-* @throws {TypeError} `p` must be a probability
+* @throws {TypeError} `p` must be a probability (i.e., a number on the interval [0,1])
 * @throws {TypeError} options argument must be an object
 * @throws {TypeError} must provide valid options
 * @throws {Error} must provide a valid state
 * @returns {Function} function for creating arrays
 *
 * @example
-* var geometric = factory( 0.3 );
+* var geometric = factory( 0.01 );
 * // returns <Function>
 *
 * var arr = geometric( 10 );
 * // returns <Float64Array>
 *
 * @example
-* var geometric = factory( 0.3 );
+* var geometric = factory( 0.01 );
 * // returns <Function>
 *
 * var arr = geometric( 10, {

array/poisson/docs/repl.txt

@@ -57,11 +57,11 @@
     Returns a function for creating arrays containing pseudorandom numbers drawn
     from a Poisson distribution.
 
-    If provided `lambda`, the returned function returns random variates drawn
-    from the specified distribution.
+    If provided a distribution parameter, the returned function returns random
+    variates drawn from the specified distribution.
 
-    If not provided `lambda`, the returned function requires that `lambda` be
-    provided at each invocation.
+    If not provided a distribution parameter, the returned function requires
+    that distribution parameters be provided at each invocation.
 
     The returned function accepts the following options:
 

array/poisson/test/test.factory.js

@@ -736,7 +736,7 @@ tape( 'the function returns a function for creating arrays containing pseudorand
 	t.strictEqual( actual.length, 10, 'returns expected value' );
 
 	for ( i = 0; i < actual.length; i++ ) {
-		t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i );
+		t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i );
 	}
 
 	random = factory();
@@ -746,7 +746,7 @@ tape( 'the function returns a function for creating arrays containing pseudorand
 	t.strictEqual( actual.length, 10, 'returns expected value' );
 
 	for ( i = 0; i < actual.length; i++ ) {
-		t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i );
+		t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i );
 	}
 	t.end();
 });

array/poisson/test/test.main.js

@@ -161,7 +161,7 @@ tape( 'the function returns an array containing pseudorandom numbers (default)',
 	t.strictEqual( actual.length, 10, 'returns expected value' );
 
 	for ( i = 0; i < actual.length; i++ ) {
-		t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i );
+		t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i );
 	}
 	t.end();
 });

array/rayleigh/docs/repl.txt

@@ -29,8 +29,7 @@
 
 
 {{alias}}.assign( sigma, out )
-    Fills an array with pseudorandom numbers drawn from a Rayleigh
-    distribution.
+    Fills an array with pseudorandom numbers drawn from a Rayleigh distribution.
 
     Parameters
     ----------
@@ -58,11 +57,11 @@
     Returns a function for creating arrays containing pseudorandom numbers drawn
     from a Rayleigh distribution.
 
-    If provided `sigma`, the returned function returns random variates drawn
-    from the specified distribution.
+    If provided a distribution parameter, the returned function returns random
+    variates drawn from the specified distribution.
 
-    If not provided `sigma`, the returned function requires that `sigma` be
-    provided at each invocation.
+    If not provided a distribution parameter, the returned function requires
+    that distribution parameters be provided at each invocation.
 
     The returned function accepts the following options: