From a665ee0dd2984bc7d48682d7727689246a283e8c Mon Sep 17 00:00:00 2001 From: aman-095 Date: Fri, 4 Oct 2024 19:45:00 +0530 Subject: [PATCH 1/4] feat: add wasm support for ddot --- .../@stdlib/blas/base/ddot-wasm/README.md | 324 +++++++++++ .../base/ddot-wasm/benchmark/benchmark.js | 107 ++++ .../ddot-wasm/benchmark/benchmark.module.js | 66 +++ .../benchmark/benchmark.module.main.js | 133 +++++ .../benchmark/benchmark.module.ndarray.js | 133 +++++ .../ddot-wasm/benchmark/benchmark.ndarray.js | 107 ++++ .../@stdlib/blas/base/ddot-wasm/docs/repl.txt | 543 ++++++++++++++++++ .../blas/base/ddot-wasm/docs/types/index.d.ts | 357 ++++++++++++ .../blas/base/ddot-wasm/docs/types/test.ts | 528 +++++++++++++++++ .../blas/base/ddot-wasm/examples/index.js | 45 ++ .../examples/little_endian_arrays.js | 73 +++ .../blas/base/ddot-wasm/examples/module.js | 67 +++ .../blas/base/ddot-wasm/lib/binary.browser.js | 33 ++ .../@stdlib/blas/base/ddot-wasm/lib/binary.js | 34 ++ .../@stdlib/blas/base/ddot-wasm/lib/index.js | 108 ++++ .../@stdlib/blas/base/ddot-wasm/lib/main.js | 62 ++ .../@stdlib/blas/base/ddot-wasm/lib/module.js | 218 +++++++ .../blas/base/ddot-wasm/lib/routine.js | 178 ++++++ .../@stdlib/blas/base/ddot-wasm/manifest.json | 36 ++ .../@stdlib/blas/base/ddot-wasm/package.json | 80 +++ .../blas/base/ddot-wasm/scripts/build.js | 63 ++ .../blas/base/ddot-wasm/scripts/template.txt | 33 ++ .../@stdlib/blas/base/ddot-wasm/src/Makefile | 232 ++++++++ .../@stdlib/blas/base/ddot-wasm/src/main.wasm | Bin 0 -> 764 bytes .../@stdlib/blas/base/ddot-wasm/src/main.wat | 368 ++++++++++++ .../@stdlib/blas/base/ddot-wasm/test/test.js | 53 ++ .../blas/base/ddot-wasm/test/test.main.js | 209 +++++++ .../blas/base/ddot-wasm/test/test.module.js | 154 +++++ .../base/ddot-wasm/test/test.module.main.js | 252 ++++++++ .../ddot-wasm/test/test.module.ndarray.js | 329 +++++++++++ .../blas/base/ddot-wasm/test/test.ndarray.js | 231 ++++++++ .../blas/base/ddot-wasm/test/test.routine.js | 71 +++ 32 files changed, 5227 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.module.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.module.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.module.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/examples/little_endian_arrays.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/examples/module.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/binary.browser.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/binary.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/module.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/routine.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/manifest.json create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/package.json create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/scripts/build.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/scripts/template.txt create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/src/Makefile create mode 100755 lib/node_modules/@stdlib/blas/base/ddot-wasm/src/main.wasm create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/src/main.wat create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.routine.js diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md b/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md new file mode 100644 index 00000000000..98040ccc8d4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md @@ -0,0 +1,324 @@ + + +# ddot + +> Compute the dot product of `x` and `y`. + +
+ +## 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. + + + +```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. + + + +```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 + +// Initialize the routine: +mod.initializeSync(); +``` + +#### ddot.Module.prototype.main( N, xp, sx, yp, sy ) + +Computes the dot product of `x` and `y`. + + + +```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 + +// 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. + + + +```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 + +// 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`. + +
+ + + +
+ +* * * + +## 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]. + +
+ + + +
+ +* * * + +## Examples + + + +```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 ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[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 + +
+ + diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.js new file mode 100644 index 00000000000..799c80bc20e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.js @@ -0,0 +1,107 @@ +/** +* @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 hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var ddot = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + 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 = ddot.main( x.length, x, 1, y, 1 ); + if ( isnan( d ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( d ) ) { + 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+':len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.module.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.module.js new file mode 100644 index 00000000000..74b2ee05b84 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.module.js @@ -0,0 +1,66 @@ +/** +* @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 hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var Memory = require( '@stdlib/wasm/memory' ); +var pkg = require( './../package.json' ).name; +var ddot = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; + + +// MAIN // + +bench( pkg+':Module:constructor', opts, function benchmark( b ) { + var values; + var o; + var v; + var i; + + o = { + 'initial': 0 + }; + values = [ + new Memory( o ), + new Memory( o ) + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = new ddot.Module( values[ i%values.length ] ); + if ( typeof v !== 'object' ) { + b.fail( 'should return an object' ); + } + } + b.toc(); + if ( typeof v !== 'object' ) { + b.fail( 'should return an object' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.module.main.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.module.main.js new file mode 100644 index 00000000000..236dfef3e49 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.module.main.js @@ -0,0 +1,133 @@ +/** +* @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 hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var Memory = require( '@stdlib/wasm/memory' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var ddot = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; +var options = { + 'dtype': 'float64' +}; + + +// 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 xptr; + var yptr; + var mod; + var mem; + var nb; + var d; + var i; + + // Create a new BLAS routine interface: + mem = new Memory({ + 'initial': 0 + }); + mod = new ddot.Module( mem ); + + // Initialize the module: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Reallocate the underlying memory to allow storing two vectors: + nb = bytesPerElement( options.dtype ); + mod.realloc( len*2*nb ); + + // Define pointers (i.e., byte offsets) to the first vector elements: + xptr = 0; + yptr = len * nb; + + // Write random values to module memory: + mod.write( xptr, uniform( len, -100.0, 100.0, options ) ); + mod.write( yptr, uniform( len, -100.0, 100.0, options ) ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + d = mod.main( len, xptr, 1, yptr, 1 ); + if ( isnan( d ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( d ) ) { + 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+'::module,pointers:len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.module.ndarray.js new file mode 100644 index 00000000000..ec01a05ccb0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.module.ndarray.js @@ -0,0 +1,133 @@ +/** +* @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 hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var Memory = require( '@stdlib/wasm/memory' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var ddot = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; +var options = { + 'dtype': 'float64' +}; + + +// 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 xptr; + var yptr; + var mod; + var mem; + var nb; + var d; + var i; + + // Create a new BLAS routine interface: + mem = new Memory({ + 'initial': 0 + }); + mod = new ddot.Module( mem ); + + // Initialize the module: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Reallocate the underlying memory to allow storing two vectors: + nb = bytesPerElement( options.dtype ); + mod.realloc( len*2*nb ); + + // Define pointers (i.e., byte offsets) to the first vector elements: + xptr = 0; + yptr = len * nb; + + // Write random values to module memory: + mod.write( xptr, uniform( len, -100.0, 100.0, options ) ); + mod.write( yptr, uniform( len, -100.0, 100.0, options ) ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + d = mod.ndarray( len, xptr, 1, 0, yptr, 1, 0 ); + if ( isnan( d ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( d ) ) { + 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+'::module,pointers:ndarray:len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.ndarray.js new file mode 100644 index 00000000000..c9f2a875429 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/benchmark/benchmark.ndarray.js @@ -0,0 +1,107 @@ +/** +* @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 hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var ddot = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + 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 = ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); + if ( isnan( d ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( d ) ) { + 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+':ndarray:len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/repl.txt new file mode 100644 index 00000000000..418138749b7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/repl.txt @@ -0,0 +1,543 @@ + +{{alias}}.main( N, x, strideX, y, strideY ) + Computes the dot product of `x` and `y`. + + The `N` and stride parameters determine which elements in the strided arrays + are accessed at runtime. + + Indexing is relative to the first index. To introduce an offset, use typed + array views. + + If `N <= 0` the function returns `0`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + Input array. + + strideX: integer + Index increment for `x`. + + y: Float64Array + Output array. + + strideY: integer + Index increment for `y`. + + Returns + ------- + out: number + Dot product. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); + > var y = new {{alias:@stdlib/array/float64}}( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + > var out = {{alias}}.main( x.length, x, 1, y, 1 ) + -5.0 + + // Strides: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + > out = {{alias}}.main( 3, x, 2, y, -1 ) + 9.0 + + // Using view offsets: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + > var x1 = new {{alias:@stdlib/array/float64}}( x.buffer, x.BYTES_PER_ELEMENT*1 ); + > var y1 = new {{alias:@stdlib/array/float64}}( y.buffer, y.BYTES_PER_ELEMENT*3 ); + > out = {{alias}}.main( 3, x1, -2, y1, 1 ) + 128.0 + + +{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + Computes the dot product of `x` and `y` using alternative indexing + semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameters support indexing semantics based on starting + indices. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + Input array. + + strideX: integer + Index increment for `x`. + + offsetX: integer + Starting index for `x`. + + y: Float64Array + Output array. + + strideY: integer + Index increment for `y`. + + offsetY: integer + Starting index for `y`. + + Returns + ------- + out: number + Dot product. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); + > var y = new {{alias:@stdlib/array/float64}}( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + > var out = {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ) + -5.0 + + // Strides: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + > out = {{alias}}.ndarray( 3, x, 2, 0, y, 2, 0 ) + 9.0 + + // Using offset indices: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + > out = {{alias}}.ndarray( 3, x, -2, x.length-1, y, 1, 3 ) + 128.0 + + +{{alias}}.Module( memory ) + Returns a new WebAssembly module wrapper which uses the provided WebAssembly + memory instance as its underlying memory. + + Parameters + ---------- + memory: Memory + WebAssembly memory instance. + + Returns + ------- + mod: Module + WebAssembly module wrapper. + + Examples + -------- + // Create a new memory instance: + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + + // Create a new routine: + > var mod = new {{alias}}.Module( mem ); + + // Initialize the routine: + > mod.initializeSync(); + + +{{alias}}.Module.prototype.binary + Read-only property which returns WebAssembly binary code. + + Returns + ------- + out: Uint8Array + WebAssembly binary code. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.binary + + + +{{alias}}.Module.prototype.memory + Read-only property which returns WebAssembly memory. + + Returns + ------- + mem: Memory|null + WebAssembly memory. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.memory + + + +{{alias}}.Module.prototype.buffer + Read-only property which returns a WebAssembly memory buffer as a + Uint8Array. + + Returns + ------- + buf: Uint8Array|null + WebAssembly memory buffer. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.buffer + + + +{{alias}}.Module.prototype.view + Read-only property which returns a WebAsssembly memory buffer as a DataView. + + Returns + ------- + view: DataView|null + WebAssembly memory view. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.view + + + +{{alias}}.Module.prototype.exports + Read-only property which returns "raw" WebAssembly module exports. + + Returns + ------- + out: Object|null + WebAssembly module exports. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.exports + {...} + + +{{alias}}.Module.prototype.initialize() + Asynchronously initializes a WebAssembly module instance. + + Returns + ------- + p: Promise + Promise which resolves upon initializing a WebAssembly module instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initialize(); + + +{{alias}}.Module.prototype.initializeAsync( clbk ) + Asynchronously initializes a WebAssembly module instance. + + Parameters + ---------- + clbk: Function + Callback to invoke upon initializing a WebAssembly module instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > function clbk() { console.log( 'done' ) }; + > mod.initializeAsync( clbk ); + + +{{alias}}.Module.prototype.initializeSync() + Synchronously initializes a WebAssembly module instance. + + In web browsers, JavaScript engines may raise an exception when attempting + to synchronously compile large WebAssembly binaries due to concerns about + blocking the main thread. Hence, to initialize WebAssembly modules having + large binaries (e.g., >4KiB), consider using asynchronous initialization + methods in browser contexts. + + Returns + ------- + mod: Module + Module wrapper instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + + +{{alias}}.Module.prototype.realloc( nbytes ) + Reallocates the underlying WebAssembly memory instance to a specified number + of bytes. + + WebAssembly memory can only **grow**, not shrink. Hence, if provided a + number of bytes which is less than or equal to the size of the current + memory, the function does nothing. + + When non-shared memory is resized, the underlying the `ArrayBuffer` is + detached, consequently invalidating any associated typed array views. Before + resizing non-shared memory, ensure that associated typed array views no + longer need byte access and can be garbage collected. + + Parameters + ---------- + nbytes: integer + Memory size (in bytes). + + Returns + ------- + bool: boolean + Boolean indicating whether the resize operation was successful. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ) + + + +{{alias}}.Module.prototype.hasCapacity( byteOffset, values ) + Returns a boolean indicating whether the underlying WebAssembly memory + instance has the capacity to store a provided list of values starting from a + specified byte offset. + + Parameters + ---------- + byteOffset: integer + Byte offset at which to start writing values. + + values: ArrayLikeObject + Input array containing values to write. + + Returns + ------- + bool: boolean + Boolean indicating whether the underlying WebAssembly memory instance + has enough capacity. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ); + > mod.hasCapacity( 0, [ 1, 2, 3, 4 ] ) + true + + +{{alias}}.Module.prototype.isView( values ) + Returns a boolean indicating whether a provided list of values is a view of + the underlying memory of the WebAssembly module. + + Parameters + ---------- + values: ArrayLikeObject + Input array. + + Returns + ------- + bool: boolean + Boolean indicating whether the list is a memory view. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ); + > mod.isView( [ 1, 2, 3, 4 ] ) + false + + +{{alias}}.Module.prototype.write( byteOffset, values ) + Writes values to the underlying WebAssembly memory instance. + + The function infers element size (i.e., number of bytes per element) from + the data type of the input array. For example, if provided a Float32Array, + the function writes each element as a single-precision floating-point number + to the underlying WebAssembly memory instance. + + In order to write elements as a different data type, you need to perform an + explicit cast *before* calling this method. For example, in order to write + single-precision floating-point numbers contained in a Float32Array as + signed 32-bit integers, you must first convert the Float32Array to an + Int32Array before passing the values to this method. + + If provided an array having an unknown or "generic" data type, elements are + written as double-precision floating-point numbers. + + Parameters + ---------- + byteOffset: integer + Byte offset at which to start writing values. + + values: ArrayLikeObject + Input array containing values to write. + + Returns + ------- + mod: Module + Module wrapper instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ); + > mod.write( 0, [ 1, 2, 3, 4 ] ); + + +{{alias}}.Module.prototype.read( byteOffset, out ) + Reads values from the underlying WebAssembly memory instance. + + The function infers element size (i.e., number of bytes per element) from + the data type of the output array. For example, if provided a Float32Array, + the function reads each element as a single-precision floating-point number + from the underlying WebAssembly memory instance. + + In order to read elements as a different data type, you need to perform an + explicit cast *after* calling this method. For example, in order to read + single-precision floating-point numbers contained in a Float32Array as + signed 32-bit integers, you must convert the Float32Array to an Int32Array + after reading memory values using this method. + + If provided an output array having an unknown or "generic" data type, + elements are read as double-precision floating-point numbers. + + Parameters + ---------- + byteOffset: integer + Byte offset at which to start reading values. + + out: ArrayLikeObject + Output array for storing read values. + + Returns + ------- + mod: Module + Module wrapper instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ); + > mod.write( 0, [ 1, 2, 3, 4 ] ); + > var out = [ 0, 0, 0, 0 ]; + > mod.read( 0, out ); + > out + [ 1, 2, 3, 4 ] + + +{{alias}}.Module.prototype.main( N, xp, sx, yp, sy ) + Computes the dot product of `x` and `y`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + xp: integer + Input array pointer (i.e., byte offset). + + sx: integer + Index increment for `x`. + + yp: integer + Output array pointer (i.e., byte offset). + + sy: integer + Index increment for `y`. + + Returns + ------- + out: number + Dot product. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 1 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + + // Define "pointers" (i.e., byte offsets) into module memory: + > var xptr = 0; + > var yptr = 40; + + // Write data to module memory: + > mod.write( xptr, {{alias:@stdlib/array/one-to}}( 5, 'float64' ) ); + > mod.write( yptr, {{alias:@stdlib/array/ones}}( 5, 'float64' ) ); + + // Perform computation: + > var dot = mod.main( 5, xptr, 1, yptr, 1 ) + 15.0 + + +{{alias}}.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy ) + Computes the dot product of `x` and `y`, using alternative indexing + semantics. + + Parameters + ---------- + N: integer + Number of indexed elements. + + xp: integer + Input array pointer (i.e., byte offset). + + sx: integer + Index increment for `x`. + + ox: integer + Starting index for `x`. + + yp: integer + Output array pointer (i.e., byte offset). + + sy: integer + Index increment for `y`. + + oy: integer + Starting index for `y`. + + Returns + ------- + out: number + Dot product. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 1 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + + // Define "pointers" (i.e., byte offsets) into module memory: + > var xptr = 0; + > var yptr = 40; + + // Write data to module memory: + > mod.write( xptr, {{alias:@stdlib/array/one-to}}( 5, 'float64' ) ); + > mod.write( yptr, {{alias:@stdlib/array/ones}}( 5, 'float64' ) ); + + // Perform computation: + > var dot = mod.ndarray( 5, xptr, 1, 0, yptr, 1, 0 ) + 15.0 + + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/index.d.ts new file mode 100644 index 00000000000..cdc0d5e7846 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/index.d.ts @@ -0,0 +1,357 @@ +/* +* @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. +*/ + +// TypeScript Version: 4.1 + +/// + +import { ModuleWrapper, Memory } from '@stdlib/types/wasm'; + +/** +* Interface defining a module constructor which is both "newable" and "callable". +*/ +interface ModuleConstructor { + /** + * Returns a new WebAssembly module wrapper instance which uses the provided WebAssembly memory instance as its underlying memory. + * + * @param mem - WebAssembly memory instance + * @returns module wrapper instance + * + * @example + * 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 ddot = new ddot.Module( mem ); + * // returns + * + * // Initialize the routine: + * ddot.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: + * ddot.write( xptr, oneTo( N, dtype ) ); + * ddot.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var dot = ddot.main( N, xptr, 1, yptr, 1 ); + * // returns 15.0 + */ + new( mem: Memory ): Module; // newable + + /** + * Returns a new WebAssembly module wrapper instance which uses the provided WebAssembly memory instance as its underlying memory. + * + * @param mem - WebAssembly memory instance + * @returns module wrapper instance + * + * @example + * 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 ddot = ddot.Module( mem ); + * // returns + * + * // Initialize the routine: + * ddot.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: + * ddot.write( xptr, oneTo( N, dtype ) ); + * ddot.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var dot = ddot.main( N, xptr, 1, yptr, 1 ); + * // returns 15.0 + */ + ( mem: Memory ): Module; // callable +} + +/** +* Interface describing a `ddot` WebAssembly module. +*/ +interface Module extends ModuleWrapper { + /** + * Computes the dot product of `x` and `y`. + * + * @param N - number of indexed elements + * @param xptr - input array pointer (i.e., byte offset) + * @param strideX - `x` stride length + * @param yptr - output array pointer (i.e., byte offset) + * @param strideY - `y` stride length + * @returns dot product + * + * @example + * 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 ddot = new Module( mem ); + * // returns + * + * // Initialize the routine: + * ddot.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: + * ddot.write( xptr, oneTo( N, dtype ) ); + * ddot.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var dot = ddot.main( N, 5.0, xptr, 1, yptr, 1 ); + * // returns 15.0 + */ + main( N: number, xptr: number, strideX: number, yptr: number, strideY: number ): number; + + /** + * Computes the dot product of `x` and `y` using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param xptr - input array pointer (i.e., byte offset) + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @param yptr - output array pointer (i.e., byte offset) + * @param strideY - `y` stride length + * @param offsetY - starting index for `y` + * @returns dot product + * + * @example + * 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 ddot = new Module( mem ); + * // returns + * + * // Initialize the routine: + * ddot.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: + * ddot.write( xptr, oneTo( N, dtype ) ); + * ddot.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var dot = ddot.ndarray( N, 5.0, xptr, 1, 0, yptr, 1, 0 ); + * // returns 15.0 + */ + ndarray( N: number, xptr: number, strideX: number, offsetX: number, yptr: number, strideY: number, offsetY: number ): number; +} + +/** +* Interface describing `ddot`. +*/ +interface Routine extends ModuleWrapper { + /** + * Computes the dot product of `x` and `y`. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - `x` stride length + * @param y - output array + * @param strideY - `y` stride length + * @returns dot product + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + * + * var dot = ddot.main( x.length, x, 1, y, 1 ); + * // returns 15.0 + */ + main( N: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number ): Float64Array; + + /** + * Computes the dot product of `x` and `y` using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @param y - output array + * @param strideY - `y` stride length + * @param offsetY - starting index for `y` + * @returns dot product + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + * + * ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); + * // returns 15.0 + */ + ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, y: Float64Array, strideY: number, offsetY: number ): Float64Array; + + /** + * Returns a new WebAssembly module wrapper instance which uses the provided WebAssembly memory instance as its underlying memory. + * + * @param mem - WebAssembly memory instance + * @returns module wrapper instance + * + * @example + * 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 ddot = new ddot.Module( mem ); + * // returns + * + * // Initialize the routine: + * ddot.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: + * ddot.write( xptr, oneTo( N, dtype ) ); + * ddot.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var dot = ddot.main( N, xptr, 1, yptr, 1 ); + * // returns 15.0 + */ + Module: ModuleConstructor; +} + +/** +* Computes the dot product of `x` and `y`. +* +* @param N - number of indexed elements +* @param x - input array +* @param strideX - `x` stride length +* @param y - output array +* @param strideY - `y` stride length +* @returns output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* var dot = ddot.main( x.length, x, 1, y, 1 ); +* // returns 15.0 +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* var dot = ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // returns 15.0 +*/ +declare var ddot: Routine; + + +// EXPORTS // + +export = ddot; diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/test.ts new file mode 100644 index 00000000000..5acbd8a3c4b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/test.ts @@ -0,0 +1,528 @@ +/* +* @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. +*/ + +/* eslint-disable space-in-parens */ + +import Memory = require( '@stdlib/wasm/memory' ); +import ddot = require( './index' ); + + +// TESTS // + +// Attached to the main export is a `main` method which returns a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.main( x.length, x, 1, y, 1 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the `main` method is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.main( '10', x, 1, y, 1 ); // $ExpectError + ddot.main( true, x, 1, y, 1 ); // $ExpectError + ddot.main( false, x, 1, y, 1 ); // $ExpectError + ddot.main( null, x, 1, y, 1 ); // $ExpectError + ddot.main( undefined, x, 1, y, 1 ); // $ExpectError + ddot.main( [], x, 1, y, 1 ); // $ExpectError + ddot.main( {}, x, 1, y, 1 ); // $ExpectError + ddot.main( ( x: number ): number => x, x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a second argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.main( x.length, 10, 1, y, 1 ); // $ExpectError + ddot.main( x.length, '10', 1, y, 1 ); // $ExpectError + ddot.main( x.length, true, 1, y, 1 ); // $ExpectError + ddot.main( x.length, false, 1, y, 1 ); // $ExpectError + ddot.main( x.length, null, 1, y, 1 ); // $ExpectError + ddot.main( x.length, undefined, 1, y, 1 ); // $ExpectError + ddot.main( x.length, [], 1, y, 1 ); // $ExpectError + ddot.main( x.length, {}, 1, y, 1 ); // $ExpectError + ddot.main( x.length, ( x: number ): number => x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.main( x.length, x, '10', y, 1 ); // $ExpectError + ddot.main( x.length, x, true, y, 1 ); // $ExpectError + ddot.main( x.length, x, false, y, 1 ); // $ExpectError + ddot.main( x.length, x, null, y, 1 ); // $ExpectError + ddot.main( x.length, x, undefined, y, 1 ); // $ExpectError + ddot.main( x.length, x, [], y, 1 ); // $ExpectError + ddot.main( x.length, x, {}, y, 1 ); // $ExpectError + ddot.main( x.length, x, ( x: number ): number => x, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a fourth argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + ddot.main( x.length, x, 1, 10, 1 ); // $ExpectError + ddot.main( x.length, x, 1, '10', 1 ); // $ExpectError + ddot.main( x.length, x, 1, true, 1 ); // $ExpectError + ddot.main( x.length, x, 1, false, 1 ); // $ExpectError + ddot.main( x.length, x, 1, null, 1 ); // $ExpectError + ddot.main( x.length, x, 1, undefined, 1 ); // $ExpectError + ddot.main( x.length, x, 1, [], 1 ); // $ExpectError + ddot.main( x.length, x, 1, {}, 1 ); // $ExpectError + ddot.main( x.length, x, 1, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a fifth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.main( x.length, x, 1, y, '10' ); // $ExpectError + ddot.main( x.length, x, 1, y, true ); // $ExpectError + ddot.main( x.length, x, 1, y, false ); // $ExpectError + ddot.main( x.length, x, 1, y, null ); // $ExpectError + ddot.main( x.length, x, 1, y, undefined ); // $ExpectError + ddot.main( x.length, x, 1, y, [] ); // $ExpectError + ddot.main( x.length, x, 1, y, {} ); // $ExpectError + ddot.main( x.length, x, 1, y, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.main(); // $ExpectError + ddot.main( x.length ); // $ExpectError + ddot.main( x.length, x ); // $ExpectError + ddot.main( x.length, x, 1 ); // $ExpectError + ddot.main( x.length, x, 1, y ); // $ExpectError + ddot.main( x.length, x, 1, y, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.ndarray( '10', x, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( true, x, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( false, x, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( null, x, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( undefined, x, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( [], x, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( {}, x, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( ( x: number ): number => x, x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.ndarray( x.length, 10, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, '10', 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, true, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, false, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, null, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, undefined, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, [], 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, {}, 1, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, ( x: number ): number => x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.ndarray( x.length, x, '10', 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, true, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, false, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, null, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, undefined, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, [], 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, {}, 0, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, ( x: number ): number => x, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.ndarray( x.length, x, 1, '10', y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, true, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, false, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, null, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, undefined, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, [], y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, {}, y, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, ( x: number ): number => x, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + ddot.ndarray( x.length, x, 1, 0, 10, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, '10', 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, true, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, false, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, null, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, undefined, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, [], 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, {}, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.ndarray( x.length, x, 1, 0, y, '10', 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, true, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, false, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, null, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, undefined, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, [], 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, {}, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.ndarray( x.length, x, 1, 0, y, 1, '10' ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, 1, true ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, 1, false ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, 1, null ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, 1, undefined ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, 1, [] ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, 1, {} ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + ddot.ndarray(); // $ExpectError + ddot.ndarray( x.length ); // $ExpectError + ddot.ndarray( x.length, x ); // $ExpectError + ddot.ndarray( x.length, x, 1 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError + ddot.ndarray( x.length, x, 1, 0, y, 1, 0, 10 ); // $ExpectError +} + +// Attached to the main export is a `Module` constructor which returns a module... +{ + const mem = new Memory({ + 'initial': 0 + }); + + ddot.Module( mem ); // $ExpectType Module +} + +// The compiler throws an error if the `Module` constructor is not provided a WebAssembly memory instance... +{ + ddot.Module( '10' ); // $ExpectError + ddot.Module( true ); // $ExpectError + ddot.Module( false ); // $ExpectError + ddot.Module( null ); // $ExpectError + ddot.Module( undefined ); // $ExpectError + ddot.Module( [] ); // $ExpectError + ddot.Module( {} ); // $ExpectError + ddot.Module( ( x: number ): number => x ); // $ExpectError +} + +// The `Module` constructor returns a module instance having a `main` method which returns a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.main( 10, 0, 1, 80, 1 ); // $ExpectType number +} + +// The compiler throws an error if the `main` method of a module instance is provided a first argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.main( '10', 10, 1, 80, 1 ); // $ExpectError + mod.main( true, 10, 1, 80, 1 ); // $ExpectError + mod.main( false, 10, 1, 80, 1 ); // $ExpectError + mod.main( null, 10, 1, 80, 1 ); // $ExpectError + mod.main( undefined, 10, 1, 80, 1 ); // $ExpectError + mod.main( [], 10, 1, 80, 1 ); // $ExpectError + mod.main( {}, 10, 1, 80, 1 ); // $ExpectError + mod.main( ( x: number ): number => x, 10, 1, 80, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided a second argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.main( 10, '10', 1, 80, 1 ); // $ExpectError + mod.main( 10, true, 1, 80, 1 ); // $ExpectError + mod.main( 10, false, 1, 80, 1 ); // $ExpectError + mod.main( 10, null, 1, 80, 1 ); // $ExpectError + mod.main( 10, undefined, 1, 80, 1 ); // $ExpectError + mod.main( 10, [], 1, 80, 1 ); // $ExpectError + mod.main( 10, {}, 1, 80, 1 ); // $ExpectError + mod.main( 10, ( x: number ): number => x, 1, 80, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided a third argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.main( 10, 0, '10', 80, 1 ); // $ExpectError + mod.main( 10, 0, true, 80, 1 ); // $ExpectError + mod.main( 10, 0, false, 80, 1 ); // $ExpectError + mod.main( 10, 0, null, 80, 1 ); // $ExpectError + mod.main( 10, 0, undefined, 80, 1 ); // $ExpectError + mod.main( 10, 0, [], 80, 1 ); // $ExpectError + mod.main( 10, 0, {}, 80, 1 ); // $ExpectError + mod.main( 10, 0, ( x: number ): number => x, 80, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided a fourth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.main( 10, 0, 1, '10', 1 ); // $ExpectError + mod.main( 10, 0, 1, true, 1 ); // $ExpectError + mod.main( 10, 0, 1, false, 1 ); // $ExpectError + mod.main( 10, 0, 1, null, 1 ); // $ExpectError + mod.main( 10, 0, 1, undefined, 1 ); // $ExpectError + mod.main( 10, 0, 1, [], 1 ); // $ExpectError + mod.main( 10, 0, 1, {}, 1 ); // $ExpectError + mod.main( 10, 0, 1, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided a fifth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.main( 10, 0, 1, 80, '10' ); // $ExpectError + mod.main( 10, 0, 1, 80, true ); // $ExpectError + mod.main( 10, 0, 1, 80, false ); // $ExpectError + mod.main( 10, 0, 1, 80, null ); // $ExpectError + mod.main( 10, 0, 1, 80, undefined ); // $ExpectError + mod.main( 10, 0, 1, 80, [] ); // $ExpectError + mod.main( 10, 0, 1, 80, {} ); // $ExpectError + mod.main( 10, 0, 1, 80, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided an unsupported number of arguments... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.main(); // $ExpectError + mod.main( 10 ); // $ExpectError + mod.main( 10, 0 ); // $ExpectError + mod.main( 10, 0, 1 ); // $ExpectError + mod.main( 10, 0, 1, 80 ); // $ExpectError + mod.main( 10, 0, 1, 80, 1, 10 ); // $ExpectError +} + +// The `Module` constructor returns a module instance having an `ndarray` method which returns a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.ndarray( 10, 0, 1, 0, 80, 1, 0 ); // $ExpectType number +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a first argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.ndarray( '10', 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( true, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( false, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( null, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( undefined, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( [], 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( {}, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( ( x: number ): number => x, 0, 1, 0, 80, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a second argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.ndarray( 10, '10', 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, true, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, false, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, null, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, undefined, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, [], 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, {}, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, ( x: number ): number => x, 1, 0, 80, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a third argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.ndarray( 10, 0, '10', 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, true, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, false, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, null, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, undefined, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, [], 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, {}, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, ( x: number ): number => x, 0, 80, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a fourth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.ndarray( 10, 0, 1, '10', 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, true, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, false, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, null, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, undefined, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, [], 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, {}, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, ( x: number ): number => x, 80, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a fifth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.ndarray( 10, 0, 1, 0, '10', 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, true, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, false, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, null, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, undefined, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, [], 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, {}, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a sixth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.ndarray( 10, 0, 1, 0, 80, '10', 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, true, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, false, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, null, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, undefined, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, [], 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, {}, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided an seventh argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.ndarray( 10, 0, 1, 0, 80, 1, '10' ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, true ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, false ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, null ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, undefined ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, [] ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, {} ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided an unsupported number of arguments... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = ddot.Module( mem ); + + mod.ndarray(); // $ExpectError + mod.ndarray( 10 ); // $ExpectError + mod.ndarray( 10, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/examples/index.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/examples/index.js new file mode 100644 index 00000000000..e5b89b84db9 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/examples/index.js @@ -0,0 +1,45 @@ +/** +* @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'; + +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var oneTo = require( '@stdlib/array/one-to' ); +var ones = require( '@stdlib/array/ones' ); +var ddot = require( './../lib' ); + +function main() { + if ( !hasWebAssemblySupport() ) { + console.error( 'Environment does not support WebAssembly.' ); + return; + } + // Specify a vector length: + var N = 5; + + // Create two arrays: + var x = oneTo( N, 'float64' ); + var y = ones( N, 'float64' ); + + // Perform computation: + var dot = ddot.ndarray( N, x, 1, 0, y, 1, 0 ); + + // Print the result: + console.log( dot ); +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/examples/little_endian_arrays.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/examples/little_endian_arrays.js new file mode 100644 index 00000000000..3504d2e4633 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/examples/little_endian_arrays.js @@ -0,0 +1,73 @@ +/** +* @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'; + +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var Memory = require( '@stdlib/wasm/memory' ); +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; +var gfill = require( '@stdlib/blas/ext/base/gfill' ); +var gfillBy = require( '@stdlib/blas/ext/base/gfill-by' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +var Float64ArrayLE = require( '@stdlib/array/little-endian-float64' ); +var ddot = require( './../lib' ); + +function main() { + if ( !hasWebAssemblySupport() ) { + console.error( 'Environment does not support WebAssembly.' ); + return; + } + // 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 + + // Initialize the routine: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // 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 ); + + // Create typed array views over module memory: + var x = new Float64ArrayLE( mod.memory.buffer, xptr, N ); + var y = new Float64ArrayLE( mod.memory.buffer, yptr, N ); + + // Write values to module memory: + gfillBy( N, x, 1, discreteUniform( -10.0, 10.0 ) ); + gfill( N, 1.0, y, 1 ); + + // Perform computation: + var dot = mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); + + // Print the result: + console.log( dot ); +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/examples/module.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/examples/module.js new file mode 100644 index 00000000000..fcc482f2114 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/examples/module.js @@ -0,0 +1,67 @@ +/** +* @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'; + +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var Memory = require( '@stdlib/wasm/memory' ); +var oneTo = require( '@stdlib/array/one-to' ); +var ones = require( '@stdlib/array/ones' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +var ddot = require( './../lib' ); + +function main() { + if ( !hasWebAssemblySupport() ) { + console.error( 'Environment does not support WebAssembly.' ); + return; + } + // 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 + + // Initialize the routine: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // 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 dot = mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); + + // Print the result: + console.log( dot ); +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/binary.browser.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/binary.browser.js new file mode 100644 index 00000000000..e5d16b22ad4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/binary.browser.js @@ -0,0 +1,33 @@ +/** +* @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 base64ToUint8Array = require( '@stdlib/string/base/base64-to-uint8array' ); + + +// MAIN // + +var wasm = base64ToUint8Array( 'AGFzbQEAAAAADwhkeWxpbmsuMAEEAAAAAAEYA2AAAGAFf39/f38BfGAHf39/f39/fwF8Ag8BA2VudgZtZW1vcnkCAAADBAMAAQIHSgQRX193YXNtX2NhbGxfY3RvcnMAABhfX3dhc21fYXBwbHlfZGF0YV9yZWxvY3MAAAZjX2Rkb3QAAQ5jX2Rkb3RfbmRhcnJheQACCuMEAwMAAQs7AQJ+IAAgASACIAKsIgVCASAArCIGfX5CACAFQgBXG6cgAyAEIASsIgVCASAGfX5CACAFQgBXG6cQAgugBAIBfAl/IABBAEwEQEQAAAAAAAAAAA8LAkACQAJAIAJBAUYgBUEBRnFFBEAgAEEBcSEJIABBAUcNAQwCCwJAIABBBXAiBUUEQAwBCyAFQQFxIQoCQCAAQQVwIgtBAUYEQCAGIQggAyECDAELIARBCGohDCABQQhqIQ0gBUEGcSEOIAYhCCADIQIDQCANIAJBA3QiD2orAwAgDCAIQQN0IhBqKwMAoiABIA9qKwMAIAQgEGorAwCiIAegoCEHIAhBAmohCCACQQJqIQIgCUECaiIJIA5HDQALCyAKBEAgASACQQN0aisDACAEIAhBA3RqKwMAoiAHoCEHCyAAIAZqIAAgC2siAmshBiAAIANqIAJrIQMLIABBBUgNAgNAIAcgASADQQN0aiICKwMgIAQgBkEDdGoiCCsDIKIgAisDGCAIKwMYoiACKwMQIAgrAxCiIAIrAwAgCCsDAKIgAisDCCAIKwMIoqCgoKCgIQcgBkEFaiEGIANBBWohAyAFQQVqIgUgAEgNAAsMAgsgAEH+////B3EhACAFIAVqIQogAiACaiELA0AgASACIANqQQN0aisDACAEIAUgBmpBA3RqKwMAoiABIANBA3RqKwMAIAQgBkEDdGorAwCiIAegoCEHIAYgCmohBiADIAtqIQMgCEECaiIIIABHDQALCyAJRQ0AIAEgA0EDdGorAwAgBCAGQQN0aisDAKIgB6AhBwsgBws=' ); + + +// EXPORTS // + +module.exports = wasm; diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/binary.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/binary.js new file mode 100644 index 00000000000..6f02393f96e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/binary.js @@ -0,0 +1,34 @@ +/** +* @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 resolve = require( 'path' ).resolve; +var readWASM = require( '@stdlib/fs/read-wasm' ).sync; + + +// MAIN // + +var wasm = readWASM( resolve( __dirname, '..', 'src', 'main.wasm' ) ); + + +// EXPORTS // + +module.exports = wasm; diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/index.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/index.js new file mode 100644 index 00000000000..fa0da9f000e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/index.js @@ -0,0 +1,108 @@ +/** +* @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'; + +/** +* WebAssembly routine to compute the dot product of `x` and `y`. +* +* @module @stdlib/blas/base/ddot-wasm +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var ddot = require( '@stdlib/blas/base/ddot-wasm' ); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* var dot = ddot.main( x.length, 5.0, x, 1, y, 1 ); +* // returns 15.0 +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var ddot = require( '@stdlib/blas/base/ddot-wasm' ); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* var dot = ddot.ndarray( x.length, 5.0, x, 1, 0, y, 1, 0 ); +* // returns 15.0 +* +* @example +* 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' ); +* var ddot = require( '@stdlib/blas/base/ddot-wasm' ); +* +* // 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 +* +* // 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 dot = mod.main( N, xptr, 1, yptr, 1 ); +* +* console.log( dot ); +* // returns 15.0 +*/ + +// MODULES // + +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var main = require( './main.js' ); +var Module = require( './module.js' ); + + +// MAIN // + +setReadOnly( main, 'Module', Module ); + + +// EXPORTS // + +module.exports = main; + +// exports: { "Module": "main.Module" } diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/main.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/main.js new file mode 100644 index 00000000000..29a7738657d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/main.js @@ -0,0 +1,62 @@ +/** +* @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 Routine = require( './routine.js' ); + + +// MAIN // + +/** +* WebAssembly module to compute the dot product of `x` and `y`. +* +* @name ddot +* @type {Routine} +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* var dot = ddot.main( x.length, x, 1, y, 1 ); +* // returns 15.0 +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* var dot = ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // returns 15.0 +*/ +var ddot = new Routine(); +ddot.initializeSync(); // eslint-disable-line node/no-sync + + +// EXPORTS // + +module.exports = ddot; diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/module.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/module.js new file mode 100644 index 00000000000..bacc3f7d721 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/module.js @@ -0,0 +1,218 @@ +/** +* @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. +*/ + +/* eslint-disable no-restricted-syntax, no-invalid-this */ + +'use strict'; + +// MODULES // + +var isWebAssemblyMemory = require( '@stdlib/assert/is-wasm-memory' ); +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var inherits = require( '@stdlib/utils/inherit' ); +var WasmModule = require( '@stdlib/wasm/module-wrapper' ); +var format = require( '@stdlib/string/format' ); +var wasmBinary = require( './binary.js' ); + + +// MAIN // + +/** +* BLAS routine WebAssembly module wrapper constructor. +* +* @constructor +* @param {Object} memory - WebAssembly memory instance +* @throws {TypeError} must provide a WebAssembly memory instance +* @returns {Module} module instance +* +* @example +* 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 ddot = new Module( mem ); +* // returns +* +* // Initialize the routine: +* ddot.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: +* ddot.write( xptr, oneTo( N, dtype ) ); +* ddot.write( yptr, ones( N, dtype ) ); +* +* // Perform computation: +* var dot = ddot.main( N, xptr, 1, yptr, 1 ); +* // returns 15.0 +*/ +function Module( memory ) { + if ( !( this instanceof Module ) ) { + return new Module( memory ); + } + if ( !isWebAssemblyMemory( memory ) ) { + throw new TypeError( format( 'invalid argument. Must provide a WebAssembly memory instance. Value: `%s`.', memory ) ); + } + // Call the parent constructor: + WasmModule.call( this, wasmBinary, memory, { + 'env': { + 'memory': memory + } + }); + + return this; +} + +// Inherit from the parent constructor: +inherits( Module, WasmModule ); + +/** +* Computes the dot product of `x` and `y`. +* +* @name main +* @memberof Module.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {NonNegativeInteger} xptr - input array pointer (i.e., byte offset) +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} yptr - output array pointer (i.e., byte offset) +* @param {integer} strideY - `y` stride length +* @returns {number} dot product +* +* @example +* 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 ddot = new Module( mem ); +* // returns +* +* // Initialize the routine: +* ddot.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: +* ddot.write( xptr, oneTo( N, dtype ) ); +* ddot.write( yptr, ones( N, dtype ) ); +* +* // Perform computation: +* var dot = ddot.main( N, xptr, 1, yptr, 1 ); +* // returns 15.0 +*/ +setReadOnly( Module.prototype, 'main', function ddot( N, xptr, strideX, yptr, strideY ) { + return this._instance.exports.c_ddot( N, xptr, strideX, yptr, strideY ); +}); + +/** +* Computes the dot product of `x` and `y` using alternative indexing semantics. +* +* @name ndarray +* @memberof Module.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {NonNegativeInteger} xptr - input array pointer (i.e., byte offset) +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting `x` index +* @param {NonNegativeInteger} yptr - output array pointer (i.e., byte offset) +* @param {integer} strideY - `y` stride length +* @param {NonNegativeInteger} offsetY - starting `y` index +* @returns {number} dot product +* +* @example +* 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 ddot = new Module( mem ); +* // returns +* +* // Initialize the routine: +* ddot.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: +* ddot.write( xptr, oneTo( N, dtype ) ); +* ddot.write( yptr, ones( N, dtype ) ); +* +* // Perform computation: +* var ddot = ddot.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); +* // returns 15.0 +*/ +setReadOnly( Module.prototype, 'ndarray', function ddot( N, xptr, strideX, offsetX, yptr, strideY, offsetY ) { + return this._instance.exports.c_ddot_ndarray( N, xptr, strideX, offsetX, yptr, strideY, offsetY ); // eslint-disable-line max-len +}); + + +// EXPORTS // + +module.exports = Module; diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/routine.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/routine.js new file mode 100644 index 00000000000..ec9c29e8e51 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/routine.js @@ -0,0 +1,178 @@ +/** +* @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. +*/ + +/* eslint-disable no-restricted-syntax, no-invalid-this */ + +'use strict'; + +// MODULES // + +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var inherits = require( '@stdlib/utils/inherit' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var Memory = require( '@stdlib/wasm/memory' ); +var arrays2ptrs = require( '@stdlib/wasm/base/arrays2ptrs' ); +var strided2object = require( '@stdlib/wasm/base/strided2object' ); +var Module = require( './module.js' ); + + +// MAIN // + +/** +* Routine constructor. +* +* @private +* @constructor +* @returns {Routine} routine instance +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Create a new routine: +* var ddot = new Routine(); +* +* // Initialize the module: +* ddot.initializeSync(); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* var dot = ddot.main( x.length, x, 1, y, 1 ); +* // returns 15.0 +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Create a new routine: +* var ddot = new Routine(); +* +* // Initialize the module: +* ddot.initializeSync(); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* var dot = ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // returns 15.0 +*/ +function Routine() { + if ( !( this instanceof Routine ) ) { + return new Routine(); + } + Module.call( this, new Memory({ + 'initial': 0 + })); + return this; +} + +// Inherit from the parent constructor: +inherits( Routine, Module ); + +/** +* Computes the dot product of `x` and `y`. +* +* @name main +* @memberof Routine.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {Float64Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {Float64Array} y - output array +* @param {integer} strideY - `y` stride length +* @returns {number} dot product +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Create a new routine: +* var ddot = new Routine(); +* +* // Initialize the module: +* ddot.initializeSync(); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* var dot = ddot.main( x.length, x, 1, y, 1 ); +* // returns 15.0 +*/ +setReadOnly( Routine.prototype, 'main', function ddot( N, x, strideX, y, strideY ) { + return this.ndarray( N, x, strideX, stride2offset( N, strideX ), y, strideY, stride2offset( N, strideY ) ); // eslint-disable-line max-len +}); + +/** +* Computes the dot product of `x` and `y` using alternative indexing semantics. +* +* @name ndarray +* @memberof Routine.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {Float64Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting `x` index +* @param {Float64Array} y - output array +* @param {integer} strideY - `y` stride length +* @param {NonNegativeInteger} offsetY - starting `y` index +* @returns {number} dot product +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Create a new routine: +* var ddot = new Routine(); +* +* // Initialize the module: +* ddot.initializeSync(); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* var dot = ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // returns 15.0 +*/ +setReadOnly( Routine.prototype, 'ndarray', function ddot( N, x, strideX, offsetX, y, strideY, offsetY ) { + var ptrs; + var p0; + var p1; + + // Convert the input arrays to "pointers" in the module's memory: + ptrs = arrays2ptrs( this, [ + strided2object( N, x, strideX, offsetX ), + strided2object( N, y, strideY, offsetY ) + ]); + p0 = ptrs[ 0 ]; + p1 = ptrs[ 1 ]; + + // Perform computation by calling the corresponding parent method: + return Module.prototype.ndarray.call( this, N, p0.ptr, p0.stride, p0.offset, p1.ptr, p1.stride, p1.offset ); // eslint-disable-line max-len +}); + + +// EXPORTS // + +module.exports = Routine; diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/manifest.json b/lib/node_modules/@stdlib/blas/base/ddot-wasm/manifest.json new file mode 100644 index 00000000000..d5b6aa8d273 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/manifest.json @@ -0,0 +1,36 @@ +{ + "options": {}, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { + "src": [], + "include": [], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/ddot" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/package.json b/lib/node_modules/@stdlib/blas/base/ddot-wasm/package.json new file mode 100644 index 00000000000..f17b7a0b15b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/package.json @@ -0,0 +1,80 @@ +{ + "name": "@stdlib/blas/base/ddot-wasm", + "version": "0.0.0", + "description": "Compute the dot product of `x` and `y`.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "browser": { + "./lib/binary.js": "./lib/binary.browser.js" + }, + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "scripts": "./scripts", + "src": "./src", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "blas", + "level 1", + "ddot", + "linear", + "algebra", + "subroutines", + "dot", + "vector", + "array", + "ndarray", + "float64", + "double", + "float64array", + "webassembly", + "wasm" + ], + "__stdlib__": { + "wasm": true + } +} diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/scripts/build.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/scripts/build.js new file mode 100644 index 00000000000..348354d7029 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/scripts/build.js @@ -0,0 +1,63 @@ +#!/usr/bin/env node + +/** +* @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 resolve = require( 'path' ).resolve; +var readFile = require( '@stdlib/fs/read-file' ).sync; +var writeFile = require( '@stdlib/fs/write-file' ).sync; +var replace = require( '@stdlib/string/replace' ); + + +// VARIABLES // + +var wpath = resolve( __dirname, '..', 'src', 'main.wasm' ); +var tpath = resolve( __dirname, 'template.txt' ); +var opath = resolve( __dirname, '..', 'lib', 'binary.browser.js' ); + +var opts = { + 'encoding': 'utf8' +}; + +var PLACEHOLDER = '{{WASM_BASE64}}'; + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var wasm; + var tmpl; + + wasm = readFile( wpath ); + tmpl = readFile( tpath, opts ); + + tmpl = replace( tmpl, PLACEHOLDER, wasm.toString( 'base64' ) ); + + writeFile( opath, tmpl, opts ); +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/scripts/template.txt b/lib/node_modules/@stdlib/blas/base/ddot-wasm/scripts/template.txt new file mode 100644 index 00000000000..12996dd89e3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/scripts/template.txt @@ -0,0 +1,33 @@ +/** +* @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 base64ToUint8Array = require( '@stdlib/string/base/base64-to-uint8array' ); + + +// MAIN // + +var wasm = base64ToUint8Array( '{{WASM_BASE64}}' ); + + +// EXPORTS // + +module.exports = wasm; diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/src/Makefile b/lib/node_modules/@stdlib/blas/base/ddot-wasm/src/Makefile new file mode 100644 index 00000000000..bd2f30dc5f0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/src/Makefile @@ -0,0 +1,232 @@ +#/ +# @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. +#/ + +#/ +# To compile targets listed in this Makefile, use top-level project `make` +# commands rather than commands listed in this Makefile. The top-level project +# `make` commands will ensure that various environment variables and flags are +# appropriately set. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files to WebAssembly: +ifdef EMCC_COMPILER + EMCC := $(EMCC_COMPILER) +else + EMCC := emcc +endif + +# Define the program used for compiling WebAssembly files to the WebAssembly text format: +ifdef WASM2WAT + WASM_TO_WAT := $(WASM2WAT) +else + WASM_TO_WAT := wasm2wat +endif + +# Define the program used for compiling WebAssembly files to JavaScript: +ifdef WASM2JS + WASM_TO_JS := $(WASM2JS) +else + WASM_TO_JS := wasm2js +endif + +# Define the path to the Node.js executable: +ifdef NODE + NODEJS := $(NODE) +else + NODEJS := node +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic \ + -D CBLAS_INT=int32_t + +# Define the command-line options when compiling C files to WebAssembly and asm.js: +EMCCFLAGS ?= $(CFLAGS) + +# Define shared `emcc` flags: +EMCC_SHARED_FLAGS := \ + -s SIDE_MODULE=2 \ + -s WASM_BIGINT=0 \ + -s EXPORTED_FUNCTIONS="['_c_ddot','_c_ddot_ndarray']" + +# Define WebAssembly `emcc` flags: +EMCC_WASM_FLAGS := $(EMCC_SHARED_FLAGS) \ + -s WASM=1 + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of WebAssembly targets: +wasm_targets := main.wasm + +# List of WebAssembly WAT targets: +wat_targets := main.wat + +# List of WebAssembly JavaScript targets: +wasm_js_targets := main.wasm.js + +# List of other JavaScript targets: +browser_js_targets := ./../lib/binary.browser.js + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [EMCC_COMPILER] - EMCC compiler (e.g., `emcc`) +# @param {string} [EMCCFLAGS] - EMCC compiler options +# @param {string} [WASM2WAT] - WebAssembly text format compiler (e.g., `wasm2wat`) +# @param {string} [WASM2JS] - WebAssembly JavaScript compiler (e.g., `wasm2js`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: wasm + +.PHONY: all + +#/ +# Compiles source files to WebAssembly. +# +# @param {string} [EMCC_COMPILER] - EMCC compiler (e.g., `emcc`) +# @param {string} [EMCCFLAGS] - EMCC compiler options +# @param {string} [WASM2WAT] - WebAssembly text format compiler (e.g., `wasm2wat`) +# @param {string} [WASM2JS] - WebAssembly JavaScript compiler (e.g., `wasm2js`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make wasm +#/ +wasm: $(wasm_targets) $(wat_targets) $(browser_js_targets) + +.PHONY: wasm + +#/ +# Compiles C source files to WebAssembly binaries. +# +# @private +# @param {string} EMCC - EMCC compiler (e.g., `emcc`) +# @param {string} EMCCFLAGS - EMCC compiler options +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(wasm_targets): + $(QUIET) $(EMCC) $(EMCCFLAGS) $(EMCC_WASM_FLAGS) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) $(LIBRARIES) + +#/ +# Compiles WebAssembly binary files to the WebAssembly text format. +# +# @private +# @param {string} WASM2WAT - WAT compiler (e.g., `wasm2wat`) +#/ +$(wat_targets): %.wat: %.wasm + $(QUIET) $(WASM_TO_WAT) -o $@ $(wasm_targets) + +#/ +# Compiles WebAssembly binary files to JavaScript. +# +# @private +# @param {string} WASM2JS - JavaScript compiler (e.g., `wasm2js`) +#/ +$(wasm_js_targets): %.wasm.js: %.wasm + $(QUIET) $(WASM_TO_JS) -o $@ $(wasm_targets) + +#/ +# Generates an inline WebAssembly build for use in bundlers. +# +# @private +# @param {string} NODE - Node.js executable +#/ +$(browser_js_targets): $(wasm_targets) + $(QUIET) $(NODEJS) ./../scripts/build.js + +#/ +# Removes generated WebAssembly files. +# +# @example +# make clean-wasm +#/ +clean-wasm: + $(QUIET) -rm -f *.wasm *.wat *.wasm.js + +.PHONY: clean-wasm + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-wasm + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/src/main.wasm b/lib/node_modules/@stdlib/blas/base/ddot-wasm/src/main.wasm new file mode 100755 index 0000000000000000000000000000000000000000..403fd9d8cf4f652baea185fbde2469733750f8de GIT binary patch literal 764 zcmZ`%xo+D)5S_hvXhlis1f&_VH4vmvBMEVA817S2gs39aEei<*IQFjyYTWp*@*h#& zkTjAeOMvs{dNX`WDjrsfaQabsTz*?GK73SGd^I#vqN#h9qaLSW4Fu}GGV}HKU^QQD z_D4-*tRbbtJNqure}FHa70YElJ8bq3M8h^#Y`4o}UKWQU-_Mtu8B)P4FU!q=RIdT~ zx-9nl;z+vl%NlU{Pf9;Av0}~oHFFci^qK`fpC-g^LSNs%uwl!#N&OoiXn(R=J;u*W zW4gDa&(xm2*CTmYkJT4;c>d}U#AdT3h zTJm-rRcV)%m;}|qF73VL&4?3>Gl#5ST^ZsoN8${`IkVy>YPk)Br&AiDL|35KVl>Av zSCbjDY~I${f=z_Jx`l`}=aagu4_M z$EfJYjaI40B67K=`ui;oySJW*Q|~CMwHwys8;Jt$)Fau;ND(ZHm>P-V>qP#W|8$E+ Gq5lIjG>3Ko literal 0 HcmV?d00001 diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/src/main.wat b/lib/node_modules/@stdlib/blas/base/ddot-wasm/src/main.wat new file mode 100644 index 00000000000..3aed2b72c24 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/src/main.wat @@ -0,0 +1,368 @@ +;; @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. + +(module + (type (;0;) (func)) + (type (;1;) (func (param i32 i32 i32 i32 i32) (result f64))) + (type (;2;) (func (param i32 i32 i32 i32 i32 i32 i32) (result f64))) + (import "env" "memory" (memory (;0;) 0)) + (func (;0;) (type 0) + nop) + (func (;1;) (type 1) (param i32 i32 i32 i32 i32) (result f64) + (local i64 i64) + local.get 0 + local.get 1 + local.get 2 + local.get 2 + i64.extend_i32_s + local.tee 5 + i64.const 1 + local.get 0 + i64.extend_i32_s + local.tee 6 + i64.sub + i64.mul + i64.const 0 + local.get 5 + i64.const 0 + i64.le_s + select + i32.wrap_i64 + local.get 3 + local.get 4 + local.get 4 + i64.extend_i32_s + local.tee 5 + i64.const 1 + local.get 6 + i64.sub + i64.mul + i64.const 0 + local.get 5 + i64.const 0 + i64.le_s + select + i32.wrap_i64 + call 2) + (func (;2;) (type 2) (param i32 i32 i32 i32 i32 i32 i32) (result f64) + (local f64 i32 i32 i32 i32 i32 i32 i32 i32 i32) + local.get 0 + i32.const 0 + i32.le_s + if ;; label = @1 + f64.const 0x0p+0 (;=0;) + return + end + block ;; label = @1 + block ;; label = @2 + block ;; label = @3 + local.get 2 + i32.const 1 + i32.eq + local.get 5 + i32.const 1 + i32.eq + i32.and + i32.eqz + if ;; label = @4 + local.get 0 + i32.const 1 + i32.and + local.set 9 + local.get 0 + i32.const 1 + i32.ne + br_if 1 (;@3;) + br 2 (;@2;) + end + block ;; label = @4 + local.get 0 + i32.const 5 + i32.rem_u + local.tee 5 + i32.eqz + if ;; label = @5 + br 1 (;@4;) + end + local.get 5 + i32.const 1 + i32.and + local.set 10 + block ;; label = @5 + local.get 0 + i32.const 5 + i32.rem_u + local.tee 11 + i32.const 1 + i32.eq + if ;; label = @6 + local.get 6 + local.set 8 + local.get 3 + local.set 2 + br 1 (;@5;) + end + local.get 4 + i32.const 8 + i32.add + local.set 12 + local.get 1 + i32.const 8 + i32.add + local.set 13 + local.get 5 + i32.const 6 + i32.and + local.set 14 + local.get 6 + local.set 8 + local.get 3 + local.set 2 + loop ;; label = @6 + local.get 13 + local.get 2 + i32.const 3 + i32.shl + local.tee 15 + i32.add + f64.load + local.get 12 + local.get 8 + i32.const 3 + i32.shl + local.tee 16 + i32.add + f64.load + f64.mul + local.get 1 + local.get 15 + i32.add + f64.load + local.get 4 + local.get 16 + i32.add + f64.load + f64.mul + local.get 7 + f64.add + f64.add + local.set 7 + local.get 8 + i32.const 2 + i32.add + local.set 8 + local.get 2 + i32.const 2 + i32.add + local.set 2 + local.get 9 + i32.const 2 + i32.add + local.tee 9 + local.get 14 + i32.ne + br_if 0 (;@6;) + end + end + local.get 10 + if ;; label = @5 + local.get 1 + local.get 2 + i32.const 3 + i32.shl + i32.add + f64.load + local.get 4 + local.get 8 + i32.const 3 + i32.shl + i32.add + f64.load + f64.mul + local.get 7 + f64.add + local.set 7 + end + local.get 0 + local.get 6 + i32.add + local.get 0 + local.get 11 + i32.sub + local.tee 2 + i32.sub + local.set 6 + local.get 0 + local.get 3 + i32.add + local.get 2 + i32.sub + local.set 3 + end + local.get 0 + i32.const 5 + i32.lt_s + br_if 2 (;@1;) + loop ;; label = @4 + local.get 7 + local.get 1 + local.get 3 + i32.const 3 + i32.shl + i32.add + local.tee 2 + f64.load offset=32 + local.get 4 + local.get 6 + i32.const 3 + i32.shl + i32.add + local.tee 8 + f64.load offset=32 + f64.mul + local.get 2 + f64.load offset=24 + local.get 8 + f64.load offset=24 + f64.mul + local.get 2 + f64.load offset=16 + local.get 8 + f64.load offset=16 + f64.mul + local.get 2 + f64.load + local.get 8 + f64.load + f64.mul + local.get 2 + f64.load offset=8 + local.get 8 + f64.load offset=8 + f64.mul + f64.add + f64.add + f64.add + f64.add + f64.add + local.set 7 + local.get 6 + i32.const 5 + i32.add + local.set 6 + local.get 3 + i32.const 5 + i32.add + local.set 3 + local.get 5 + i32.const 5 + i32.add + local.tee 5 + local.get 0 + i32.lt_s + br_if 0 (;@4;) + end + br 2 (;@1;) + end + local.get 0 + i32.const 2147483646 + i32.and + local.set 0 + local.get 5 + local.get 5 + i32.add + local.set 10 + local.get 2 + local.get 2 + i32.add + local.set 11 + loop ;; label = @3 + local.get 1 + local.get 2 + local.get 3 + i32.add + i32.const 3 + i32.shl + i32.add + f64.load + local.get 4 + local.get 5 + local.get 6 + i32.add + i32.const 3 + i32.shl + i32.add + f64.load + f64.mul + local.get 1 + local.get 3 + i32.const 3 + i32.shl + i32.add + f64.load + local.get 4 + local.get 6 + i32.const 3 + i32.shl + i32.add + f64.load + f64.mul + local.get 7 + f64.add + f64.add + local.set 7 + local.get 6 + local.get 10 + i32.add + local.set 6 + local.get 3 + local.get 11 + i32.add + local.set 3 + local.get 8 + i32.const 2 + i32.add + local.tee 8 + local.get 0 + i32.ne + br_if 0 (;@3;) + end + end + local.get 9 + i32.eqz + br_if 0 (;@1;) + local.get 1 + local.get 3 + i32.const 3 + i32.shl + i32.add + f64.load + local.get 4 + local.get 6 + i32.const 3 + i32.shl + i32.add + f64.load + f64.mul + local.get 7 + f64.add + local.set 7 + end + local.get 7) + (export "__wasm_call_ctors" (func 0)) + (export "__wasm_apply_data_relocs" (func 0)) + (export "c_ddot" (func 1)) + (export "c_ddot_ndarray" (func 2))) diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.js new file mode 100644 index 00000000000..fcbd4b67fd5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.js @@ -0,0 +1,53 @@ +/** +* @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 tape = require( 'tape' ); +var ddot = require( './../lib' ); + + +// TESTS // + +tape( 'main export is an object', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ddot, 'object', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is a `main` method', function test( t ) { + t.strictEqual( typeof ddot.main, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is an `ndarray` method', function test( t ) { + t.strictEqual( typeof ddot.ndarray, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is a `Module` constructor', function test( t ) { + t.strictEqual( typeof ddot.Module, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'the main export is a `Module` instance', function test( t ) { + t.strictEqual( ddot instanceof ddot.Module, true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.main.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.main.js new file mode 100644 index 00000000000..da2d68077fa --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.main.js @@ -0,0 +1,209 @@ +/** +* @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 tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var ddot = require( './../lib' ); + + +// TESTS // + +tape( 'main export is an object', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ddot, 'object', 'main export is an object' ); + t.end(); +}); + +tape( 'the `main` method has an arity of 5', function test( t ) { + t.strictEqual( ddot.main.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method computes the dot product of `x` and `y`', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ); + y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ); + + dot = ddot.main( x.length, x, 1, y, 1 ); + t.strictEqual( dot, -17.0, 'returns expected value' ); + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + dot = ddot.main( x.length, x, 1, y, 1 ); + t.strictEqual( dot, 14.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the `main` method supports an `x` stride', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, // 1 + -3.0, // 2 + 3.0, + -4.0, + 1.0 + ]); + + dot = ddot.main( 3, x, 2, y, 1 ); + t.strictEqual( dot, -12.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method supports a `y` stride', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ]); + + dot = ddot.main( 3, x, 1, y, 2 ); + t.strictEqual( dot, 45.0, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the `main` method returns the output array unchanged', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + dot = ddot.main( 0, x, 1, y, 1 ); + t.strictEqual( dot, 0.0, 'returns expected value' ); + + dot = ddot.main( -4, x, 1, y, 1 ); + t.strictEqual( dot, 0.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method supports negative strides', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + dot = ddot.main( 3, x, -2, y, -1 ); + t.strictEqual( dot, 67.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method supports complex access patterns', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + dot = ddot.main( 3, x, 2, y, -1 ); + t.strictEqual( dot, 59.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method supports view offsets', function test( t ) { + var dot; + var x0; + var y0; + var x1; + var y1; + + x0 = new Float64Array([ + 1.0, + 2.0, // 0 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 2 + ]); + y0 = new Float64Array([ + 6.0, + 7.0, + 8.0, + 9.0, // 0 + 10.0, // 1 + 11.0 // 2 + ]); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); + + dot = ddot.main( 3, x1, 2, y1, 1 ); + t.strictEqual( dot, 124.0, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.js new file mode 100644 index 00000000000..9adcb07e22f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.js @@ -0,0 +1,154 @@ +/** +* @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 tape = require( 'tape' ); +var Memory = require( '@stdlib/wasm/memory' ); +var ModuleWrapper = require( '@stdlib/wasm/module-wrapper' ); +var Module = require( './../lib' ).Module; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof Module, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'the function is a constructor', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = new Module( mem ); + t.strictEqual( mod instanceof Module, true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function is a constructor which does not require `new`', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = Module( mem ); // eslint-disable-line new-cap + t.strictEqual( mod instanceof Module, true, 'returns expected value' ); + t.end(); +}); + +tape( 'the module constructor throws an error if provided a first argument which is not a WebAssembly memory instance (new)', function test( t ) { + var values; + var i; + + values = [ + '5', + 5, + NaN, + true, + false, + null, + void 0, + [], + {}, + function noop() {} + ]; + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + return new Module( value ); + }; + } +}); + +tape( 'the module constructor throws an error if provided a first argument which is not a WebAssembly memory instance (no new)', function test( t ) { + var values; + var i; + + values = [ + '5', + 5, + NaN, + true, + false, + null, + void 0, + [], + {}, + function noop() {} + ]; + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + return Module( value ); // eslint-disable-line new-cap + }; + } +}); + +tape( 'the module instance returned by the module constructor inherits from a module wrapper', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = new Module( mem ); + + t.strictEqual( mod instanceof ModuleWrapper, true, 'returns expected value' ); + t.end(); +}); + +tape( 'attached to a module instance is a `main` method', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = new Module( mem ); + + t.strictEqual( typeof mod.main, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to a module instance is an `ndarray` method', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = new Module( mem ); + + t.strictEqual( typeof mod.ndarray, 'function', 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.main.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.main.js new file mode 100644 index 00000000000..df7478567dd --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.main.js @@ -0,0 +1,252 @@ +/** +* @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. +*/ + +/* eslint-disable node/no-sync */ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Memory = require( '@stdlib/wasm/memory' ); +var Float64Array = require( '@stdlib/array/float64' ); +var Module = require( './../lib' ).Module; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof Module, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'a module instance has a `main` method which has an arity of 5', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = new Module( mem ); + t.strictEqual( mod.main.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'a module instance has a `main` method which computes the dot product of `x` and `y`', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 64; + + mod.write( xp, new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ) ); + mod.write( yp, new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ) ); + + dot = mod.main( 8, xp, 1, yp, 1 ); + t.strictEqual( dot, -17.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which supports an `x` stride', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 2.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ])); + mod.write( yp, new Float64Array([ + 8.0, // 0 + 2.0, // 1 + -3.0, // 2 + 3.0, + -4.0, + 1.0 + ])); + + dot = mod.main( 3, xp, 2, yp, 1 ); + t.strictEqual( dot, -12.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which supports a `y` stride', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ])); + mod.write( yp, new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ])); + + dot = mod.main( 3, xp, 1, yp, 2 ); + t.strictEqual( dot, 45.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, a module instance has a `main` method which returns `0`', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + mod.write( yp, new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ) ); + + dot = mod.main( -1, xp, 1, yp, 1 ); + t.strictEqual( dot, 0.0, 'returns expected value' ); + + dot = mod.main( 0, xp, 1, yp, 1 ); + t.strictEqual( dot, 0.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which supports negative strides', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ])); + mod.write( yp, new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ])); + + dot = mod.main( 3, xp, -2, yp, -1 ); + t.strictEqual( dot, 67.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which supports complex access patterns', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ])); + mod.write( yp, new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ])); + + dot = mod.main( 3, xp, 2, yp, -1 ); + t.strictEqual( dot, 59.0, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.ndarray.js new file mode 100644 index 00000000000..1063a3d03a6 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.ndarray.js @@ -0,0 +1,329 @@ +/** +* @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. +*/ + +/* eslint-disable node/no-sync */ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Memory = require( '@stdlib/wasm/memory' ); +var Float64Array = require( '@stdlib/array/float64' ); +var Module = require( './../lib' ).Module; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof Module, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which has an arity of 7', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = new Module( mem ); + t.strictEqual( mod.ndarray.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which computes the dot product of `x` and `y`', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + mod.write( yp, new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ) ); + + dot = mod.ndarray( 5, xp, 1, 0, yp, 1, 0 ); + t.strictEqual( dot, 15.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports an `x` stride', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 2.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ])); + mod.write( yp, new Float64Array([ + 8.0, // 0 + 2.0, // 1 + -3.0, // 2 + 3.0, + -4.0, + 1.0 + ])); + + dot = mod.ndarray( 3, xp, 2, 0, yp, 1, 0 ); + t.strictEqual( dot, -12.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports an `x` offset', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ])); + mod.write( yp, new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ])); + + dot = mod.ndarray( 3, xp, 1, 0, yp, 2, 0 ); + t.strictEqual( dot, 45.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports a `y` stride', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ])); + mod.write( yp, new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ])); + + dot = mod.ndarray( 3, xp, 1, 0, yp, 2, 0 ); + t.strictEqual( dot, 45.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports a `y` offset', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 48; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0, // 2 + 6.0 + ])); + mod.write( yp, new Float64Array([ + 6.0, + 7.0, + 8.0, + 9.0, // 0 + 10.0, // 1 + 11.0 // 2 + ])); + + dot = mod.ndarray( 3, xp, 2, 0, yp, 1, 3 ); + t.strictEqual( dot, 94.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, a module instance has an `ndarray` method which leaves the output array unchanged', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + mod.write( yp, new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ) ); + + dot = mod.ndarray( -1, 3.0, xp, 1, 0, yp, 1, 0 ); + t.strictEqual( dot, 0.0, 'returns expected value' ); + + dot = mod.ndarray( 0, 3.0, xp, 1, 0, yp, 1, 0 ); + t.strictEqual( dot, 0.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports negative strides', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ])); + mod.write( yp, new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ])); + + dot = mod.ndarray( 3, xp, -2, 4, yp, -1, 2 ); + t.strictEqual( dot, 67.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports complex access patterns', function test( t ) { + var dot; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ])); + mod.write( yp, new Float64Array([ + 6.0, + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 + 10.0 + ])); + + dot = mod.ndarray( 3, xp, 2, 0, yp, -1, 3 ); + t.strictEqual( dot, 68.0, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.ndarray.js new file mode 100644 index 00000000000..902c222f1e1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.ndarray.js @@ -0,0 +1,231 @@ +/** +* @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 tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var ddot = require( './../lib' ); + + +// TESTS // + +tape( 'main export is an object', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ddot, 'object', 'main export is an object' ); + t.end(); +}); + +tape( 'the `ndarray` method has an arity of 7', function test( t ) { + t.strictEqual( ddot.ndarray.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method computes the dot product of `x` and `y`', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ); + y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ); + + dot = ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( dot, -17.0, 'returns expected value' ); + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + dot = ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); + t.strictEqual( dot, 14.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the `ndarray` method supports an `x` stride', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, // 1 + -3.0, // 2 + 3.0, + -4.0, + 1.0 + ]); + + dot = ddot.ndarray( 3, x, 2, 0, y, 1, 0 ); + t.strictEqual( dot, -12.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method supports an `x` offset', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array([ + 1.0, + 2.0, // 0 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 6.0, // 0 + 7.0, // 1 + 8.0, // 2 + 9.0, + 10.0, + 11.0 + ]); + + dot = ddot.ndarray( 3, x, 2, 1, y, 1, 0 ); + t.strictEqual( dot, 88.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method supports a `y` stride', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array([ + 2.0, // 0 + -3.0, // 1 + -5.0, // 2 + 7.0, + 6.0 + ]); + y = new Float64Array([ + 8.0, // 0 + 2.0, + -3.0, // 1 + 3.0, + -4.0, // 2 + 1.0 + ]); + + dot = ddot.ndarray( 3, x, 1, 0, y, 2, 0 ); + t.strictEqual( dot, 45.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method supports a `y` offset', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0, // 2 + 6.0 + ]); + y = new Float64Array([ + 6.0, + 7.0, + 8.0, + 9.0, // 0 + 10.0, // 1 + 11.0 // 2 + ]); + + dot = ddot.ndarray( 3, x, 2, 0, y, 1, 3 ); + t.strictEqual( dot, 94.0, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the `ndarray` method returns the output array unchanged', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array( [ 3.0, -4.0, 1.0 ] ); + y = new Float64Array( [ 1.0, -2.0, 3.0 ] ); + + dot = ddot.ndarray( 0, x, 1, 0, y, 1, 0 ); + t.strictEqual( dot, 0.0, 'returns expected value' ); + + dot = ddot.ndarray( -4, x, 1, 0, y, 1, 0 ); + t.strictEqual( dot, 0.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method supports negative strides', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + + dot = ddot.ndarray( 3, x, -2, x.length-1, y, -1, 2 ); + t.strictEqual( dot, 67.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method supports complex access patterns', function test( t ) { + var dot; + var x; + var y; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + y = new Float64Array([ + 6.0, + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 + 10.0 + ]); + + dot = ddot.ndarray( 3, x, 2, 0, y, -1, y.length-2 ); + t.strictEqual( dot, 68.0, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.routine.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.routine.js new file mode 100644 index 00000000000..56a4b67daaf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.routine.js @@ -0,0 +1,71 @@ +/** +* @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 tape = require( 'tape' ); +var ModuleWrapper = require( '@stdlib/wasm/module-wrapper' ); +var Module = require( './../lib/module.js' ); +var Routine = require( './../lib/routine.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof Routine, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'the function is a constructor', function test( t ) { + var mod = new Routine(); + t.strictEqual( mod instanceof Routine, true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function is a constructor which does not require `new`', function test( t ) { + var mod = Routine(); // eslint-disable-line new-cap + t.strictEqual( mod instanceof Routine, true, 'returns expected value' ); + t.end(); +}); + +tape( 'the module instance returned by the constructor inherits from a module wrapper', function test( t ) { + var mod = new Routine(); + t.strictEqual( mod instanceof ModuleWrapper, true, 'returns expected value' ); + t.end(); +}); + +tape( 'the module instance returned by the constructor inherits from a BLAS routine module', function test( t ) { + var mod = new Routine(); + t.strictEqual( mod instanceof Module, true, 'returns expected value' ); + t.end(); +}); + +tape( 'attached to a module instance is a `main` method', function test( t ) { + var mod = new Routine(); + t.strictEqual( typeof mod.main, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to a module instance is an `ndarray` method', function test( t ) { + var mod = new Routine(); + t.strictEqual( typeof mod.ndarray, 'function', 'returns expected value' ); + t.end(); +}); From be3a050e82c02e9ddbf268402518173f65d1af2f Mon Sep 17 00:00:00 2001 From: aman-095 Date: Fri, 18 Oct 2024 11:50:04 +0530 Subject: [PATCH 2/4] chore: apply review changes --- .../@stdlib/blas/base/ddot-wasm/README.md | 4 +- .../@stdlib/blas/base/ddot-wasm/docs/repl.txt | 12 ++--- .../blas/base/ddot-wasm/docs/types/index.d.ts | 50 +++++++++---------- .../blas/base/ddot-wasm/test/test.main.js | 2 +- .../base/ddot-wasm/test/test.module.main.js | 2 +- .../ddot-wasm/test/test.module.ndarray.js | 2 +- .../blas/base/ddot-wasm/test/test.ndarray.js | 2 +- 7 files changed, 37 insertions(+), 37 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md b/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md index 98040ccc8d4..69664202354 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md @@ -52,7 +52,7 @@ The function has the following parameters: - **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, +The `N` and stride 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' ); @@ -256,7 +256,7 @@ The function has the following additional parameters: ## Notes -- If `N <= 0` both vectors are left unchanged. +- If `N <= 0`, both `main` and `ndarray` methods return `0.0`. - 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]. diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/repl.txt index 418138749b7..f1ec2504bbf 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/repl.txt @@ -8,7 +8,7 @@ Indexing is relative to the first index. To introduce an offset, use typed array views. - If `N <= 0` the function returns `0`. + If `N <= 0` both the functions return `0`. Parameters ---------- @@ -40,7 +40,7 @@ > var out = {{alias}}.main( x.length, x, 1, y, 1 ) -5.0 - // Strides: + // Using `N` and stride parameters: > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); > y = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); > out = {{alias}}.main( 3, x, 2, y, -1 ) @@ -99,7 +99,7 @@ > var out = {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ) -5.0 - // Strides: + // Using `N` and stride parameters: > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); > y = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); > out = {{alias}}.ndarray( 3, x, 2, 0, y, 2, 0 ) @@ -280,9 +280,9 @@ Reallocates the underlying WebAssembly memory instance to a specified number of bytes. - WebAssembly memory can only **grow**, not shrink. Hence, if provided a - number of bytes which is less than or equal to the size of the current - memory, the function does nothing. + WebAssembly memory can only *grow*, not shrink. Hence, if provided a number + of bytes which is less than or equal to the size of the current memory, the + function does nothing. When non-shared memory is resized, the underlying the `ArrayBuffer` is detached, consequently invalidating any associated typed array views. Before diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/index.d.ts index cdc0d5e7846..2fe3dc19b47 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/index.d.ts @@ -46,11 +46,11 @@ interface ModuleConstructor { * }); * * // Create a BLAS routine: - * var ddot = new ddot.Module( mem ); + * var mod = new ddot.Module( mem ); * // returns * * // Initialize the routine: - * ddot.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float64'; @@ -63,11 +63,11 @@ interface ModuleConstructor { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * ddot.write( xptr, oneTo( N, dtype ) ); - * ddot.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var dot = ddot.main( N, xptr, 1, yptr, 1 ); + * var dot = mod.main( N, xptr, 1, yptr, 1 ); * // returns 15.0 */ new( mem: Memory ): Module; // newable @@ -92,11 +92,11 @@ interface ModuleConstructor { * }); * * // Create a BLAS routine: - * var ddot = ddot.Module( mem ); + * var mod = ddot.Module( mem ); * // returns * * // Initialize the routine: - * ddot.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float64'; @@ -109,11 +109,11 @@ interface ModuleConstructor { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * ddot.write( xptr, oneTo( N, dtype ) ); - * ddot.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var dot = ddot.main( N, xptr, 1, yptr, 1 ); + * var dot = mod.main( N, xptr, 1, yptr, 1 ); * // returns 15.0 */ ( mem: Memory ): Module; // callable @@ -147,11 +147,11 @@ interface Module extends ModuleWrapper { * }); * * // Create a BLAS routine: - * var ddot = new Module( mem ); + * var mod = new ddot.Module( mem ); * // returns * * // Initialize the routine: - * ddot.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float64'; @@ -164,11 +164,11 @@ interface Module extends ModuleWrapper { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * ddot.write( xptr, oneTo( N, dtype ) ); - * ddot.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var dot = ddot.main( N, 5.0, xptr, 1, yptr, 1 ); + * var dot = mod.main( N, 5.0, xptr, 1, yptr, 1 ); * // returns 15.0 */ main( N: number, xptr: number, strideX: number, yptr: number, strideY: number ): number; @@ -199,11 +199,11 @@ interface Module extends ModuleWrapper { * }); * * // Create a BLAS routine: - * var ddot = new Module( mem ); + * var mod = new ddot.Module( mem ); * // returns * * // Initialize the routine: - * ddot.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float64'; @@ -216,11 +216,11 @@ interface Module extends ModuleWrapper { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * ddot.write( xptr, oneTo( N, dtype ) ); - * ddot.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var dot = ddot.ndarray( N, 5.0, xptr, 1, 0, yptr, 1, 0 ); + * var dot = mod.ndarray( N, 5.0, xptr, 1, 0, yptr, 1, 0 ); * // returns 15.0 */ ndarray( N: number, xptr: number, strideX: number, offsetX: number, yptr: number, strideY: number, offsetY: number ): number; @@ -294,11 +294,11 @@ interface Routine extends ModuleWrapper { * }); * * // Create a BLAS routine: - * var ddot = new ddot.Module( mem ); + * var mod = new ddot.Module( mem ); * // returns * * // Initialize the routine: - * ddot.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float64'; @@ -311,11 +311,11 @@ interface Routine extends ModuleWrapper { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * ddot.write( xptr, oneTo( N, dtype ) ); - * ddot.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var dot = ddot.main( N, xptr, 1, yptr, 1 ); + * var dot = mod.main( N, xptr, 1, yptr, 1 ); * // returns 15.0 */ Module: ModuleConstructor; diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.main.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.main.js index da2d68077fa..de10dc3f944 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.main.js @@ -110,7 +110,7 @@ tape( 'the `main` method supports a `y` stride', function test( t ) { t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, the `main` method returns the output array unchanged', function test( t ) { +tape( 'if provided an `N` parameter less than or equal to `0`, the `main` method returns `0.0`', function test( t ) { var dot; var x; var y; diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.main.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.main.js index df7478567dd..ce6d2e83455 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.main.js +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.main.js @@ -149,7 +149,7 @@ tape( 'a module instance has a `main` method which supports a `y` stride', funct t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, a module instance has a `main` method which returns `0`', function test( t ) { +tape( 'if provided an `N` parameter less than or equal to `0`, a module instance has a `main` method which returns `0.0`', function test( t ) { var dot; var mem; var mod; diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.ndarray.js index 1063a3d03a6..22a14b21cfc 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.ndarray.js @@ -226,7 +226,7 @@ tape( 'a module instance has an `ndarray` method which supports a `y` offset', f t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, a module instance has an `ndarray` method which leaves the output array unchanged', function test( t ) { +tape( 'if provided an `N` parameter less than or equal to `0`, a module instance has an `ndarray` method which returns `0.0`', function test( t ) { var dot; var mem; var mod; diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.ndarray.js index 902c222f1e1..f8913432750 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.ndarray.js @@ -164,7 +164,7 @@ tape( 'the `ndarray` method supports a `y` offset', function test( t ) { t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, the `ndarray` method returns the output array unchanged', function test( t ) { +tape( 'if provided an `N` parameter less than or equal to `0`, the `ndarray` method returns `0.0`', function test( t ) { var dot; var x; var y; From 0d062518305cc5d9dd568e28fcc880323713f63a Mon Sep 17 00:00:00 2001 From: aman-095 Date: Fri, 18 Oct 2024 11:56:23 +0530 Subject: [PATCH 3/4] chore: resolve max-len warning --- .../@stdlib/blas/base/ddot-wasm/test/test.module.main.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.main.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.main.js index ce6d2e83455..27e5613ade1 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.main.js +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.main.js @@ -64,8 +64,8 @@ tape( 'a module instance has a `main` method which computes the dot product of ` xp = 0; yp = 64; - mod.write( xp, new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ) ); - mod.write( yp, new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ) ); + mod.write( xp, new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 2.0, -5.0, 6.0 ] ) ); // eslint-disable-line max-len + mod.write( yp, new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 8.0, 2.0, -3.0 ] ) ); // eslint-disable-line max-len dot = mod.main( 8, xp, 1, yp, 1 ); t.strictEqual( dot, -17.0, 'returns expected value' ); From 8c7e2aac0143e712a9e60b4d53af2e55a209bd7d Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Fri, 18 Oct 2024 14:19:37 +0200 Subject: [PATCH 4/4] chore: apply review changes --- .../@stdlib/blas/base/ddot-wasm/README.md | 8 ++--- .../@stdlib/blas/base/ddot-wasm/docs/repl.txt | 22 ++++++------ .../blas/base/ddot-wasm/docs/types/index.d.ts | 26 +++++++------- .../blas/base/ddot-wasm/docs/types/test.ts | 10 +++--- .../@stdlib/blas/base/ddot-wasm/lib/index.js | 4 +-- .../@stdlib/blas/base/ddot-wasm/lib/module.js | 8 ++--- .../blas/base/ddot-wasm/lib/routine.js | 8 ++--- .../ddot-wasm/test/test.module.ndarray.js | 34 +++++++++---------- .../blas/base/ddot-wasm/test/test.ndarray.js | 6 ++-- 9 files changed, 63 insertions(+), 63 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md b/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md index 69664202354..f13388eea67 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/README.md @@ -47,9 +47,9 @@ var z = ddot.main( x.length, x, 1, y, 1 ); The function has the following parameters: - **N**: number of indexed elements. -- **x**: input [`Float64Array`][@stdlib/array/float64]. +- **x**: first input [`Float64Array`][@stdlib/array/float64]. - **strideX**: index increment for `x`. -- **y**: input [`Float64Array`][@stdlib/array/float64]. +- **y**: second input [`Float64Array`][@stdlib/array/float64]. - **strideY**: index increment for `y`. The `N` and stride 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, @@ -190,9 +190,9 @@ 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). +- **xp**: first 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). +- **yp**: second 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 ) diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/repl.txt index f1ec2504bbf..df861a9da5d 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/repl.txt @@ -8,7 +8,7 @@ Indexing is relative to the first index. To introduce an offset, use typed array views. - If `N <= 0` both the functions return `0`. + If `N <= 0`, both the functions return `0`. Parameters ---------- @@ -16,13 +16,13 @@ Number of indexed elements. x: Float64Array - Input array. + First input array. strideX: integer Index increment for `x`. y: Float64Array - Output array. + Second input array. strideY: integer Index increment for `y`. @@ -69,7 +69,7 @@ Number of indexed elements. x: Float64Array - Input array. + First input array. strideX: integer Index increment for `x`. @@ -78,7 +78,7 @@ Starting index for `x`. y: Float64Array - Output array. + Second input array. strideY: integer Index increment for `y`. @@ -452,13 +452,13 @@ Number of indexed elements. xp: integer - Input array pointer (i.e., byte offset). + First input array pointer (i.e., byte offset). sx: integer Index increment for `x`. yp: integer - Output array pointer (i.e., byte offset). + Second input array pointer (i.e., byte offset). sy: integer Index increment for `y`. @@ -483,7 +483,7 @@ > mod.write( yptr, {{alias:@stdlib/array/ones}}( 5, 'float64' ) ); // Perform computation: - > var dot = mod.main( 5, xptr, 1, yptr, 1 ) + > var out = mod.main( 5, xptr, 1, yptr, 1 ) 15.0 @@ -497,7 +497,7 @@ Number of indexed elements. xp: integer - Input array pointer (i.e., byte offset). + First input array pointer (i.e., byte offset). sx: integer Index increment for `x`. @@ -506,7 +506,7 @@ Starting index for `x`. yp: integer - Output array pointer (i.e., byte offset). + Second input array pointer (i.e., byte offset). sy: integer Index increment for `y`. @@ -534,7 +534,7 @@ > mod.write( yptr, {{alias:@stdlib/array/ones}}( 5, 'float64' ) ); // Perform computation: - > var dot = mod.ndarray( 5, xptr, 1, 0, yptr, 1, 0 ) + > var out = mod.ndarray( 5, xptr, 1, 0, yptr, 1, 0 ) 15.0 diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/index.d.ts index 2fe3dc19b47..65dab9ebec2 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/index.d.ts @@ -127,9 +127,9 @@ interface Module extends ModuleWrapper { * Computes the dot product of `x` and `y`. * * @param N - number of indexed elements - * @param xptr - input array pointer (i.e., byte offset) + * @param xptr - first input array pointer (i.e., byte offset) * @param strideX - `x` stride length - * @param yptr - output array pointer (i.e., byte offset) + * @param yptr - second input array pointer (i.e., byte offset) * @param strideY - `y` stride length * @returns dot product * @@ -177,10 +177,10 @@ interface Module extends ModuleWrapper { * Computes the dot product of `x` and `y` using alternative indexing semantics. * * @param N - number of indexed elements - * @param xptr - input array pointer (i.e., byte offset) + * @param xptr - first input array pointer (i.e., byte offset) * @param strideX - `x` stride length * @param offsetX - starting index for `x` - * @param yptr - output array pointer (i.e., byte offset) + * @param yptr - second input array pointer (i.e., byte offset) * @param strideY - `y` stride length * @param offsetY - starting index for `y` * @returns dot product @@ -234,9 +234,9 @@ interface Routine extends ModuleWrapper { * Computes the dot product of `x` and `y`. * * @param N - number of indexed elements - * @param x - input array + * @param x - first input array * @param strideX - `x` stride length - * @param y - output array + * @param y - second input array * @param strideY - `y` stride length * @returns dot product * @@ -249,16 +249,16 @@ interface Routine extends ModuleWrapper { * var dot = ddot.main( x.length, x, 1, y, 1 ); * // returns 15.0 */ - main( N: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number ): Float64Array; + main( N: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number ): number; /** * Computes the dot product of `x` and `y` using alternative indexing semantics. * * @param N - number of indexed elements - * @param x - input array + * @param x - first input array * @param strideX - `x` stride length * @param offsetX - starting index for `x` - * @param y - output array + * @param y - second input array * @param strideY - `y` stride length * @param offsetY - starting index for `y` * @returns dot product @@ -272,7 +272,7 @@ interface Routine extends ModuleWrapper { * ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); * // returns 15.0 */ - ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, y: Float64Array, strideY: number, offsetY: number ): Float64Array; + ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, y: Float64Array, strideY: number, offsetY: number ): number; /** * Returns a new WebAssembly module wrapper instance which uses the provided WebAssembly memory instance as its underlying memory. @@ -325,11 +325,11 @@ interface Routine extends ModuleWrapper { * Computes the dot product of `x` and `y`. * * @param N - number of indexed elements -* @param x - input array +* @param x - first input array * @param strideX - `x` stride length -* @param y - output array +* @param y - second input array * @param strideY - `y` stride length -* @returns output array +* @returns dot product * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/test.ts index 5acbd8a3c4b..29889263520 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/docs/types/test.ts @@ -24,12 +24,12 @@ import ddot = require( './index' ); // TESTS // -// Attached to the main export is a `main` method which returns a Float64Array... +// Attached to the main export is a `main` method which returns a number... { const x = new Float64Array( 10 ); const y = new Float64Array( 10 ); - ddot.main( x.length, x, 1, y, 1 ); // $ExpectType Float64Array + ddot.main( x.length, x, 1, y, 1 ); // $ExpectType number } // The compiler throws an error if the `main` method is provided a first argument which is not a number... @@ -121,12 +121,12 @@ import ddot = require( './index' ); ddot.main( x.length, x, 1, y, 1, 10 ); // $ExpectError } -// Attached to main export is an `ndarray` method which returns a Float64Array... +// Attached to main export is an `ndarray` method which returns a number... { const x = new Float64Array( 10 ); const y = new Float64Array( 10 ); - ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectType Float64Array + ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectType number } // The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... @@ -493,7 +493,7 @@ import ddot = require( './index' ); mod.ndarray( 10, 0, 1, 0, 80, ( x: number ): number => x, 0 ); // $ExpectError } -// The compiler throws an error if the `ndarray` method of a module instance is provided an seventh argument which is not a number... +// The compiler throws an error if the `ndarray` method of a module instance is provided a seventh argument which is not a number... { const mem = new Memory({ 'initial': 1 diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/index.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/index.js index fa0da9f000e..61ca31aeaa0 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/index.js @@ -32,7 +32,7 @@ * var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); * * // Perform operation: -* var dot = ddot.main( x.length, 5.0, x, 1, y, 1 ); +* var dot = ddot.main( x.length, x, 1, y, 1 ); * // returns 15.0 * * @example @@ -44,7 +44,7 @@ * var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); * * // Perform operation: -* var dot = ddot.ndarray( x.length, 5.0, x, 1, 0, y, 1, 0 ); +* var dot = ddot.ndarray( x.length, x, 1, 0, y, 1, 0 ); * // returns 15.0 * * @example diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/module.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/module.js index bacc3f7d721..09c32bc4347 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/module.js +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/module.js @@ -106,9 +106,9 @@ inherits( Module, WasmModule ); * @readonly * @type {Function} * @param {PositiveInteger} N - number of indexed elements -* @param {NonNegativeInteger} xptr - input array pointer (i.e., byte offset) +* @param {NonNegativeInteger} xptr - first input array pointer (i.e., byte offset) * @param {integer} strideX - `x` stride length -* @param {NonNegativeInteger} yptr - output array pointer (i.e., byte offset) +* @param {NonNegativeInteger} yptr - second input array pointer (i.e., byte offset) * @param {integer} strideY - `y` stride length * @returns {number} dot product * @@ -162,10 +162,10 @@ setReadOnly( Module.prototype, 'main', function ddot( N, xptr, strideX, yptr, st * @readonly * @type {Function} * @param {PositiveInteger} N - number of indexed elements -* @param {NonNegativeInteger} xptr - input array pointer (i.e., byte offset) +* @param {NonNegativeInteger} xptr - first input array pointer (i.e., byte offset) * @param {integer} strideX - `x` stride length * @param {NonNegativeInteger} offsetX - starting `x` index -* @param {NonNegativeInteger} yptr - output array pointer (i.e., byte offset) +* @param {NonNegativeInteger} yptr - second input array pointer (i.e., byte offset) * @param {integer} strideY - `y` stride length * @param {NonNegativeInteger} offsetY - starting `y` index * @returns {number} dot product diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/routine.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/routine.js index ec9c29e8e51..73fc999c7e2 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/routine.js +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/lib/routine.js @@ -95,9 +95,9 @@ inherits( Routine, Module ); * @readonly * @type {Function} * @param {PositiveInteger} N - number of indexed elements -* @param {Float64Array} x - input array +* @param {Float64Array} x - first input array * @param {integer} strideX - `x` stride length -* @param {Float64Array} y - output array +* @param {Float64Array} y - second input array * @param {integer} strideY - `y` stride length * @returns {number} dot product * @@ -130,10 +130,10 @@ setReadOnly( Routine.prototype, 'main', function ddot( N, x, strideX, y, strideY * @readonly * @type {Function} * @param {PositiveInteger} N - number of indexed elements -* @param {Float64Array} x - input array +* @param {Float64Array} x - first input array * @param {integer} strideX - `x` stride length * @param {NonNegativeInteger} offsetX - starting `x` index -* @param {Float64Array} y - output array +* @param {Float64Array} y - second input array * @param {integer} strideY - `y` stride length * @param {NonNegativeInteger} offsetY - starting `y` index * @returns {number} dot product diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.ndarray.js index 22a14b21cfc..54ae75b8c0d 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.module.ndarray.js @@ -128,23 +128,23 @@ tape( 'a module instance has an `ndarray` method which supports an `x` offset', yp = 40; mod.write( xp, new Float64Array([ - 2.0, // 0 - -3.0, // 1 - -5.0, // 2 - 7.0, + 2.0, + -3.0, // 0 + -5.0, // 1 + 7.0, // 2 6.0 ])); mod.write( yp, new Float64Array([ 8.0, // 0 - 2.0, - -3.0, // 1 + 2.0, // 1 + -3.0, // 2 3.0, - -4.0, // 2 + -4.0, 1.0 ])); - dot = mod.ndarray( 3, xp, 1, 0, yp, 2, 0 ); - t.strictEqual( dot, 45.0, 'returns expected value' ); + dot = mod.ndarray( 3, xp, 1, 1, yp, 1, 0 ); + t.strictEqual( dot, -55.0, 'returns expected value' ); t.end(); }); @@ -205,10 +205,10 @@ tape( 'a module instance has an `ndarray` method which supports a `y` offset', f mod.write( xp, new Float64Array([ 1.0, // 0 - 2.0, - 3.0, // 1 + 2.0, // 1 + 3.0, // 2 4.0, - 5.0, // 2 + 5.0, 6.0 ])); mod.write( yp, new Float64Array([ @@ -220,8 +220,8 @@ tape( 'a module instance has an `ndarray` method which supports a `y` offset', f 11.0 // 2 ])); - dot = mod.ndarray( 3, xp, 2, 0, yp, 1, 3 ); - t.strictEqual( dot, 94.0, 'returns expected value' ); + dot = mod.ndarray( 3, xp, 1, 0, yp, 1, 3 ); + t.strictEqual( dot, 62.0, 'returns expected value' ); t.end(); }); @@ -316,9 +316,9 @@ tape( 'a module instance has an `ndarray` method which supports complex access p ])); mod.write( yp, new Float64Array([ 6.0, - 7.0, // 2 - 8.0, // 1 - 9.0, // 0 + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 10.0 ])); diff --git a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.ndarray.js index f8913432750..6c455fd80c4 100644 --- a/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/ddot-wasm/test/test.ndarray.js @@ -219,9 +219,9 @@ tape( 'the `ndarray` method supports complex access patterns', function test( t ]); y = new Float64Array([ 6.0, - 7.0, // 2 - 8.0, // 1 - 9.0, // 0 + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 10.0 ]);