feat: add blas/tools/dot-factory

lib/node_modules/@stdlib/blas/tools/dot-factory/README.md

@@ -0,0 +1,181 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 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.
+
+-->
+
+# factory
+
+> Return a function which computes the dot product.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var factory = require( '@stdlib/blas/tools/dot-factory' );
+```
+
+#### factory( base, dtype )
+
+Returns a function which computes the dot product.
+
+```javascript
+var ddot = require( '@stdlib/blas/base/ddot' ).ndarray;
+
+var dot = factory( ddot, 'float64' );
+```
+
+The function has the following parameters:
+
+-   **base**: "base" function which computes the dot product. Must have an `ndarray` function signature (i.e., must support index offsets).
+-   **dtype**: array data type. The function assumes that the data type of all provided arrays is the same.
+
+#### dot( x, y\[, dim] )
+
+Computes the dot product of two floating-point vectors.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+var array = require( '@stdlib/ndarray/array' );
+var ddot = require( '@stdlib/blas/base/ddot' ).ndarray;
+
+var dot = factory( ddot, 'float64' );
+
+var x = array( new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) );
+var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
+
+var z = dot( x, y );
+// returns <ndarray>
+
+var v = z.get();
+// returns -5.0
+```
+
+The returned function has the following parameters:
+
+-   **x**: a non-zero-dimensional [`ndarray`][@stdlib/ndarray/ctor]. Must be [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with `y`.
+-   **y**: a non-zero-dimensional [`ndarray`][@stdlib/ndarray/ctor]. Must be [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with `x`.
+-   **dim**: dimension for which to compute the dot product. Must be a negative integer. Negative indices are resolved relative to the last array dimension, with the last dimension corresponding to `-1`. Default: `-1`.
+
+If provided at least one input [`ndarray`][@stdlib/ndarray/ctor] having more than one dimension, the input [`ndarrays`][@stdlib/ndarray/ctor] are [broadcasted][@stdlib/ndarray/base/broadcast-shapes] to a common shape. For multi-dimensional input [`ndarrays`][@stdlib/ndarray/ctor], the function performs batched computation, such that the function computes the dot product for each pair of vectors in `x` and `y` according to the specified dimension index.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+var array = require( '@stdlib/ndarray/array' );
+var ddot = require( '@stdlib/blas/base/ddot' ).ndarray;
+
+var dot = factory( ddot, 'float64' );
+
+var opts = {
+    'shape': [ 2, 3 ]
+};
+var x = array( new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 3.0 ] ), opts );
+var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 2.0 ] ), opts );
+
+var z = dot( x, y );
+// returns <ndarray>
+
+var v1 = z.get( 0 );
+// returns 23.0
+
+var v2 = z.get( 1 );
+// returns -22.0
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+For the returned function,
+
+-   The size of the contracted dimension must be the same for both input [`ndarrays`][@stdlib/ndarray/ctor].
+-   The function resolves the dimension index for which to compute the dot product **before** broadcasting.
+-   Negative indices are resolved relative to the last [`ndarray`][@stdlib/ndarray/ctor] dimension, with the last dimension corresponding to `-1`.
+-   The output [`ndarray`][@stdlib/ndarray/ctor] has the same data type as the input [`ndarrays`][@stdlib/ndarray/ctor] and has a shape which is determined by broadcasting and excludes the contracted dimension.
+-   If provided empty vectors, the dot product is `0`.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var array = require( '@stdlib/ndarray/array' );
+var ddot = require( '@stdlib/blas/base/ddot' ).ndarray;
+var factory = require( '@stdlib/blas/tools/dot-factory' );
+
+var dot = factory( ddot, 'float64' );
+
+var opts = {
+    'dtype': 'float64'
+};
+
+var x = array( discreteUniform( 10, 0, 100, opts ), {
+    'shape': [ 5, 2 ]
+});
+console.log( ndarray2array( x ) );
+
+var y = array( discreteUniform( 10, 0, 10, opts ), {
+    'shape': x.shape
+});
+console.log( ndarray2array( y ) );
+
+var z = dot( x, y, -1 );
+console.log( ndarray2array( z ) );
+```
+
+</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">
+
+[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
+
+[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/tools/dot-factory/benchmark/benchmark.js

@@ -0,0 +1,106 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var array = require( '@stdlib/ndarray/array' );
+var ddot = require( '@stdlib/blas/base/ddot' ).ndarray;
+var pkg = require( './../package.json' ).name;
+var factory = require( './../lib' );
+
+
+// VARIABLES //
+
+var opts = {
+	'dtype': 'float64'
+};
+var dot = factory( ddot, opts.dtype );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var x = array( uniform( len, -100.0, 100.0, opts ) );
+	var y = array( uniform( len, -100.0, 100.0, opts ) );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var d;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			d = dot( x, y );
+			if ( isnan( d.get() ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnan( d.get() ) ) {
+			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+'::vectors:len='+len, f );
+	}
+}
+
+main();