feat: add lapack/base/dlaruv

lib/node_modules/@stdlib/lapack/base/dlaruv/README.md

@@ -0,0 +1,261 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2026 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.
+
+-->
+
+# dlaruv
+
+> Return a vector of `N` random real numbers drawn from a uniform (0,1) distribution.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var dlaruv = require( '@stdlib/lapack/base/dlaruv' );
+```
+
+#### dlaruv( seed, N, x )
+
+Returns a vector of `N` random real numbers drawn from a uniform (0,1) distribution.
+
+```javascript
+var Int32Array = require( '@stdlib/array/int32' );
+var Float64Array = require( '@stdlib/array/float64' );
+
+var seed = new Int32Array( [ 0, 1, 2, 3 ] );
+var x = new Float64Array( 3 );
+
+dlaruv( seed, 3, x );
+// x => <Float64Array>[ ~0.1319, ~0.2338, ~0.3216 ]
+```
+
+The function has the following parameters:
+
+-   **seed**: [`Int32Array`][@stdlib/array/int32] seed array of four integers. Each element must be between `0` and `4095`, and `seed[3]` must be odd. On exit, the seed is updated.
+-   **N**: number of random numbers to generate. Must be at most `128`.
+-   **x**: output [`Float64Array`][@stdlib/array/float64].
+
+Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
+
+<!-- eslint-disable stdlib/capitalized-comments -->
+
+```javascript
+var Int32Array = require( '@stdlib/array/int32' );
+var Float64Array = require( '@stdlib/array/float64' );
+
+// Initial arrays...
+var seed0 = new Int32Array( [ 0, 0, 1, 2, 3 ] );
+var x0 = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );
+
+// Create offset views...
+var seed1 = new Int32Array( seed0.buffer, seed0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+
+dlaruv( seed1, 3, x1 );
+// x0 => <Float64Array>[ 0.0, ~0.1319, ~0.2338, ~0.3216 ]
+```
+
+#### dlaruv.ndarray( N, seed, strideS, offsetS, x, strideX, offsetX )
+
+Returns a vector of `N` random real numbers drawn from a uniform (0,1) distribution using alternative indexing semantics.
+
+```javascript
+var Int32Array = require( '@stdlib/array/int32' );
+var Float64Array = require( '@stdlib/array/float64' );
+
+var seed = new Int32Array( [ 0, 1, 2, 3 ] );
+var x = new Float64Array( 3 );
+
+dlaruv.ndarray( 3, seed, 1, 0, x, 1, 0 );
+// x => <Float64Array>[ ~0.1319, ~0.2338, ~0.3216 ]
+```
+
+The function has the following additional parameters:
+
+-   **strideS**: stride length for `seed`.
+-   **offsetS**: starting index for `seed`.
+-   **strideX**: stride length for `x`.
+-   **offsetX**: starting index for `x`.
+
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,
+
+<!-- eslint-disable max-len -->
+
+```javascript
+var Int32Array = require( '@stdlib/array/int32' );
+var Float64Array = require( '@stdlib/array/float64' );
+
+var seed = new Int32Array( [ 0, 0, 1, 2, 3 ] );
+var x = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
+
+dlaruv.ndarray( 3, seed, 1, 1, x, 1, 2 );
+// x => <Float64Array>[ 0.0, 0.0, ~0.1319, ~0.2338, ~0.3216 ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   `seed` is updated in-place and should be reused across invocations in order to generate a continuous stream of random numbers.
+-   At most `128` random numbers are generated per invocation. If `N > 128`, only the first `128` indexed elements of `x` are updated.
+-   If `N <= 0`, the functions return `x` unchanged and do not update `seed`.
+-   Generated values are always on the open interval `(0,1)`, as the largest representable output is `1 - 2^-48`.
+-   `dlaruv()` corresponds to the [LAPACK][LAPACK] function [`dlaruv`][lapack-dlaruv].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var Int32Array = require( '@stdlib/array/int32' );
+var Float64Array = require( '@stdlib/array/float64' );
+var dlaruv = require( '@stdlib/lapack/base/dlaruv' );
+
+var seed = new Int32Array( [ 1, 23, 456, 3795 ] );
+var x = new Float64Array( 10 );
+
+dlaruv( seed, x.length, x );
+
+console.log( x );
+console.log( seed );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+TODO
+```
+
+#### TODO
+
+TODO.
+
+```c
+TODO
+```
+
+TODO
+
+```c
+TODO
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+TODO
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+* * *
+
+<section class="references">
+
+## References
+
+-   Fishman, George S. 1990. "Multiplicative Congruential Random Number Generators with Modulus 2^β: An Exhaustive Analysis for β = 32 and a Partial Analysis for β = 48." _Mathematics of Computation_ 54 (189). American Mathematical Society: 331–44. doi:[10.2307/2008698][@fishman1990a].
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[lapack]: https://www.netlib.org/lapack/explore-html/
+
+[lapack-dlaruv]: https://netlib.org/lapack/explore-html/d9/d0f/group__laruv.html
+
+[@stdlib/array/int32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/int32
+
+[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+[@fishman1990a]: https://doi.org/10.2307/2008698
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/lapack/base/dlaruv/benchmark/benchmark.js

@@ -0,0 +1,97 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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' );
+var Int32Array = require( '@stdlib/array/int32' );
+var Float64Array = require( '@stdlib/array/float64' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var dlaruv = require( './../lib/dlaruv.js' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var seed = new Int32Array( [ 1619, 1381, 1011, 2459 ] );
+	var x = new Float64Array( len );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			dlaruv( seed, len, x );
+			if ( isnan( x[ 0 ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnan( x[ 0 ] ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var max;
+	var min;
+	var f;
+	var i;
+
+	min = 0; // 2^min
+	max = 7; // 2^max (capped at 128)
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 2, i );
+		f = createBenchmark( len );
+		bench( format( '%s:len=%d', pkg, len ), f );
+	}
+}
+
+main();