feat: add blas/base/ndarray/dger

lib/node_modules/@stdlib/blas/base/ndarray/dger/README.md

@@ -0,0 +1,130 @@
+<!--
+
+@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.
+
+-->
+
+# dger
+
+> Perform the rank 1 operation `A = alpha*x*y^T + A`.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var dger = require( '@stdlib/blas/base/ndarray/dger' );
+```
+
+#### dger( arrays )
+
+Performs the rank 1 operation `A = alpha*x*y^T + A`, where `alpha` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix.
+
+```javascript
+var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Vector( [ 1.0, 2.0 ] );
+var y = new Float64Vector( [ 3.0, 4.0, 5.0 ] );
+var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), [ 2, 3 ], [ 3, 1 ], 0, 'row-major' );
+
+var alpha = scalar2ndarray( 2.0, {
+    'dtype': 'float64'
+});
+
+var out = dger( [ x, y, A, alpha ] );
+// returns <ndarray>[ [ 7.0, 10.0, 13.0 ], [ 16.0, 21.0, 26.0 ] ]
+
+var bool = ( out === A );
+// returns true
+```
+
+The function has the following parameters:
+
+-   **arrays**: array-like object containing the following ndarrays:
+
+    -   first one-dimensional input ndarray.
+    -   second one-dimensional input ndarray.
+    -   a two-dimensional input ndarray.
+    -   a zero-dimensional ndarray containing a scalar constant.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var Float64Array = require( '@stdlib/array/float64' );
+var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var dger = require( '@stdlib/blas/base/ndarray/dger' );
+
+var opts = {
+    'dtype': 'float64'
+};
+
+var x = new Float64Vector( discreteUniform( 3, 0, 10, opts ) );
+var y = new Float64Vector( discreteUniform( 4, 0, 10, opts ) );
+var A = new ndarray( 'float64', new Float64Array( discreteUniform( 12, 0, 10, opts ) ), [ 3, 4 ], [ 4, 1 ], 0, 'row-major' );
+
+var alpha = scalar2ndarray( 1.0, opts );
+
+var out = dger( [ x, y, A, alpha ] );
+console.log( ndarray2array( out ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- 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">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/base/ndarray/dger/benchmark/benchmark.js

@@ -0,0 +1,114 @@
+/**
+* @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 uniform = require( '@stdlib/random/uniform' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var dger = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'float64'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var alpha;
+	var x;
+	var y;
+	var A;
+
+	x = uniform( [ len ], -100.0, 100.0, options );
+	y = uniform( [ len ], -100.0, 100.0, options );
+	A = uniform( [ len, len ], -100.0, 100.0, options );
+
+	alpha = scalar2ndarray( 1.0, options );
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var z;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			z = dger( [ x, y, A, alpha ] );
+			if ( typeof z !== 'object' ) {
+				b.fail( 'should return an ndarray' );
+			}
+		}
+		b.toc();
+		if ( isnan( z.get( 0, 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 = 3; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( format( '%s:len=%d', pkg, len ), f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/blas/base/ndarray/dger/docs/repl.txt

@@ -0,0 +1,38 @@
+
+{{alias}}( arrays )
+    Performs the rank 1 operation `A = alpha*x*y^T + A`, where `alpha` is a
+    scalar, `x` is an `M` element vector, `y` is an `N` element vector, and
+    `A` is an `M` by `N` matrix.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ndarray>
+        Array-like object containing the following ndarrays:
+
+        - first one-dimensional input ndarray.
+        - second one-dimensional input ndarray.
+        - a two-dimensional input ndarray.
+        - a zero-dimensional ndarray containing a scalar constant.
+
+    Returns
+    -------
+    out: ndarray
+        Output ndarray.
+
+    Examples
+    --------
+    > var x = new {{alias:@stdlib/ndarray/vector/float64}}( [ 1.0, 2.0 ] );
+    > var y = new {{alias:@stdlib/ndarray/vector/float64}}( [ 3.0, 4.0, 5.0 ] );
+    > var buf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+    > var sh = [ 2, 3 ];
+    > var st = [ 3, 1 ];
+    > var A = new {{alias:@stdlib/ndarray/base/ctor}}( 'float64', buf, sh, st, 0, 'row-major' );
+    > var alpha = {{alias:@stdlib/ndarray/from-scalar}}( 2.0, { 'dtype': 'float64' });
+
+    > {{alias}}( [ x, y, A, alpha ] );
+    > A
+    <ndarray>[ [ 7.0, 10.0, 13.0 ], [ 16.0, 21.0, 26.0 ] ]
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/blas/base/ndarray/dger/docs/types/index.d.ts

@@ -0,0 +1,65 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { float64ndarray } from '@stdlib/types/ndarray';
+
+/**
+* Performs the rank 1 operation `A = alpha*x*y^T + A`, where `alpha` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix.
+*
+* ## Notes
+*
+* -   The function expects the following ndarrays:
+*
+*     -   first one-dimensional input ndarray.
+*     -   second one-dimensional input ndarray.
+*     -   a two-dimensional input ndarray.
+*     -   a zero-dimensional ndarray containing a scalar constant.
+*
+* @param arrays - array-like object containing ndarrays
+* @returns output ndarray
+*
+* @example
+* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
+* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+* var ndarray = require( '@stdlib/ndarray/base/ctor' );
+* var Float64Array = require( '@stdlib/array/float64' );
+*
+* var x = new Float64Vector( [ 1.0, 2.0 ] );
+* var y = new Float64Vector( [ 3.0, 4.0, 5.0 ] );
+* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), [ 2, 3 ], [ 3, 1 ], 0, 'row-major' );
+*
+* var alpha = scalar2ndarray( 2.0, {
+*     'dtype': 'float64'
+* });
+*
+* var z = dger( [ x, y, A, alpha ] );
+* // returns <ndarray>[ [ 7.0, 10.0, 13.0 ], [ 16.0, 21.0, 26.0 ] ]
+*
+* var bool = ( z === A );
+* // returns true
+*/
+declare function dger( arrays: [ float64ndarray, float64ndarray, float64ndarray, float64ndarray ] ): float64ndarray;
+
+
+// EXPORTS //
+
+export = dger;