Auto-generated commit

Author: stdlib-bot

Diff for: .github/.keepalive

@@ -1 +1 @@
-Copyright (c) 2016-2023 The Stdlib Authors.
+Copyright (c) 2016-2024 The Stdlib Authors.

Diff for: NOTICE

@@ -33,7 +33,7 @@ limitations under the License.
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
-> Create an array containing pseudorandom numbers drawn from a [discrete uniform][@stdlib/random/base/discete-uniform] distribution.
+> Create an array containing pseudorandom numbers drawn from a [discrete uniform][@stdlib/random/base/discrete-uniform] distribution.
 
 <section class="installation">
 
@@ -63,7 +63,7 @@ var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
 
 #### discreteUniform( len, a, b\[, options] )
 
-Returns an array containing pseudorandom numbers drawn from a [discrete uniform][@stdlib/random/base/discete-uniform] distribution.
+Returns an array containing pseudorandom numbers drawn from a [discrete uniform][@stdlib/random/base/discrete-uniform] distribution.
 
 ```javascript
 var out = discreteUniform( 10, -10, 10 );
@@ -92,9 +92,32 @@ var out = discreteUniform( 10, -10, 10, opts );
 // returns [...]
 ```
 
+#### discreteUniform.assign( a, b, out )
+
+Fills an array with pseudorandom numbers drawn from a [discrete uniform][@stdlib/random/base/discrete-uniform] distribution.
+
+```javascript
+var zeros = require( '@stdlib/array-zeros' );
+
+var x = zeros( 10, 'float64' );
+// returns <Float64Array>
+
+var out = discreteUniform.assign( -10, 10, x );
+// returns <Float64Array>
+
+var bool = ( out === x );
+// returns true
+```
+
+The function has the following parameters:
+
+-   **a**: minimum support.
+-   **b**: maximum support.
+-   **out**: output array.
+
 #### discreteUniform.factory( \[a, b, ]\[options] )
 
-Returns a function for creating arrays containing pseudorandom numbers drawn from a [discrete uniform][@stdlib/random/base/discete-uniform] distribution.
+Returns a function for creating arrays containing pseudorandom numbers drawn from a [discrete uniform][@stdlib/random/base/discrete-uniform] distribution.
 
 ```javascript
 var random = discreteUniform.factory();
@@ -106,7 +129,7 @@ var len = out.length;
 // returns 10
 ```
 
-If provided `a` and `b`, the returned generator returns random variates from the specified distribution.
+If provided distribution parameters, the returned generator returns random variates from the specified distribution.
 
 ```javascript
 var random = discreteUniform.factory( -10, 10 );
@@ -118,7 +141,7 @@ out = random( 10 );
 // returns <Float64Array>
 ```
 
-If not provided `a` and `b`, the returned generator requires that both parameters be provided at each invocation.
+If not provided distribution parameters, the returned generator requires that distribution parameters be provided at each invocation.
 
 ```javascript
 var random = discreteUniform.factory();
@@ -132,8 +155,7 @@ out = random( 10, -10, 10 );
 
 The function accepts the following `options`:
 
--   **prng**: pseudorandom number generator for generating uniformly distributed pseudorandom numbers. If provided, the function **ignores** both the `state` and `seed` options. In order to seed the underlying pseudorandom number generator, one must seed the provided `prng` (assuming the provided `prng` is seedable).
--   **seed**: pseudorandom number generator seed.
+-   **prng**: pseudorandom number generator for generating uniformly distributed pseudorandom integers. If provided, the function **ignores** both the `state` and `seed` options. In order to seed the returned pseudorandom number generator, one must seed the provided `prng` (assuming the provided `prng` is seedable). The provided PRNG **must** have `MIN` and `MAX` properties specifying the minimum and maximum possible pseudorandom integers.
 -   **state**: a [`Uint32Array`][@stdlib/array/uint32] containing pseudorandom number generator state. If provided, the function ignores the `seed` option.
 -   **copy**: `boolean` indicating whether to copy a provided pseudorandom number generator state. Setting this option to `false` allows sharing state between two or more pseudorandom number generators. Setting this option to `true` ensures that an underlying generator has exclusive control over its internal state. Default: `true`.
 -   **dtype**: default output array data type. Must be a [real-valued data type][@stdlib/array/typed-real-dtypes] or "generic". Default: `'float64'`.
@@ -339,7 +361,7 @@ var x2 = random( 5 );
 var x3 = random( 5 );
 
 // Print the contents:
-logEach( '%d, %d, %d', x1, x2, x3 );
+logEach( '%f, %f, %f', x1, x2, x3 );
 
 // Create another function for generating random arrays with the original state:
 random = discreteUniform.factory( -10, 10, {
@@ -351,7 +373,7 @@ random = discreteUniform.factory( -10, 10, {
 var x4 = random( 15 );
 
 // Print the contents:
-logEach( '%d', x4 );
+logEach( '%f', x4 );
 ```
 
 </section>
@@ -362,14 +384,6 @@ logEach( '%d', x4 );
 
 <section class="related">
 
-* * *
-
-## See Also
-
--   <span class="package-name">[`@stdlib/random-array/uniform`][@stdlib/random/array/uniform]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a continuous uniform distribution.</span>
--   <span class="package-name">[`@stdlib/random-base/discrete-uniform`][@stdlib/random/base/discrete-uniform]</span><span class="delimiter">: </span><span class="description">discrete uniform distributed pseudorandom numbers.</span>
--   <span class="package-name">[`@stdlib/random-strided/discrete-uniform`][@stdlib/random/strided/discrete-uniform]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a discrete uniform distribution.</span>
-
 </section>
 
 <!-- /.related -->
@@ -443,24 +457,14 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-discrete-uniform/main/LICENSE
 
-[@stdlib/random/base/discete-uniform]: https://github.com/stdlib-js/random-base-discete-uniform
+[@stdlib/random/base/discrete-uniform]: https://github.com/stdlib-js/random-base-discrete-uniform
 
 [@stdlib/array/typed-real-dtypes]: https://github.com/stdlib-js/array-typed-real-dtypes
 
 [@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32
 
 [@stdlib/array/float64]: https://github.com/stdlib-js/array-float64
 
-<!-- <related-links> -->
-
-[@stdlib/random/array/uniform]: https://github.com/stdlib-js/random-array-uniform
-
-[@stdlib/random/base/discrete-uniform]: https://github.com/stdlib-js/random-base-discrete-uniform
-
-[@stdlib/random/strided/discrete-uniform]: https://github.com/stdlib-js/random-strided-discrete-uniform
-
-<!-- </related-links> -->
-
 </section>
 
 <!-- /.links -->

Diff for: README.md

@@ -0,0 +1,97 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench-harness' );
+var isnanf = require( '@stdlib/math-base-assert-is-nanf' );
+var pow = require( '@stdlib/math-base-special-pow' );
+var zeros = require( '@stdlib/array-zeros' );
+var pkg = require( './../package.json' ).name;
+var random = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var o;
+		var i;
+
+		out = zeros( len, 'float32' );
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			o = random.assign( -10, 10, out );
+			if ( isnanf( o[ i%len ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnanf( o[ i%len ] ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':assign:dtype=float32,len='+len, f );
+	}
+}
+
+main();

Diff for: benchmark/benchmark.float32.assign.js

@@ -24,7 +24,7 @@ var bench = require( '@stdlib/bench-harness' );
 var isnanf = require( '@stdlib/math-base-assert-is-nanf' );
 var pow = require( '@stdlib/math-base-special-pow' );
 var pkg = require( './../package.json' ).name;
-var discreteUniform = require( './../lib' );
+var random = require( './../lib' );
 
 
 // FUNCTIONS //
@@ -37,7 +37,7 @@ var discreteUniform = require( './../lib' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var fcn = discreteUniform.factory( -10, 10, {
+	var fcn = random.factory( -10, 10, {
 		'dtype': 'float32'
 	});
 	return benchmark;

Diff for: benchmark/benchmark.float32.factory.js

@@ -24,7 +24,7 @@ var bench = require( '@stdlib/bench-harness' );
 var isnanf = require( '@stdlib/math-base-assert-is-nanf' );
 var pow = require( '@stdlib/math-base-special-pow' );
 var pkg = require( './../package.json' ).name;
-var discreteUniform = require( './../lib' );
+var random = require( './../lib' );
 
 
 // FUNCTIONS //
@@ -56,7 +56,7 @@ function createBenchmark( len ) {
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			o = discreteUniform( len, -10, 10, opts );
+			o = random( len, -10, 10, opts );
 			if ( isnanf( o[ i%len ] ) ) {
 				b.fail( 'should not return NaN' );
 			}

Diff for: benchmark/benchmark.float32.js

@@ -0,0 +1,97 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench-harness' );
+var isnan = require( '@stdlib/math-base-assert-is-nan' );
+var pow = require( '@stdlib/math-base-special-pow' );
+var zeros = require( '@stdlib/array-zeros' );
+var pkg = require( './../package.json' ).name;
+var random = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var o;
+		var i;
+
+		out = zeros( len, 'float64' );
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			o = random.assign( -10, 10, out );
+			if ( isnan( o[ i%len ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnan( o[ i%len ] ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':assign:dtype=float64,len='+len, f );
+	}
+}
+
+main();

Diff for: benchmark/benchmark.float64.assign.js

@@ -24,7 +24,7 @@ var bench = require( '@stdlib/bench-harness' );
 var isnan = require( '@stdlib/math-base-assert-is-nan' );
 var pow = require( '@stdlib/math-base-special-pow' );
 var pkg = require( './../package.json' ).name;
-var discreteUniform = require( './../lib' );
+var random = require( './../lib' );
 
 
 // FUNCTIONS //
@@ -37,7 +37,7 @@ var discreteUniform = require( './../lib' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var fcn = discreteUniform.factory( -10, 10, {
+	var fcn = random.factory( -10, 10, {
 		'dtype': 'float64'
 	});
 	return benchmark;