stdlib-js · aman-095 · Oct 4, 2024
diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md b/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md
@@ -0,0 +1,324 @@
+<!--
+
+@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.
+
+-->
+
+# ddot
+
+> Compute the dot product of `x` and `y`.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var ddot = require( '@stdlib/blas/base/ddot-wasm' );
+```
+
+#### ddot.main( N, x, strideX, y, strideY )
+
+Computes the dot product of `x` and `y`.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
+var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
+
+var z = ddot.main( x.length, x, 1, y, 1 );
+// returns -5.0
+```
+
+The function has the following parameters:
+
+- **N**: number of indexed elements.
+- **x**: input [`Float64Array`][@stdlib/array/float64].
+- **strideX**: index increment for `x`.
+- **y**: input [`Float64Array`][@stdlib/array/float64].
+- **strideY**: index increment for `y`.
+
+The `N` and strides parameters determine which elements in the strided arrays are accessed at runtime. For example, to calculate the dot product of every other value in `x` and the first `N` elements of `y` in reverse order,
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
+
+var z = ddot.main( 3, x, 2, y, -1 );
+// returns 9.0
+```
+
+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 Float64Array = require( '@stdlib/array/float64' );
+
+// Initial arrays...
+var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+var y0 = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+
+// Create offset views...
+var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element
+
+var z = ddot.main( 3, x1, -2, y1, 1 );
+// returns 128.0
+```
+
+#### ddot.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
+
+Computes the dot product of `x` and `y` using alternative indexing semantics.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
+var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
+
+var z = ddot.ndarray( x.length, x, 1, 0, y, 1, 0 );
+// returns -5.0
+```
+
+The function has the following additional parameters:
+
+- **offsetX**: starting index for `x`.
+- **offsetY**: starting index for `y`.
+
+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, to calculate the dot product of every other value in `x` starting from the second value with the last 3 elements in `y` in reverse order
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+var y = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+
+var z = ddot.ndarray( 3, x, 2, 1, y, -1, y.length-1 );
+// returns 128.0
+```
+
+* * *
+
+### Module
+
+#### ddot.Module( memory )
+
+Returns a new WebAssembly [module wrapper][@stdlib/wasm/module-wrapper] instance which uses the provided WebAssembly [memory][@stdlib/wasm/memory] instance as its underlying memory.
+
+<!-- eslint-disable node/no-sync -->
+
+```javascript
+var Memory = require( '@stdlib/wasm/memory' );
+
+// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
+var mem = new Memory({
+ 'initial': 10,
+ 'maximum': 100
+});
+
+// Create a BLAS routine:
+var mod = new ddot.Module( mem );
+// returns <Module>
+
+// Initialize the routine:
+mod.initializeSync();
+```
+
+#### ddot.Module.prototype.main( N, xp, sx, yp, sy )
+
+Computes the dot product of `x` and `y`.
+
+<!-- eslint-disable node/no-sync -->
+
+```javascript
+var Memory = require( '@stdlib/wasm/memory' );
+var oneTo = require( '@stdlib/array/one-to' );
+var ones = require( '@stdlib/array/ones' );
+var zeros = require( '@stdlib/array/zeros' );
+var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' );
+
+// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
+var mem = new Memory({
+ 'initial': 10,
+ 'maximum': 100
+});
+
+// Create a BLAS routine:
+var mod = new ddot.Module( mem );
+// returns <Module>
+
+// Initialize the routine:
+mod.initializeSync();
+
+// Define a vector data type:
+var dtype = 'float64';
+
+// Specify a vector length:
+var N = 5;
+
+// Define pointers (i.e., byte offsets) for storing two vectors:
+var xptr = 0;
+var yptr = N * bytesPerElement( dtype );
+
+// Write vector values to module memory:
+mod.write( xptr, oneTo( N, dtype ) );
+mod.write( yptr, ones( N, dtype ) );
+
+// Perform computation:
+var z = mod.main( N, xptr, 1, yptr, 1 );
+
+console.log( z );
+```
+
+The function has the following parameters:
+
+- **N**: number of indexed elements.
+- **xp**: input [`Float64Array`][@stdlib/array/float64] pointer (i.e., byte offset).
+- **sx**: index increment for `x`.
+- **yp**: input [`Float64Array`][@stdlib/array/float64] pointer (i.e., byte offset).
+- **sy**: index increment for `y`.
+
+#### ddot.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy )
+
+Computes the dot product of `x` and `y` using alternative indexing semantics.
+
+<!-- eslint-disable node/no-sync -->
+
+```javascript
+var Memory = require( '@stdlib/wasm/memory' );
+var oneTo = require( '@stdlib/array/one-to' );
+var ones = require( '@stdlib/array/ones' );
+var zeros = require( '@stdlib/array/zeros' );
+var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' );
+
+// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
+var mem = new Memory({
+ 'initial': 10,
+ 'maximum': 100
+});
+
+// Create a BLAS routine:
+var mod = new ddot.Module( mem );
+// returns <Module>
+
+// Initialize the routine:
+mod.initializeSync();
+
+// Define a vector data type:
+var dtype = 'float64';
+
+// Specify a vector length:
+var N = 5;
+
+// Define pointers (i.e., byte offsets) for storing two vectors:
+var xptr = 0;
+var yptr = N * bytesPerElement( dtype );
+
+// Write vector values to module memory:
+mod.write( xptr, oneTo( N, dtype ) );
+mod.write( yptr, ones( N, dtype ) );
+
+// Perform computation:
+var z = mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 );
+
+console.log( z );
+```
+
+The function has the following additional parameters:
+
+- **ox**: starting index for `x`.
+- **oy**: starting index for `y`.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+* * *
+
+## Notes
+
+- If `N <= 0` both vectors are left unchanged.
+- This package implements routines using WebAssembly. When provided arrays which are not allocated on a `ddot` module memory instance, data must be explicitly copied to module memory prior to computation. Data movement may entail a performance cost, and, thus, if you are using arrays external to module memory, you should prefer using [`@stdlib/blas/base/ddot`][@stdlib/blas/base/ddot]. However, if working with arrays which are allocated and explicitly managed on module memory, you can achieve better performance when compared to the pure JavaScript implementations found in [`@stdlib/blas/base/ddot`][@stdlib/blas/base/ddot]. Beware that such performance gains may come at the cost of additional complexity when having to perform manual memory management. Choosing between implementations depends heavily on the particular needs and constraints of your application, with no one choice universally better than the other.
+- `ddot()` corresponds to the [BLAS][blas] level 1 function [`ddot`][ddot].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+* * *
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var ddot = require( '@stdlib/blas/base/ddot-wasm' );
+
+var opts = {
+ 'dtype': 'float64'
+};
+var x = discreteUniform( 10, 0, 100, opts );
+console.log( x );
+
+var y = discreteUniform( x.length, 0, 10, opts );
+console.log( y );
+
+var z = ddot.ndarray( x.length, x, 1, 0, y, -1, y.length-1 );
+console.log( 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">
+
+[blas]: http://www.netlib.org/blas
+
+[ddot]: http://www.netlib.org/lapack/explore-html/de/da4/group__double__blas__level1.html
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
+
+[@stdlib/wasm/memory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/wasm/memory
+
+[@stdlib/wasm/module-wrapper]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/wasm/module-wrapper
+
+[@stdlib/blas/base/ddot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ddot
+
+</section>
+
+<!-- /.links -->