From b08c0644236eaf8d918019b98a817800fa2b14a4 Mon Sep 17 00:00:00 2001 From: aman-095 Date: Fri, 4 Oct 2024 16:02:07 +0530 Subject: [PATCH] feat: add wasm support for dscal --- .../@stdlib/blas/base/dscal-wasm/README.md | 319 +++++++++++ .../base/dscal-wasm/benchmark/benchmark.js | 106 ++++ .../dscal-wasm/benchmark/benchmark.module.js | 66 +++ .../benchmark/benchmark.module.main.js | 135 +++++ .../benchmark/benchmark.module.ndarray.js | 135 +++++ .../dscal-wasm/benchmark/benchmark.ndarray.js | 106 ++++ .../blas/base/dscal-wasm/docs/repl.txt | 520 ++++++++++++++++++ .../base/dscal-wasm/docs/types/index.d.ts | 378 +++++++++++++ .../blas/base/dscal-wasm/docs/types/test.ts | 413 ++++++++++++++ .../blas/base/dscal-wasm/examples/index.js | 44 ++ .../examples/little_endian_arrays.js | 65 +++ .../blas/base/dscal-wasm/examples/module.js | 68 +++ .../base/dscal-wasm/lib/binary.browser.js | 33 ++ .../blas/base/dscal-wasm/lib/binary.js | 34 ++ .../@stdlib/blas/base/dscal-wasm/lib/index.js | 108 ++++ .../@stdlib/blas/base/dscal-wasm/lib/main.js | 60 ++ .../blas/base/dscal-wasm/lib/module.js | 235 ++++++++ .../blas/base/dscal-wasm/lib/routine.js | 175 ++++++ .../blas/base/dscal-wasm/manifest.json | 36 ++ .../@stdlib/blas/base/dscal-wasm/package.json | 80 +++ .../blas/base/dscal-wasm/scripts/build.js | 63 +++ .../blas/base/dscal-wasm/scripts/template.txt | 33 ++ .../@stdlib/blas/base/dscal-wasm/src/Makefile | 232 ++++++++ .../blas/base/dscal-wasm/src/main.wasm | Bin 0 -> 754 bytes .../@stdlib/blas/base/dscal-wasm/src/main.wat | 350 ++++++++++++ .../@stdlib/blas/base/dscal-wasm/test/test.js | 53 ++ .../blas/base/dscal-wasm/test/test.main.js | 186 +++++++ .../blas/base/dscal-wasm/test/test.module.js | 154 ++++++ .../base/dscal-wasm/test/test.module.main.js | 253 +++++++++ .../dscal-wasm/test/test.module.ndarray.js | 289 ++++++++++ .../blas/base/dscal-wasm/test/test.ndarray.js | 183 ++++++ .../blas/base/dscal-wasm/test/test.routine.js | 71 +++ 32 files changed, 4983 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/README.md create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.module.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.module.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.module.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/examples/little_endian_arrays.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/examples/module.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/binary.browser.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/binary.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/module.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/routine.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/manifest.json create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/package.json create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/scripts/build.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/scripts/template.txt create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/src/Makefile create mode 100755 lib/node_modules/@stdlib/blas/base/dscal-wasm/src/main.wasm create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/src/main.wat create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.module.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.module.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.module.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.routine.js diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/README.md b/lib/node_modules/@stdlib/blas/base/dscal-wasm/README.md new file mode 100644 index 00000000000..dae7783d95a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/README.md @@ -0,0 +1,319 @@ + + +# dscal + +> Multiply a vector `x` by a constant `alpha`. + +
+ +## Usage + +```javascript +var dscal = require( '@stdlib/blas/base/dscal-wasm' ); +``` + +#### dscal.main( N, alpha, x, strideX ) + +Multiplies a vector `x` by a constant `alpha`. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + +dscal.main( x.length, 5.0, x, 1 ); +// x => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **alpha**: scalar constant. +- **x**: input [`Float64Array`][@stdlib/array/float64]. +- **strideX**: index increment for `x`. + +The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to multiply every other value in `x` by `alpha` 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 ] ); + +dscal.main( 5, 5.0, x, -1 ); +// x => [ 5.0, 10.0, 15.0, 20.0, 25.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 ] ); + +// Create offset view... +var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +dscal.main( 3, 5.0, x1, -2 ); +// x0 => [ 1.0, 10.0, 3.0, 20.0, 5.0, 30.0 ] +``` + +#### dscal.ndarray( N, alpha, x, strideX, offsetX ) + +Multiplies a vector `x` by a constant `alpha` using alternative indexing semantics. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + +dscal.ndarray( x.length, 5.0, x, 1, 0 ); +// x => [ 5.0, 10.0, 15.0, 20.0, 25.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 multiply every other value in `x` by a constant `alpha` starting from the second element, + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + +dscal.ndarray( 3, 5.0, x, 2, 1 ); +// x => [ 1.0, 10.0, 3.0, 20.0, 5.0, 30.0 ] +``` + +* * * + +### Module + +#### dscal.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 dscal.Module( mem ); +// returns + +// Initialize the routine: +mod.initializeSync(); +``` + +#### dscal.Module.prototype.main( N, α, xp, sx ) + +Multiplies a vector `x` by a constant `α`. + + + +```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 dscal.Module( mem ); +// returns + +// Initialize the routine: +mod.initializeSync(); + +// Define a vector data type: +var dtype = 'float64'; + +// Specify a vector length: +var N = 5; + +// Define pointer (i.e., byte offsets) for storing input vector: +var xptr = 0; + +// Write vector values to module memory: +mod.write( xptr, oneTo( N, dtype ) ); + +// Perform computation: +mod.main( N, 5.0, xptr, 1 ); + +// Read out the results: +var view = zeros( N, dtype ); +mod.read( xptr, view ); + +console.log( view ); +// => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **α**: scalar constant. +- **xp**: input [`Float64Array`][@stdlib/array/float64] pointer (i.e., byte offset). +- **sx**: index increment for `x`. + +#### dscal.Module.prototype.ndarray( N, α, xp, sx, ox ) + +Multiplies a vector `x` by a constant `α` 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 dscal.Module( mem ); +// returns + +// Initialize the routine: +mod.initializeSync(); + +// Define a vector data type: +var dtype = 'float64'; + +// Specify a vector length: +var N = 5; + +// Define pointer (i.e., byte offsets) for storing input vector: +var xptr = 0; + +// Write vector values to module memory: +mod.write( xptr, oneTo( N, dtype ) ); + +// Perform computation: +mod.ndarray( N, 5.0, xptr, 1, 0 ); + +// Read out the results: +var view = zeros( N, dtype ); +mod.read( xptr, view ); + +console.log( view ); +// => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +``` + +The function has the following additional parameters: + +- **ox**: starting index for `x`. +- **oy**: starting index for `y`. + +
+ + + +
+ +* * * + +## Notes + +- If `N <= 0`, `x` is left unchanged. +- This package implements routines using WebAssembly. When provided arrays which are not allocated on a `dscal` 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/dscal`][@stdlib/blas/base/dscal]. 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/dscal`][@stdlib/blas/base/dscal]. 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. +- `dscal()` corresponds to the [BLAS][blas] level 1 function [`dscal`][dscal]. + +
+ + + +
+ +* * * + +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var dscal = require( '@stdlib/blas/base/dscal-wasm' ); + +var opts = { + 'dtype': 'float64' +}; +var x = discreteUniform( 10, 0, 100, opts ); +console.log( x ); + +dscal.ndarray( x.length, 5.0, x, 1, 0 ); +console.log( x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[blas]: http://www.netlib.org/blas + +[dscal]: https://www.netlib.org/lapack/explore-html-3.6.1/de/da4/group__double__blas__level1_ga793bdd0739bbd0e0ec8655a0df08981a.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/dscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dscal + +
+ + diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.js new file mode 100644 index 00000000000..936a8033c3f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.js @@ -0,0 +1,106 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var 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 dscal = 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 ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = dscal.main( x.length, 1.01, x, 1 ); + if ( isnan( y[ i%x.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y[ i%x.length ] ) ) { + 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/dscal-wasm/benchmark/benchmark.module.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.module.js new file mode 100644 index 00000000000..71cae7896a5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-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 dscal = 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 dscal.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/dscal-wasm/benchmark/benchmark.module.main.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.module.main.js new file mode 100644 index 00000000000..da9c5755614 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.module.main.js @@ -0,0 +1,135 @@ +/** +* @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 dscal = 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 byteOffset; + var view; + var xptr; + var mod; + var mem; + var nb; + var i; + + // Create a new BLAS routine interface: + mem = new Memory({ + 'initial': 0 + }); + mod = new dscal.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*nb ); + + // Define pointer (i.e., byte offsets) to the vector elements: + xptr = 0; + + // Write random values to module memory: + mod.write( xptr, uniform( len, -100.0, 100.0, options ) ); + + // Retrieve a DataView of module memory: + view = mod.view; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + mod.main( len, 5.0, xptr, 1 ); + byteOffset = xptr + ( (i%len)*nb ); + if ( isnan( view.getFloat64( byteOffset, true ) ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( view.getFloat64( byteOffset, true ) ) ) { + 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/dscal-wasm/benchmark/benchmark.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.module.ndarray.js new file mode 100644 index 00000000000..ec1dfd190af --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.module.ndarray.js @@ -0,0 +1,135 @@ +/** +* @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 dscal = 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 byteOffset; + var view; + var xptr; + var mod; + var mem; + var nb; + var i; + + // Create a new BLAS routine interface: + mem = new Memory({ + 'initial': 0 + }); + mod = new dscal.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*nb ); + + // Define pointers (i.e., byte offsets) to the first vector elements: + xptr = 0; + + // Write random values to module memory: + mod.write( xptr, uniform( len, -100.0, 100.0, options ) ); + + // Retrieve a DataView of module memory: + view = mod.view; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + mod.ndarray( len, 5.0, xptr, 1, 0 ); + byteOffset = xptr + ( (i%len)*nb ); + if ( isnan( view.getFloat64( byteOffset, true ) ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( view.getFloat64( byteOffset, true ) ) ) { + 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/dscal-wasm/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.ndarray.js new file mode 100644 index 00000000000..37ec7b271c9 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/benchmark/benchmark.ndarray.js @@ -0,0 +1,106 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var 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 dscal = 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 ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = dscal.ndarray( x.length, 5.0, x, 1, 0 ); + if ( isnan( y[ i%x.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y[ i%x.length ] ) ) { + 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/dscal-wasm/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/dscal-wasm/docs/repl.txt new file mode 100644 index 00000000000..16646f8b606 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/docs/repl.txt @@ -0,0 +1,520 @@ + +{{alias}}.main( N, alpha, x, strideX ) + Multiplies a vector `x` by a constant `alpha`. + + 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 `x` unchanged. + + Parameters + ---------- + N: integer + Number of indexed elements. + + alpha: number + Constant. + + x: Float64Array + Input array. + + strideX: integer + Index increment for `x`. + + Returns + ------- + x: Float64Array + Input array. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 3.0, -5.0 ] ); + > {{alias}}.main( x.length, 5.0, x, 1 ) + [ -10.0, 5.0, 15.0, -25.0 ] + + // Using `N` and stride parameters: + > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 3.0, -5.0 ] ); + > {{alias}}.main( 2, 5.0, x, 2 ) + [ -10.0, 1.0, 15.0, -5.0 ] + + // Using view offsets: + > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0 ] ); + > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > {{alias}}.main( 2, 5.0, x1, 2 ) + [ -10.0, 3.0, -20.0 ] + > x0 + [ 1.0, -10.0, 3.0, -20.0 ] + + +{{alias}}.ndarray( N, alpha, x, strideX, offsetX ) + Multiplies a vector `x` by a constant `alpha` 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. + + alpha: number + Constant. + + x: Float64Array + Input array. + + strideX: integer + Index increment for `x`. + + offsetX: integer + Starting index for `x`. + + Returns + ------- + x: Float64Array + Input array. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 3.0, -5.0 ] ); + > {{alias}}.ndarray( x.length, 5.0, x, 1, 0 ) + [ -10.0, 5.0, 15.0, -25.0 ] + + // Using an index offset: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0 ] ); + > {{alias}}.ndarray( 2, 5.0, x, 2, 1 ) + [ 1.0, -10.0, 3.0, -20.0, 5.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 ) + Multiples a vector `x` by a constant `α`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + α: number + Constant. + + xp: integer + Input array pointer (i.e., byte offset). + + sx: integer + Index increment for `x`. + + Returns + ------- + xp: integer + Input array pointer (i.e., byte offset). + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 1 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + + // Define "pointer" (i.e., byte offsets) into module memory: + > var xptr = 0; + + // Write data to module memory: + > mod.write( xptr, {{alias:@stdlib/array/one-to}}( 5, 'float64' ) ); + + // Perform computation: + > mod.main( 5, 5.0, xptr, 1 ); + + // Extract results from module memory: + > var view = {{alias:@stdlib/array/zeros}}( 5, 'float64' ); + > mod.read( xptr, view ); + > view + [ 5.0, 10.0, 15.0, 20.0, 25.0 ] + + +{{alias}}.Module.prototype.ndarray( N, α, xp, sx, ox ) + Multiples a vector `x` by a constant `α` using alternative indexing + semantics. + + Parameters + ---------- + N: integer + Number of indexed elements. + + α: number + Constant. + + xp: integer + Input array pointer (i.e., byte offset). + + sx: integer + Index increment for `x`. + + ox: integer + Starting index for `x`. + + Returns + ------- + ox: integer + Input array pointer (i.e., byte offset). + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 1 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + + // Define "pointer" (i.e., byte offsets) into module memory: + > var xptr = 0; + + // Write data to module memory: + > mod.write( xptr, {{alias:@stdlib/array/one-to}}( 5, 'float64' ) ); + + // Perform computation: + > mod.ndarray( 5, 5.0, xptr, 1, 0 ); + + // Extract results from module memory: + > var view = {{alias:@stdlib/array/zeros}}( 5, 'float64' ); + > mod.read( xptr, view ); + > view + [ 5.0, 10.0, 15.0, 20.0, 25.0 ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/dscal-wasm/docs/types/index.d.ts new file mode 100644 index 00000000000..cd19b005710 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/docs/types/index.d.ts @@ -0,0 +1,378 @@ +/* +* @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 mod = new dscal.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float64'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointer (i.e., byte offsets) for storing input vector: + * var xptr = 0; + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.main( N, 5.0, xptr, 1 ); + * // returns + * + * var bool = ( ptr === xptr ); + * // returns true + * + * // Read out the results: + * var view = zeros( N, dtype ); + * mod.read( xptr, view ); + * // view => [ 5.0, 10.0, 15.0, 20.0, 25.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 mod = dscal.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float64'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointer (i.e., byte offsets) for storing input vectors: + * var xptr = 0; + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.main( N, 5.0, xptr, 1 ); + * // returns + * + * var bool = ( ptr === xptr ); + * // returns true + * + * // Read out the results: + * var view = zeros( N, dtype ); + * mod.read( xptr, view ); + * // view => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] + */ + ( mem: Memory ): Module; // callable +} + +/** +* Interface describing a `dscal` WebAssembly module. +*/ +interface Module extends ModuleWrapper { + /** + * Multiplies a vector `x` by a constant `alpha`. + * + * @param N - number of indexed elements + * @param alpha - constant + * @param xptr - input array pointer (i.e., byte offset) + * @param strideX - `x` stride length + * @returns input array pointer (i.e., byte offset) + * + * @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 mod = new dscal.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float64'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointer (i.e., byte offsets) for storing input vector: + * var xptr = 0; + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.main( N, 5.0, xptr, 1 ); + * // returns + * + * var bool = ( ptr === xptr ); + * // returns true + * + * // Read out the results: + * var view = zeros( N, dtype ); + * mod.read( xptr, view ); + * // view => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] + */ + main( N: number, alpha: number, xptr: number, strideX: number ): number; + + /** + * Multiplies a vector `x` by a constant `alpha` using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param alpha - constant + * @param xptr - input array pointer (i.e., byte offset) + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @returns input array pointer (i.e., byte offset) + * + * @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 mod = new dscal.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float64'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointer (i.e., byte offsets) for storing input vector: + * var xptr = 0; + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.ndarray( N, 5.0, xptr, 1, 0 ); + * // returns + * + * var bool = ( ptr === xptr ); + * // returns true + * + * // Read out the results: + * var view = zeros( N, dtype ); + * mod.read( xptr, view ); + * // view => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] + */ + ndarray( N: number, alpha: number, xptr: number, strideX: number, offsetX: number ): number; +} + +/** +* Interface describing `dscal`. +*/ +interface Routine extends ModuleWrapper { + /** + * Multiplies a vector `x` by a constant `alpha`. + * + * @param N - number of indexed elements + * @param alpha - constant + * @param x - input array + * @param strideX - `x` stride length + * @param y - output array + * @param strideY - `y` stride length + * @returns input array + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * + * dscal.main( x.length, 5.0, x, 1 ); + * // x => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] + */ + main( N: number, alpha: number, x: Float64Array, strideX: number ): Float64Array; + + /** + * Multiplies a vector `x` by a constant `alpha` using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param alpha - constant + * @param x - input array + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @returns input array + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * + * dscal.ndarray( x.length, 5.0, x, 1, 0 ); + * // x => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] + */ + ndarray( N: number, alpha: number, x: Float64Array, strideX: number, offsetX: 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 mod = new dscal.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; + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.main( N, 5.0, xptr, 1 ); + * // returns + * + * var bool = ( ptr === xptr ); + * // returns true + * + * // Read out the results: + * var view = zeros( N, dtype ); + * mod.read( xptr, view ); + * // view => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] + */ + Module: ModuleConstructor; +} + +/** +* Multiplies a vector `x` by a constant `alpha`. +* +* @param N - number of indexed elements +* @param alpha - constant +* @param x - input array +* @param strideX - `x` stride length +* @returns input array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* +* dscal.main( x.length, 5.0, x, 1 ); +* // x => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* +* dscal.ndarray( x.length, 5.0, x, 1, 0 ); +* // x => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +*/ +declare var dscal: Routine; + + +// EXPORTS // + +export = dscal; diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/dscal-wasm/docs/types/test.ts new file mode 100644 index 00000000000..c6b95d6060c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/docs/types/test.ts @@ -0,0 +1,413 @@ +/* +* @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 dscal = require( './index' ); + + +// TESTS // + +// Attached to the main export is a `main` method which returns a Float64Array... +{ + const x = new Float64Array( 10 ); + + dscal.main( x.length, 5.0, x, 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 ); + + dscal.main( '10', 5.0, x, 1 ); // $ExpectError + dscal.main( true, 5.0, x, 1 ); // $ExpectError + dscal.main( false, 5.0, x, 1 ); // $ExpectError + dscal.main( null, 5.0, x, 1 ); // $ExpectError + dscal.main( undefined, 5.0, x, 1 ); // $ExpectError + dscal.main( [], 5.0, x, 1 ); // $ExpectError + dscal.main( {}, 5.0, x, 1 ); // $ExpectError + dscal.main( ( x: number ): number => x, 5.0, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a second argument which is not a number... +{ + const x = new Float64Array( 10 ); + + dscal.main( x.length, '10', x, 1 ); // $ExpectError + dscal.main( x.length, true, x, 1 ); // $ExpectError + dscal.main( x.length, false, x, 1 ); // $ExpectError + dscal.main( x.length, null, x, 1 ); // $ExpectError + dscal.main( x.length, undefined, x, 1 ); // $ExpectError + dscal.main( x.length, [], x, 1 ); // $ExpectError + dscal.main( x.length, {}, x, 1 ); // $ExpectError + dscal.main( x.length, ( x: number ): number => x, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a third argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + dscal.main( x.length, 5.0, 10, 1 ); // $ExpectError + dscal.main( x.length, 5.0, '10', 1 ); // $ExpectError + dscal.main( x.length, 5.0, true, 1 ); // $ExpectError + dscal.main( x.length, 5.0, false, 1 ); // $ExpectError + dscal.main( x.length, 5.0, null, 1 ); // $ExpectError + dscal.main( x.length, 5.0, undefined, 1 ); // $ExpectError + dscal.main( x.length, 5.0, [], 1 ); // $ExpectError + dscal.main( x.length, 5.0, {}, 1 ); // $ExpectError + dscal.main( x.length, 5.0, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a fourth argument which is not a number... +{ + const x = new Float64Array( 10 ); + + dscal.main( x.length, 5.0, x, '10' ); // $ExpectError + dscal.main( x.length, 5.0, x, true ); // $ExpectError + dscal.main( x.length, 5.0, x, false ); // $ExpectError + dscal.main( x.length, 5.0, x, null ); // $ExpectError + dscal.main( x.length, 5.0, x, undefined ); // $ExpectError + dscal.main( x.length, 5.0, x, [] ); // $ExpectError + dscal.main( x.length, 5.0, x, {} ); // $ExpectError + dscal.main( x.length, 5.0, x, ( 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 ); + + dscal.main(); // $ExpectError + dscal.main( x.length ); // $ExpectError + dscal.main( x.length, 5.0 ); // $ExpectError + dscal.main( x.length, 5.0, x ); // $ExpectError + dscal.main( x.length, 5.0, x, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Float64Array... +{ + const x = new Float64Array( 10 ); + + dscal.ndarray( x.length, 5.0, x, 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 ); + + dscal.ndarray( '10', 5.0, x, 1, 0 ); // $ExpectError + dscal.ndarray( true, 5.0, x, 1, 0 ); // $ExpectError + dscal.ndarray( false, 5.0, x, 1, 0 ); // $ExpectError + dscal.ndarray( null, 5.0, x, 1, 0 ); // $ExpectError + dscal.ndarray( undefined, 5.0, x, 1, 0 ); // $ExpectError + dscal.ndarray( [], 5.0, x, 1, 0 ); // $ExpectError + dscal.ndarray( {}, 5.0, x, 1, 0 ); // $ExpectError + dscal.ndarray( ( x: number ): number => x, 5.0, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a number... +{ + const x = new Float64Array( 10 ); + + dscal.ndarray( x.length, '10', x, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, true, x, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, false, x, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, null, x, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, undefined, x, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, [], x, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, {}, x, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, ( x: number ): number => x, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + dscal.ndarray( x.length, 5.0, 10, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, '10', 1, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, true, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, false, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, null, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, undefined, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, [], 1, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, {}, 1, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, ( x: number ): number => x, 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 ); + + dscal.ndarray( x.length, 5.0, x, '10', 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, true, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, false, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, null, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, undefined, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, [], 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, {}, 0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a number... +{ + const x = new Float64Array( 10 ); + + dscal.ndarray( x.length, 5.0, x, 1, '10' ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, 1, true ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, 1, false ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, 1, null ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, 1, undefined ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, 1, [] ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, 1, {} ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, 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 ); + + dscal.ndarray(); // $ExpectError + dscal.ndarray( x.length ); // $ExpectError + dscal.ndarray( x.length, 5.0 ); // $ExpectError + dscal.ndarray( x.length, 5.0, x ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, 1 ); // $ExpectError + dscal.ndarray( x.length, 5.0, x, 1, 0, 10 ); // $ExpectError +} + +// Attached to the main export is a `Module` constructor which returns a module... +{ + const mem = new Memory({ + 'initial': 0 + }); + + dscal.Module( mem ); // $ExpectType Module +} + +// The compiler throws an error if the `Module` constructor is not provided a WebAssembly memory instance... +{ + dscal.Module( '10' ); // $ExpectError + dscal.Module( true ); // $ExpectError + dscal.Module( false ); // $ExpectError + dscal.Module( null ); // $ExpectError + dscal.Module( undefined ); // $ExpectError + dscal.Module( [] ); // $ExpectError + dscal.Module( {} ); // $ExpectError + dscal.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 = dscal.Module( mem ); + + mod.main( 10, 5.0, 0, 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 = dscal.Module( mem ); + + mod.main( '10', 5.0, 10, 1 ); // $ExpectError + mod.main( true, 5.0, 10, 1 ); // $ExpectError + mod.main( false, 5.0, 10, 1 ); // $ExpectError + mod.main( null, 5.0, 10, 1 ); // $ExpectError + mod.main( undefined, 5.0, 10, 1 ); // $ExpectError + mod.main( [], 5.0, 10, 1 ); // $ExpectError + mod.main( {}, 5.0, 10, 1 ); // $ExpectError + mod.main( ( x: number ): number => x, 5.0, 10, 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 = dscal.Module( mem ); + + mod.main( 10, '10', 0, 1 ); // $ExpectError + mod.main( 10, true, 0, 1 ); // $ExpectError + mod.main( 10, false, 0, 1 ); // $ExpectError + mod.main( 10, null, 0, 1 ); // $ExpectError + mod.main( 10, undefined, 0, 1 ); // $ExpectError + mod.main( 10, [], 0, 1 ); // $ExpectError + mod.main( 10, {}, 0, 1 ); // $ExpectError + mod.main( 10, ( x: number ): number => x, 0, 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 = dscal.Module( mem ); + + mod.main( 10, 5.0, '10', 1 ); // $ExpectError + mod.main( 10, 5.0, true, 1 ); // $ExpectError + mod.main( 10, 5.0, false, 1 ); // $ExpectError + mod.main( 10, 5.0, null, 1 ); // $ExpectError + mod.main( 10, 5.0, undefined, 1 ); // $ExpectError + mod.main( 10, 5.0, [], 1 ); // $ExpectError + mod.main( 10, 5.0, {}, 1 ); // $ExpectError + mod.main( 10, 5.0, ( x: number ): number => x, 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 = dscal.Module( mem ); + + mod.main( 10, 5.0, 0, '10' ); // $ExpectError + mod.main( 10, 5.0, 0, true ); // $ExpectError + mod.main( 10, 5.0, 0, false ); // $ExpectError + mod.main( 10, 5.0, 0, null ); // $ExpectError + mod.main( 10, 5.0, 0, undefined ); // $ExpectError + mod.main( 10, 5.0, 0, [] ); // $ExpectError + mod.main( 10, 5.0, 0, {} ); // $ExpectError + mod.main( 10, 5.0, 0, ( 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 = dscal.Module( mem ); + + mod.main(); // $ExpectError + mod.main( 10 ); // $ExpectError + mod.main( 10, 5.0 ); // $ExpectError + mod.main( 10, 5.0, 0 ); // $ExpectError + mod.main( 10, 5.0, 0, 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 = dscal.Module( mem ); + + mod.ndarray( 10, 5.0, 0, 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 = dscal.Module( mem ); + + mod.ndarray( '10', 5.0, 0, 1, 0 ); // $ExpectError + mod.ndarray( true, 5.0, 0, 1, 0 ); // $ExpectError + mod.ndarray( false, 5.0, 0, 1, 0 ); // $ExpectError + mod.ndarray( null, 5.0, 0, 1, 0 ); // $ExpectError + mod.ndarray( undefined, 5.0, 0, 1, 0 ); // $ExpectError + mod.ndarray( [], 5.0, 0, 1, 0 ); // $ExpectError + mod.ndarray( {}, 5.0, 0, 1, 0 ); // $ExpectError + mod.ndarray( ( x: number ): number => x, 5.0, 0, 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 = dscal.Module( mem ); + + mod.ndarray( 10, '10', 0, 1, 0 ); // $ExpectError + mod.ndarray( 10, true, 0, 1, 0 ); // $ExpectError + mod.ndarray( 10, false, 0, 1, 0 ); // $ExpectError + mod.ndarray( 10, null, 0, 1, 0 ); // $ExpectError + mod.ndarray( 10, undefined, 0, 1, 0 ); // $ExpectError + mod.ndarray( 10, [], 0, 1, 0 ); // $ExpectError + mod.ndarray( 10, {}, 0, 1, 0 ); // $ExpectError + mod.ndarray( 10, ( x: number ): number => x, 0, 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 = dscal.Module( mem ); + + mod.ndarray( 10, 5.0, '10', 1, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, true, 1, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, false, 1, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, null, 1, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, undefined, 1, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, [], 1, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, {}, 1, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, ( x: number ): number => x, 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 = dscal.Module( mem ); + + mod.ndarray( 10, 5.0, 0, '10', 0 ); // $ExpectError + mod.ndarray( 10, 5.0, 0, true, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, 0, false, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, 0, null, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, 0, undefined, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, 0, [], 0 ); // $ExpectError + mod.ndarray( 10, 5.0, 0, {}, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, 0, ( x: number ): number => x, 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 = dscal.Module( mem ); + + mod.ndarray( 10, 5.0, 0, 1, '10' ); // $ExpectError + mod.ndarray( 10, 5.0, 0, 1, true ); // $ExpectError + mod.ndarray( 10, 5.0, 0, 1, false ); // $ExpectError + mod.ndarray( 10, 5.0, 0, 1, null ); // $ExpectError + mod.ndarray( 10, 5.0, 0, 1, undefined ); // $ExpectError + mod.ndarray( 10, 5.0, 0, 1, [] ); // $ExpectError + mod.ndarray( 10, 5.0, 0, 1, {} ); // $ExpectError + mod.ndarray( 10, 5.0, 0, 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 = dscal.Module( mem ); + + mod.ndarray(); // $ExpectError + mod.ndarray( 10 ); // $ExpectError + mod.ndarray( 10, 5.0 ); // $ExpectError + mod.ndarray( 10, 5.0, 0 ); // $ExpectError + mod.ndarray( 10, 5.0, 0, 1 ); // $ExpectError + mod.ndarray( 10, 5.0, 0, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/examples/index.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/examples/index.js new file mode 100644 index 00000000000..9a71316de58 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/examples/index.js @@ -0,0 +1,44 @@ +/** +* @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 dscal = require( './../lib' ); + +function main() { + if ( !hasWebAssemblySupport() ) { + console.error( 'Environment does not support WebAssembly.' ); + return; + } + // Specify a vector length: + var N = 5; + + // Create input array: + var x = oneTo( N, 'float64' ); + + // Perform computation: + dscal.ndarray( N, 5.0, x, 1, 0 ); + + // Print the results: + console.log( x ); + // => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/examples/little_endian_arrays.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/examples/little_endian_arrays.js new file mode 100644 index 00000000000..ed522f89ea4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/examples/little_endian_arrays.js @@ -0,0 +1,65 @@ +/** +* @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 gfillBy = require( '@stdlib/blas/ext/base/gfill-by' ); +var Float64ArrayLE = require( '@stdlib/array/little-endian-float64' ); +var dscal = 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 dscal.Module( mem ); + // returns + + // Initialize the routine: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Specify a vector length: + var N = 5; + + // Define pointer (i.e., byte offsets) for storing input vector: + var xptr = 0; + + // Create a typed array view over module memory: + var x = new Float64ArrayLE( mod.memory.buffer, xptr, N ); + + // Write values to module memory: + gfillBy( N, x, 1, discreteUniform( -10.0, 10.0 ) ); + + // Perform computation: + mod.ndarray( N, 5.0, xptr, 1, 0 ); + + // Print the result: + console.log( 'x[:] = [%s]', x.toString() ); +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/examples/module.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/examples/module.js new file mode 100644 index 00000000000..abc9ae3f2fd --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/examples/module.js @@ -0,0 +1,68 @@ +/** +* @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 zeros = require( '@stdlib/array/zeros' ); +var dscal = 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 dscal.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 pointer (i.e., byte offsets) for storing input vector: + var xptr = 0; + + // Write vector values to module memory: + mod.write( xptr, oneTo( N, dtype ) ); + + // Perform computation: + mod.ndarray( N, 5.0, xptr, 1, 0 ); + + // Read out the results: + var view = zeros( N, dtype ); + mod.read( xptr, view ); + + console.log( view ); + // => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/binary.browser.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/binary.browser.js new file mode 100644 index 00000000000..f9b99fd093f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-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( 'AGFzbQEAAAAADwhkeWxpbmsuMAEEAAAAAAETA2AAAGAEf3x/fwBgBX98f39/AAIPAQNlbnYGbWVtb3J5AgAAAwQDAAECB0wEEV9fd2FzbV9jYWxsX2N0b3JzAAAYX193YXNtX2FwcGx5X2RhdGFfcmVsb2NzAAAHY19kc2NhbAABD2NfZHNjYWxfbmRhcnJheQACCtwEAwMAAQsjAQF+IAAgASACIAMgA6wiBEIBIACsfX5CACAEQgBXG6cQAguxBAEHfwJAIABBAEwNACABRAAAAAAAAPA/YQ0AIANBAUcEQCAAQQFrQQNPBEAgAEH8////B3EhByADIANqIgggA2oiCiADaiELA0AgAiAEQQN0aiIGIAEgBisDAKI5AwAgAiADIARqQQN0aiIGIAEgBisDAKI5AwAgAiAEIAhqQQN0aiIGIAEgBisDAKI5AwAgAiAEIApqQQN0aiIGIAEgBisDAKI5AwAgBCALaiEEIAVBBGoiBSAHRw0ACwsgAEEDcSIARQ0BQQAhBQNAIAIgBEEDdGoiByABIAcrAwCiOQMAIAMgBGohBCAFQQFqIgUgAEcNAAsMAQsCQCAAQQVwIgMiBUUNACADQQFrQQNPBEAgAkEYaiEIIAJBEGohCiACQQhqIQsgBUEEcSEGA0AgAiAEQQN0IgNqIgkgASAJKwMAojkDACADIAtqIgkgASAJKwMAojkDACADIApqIgkgASAJKwMAojkDACADIAhqIgMgASADKwMAojkDACAEQQRqIQQgB0EEaiIHIAZHDQALCyAFQQNxIgdFDQBBACEDA0AgAiAEQQN0aiIIIAEgCCsDAKI5AwAgBEEBaiEEIANBAWoiAyAHRw0ACwsgAEEFSA0AA0AgAiAEQQN0aiIDIAEgAysDAKI5AwAgAyABIAMrAwiiOQMIIAMgASADKwMQojkDECADIAEgAysDGKI5AxggAyABIAMrAyCiOQMgIARBBWohBCAFQQVqIgUgAEgNAAsLCw==' ); + + +// EXPORTS // + +module.exports = wasm; diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/binary.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/binary.js new file mode 100644 index 00000000000..6f02393f96e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-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/dscal-wasm/lib/index.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/index.js new file mode 100644 index 00000000000..335a7b72f18 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-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 multiply a vector `x` by a constant `alpha`. +* +* @module @stdlib/blas/base/dscal-wasm +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var dscal = require( '@stdlib/blas/base/dscal-wasm' ); +* +* // Define a strided array: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* +* // Perform operation: +* dscal.main( x.length, 5.0, x, 1 ); +* // x => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var dscal = require( '@stdlib/blas/base/dscal-wasm' ); +* +* // Define z strided array: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* +* // Perform operation: +* dscal.ndarray( x.length, 5.0, x, 1, 0 ); +* // y => [ 5.0, 10.0, 15.0, 20.0, 25.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 dscal = require( '@stdlib/blas/base/dscal-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 dscal.Module( mem ); +* // returns +* +* // Initialize the routine: +* mod.initializeSync(); +* +* // Define a vector data type: +* var dtype = 'float64'; +* +* // Specify a vector length: +* var N = 5; +* +* // Define pointer (i.e., byte offsets) for storing input vectors: +* var xptr = 0; +* +* // Write vector values to module memory: +* mod.write( xptr, oneTo( N, dtype ) ); +* +* // Perform computation: +* mod.main( N, 5.0, xptr, 1 ); +* +* // Read out the results: +* var view = zeros( N, dtype ); +* mod.read( xptr, view ); +* +* console.log( view ); +* // => [ 5.0, 10.0, 15.0, 20.0, 25.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/dscal-wasm/lib/main.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/main.js new file mode 100644 index 00000000000..1cdd04840c3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/main.js @@ -0,0 +1,60 @@ +/** +* @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 multiply a vector `x` by a constant `alpha`. +* +* @name dscal +* @type {Routine} +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Define a strided array: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* +* // Perform operation: +* dscal.main( x.length, 5.0, x, 1 ); +* // x => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Define a strided array: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* +* // Perform operation: +* dscal.ndarray( x.length, 5.0, x, 1, 0 ); +* // x => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +*/ +var dscal = new Routine(); +dscal.initializeSync(); // eslint-disable-line node/no-sync + + +// EXPORTS // + +module.exports = dscal; diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/module.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/module.js new file mode 100644 index 00000000000..f30301ae30c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/module.js @@ -0,0 +1,235 @@ +/** +* @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 dscal = new Module( mem ); +* // returns +* +* // Initialize the routine: +* dscal.initializeSync(); +* +* // Define a vector data type: +* var dtype = 'float64'; +* +* // Specify a vector length: +* var N = 5; +* +* // Define pointer (i.e., byte offsets) for storing input vector: +* var xptr = 0; +* +* // Write vector values to module memory: +* dscal.write( xptr, oneTo( N, dtype ) ); +* +* // Perform computation: +* var ptr = dscal.main( N, 5.0, xptr, 1 ); +* // returns +* +* var bool = ( ptr === xptr ); +* // returns true +* +* // Read out the results: +* var view = zeros( N, dtype ); +* dscal.read( xptr, view ); +* // view => [ 5.0, 10.0, 15.0, 20.0, 25.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 ); + +/** +* Multiplies a vector `x` by a constant `alpha`. +* +* @name main +* @memberof Module.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {number} alpha - scalar +* @param {NonNegativeInteger} xptr - input array pointer (i.e., byte offset) +* @param {integer} strideX - `x` stride length +* @returns {NonNegativeInteger} input array pointer (i.e., byte offset) +* +* @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 dscal = new Module( mem ); +* // returns +* +* // Initialize the routine: +* dscal.initializeSync(); +* +* // Define a vector data type: +* var dtype = 'float64'; +* +* // Specify a vector length: +* var N = 5; +* +* // Define pointer (i.e., byte offsets) for storing input vector: +* var xptr = 0; +* +* // Write vector values to module memory: +* dscal.write( xptr, oneTo( N, dtype ) ); +* +* // Perform computation: +* var ptr = dscal.main( N, 5.0, xptr, 1 ); +* // returns +* +* var bool = ( ptr === xptr ); +* // returns true +* +* // Read out the results: +* var view = zeros( N, dtype ); +* dscal.read( xptr, view ); +* // view => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +*/ +setReadOnly( Module.prototype, 'main', function dscal( N, alpha, xptr, strideX ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point + this._instance.exports.c_dscal( N, alpha, xptr, strideX ); + return xptr; +}); + +/** +* Multiplies a vector `x` by a constant `alpha` using alternative indexing semantics. +* +* @name ndarray +* @memberof Module.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {number} alpha - scalar +* @param {NonNegativeInteger} xptr - input array pointer (i.e., byte offset) +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting `x` index +* @returns {NonNegativeInteger} output array pointer (i.e., byte offset) +* +* @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 dscal = new Module( mem ); +* // returns +* +* // Initialize the routine: +* dscal.initializeSync(); +* +* // Define a vector data type: +* var dtype = 'float64'; +* +* // Specify a vector length: +* var N = 5; +* +* // Define pointer (i.e., byte offsets) for storing input vectors: +* var xptr = 0; +* +* // Write vector values to module memory: +* dscal.write( xptr, oneTo( N, dtype ) ); +* +* // Perform computation: +* var ptr = dscal.ndarray( N, 5.0, xptr, 1, 0 ); +* // returns +* +* var bool = ( ptr === xptr ); +* // returns true +* +* // Read out the results: +* var view = zeros( N, dtype ); +* dscal.read( xptr, view ); +* // view => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +*/ +setReadOnly( Module.prototype, 'ndarray', function dscal( N, alpha, xptr, strideX, offsetX ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point + this._instance.exports.c_dscal_ndarray( N, alpha, xptr, strideX, offsetX ); + return xptr; +}); + + +// EXPORTS // + +module.exports = Module; diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/routine.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/routine.js new file mode 100644 index 00000000000..4de3b15ca91 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/lib/routine.js @@ -0,0 +1,175 @@ +/** +* @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 readDataView = require( '@stdlib/strided/base/read-dataview' ).ndarray; +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 dscal = new Routine(); +* +* // Initialize the module: +* dscal.initializeSync(); +* +* // Define a strided array: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* +* // Perform operation: +* dscal.main( x.length, 5.0, x, 1 ); +* // x => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Create a new routine: +* var dscal = new Routine(); +* +* // Initialize the module: +* dscal.initializeSync(); +* +* // Define a strided array: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* +* // Perform operation: +* dscal.ndarray( x.length, 5.0, x, 1, 0 ); +* // x => [ 5.0, 10.0, 15.0, 20.0, 25.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 ); + +/** +* Multiplies a vector `x` by a constant `alpha`. +* +* @name main +* @memberof Routine.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {number} alpha - scalar +* @param {Float64Array} x - input array +* @param {integer} strideX - `x` stride length +* @returns {Float64Array} input array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Create a new routine: +* var dscal = new Routine(); +* +* // Initialize the module: +* dscal.initializeSync(); +* +* // Define a strided array: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* +* // Perform operation: +* dscal.main( x.length, 5.0, x, 1 ); +* // x => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +*/ +setReadOnly( Routine.prototype, 'main', function dscal( N, alpha, x, strideX ) { + return this.ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) ); +}); + +/** +* Multiplies a vector `x` by a constant `alpha` using alternative indexing semantics. +* +* @name ndarray +* @memberof Routine.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {number} alpha - scalar +* @param {Float64Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting index for `x` +* @returns {Float64Array} input array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Create a new routine: +* var dscal = new Routine(); +* +* // Initialize the module: +* dscal.initializeSync(); +* +* // Define a strided array: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* +* // Perform operation: +* dscal.ndarray( x.length, 5.0, x, 1, 0 ); +* // x => [ 5.0, 10.0, 15.0, 20.0, 25.0 ] +*/ +setReadOnly( Routine.prototype, 'ndarray', function dscal( N, alpha, x, strideX, offsetX ) { + var ptrs; + var p0; + + // Convert the input arrays to "pointers" in the module's memory: + ptrs = arrays2ptrs( this, [ + strided2object( N, x, strideX, offsetX ) + ]); + p0 = ptrs[0]; + + // Perform computation by calling the corresponding parent method: + Module.prototype.ndarray.call( this, N, alpha, p0.ptr, p0.stride, p0.offset ); // eslint-disable-line max-len + + // If the output array data had to be copied to module memory, copy the results to the provided input array... + if ( p0.copy ) { + readDataView( N, this.view, p0.stride*p0.BYTES_PER_ELEMENT, p0.ptr, x, strideX, offsetX, true ); // eslint-disable-line max-len + } + return x; +}); + + +// EXPORTS // + +module.exports = Routine; diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/manifest.json b/lib/node_modules/@stdlib/blas/base/dscal-wasm/manifest.json new file mode 100644 index 00000000000..848e2505924 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-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/dscal" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/package.json b/lib/node_modules/@stdlib/blas/base/dscal-wasm/package.json new file mode 100644 index 00000000000..de247b938fe --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/package.json @@ -0,0 +1,80 @@ +{ + "name": "@stdlib/blas/base/dscal-wasm", + "version": "0.0.0", + "description": "Multiply a vector `x` by a scalar `alpha`.", + "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", + "dscal", + "linear", + "algebra", + "subroutines", + "alpha", + "vector", + "array", + "ndarray", + "float64", + "double", + "float64array", + "webassembly", + "wasm" + ], + "__stdlib__": { + "wasm": true + } +} diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/scripts/build.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/scripts/build.js new file mode 100644 index 00000000000..348354d7029 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-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/dscal-wasm/scripts/template.txt b/lib/node_modules/@stdlib/blas/base/dscal-wasm/scripts/template.txt new file mode 100644 index 00000000000..12996dd89e3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-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/dscal-wasm/src/Makefile b/lib/node_modules/@stdlib/blas/base/dscal-wasm/src/Makefile new file mode 100644 index 00000000000..3930516cfaa --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-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_dscal','_c_dscal_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/dscal-wasm/src/main.wasm b/lib/node_modules/@stdlib/blas/base/dscal-wasm/src/main.wasm new file mode 100755 index 0000000000000000000000000000000000000000..81f50294979c0847e225cf2ac2b65f5d229cfbdd GIT binary patch literal 754 zcmZ`$O^?$s5S{VZaW4sv04r*apagrZ4YGAue1VHg3W*7!euY~ zAASTs0I7_Vw!3H-A8fy|-@JJ2V0=bnfU$1AHVuqTI2urW zq}k$gG@s3v^-ckhCO~Dc^wT{5BB}C8QC0b5yR0_=!$YiCt*Tu2 zS3UXr4%+qmZ6Sy8~CqjQnb8Es1+iDdMW;QJeb zR$G^k#WlzOi6@W5HM=s^Y%*PX!}hWV&Pipo_Hfa|3{rEi0xK2RV+F*zV`5-JU_L?D zdNwOh-duE64<1!EEYp}(HYn3Xj#$hE*>xJ76uj6z6OFSw4fi0DJcz`lCt=Z%rNxYR zvcZ$(sPklkCo46HCpsyHUL(hMObkpJP)K>|hI!wEdz62~4j`7P$k@6v1_B00FcdI6 S0v5nBPt&!|w5^lu&bhzPR(!7j literal 0 HcmV?d00001 diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/src/main.wat b/lib/node_modules/@stdlib/blas/base/dscal-wasm/src/main.wat new file mode 100644 index 00000000000..3f8a006dbbd --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/src/main.wat @@ -0,0 +1,350 @@ +;; @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 f64 i32 i32))) + (type (;2;) (func (param i32 f64 i32 i32 i32))) + (import "env" "memory" (memory (;0;) 0)) + (func (;0;) (type 0) + nop) + (func (;1;) (type 1) (param i32 f64 i32 i32) + (local i64) + local.get 0 + local.get 1 + local.get 2 + local.get 3 + local.get 3 + i64.extend_i32_s + local.tee 4 + i64.const 1 + local.get 0 + i64.extend_i32_s + i64.sub + i64.mul + i64.const 0 + local.get 4 + i64.const 0 + i64.le_s + select + i32.wrap_i64 + call 2) + (func (;2;) (type 2) (param i32 f64 i32 i32 i32) + (local i32 i32 i32 i32 i32 i32 i32) + block ;; label = @1 + local.get 0 + i32.const 0 + i32.le_s + br_if 0 (;@1;) + local.get 1 + f64.const 0x1p+0 (;=1;) + f64.eq + br_if 0 (;@1;) + local.get 3 + i32.const 1 + i32.ne + if ;; label = @2 + local.get 0 + i32.const 1 + i32.sub + i32.const 3 + i32.ge_u + if ;; label = @3 + local.get 0 + i32.const 2147483644 + i32.and + local.set 7 + local.get 3 + local.get 3 + i32.add + local.tee 8 + local.get 3 + i32.add + local.tee 10 + local.get 3 + i32.add + local.set 11 + loop ;; label = @4 + local.get 2 + local.get 4 + i32.const 3 + i32.shl + i32.add + local.tee 6 + local.get 1 + local.get 6 + f64.load + f64.mul + f64.store + local.get 2 + local.get 3 + local.get 4 + i32.add + i32.const 3 + i32.shl + i32.add + local.tee 6 + local.get 1 + local.get 6 + f64.load + f64.mul + f64.store + local.get 2 + local.get 4 + local.get 8 + i32.add + i32.const 3 + i32.shl + i32.add + local.tee 6 + local.get 1 + local.get 6 + f64.load + f64.mul + f64.store + local.get 2 + local.get 4 + local.get 10 + i32.add + i32.const 3 + i32.shl + i32.add + local.tee 6 + local.get 1 + local.get 6 + f64.load + f64.mul + f64.store + local.get 4 + local.get 11 + i32.add + local.set 4 + local.get 5 + i32.const 4 + i32.add + local.tee 5 + local.get 7 + i32.ne + br_if 0 (;@4;) + end + end + local.get 0 + i32.const 3 + i32.and + local.tee 0 + i32.eqz + br_if 1 (;@1;) + i32.const 0 + local.set 5 + loop ;; label = @3 + local.get 2 + local.get 4 + i32.const 3 + i32.shl + i32.add + local.tee 7 + local.get 1 + local.get 7 + f64.load + f64.mul + f64.store + local.get 3 + local.get 4 + i32.add + local.set 4 + local.get 5 + i32.const 1 + i32.add + local.tee 5 + local.get 0 + i32.ne + br_if 0 (;@3;) + end + br 1 (;@1;) + end + block ;; label = @2 + local.get 0 + i32.const 5 + i32.rem_u + local.tee 3 + local.tee 5 + i32.eqz + br_if 0 (;@2;) + local.get 3 + i32.const 1 + i32.sub + i32.const 3 + i32.ge_u + if ;; label = @3 + local.get 2 + i32.const 24 + i32.add + local.set 8 + local.get 2 + i32.const 16 + i32.add + local.set 10 + local.get 2 + i32.const 8 + i32.add + local.set 11 + local.get 5 + i32.const 4 + i32.and + local.set 6 + loop ;; label = @4 + local.get 2 + local.get 4 + i32.const 3 + i32.shl + local.tee 3 + i32.add + local.tee 9 + local.get 1 + local.get 9 + f64.load + f64.mul + f64.store + local.get 3 + local.get 11 + i32.add + local.tee 9 + local.get 1 + local.get 9 + f64.load + f64.mul + f64.store + local.get 3 + local.get 10 + i32.add + local.tee 9 + local.get 1 + local.get 9 + f64.load + f64.mul + f64.store + local.get 3 + local.get 8 + i32.add + local.tee 3 + local.get 1 + local.get 3 + f64.load + f64.mul + f64.store + local.get 4 + i32.const 4 + i32.add + local.set 4 + local.get 7 + i32.const 4 + i32.add + local.tee 7 + local.get 6 + i32.ne + br_if 0 (;@4;) + end + end + local.get 5 + i32.const 3 + i32.and + local.tee 7 + i32.eqz + br_if 0 (;@2;) + i32.const 0 + local.set 3 + loop ;; label = @3 + local.get 2 + local.get 4 + i32.const 3 + i32.shl + i32.add + local.tee 8 + local.get 1 + local.get 8 + f64.load + f64.mul + f64.store + local.get 4 + i32.const 1 + i32.add + local.set 4 + local.get 3 + i32.const 1 + i32.add + local.tee 3 + local.get 7 + i32.ne + br_if 0 (;@3;) + end + end + local.get 0 + i32.const 5 + i32.lt_s + br_if 0 (;@1;) + loop ;; label = @2 + local.get 2 + local.get 4 + i32.const 3 + i32.shl + i32.add + local.tee 3 + local.get 1 + local.get 3 + f64.load + f64.mul + f64.store + local.get 3 + local.get 1 + local.get 3 + f64.load offset=8 + f64.mul + f64.store offset=8 + local.get 3 + local.get 1 + local.get 3 + f64.load offset=16 + f64.mul + f64.store offset=16 + local.get 3 + local.get 1 + local.get 3 + f64.load offset=24 + f64.mul + f64.store offset=24 + local.get 3 + local.get 1 + local.get 3 + f64.load offset=32 + f64.mul + f64.store offset=32 + local.get 4 + i32.const 5 + i32.add + local.set 4 + local.get 5 + i32.const 5 + i32.add + local.tee 5 + local.get 0 + i32.lt_s + br_if 0 (;@2;) + end + end) + (export "__wasm_call_ctors" (func 0)) + (export "__wasm_apply_data_relocs" (func 0)) + (export "c_dscal" (func 1)) + (export "c_dscal_ndarray" (func 2))) diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.js new file mode 100644 index 00000000000..f058cbd959d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-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 dscal = require( './../lib' ); + + +// TESTS // + +tape( 'main export is an object', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dscal, 'object', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is a `main` method', function test( t ) { + t.strictEqual( typeof dscal.main, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is an `ndarray` method', function test( t ) { + t.strictEqual( typeof dscal.ndarray, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is a `Module` constructor', function test( t ) { + t.strictEqual( typeof dscal.Module, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'the main export is a `Module` instance', function test( t ) { + t.strictEqual( dscal instanceof dscal.Module, true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.main.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.main.js new file mode 100644 index 00000000000..b76dcbbe730 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.main.js @@ -0,0 +1,186 @@ +/** +* @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 dscal = require( './../lib' ); + + +// TESTS // + +tape( 'main export is an object', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dscal, 'object', 'main export is an object' ); + t.end(); +}); + +tape( 'the `main` method has an arity of 4', function test( t ) { + t.strictEqual( dscal.main.length, 4, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method multiplies `x` by a constant `alpha`', function test( t ) { + var expected; + var alpha; + var x; + + alpha = 2.0; + x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.0, 10.0 ] ); + + dscal.main( x.length, alpha, x, 1 ); + + t.deepEqual( x, expected, 'returns expected value' ); + + // Short datasets: + x = new Float64Array( [ 1.0, 2.0 ] ); + + expected = new Float64Array( [ 2.0, 4.0 ] ); + + dscal.main( x.length, alpha, x, 1 ); + + t.deepEqual( x, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the `main` method supports an `x` stride', function test( t ) { + var expected; + var x; + var N; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + N = 3; + + dscal.main( N, 2.0, x, 2 ); + + expected = new Float64Array( [ 2.0, 2.0, 6.0, 4.0, 10.0 ] ); + + t.deepEqual( x, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method returns a reference to the output array', function test( t ) { + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + out = dscal.main( x.length, 3.0, x, 1 ); + + t.strictEqual( out, x, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the `main` method returns the input array unchanged', function test( t ) { + var expected; + var x; + + x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + dscal.main( -1, 3.0, x, 1 ); + t.deepEqual( x, expected, 'returns expected value' ); + + dscal.main( 0, 3.0, x, 1 ); + t.deepEqual( x, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the `main` method supports specifying a negative stride', function test( t ) { + var expected; + var x; + var N; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + N = 3; + + dscal.main( N, 3.0, x, -2 ); + + expected = new Float64Array( [ 3.0, 2.0, 9.0, 4.0, 15.0 ] ); + + t.deepEqual( x, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method supports complex access patterns', function test( t ) { + var expected; + var x; + var N; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0, // 2 + 6.0 + ]); + N = 3; + + dscal.main( N, 3.0, x, 2 ); + + expected = new Float64Array( [ 3.0, 2.0, 9.0, 4.0, 15.0, 6.0 ] ); + + t.deepEqual( x, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method supports view offsets', function test( t ) { + var expected; + var x0; + var x1; + + // Initial array: + x0 = new Float64Array([ + 1.0, + 2.0, // 2 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 0 + ]); + + // Create offset view: + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // begin at 2nd element + + dscal.main( 3, 3.0, x1, -2 ); + expected = new Float64Array( [ 1.0, 6.0, 3.0, 12.0, 5.0, 18.0 ] ); + + t.deepEqual( x0, expected, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.module.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.module.js new file mode 100644 index 00000000000..9adcb07e22f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-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/dscal-wasm/test/test.module.main.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.module.main.js new file mode 100644 index 00000000000..236ab30f37a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.module.main.js @@ -0,0 +1,253 @@ +/** +* @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 4', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = new Module( mem ); + t.strictEqual( mod.main.length, 4, 'returns expected value' ); + t.end(); +}); + +tape( 'a module instance has a `main` method which multiplies `x` by a constant `alpha`', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + + expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.0, 10.0 ] ); + + mod.main( 5, 2.0, xp, 1 ); + + actual = new Float64Array( 5 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + // Short datasets: + xp = 0; + + mod.write( xp, new Float64Array( [ 1.0, 2.0 ] ) ); + + expected = new Float64Array( [ 2.0, 4.0 ] ); + + mod.main( 2, 2.0, xp, 1 ); + + actual = new Float64Array( 2 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which supports an `x` stride', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ])); + N = 3; + + mod.main( N, 2.0, xp, 2 ); + + expected = new Float64Array( [ 2.0, 2.0, 6.0, 4.0, 10.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which returns a pointer to the input array', function test( t ) { + var out; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + + out = mod.main( 5, 3.0, xp, 1 ); + + t.strictEqual( out, xp, '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 leaves the input array unchanged', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + + expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + mod.main( -1, 3.0, xp, 1 ); + actual = new Float64Array( 5 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + mod.main( 0, 3.0, xp, 1 ); + actual = new Float64Array( 5 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which supports specifying a negative stride', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ])); + N = 3; + + mod.main( N, 3.0, xp, -2 ); + + expected = new Float64Array( [ 3.0, 2.0, 9.0, 4.0, 15.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which supports complex access patterns', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0, // 2 + 6.0 + ])); + N = 3; + + mod.main( N, 3.0, xp, 2 ); + + expected = new Float64Array( [ 3.0, 2.0, 9.0, 4.0, 15.0, 6.0 ] ); + + actual = new Float64Array( 6 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.module.ndarray.js new file mode 100644 index 00000000000..b3490020b16 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.module.ndarray.js @@ -0,0 +1,289 @@ +/** +* @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 5', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = new Module( mem ); + t.strictEqual( mod.ndarray.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which multiplies `x` by a constant `alpha`', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + + expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.0, 10.0 ] ); + + mod.ndarray( 5, 2.0, xp, 1, 0 ); + + actual = new Float64Array( 5 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + // Short datasets: + xp = 0; + + mod.write( xp, new Float64Array( [ 1.0, 2.0 ] ) ); + + expected = new Float64Array( [ 2.0, 4.0 ] ); + + mod.ndarray( 2, 2.0, xp, 1, 0 ); + + actual = new Float64Array( 2 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports an `x` stride', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ])); + N = 3; + + mod.ndarray( N, 2.0, xp, 2, 0 ); + + expected = new Float64Array( [ 2.0, 2.0, 6.0, 4.0, 10.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports an `x` offset', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array([ + 1.0, + 2.0, + 3.0, // 0 + 4.0, // 1 + 5.0 // 2 + ])); + N = 3; + + mod.ndarray( N, 3.0, xp, 1, 2 ); + + expected = new Float64Array( [ 1.0, 2.0, 9.0, 12.0, 15.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which returns a pointer to the input array', function test( t ) { + var out; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + + out = mod.ndarray( 5, 3.0, xp, 1, 0 ); + + t.strictEqual( out, xp, '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 input array unchanged', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + + expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + mod.ndarray( -1, 3.0, xp, 1, 0 ); + actual = new Float64Array( 5 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + mod.ndarray( 0, 3.0, xp, 1, 0 ); + actual = new Float64Array( 5 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports negative strides', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ])); + N = 3; + + mod.ndarray( N, 3.0, xp, -2, 4 ); + + expected = new Float64Array( [ 3.0, 2.0, 9.0, 4.0, 15.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports complex access patterns', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0, // 0 + 6.0 + ])); + N = 3; + + mod.ndarray( N, 3.0, xp, -2, 4 ); + + expected = new Float64Array( [ 3.0, 2.0, 9.0, 4.0, 15.0, 6.0 ] ); + + actual = new Float64Array( 6 ); + mod.read( xp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.ndarray.js new file mode 100644 index 00000000000..3465293b009 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.ndarray.js @@ -0,0 +1,183 @@ +/** +* @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 dscal = require( './../lib' ); + + +// TESTS // + +tape( 'main export is an object', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dscal, 'object', 'main export is an object' ); + t.end(); +}); + +tape( 'the `ndarray` method has an arity of 5', function test( t ) { + t.strictEqual( dscal.ndarray.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method multiplies `x` by a constant `alpha`', function test( t ) { + var expected; + var alpha; + var x; + + alpha = 2.0; + x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.0, 10.0 ] ); + + dscal.ndarray( x.length, alpha, x, 1, 0 ); + + t.deepEqual( x, expected, 'returns expected value' ); + + // Short datasets: + x = new Float64Array( [ 1.0, 2.0 ] ); + + expected = new Float64Array( [ 2.0, 4.0 ] ); + + dscal.ndarray( x.length, alpha, x, 1, 0 ); + + t.deepEqual( x, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the `ndarray` method supports an `x` stride', function test( t ) { + var expected; + var x; + var N; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + N = 3; + + dscal.ndarray( N, 2.0, x, 2, 0 ); + + expected = new Float64Array( [ 2.0, 2.0, 6.0, 4.0, 10.0 ] ); + + t.deepEqual( x, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method supports an `x` offset', function test( t ) { + var expected; + var x; + var N; + + x = new Float64Array([ + 1.0, + 2.0, + 3.0, // 0 + 4.0, // 1 + 5.0 // 2 + ]); + N = 3; + + dscal.ndarray( N, 3.0, x, 1, 2 ); + + expected = new Float64Array( [ 1.0, 2.0, 9.0, 12.0, 15.0 ] ); + + t.deepEqual( x, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method returns a reference to the input array', function test( t ) { + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + out = dscal.ndarray( x.length, 3.0, x, 1, 0 ); + + t.strictEqual( out, x, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the `ndarray` method returns the input array unchanged', function test( t ) { + var expected; + var x; + + x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + dscal.ndarray( -1, 3.0, x, 1, 0 ); + t.deepEqual( x, expected, 'returns expected value' ); + + dscal.ndarray( 0, 3.0, x, 1, 0 ); + t.deepEqual( x, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the `ndarray` method supports specifying a negative stride', function test( t ) { + var expected; + var x; + var N; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + N = 3; + + dscal.ndarray( N, 3.0, x, -2, x.length-1 ); + + expected = new Float64Array( [ 3.0, 2.0, 9.0, 4.0, 15.0 ] ); + + t.deepEqual( x, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method supports complex access patterns', function test( t ) { + var expected; + var x; + var N; + + x = new Float64Array([ + 1.0, + 2.0, // 2 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 0 + ]); + N = 3; + + dscal.ndarray( N, 3.0, x, -2, 5 ); + + expected = new Float64Array( [ 1.0, 6.0, 3.0, 12.0, 5.0, 18.0 ] ); + + t.deepEqual( x, expected, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.routine.js b/lib/node_modules/@stdlib/blas/base/dscal-wasm/test/test.routine.js new file mode 100644 index 00000000000..56a4b67daaf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dscal-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(); +});