From 98600eca7ebd8e7269f051a2e87612c33dca0638 Mon Sep 17 00:00:00 2001 From: Aman Bhansali <92033532+aman-095@users.noreply.github.com> Date: Sun, 29 Sep 2024 13:20:51 +0530 Subject: [PATCH] feat: add `blas/base/dcopy-wasm` PR-URL: https://github.com/stdlib-js/stdlib/pull/2959 Ref: https://github.com/stdlib-js/stdlib/issues/2039 Co-authored-by: Athan Reines Reviewed-by: Athan Reines --- .../@stdlib/blas/base/dcopy-wasm/README.md | 334 +++++++++++ .../base/dcopy-wasm/benchmark/benchmark.js | 106 ++++ .../dcopy-wasm/benchmark/benchmark.module.js | 66 +++ .../benchmark/benchmark.module.main.js | 138 +++++ .../benchmark/benchmark.module.ndarray.js | 138 +++++ .../dcopy-wasm/benchmark/benchmark.ndarray.js | 106 ++++ .../blas/base/dcopy-wasm/docs/repl.txt | 545 ++++++++++++++++++ .../base/dcopy-wasm/docs/types/index.d.ts | 397 +++++++++++++ .../blas/base/dcopy-wasm/docs/types/test.ts | 528 +++++++++++++++++ .../blas/base/dcopy-wasm/examples/index.js | 46 ++ .../examples/little_endian_array.js | 74 +++ .../blas/base/dcopy-wasm/examples/module.js | 72 +++ .../base/dcopy-wasm/lib/binary.browser.js | 33 ++ .../blas/base/dcopy-wasm/lib/binary.js | 34 ++ .../@stdlib/blas/base/dcopy-wasm/lib/index.js | 112 ++++ .../@stdlib/blas/base/dcopy-wasm/lib/main.js | 62 ++ .../blas/base/dcopy-wasm/lib/module.js | 244 ++++++++ .../blas/base/dcopy-wasm/lib/routine.js | 185 ++++++ .../blas/base/dcopy-wasm/manifest.json | 36 ++ .../@stdlib/blas/base/dcopy-wasm/package.json | 80 +++ .../blas/base/dcopy-wasm/scripts/build.js | 63 ++ .../blas/base/dcopy-wasm/scripts/template.txt | 33 ++ .../@stdlib/blas/base/dcopy-wasm/src/Makefile | 232 ++++++++ .../blas/base/dcopy-wasm/src/main.wasm | Bin 0 -> 863 bytes .../@stdlib/blas/base/dcopy-wasm/src/main.wat | 416 +++++++++++++ .../@stdlib/blas/base/dcopy-wasm/test/test.js | 53 ++ .../blas/base/dcopy-wasm/test/test.main.js | 259 +++++++++ .../blas/base/dcopy-wasm/test/test.module.js | 154 +++++ .../base/dcopy-wasm/test/test.module.main.js | 337 +++++++++++ .../dcopy-wasm/test/test.module.ndarray.js | 427 ++++++++++++++ .../blas/base/dcopy-wasm/test/test.ndarray.js | 276 +++++++++ .../blas/base/dcopy-wasm/test/test.routine.js | 71 +++ 32 files changed, 5657 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/README.md create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.module.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.module.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.module.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/examples/little_endian_array.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/examples/module.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/binary.browser.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/binary.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/module.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/routine.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/manifest.json create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/package.json create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/scripts/build.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/scripts/template.txt create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/src/Makefile create mode 100755 lib/node_modules/@stdlib/blas/base/dcopy-wasm/src/main.wasm create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/src/main.wat create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.module.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.module.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.module.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.routine.js diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/README.md b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/README.md new file mode 100644 index 00000000000..41a17d81ee0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/README.md @@ -0,0 +1,334 @@ + + +# dcopy + +> Copy values from `x` into `y`. + +
+ +## Usage + +```javascript +var dcopy = require( '@stdlib/blas/base/dcopy-wasm' ); +``` + +#### dcopy.main( N, x, strideX, y, strideY ) + +Copies values from `x` into `y`. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + +dcopy.main( x.length, x, 1, y, 1 ); +// y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **x**: input [`Float64Array`][@stdlib/array/float64]. +- **strideX**: index increment for `x`. +- **y**: input [`Float64Array`][@stdlib/array/float64]. +- **strideY**: index increment for `y`. + +The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to copy every other element from `x` into `y` in reverse order, + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + +dcopy.main( 3, x, 2, y, -1 ); +// y => [ 5.0, 3.0, 1.0, 1.0, 1.0, 1.0 ] +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + + + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +// Initial arrays... +var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var y0 = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + +// Create offset views... +var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element +var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element + +dcopy.main( 3, x1, -2, y1, 1 ); +// y0 => [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ] +``` + +#### dcopy.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + +Copies values from `x` into `y` 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 ] ); +var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + +dcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); +// y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +``` + +The function has the following additional parameters: + +- **offsetX**: starting index for `x`. +- **offsetY**: starting index for `y`. + +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to copy every other value in `x` starting from the second value into the last `N` elements in `y` where `x[i] = y[n]`, `x[i+2] = y[n-1]`,..., + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var y = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + +dcopy.ndarray( 3, x, 2, 1, y, -1, y.length-1 ); +// y => [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ] +``` + +* * * + +### Module + +#### dcopy.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 dcopy.Module( mem ); +// returns + +// Initialize the routine: +mod.initializeSync(); +``` + +#### dcopy.Module.prototype.main( N, xp, sx, yp, sy ) + +Copies values from `x` into `y`. + + + +```javascript +var Memory = require( '@stdlib/wasm/memory' ); +var oneTo = require( '@stdlib/array/one-to' ); +var ones = require( '@stdlib/array/ones' ); +var zeros = require( '@stdlib/array/zeros' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); + +// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): +var mem = new Memory({ + 'initial': 10, + 'maximum': 100 +}); + +// Create a BLAS routine: +var mod = new dcopy.Module( mem ); +// returns + +// Initialize the routine: +mod.initializeSync(); + +// Define a vector data type: +var dtype = 'float64'; + +// Specify a vector length: +var N = 5; + +// Define pointers (i.e., byte offsets) for storing two vectors: +var xptr = 0; +var yptr = N * bytesPerElement( dtype ); + +// Write vector values to module memory: +mod.write( xptr, oneTo( N, dtype ) ); +mod.write( yptr, ones( N, dtype ) ); + +// Perform computation: +mod.main( N, xptr, 1, yptr, 1 ); + +// Read out the results: +var view = zeros( N, dtype ); +mod.read( yptr, view ); + +console.log( view ); +// => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **xp**: input [`Float64Array`][@stdlib/array/float64] pointer (i.e., byte offset). +- **sx**: index increment for `x`. +- **yp**: input [`Float64Array`][@stdlib/array/float64] pointer (i.e., byte offset). +- **sy**: index increment for `y`. + +#### dcopy.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy ) + +Copies values from `x` into `y` using alternative indexing semantics. + + + +```javascript +var Memory = require( '@stdlib/wasm/memory' ); +var oneTo = require( '@stdlib/array/one-to' ); +var ones = require( '@stdlib/array/ones' ); +var zeros = require( '@stdlib/array/zeros' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); + +// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): +var mem = new Memory({ + 'initial': 10, + 'maximum': 100 +}); + +// Create a BLAS routine: +var mod = new dcopy.Module( mem ); +// returns + +// Initialize the routine: +mod.initializeSync(); + +// Define a vector data type: +var dtype = 'float64'; + +// Specify a vector length: +var N = 5; + +// Define pointers (i.e., byte offsets) for storing two vectors: +var xptr = 0; +var yptr = N * bytesPerElement( dtype ); + +// Write vector values to module memory: +mod.write( xptr, oneTo( N, dtype ) ); +mod.write( yptr, ones( N, dtype ) ); + +// Perform computation: +mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); + +// Read out the results: +var view = zeros( N, dtype ); +mod.read( yptr, view ); + +console.log( view ); +// => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +``` + +The function has the following additional parameters: + +- **ox**: starting index for `x`. +- **oy**: starting index for `y`. + +
+ + + +
+ +* * * + +## Notes + +- If `N <= 0`, `y` is left unchanged. +- This package implements routines using WebAssembly. When provided arrays which are not allocated on a `dcopy` 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/dcopy`][@stdlib/blas/base/dcopy]. 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/dcopy`][@stdlib/blas/base/dcopy]. 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. +- `dcopy()` corresponds to the [BLAS][blas] level 1 function [`dcopy`][dcopy]. + +
+ + + +
+ +* * * + +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var dcopy = require( '@stdlib/blas/base/dcopy-wasm' ); + +var opts = { + 'dtype': 'float64' +}; +var x = discreteUniform( 10, 0, 100, opts ); +console.log( x ); + +var y = discreteUniform( x.length, 0, 10, opts ); +console.log( y ); + +dcopy.ndarray( x.length, x, 1, 0, y, -1, y.length-1 ); +console.log( y ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[blas]: http://www.netlib.org/blas + +[dcopy]: http://www.netlib.org/lapack/explore-html/de/da4/group__double__blas__level1.html + +[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray + +[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 + +[@stdlib/wasm/memory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/wasm/memory + +[@stdlib/wasm/module-wrapper]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/wasm/module-wrapper + +[@stdlib/blas/base/dcopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dcopy + +
+ + diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.js new file mode 100644 index 00000000000..00ff0915e30 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-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 dcopy = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + dcopy.main( x.length, x, 1, y, 1 ); + if ( isnan( y[ i%y.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y[ i%y.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/dcopy-wasm/benchmark/benchmark.module.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.module.js new file mode 100644 index 00000000000..1393cfb8367 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-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 dcopy = 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 dcopy.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/dcopy-wasm/benchmark/benchmark.module.main.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.module.main.js new file mode 100644 index 00000000000..45200fc392d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.module.main.js @@ -0,0 +1,138 @@ +/** +* @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 dcopy = 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 yptr; + var mod; + var mem; + var nb; + var i; + + // Create a new BLAS routine interface: + mem = new Memory({ + 'initial': 0 + }); + mod = new dcopy.Module( mem ); + + // Initialize the module: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Reallocate the underlying memory to allow storing two vectors: + nb = bytesPerElement( options.dtype ); + mod.realloc( len*2*nb ); + + // Define pointers (i.e., byte offsets) to the first vector elements: + xptr = 0; + yptr = len * nb; + + // Write random values to module memory: + mod.write( xptr, uniform( len, -100.0, 100.0, options ) ); + mod.write( yptr, uniform( len, -100.0, 100.0, options ) ); + + // Retrieve a DataView of module memory: + view = mod.view; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + mod.main( len, xptr, 1, yptr, 1 ); + byteOffset = yptr + ( (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/dcopy-wasm/benchmark/benchmark.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.module.ndarray.js new file mode 100644 index 00000000000..4744744962e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.module.ndarray.js @@ -0,0 +1,138 @@ +/** +* @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 dcopy = 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 yptr; + var mod; + var mem; + var nb; + var i; + + // Create a new BLAS routine interface: + mem = new Memory({ + 'initial': 0 + }); + mod = new dcopy.Module( mem ); + + // Initialize the module: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Reallocate the underlying memory to allow storing two vectors: + nb = bytesPerElement( options.dtype ); + mod.realloc( len*2*nb ); + + // Define pointers (i.e., byte offsets) to the first vector elements: + xptr = 0; + yptr = len * nb; + + // Write random values to module memory: + mod.write( xptr, uniform( len, -100.0, 100.0, options ) ); + mod.write( yptr, uniform( len, -100.0, 100.0, options ) ); + + // Retrieve a DataView of module memory: + view = mod.view; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + mod.ndarray( len, xptr, 1, 0, yptr, 1, 0 ); + byteOffset = yptr + ( (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/dcopy-wasm/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/benchmark/benchmark.ndarray.js new file mode 100644 index 00000000000..58ba0633f97 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-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 dcopy = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + dcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); + if ( isnan( y[ i%y.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y[ i%y.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/dcopy-wasm/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/docs/repl.txt new file mode 100644 index 00000000000..b5d70637f2e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/docs/repl.txt @@ -0,0 +1,545 @@ + +{{alias}}.main( N, x, strideX, y, strideY ) + Copies values from `x` into `y`. + + The `N` and stride parameters determine how values from `x` are copied into + `y`. + + Indexing is relative to the first index. To introduce an offset, use typed + array views. + + If `N` is less than or equal to `0`, the function returns `y` unchanged. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + Input array. + + strideX: integer + Index increment for `x`. + + y: Float64Array + Output array. + + strideY: integer + Index increment for `y`. + + Returns + ------- + y: Float64Array + Output array. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + > var y = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + > {{alias}}.main( x.length, x, 1, y, 1 ) + [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + + // Using `N` and stride parameters: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + > {{alias}}.main( 3, x, 2, y, -1 ) + [ 5.0, 3.0, 1.0, 1.0, 1.0, 1.0 ] + + // Using view offsets: + > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > var y0 = new {{alias:@stdlib/array/float64}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > var y1 = new {{alias:@stdlib/array/float64}}( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); + > {{alias}}.main( 3, x1, -2, y1, 1 ) + [ 6.0, 4.0, 2.0 ] + > y0 + [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ] + + +{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + Copies values from `x` into `y` using alternative indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameters support indexing semantics based on starting + indices. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + Input array. + + strideX: integer + Index increment for `x`. + + offsetX: integer + Starting index for `x`. + + y: Float64Array + Output array. + + strideY: integer + Index increment for `y`. + + offsetY: integer + Starting index for `y`. + + Returns + ------- + y: Float64Array + Output array. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + > var y = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + > {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ) + [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + + // Advanced indexing: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + > {{alias}}.ndarray( 3, x, 2, 1, y, -1, y.length-1 ) + [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ] + + +{{alias}}.Module( memory ) + Returns a new WebAssembly module wrapper which uses the provided WebAssembly + memory instance as its underlying memory. + + Parameters + ---------- + memory: Memory + WebAssembly memory instance. + + Returns + ------- + mod: Module + WebAssembly module wrapper. + + Examples + -------- + // Create a new memory instance: + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + + // Create a new routine: + > var mod = new {{alias}}.Module( mem ); + + // Initialize the routine: + > mod.initializeSync(); + + +{{alias}}.Module.prototype.binary + Read-only property which returns WebAssembly binary code. + + Returns + ------- + out: Uint8Array + WebAssembly binary code. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.binary + + + +{{alias}}.Module.prototype.memory + Read-only property which returns WebAssembly memory. + + Returns + ------- + mem: Memory|null + WebAssembly memory. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.memory + + + +{{alias}}.Module.prototype.buffer + Read-only property which returns a WebAssembly memory buffer as a + Uint8Array. + + Returns + ------- + buf: Uint8Array|null + WebAssembly memory buffer. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.buffer + + + +{{alias}}.Module.prototype.view + Read-only property which returns a WebAsssembly memory buffer as a DataView. + + Returns + ------- + view: DataView|null + WebAssembly memory view. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.view + + + +{{alias}}.Module.prototype.exports + Read-only property which returns "raw" WebAssembly module exports. + + Returns + ------- + out: Object|null + WebAssembly module exports. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.exports + {...} + + +{{alias}}.Module.prototype.initialize() + Asynchronously initializes a WebAssembly module instance. + + Returns + ------- + p: Promise + Promise which resolves upon initializing a WebAssembly module instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initialize(); + + +{{alias}}.Module.prototype.initializeAsync( clbk ) + Asynchronously initializes a WebAssembly module instance. + + Parameters + ---------- + clbk: Function + Callback to invoke upon initializing a WebAssembly module instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > function clbk() { console.log( 'done' ) }; + > mod.initializeAsync( clbk ); + + +{{alias}}.Module.prototype.initializeSync() + Synchronously initializes a WebAssembly module instance. + + In web browsers, JavaScript engines may raise an exception when attempting + to synchronously compile large WebAssembly binaries due to concerns about + blocking the main thread. Hence, to initialize WebAssembly modules having + large binaries (e.g., >4KiB), consider using asynchronous initialization + methods in browser contexts. + + Returns + ------- + mod: Module + Module wrapper instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + + +{{alias}}.Module.prototype.realloc( nbytes ) + Reallocates the underlying WebAssembly memory instance to a specified number + of bytes. + + WebAssembly memory can only *grow*, not shrink. Hence, if provided a number + of bytes which is less than or equal to the size of the current memory, the + function does nothing. + + When non-shared memory is resized, the underlying the `ArrayBuffer` is + detached, consequently invalidating any associated typed array views. Before + resizing non-shared memory, ensure that associated typed array views no + longer need byte access and can be garbage collected. + + Parameters + ---------- + nbytes: integer + Memory size (in bytes). + + Returns + ------- + bool: boolean + Boolean indicating whether the resize operation was successful. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ) + + + +{{alias}}.Module.prototype.hasCapacity( byteOffset, values ) + Returns a boolean indicating whether the underlying WebAssembly memory + instance has the capacity to store a provided list of values starting from a + specified byte offset. + + Parameters + ---------- + byteOffset: integer + Byte offset at which to start writing values. + + values: ArrayLikeObject + Input array containing values to write. + + Returns + ------- + bool: boolean + Boolean indicating whether the underlying WebAssembly memory instance + has enough capacity. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ); + > mod.hasCapacity( 0, [ 1, 2, 3, 4 ] ) + true + + +{{alias}}.Module.prototype.isView( values ) + Returns a boolean indicating whether a provided list of values is a view of + the underlying memory of the WebAssembly module. + + Parameters + ---------- + values: ArrayLikeObject + Input array. + + Returns + ------- + bool: boolean + Boolean indicating whether the list is a memory view. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ); + > mod.isView( [ 1, 2, 3, 4 ] ) + false + + +{{alias}}.Module.prototype.write( byteOffset, values ) + Writes values to the underlying WebAssembly memory instance. + + The function infers element size (i.e., number of bytes per element) from + the data type of the input array. For example, if provided a Float32Array, + the function writes each element as a single-precision floating-point number + to the underlying WebAssembly memory instance. + + In order to write elements as a different data type, you need to perform an + explicit cast *before* calling this method. For example, in order to write + single-precision floating-point numbers contained in a Float32Array as + signed 32-bit integers, you must first convert the Float32Array to an + Int32Array before passing the values to this method. + + If provided an array having an unknown or "generic" data type, elements are + written as double-precision floating-point numbers. + + Parameters + ---------- + byteOffset: integer + Byte offset at which to start writing values. + + values: ArrayLikeObject + Input array containing values to write. + + Returns + ------- + mod: Module + Module wrapper instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ); + > mod.write( 0, [ 1, 2, 3, 4 ] ); + + +{{alias}}.Module.prototype.read( byteOffset, out ) + Reads values from the underlying WebAssembly memory instance. + + The function infers element size (i.e., number of bytes per element) from + the data type of the output array. For example, if provided a Float32Array, + the function reads each element as a single-precision floating-point number + from the underlying WebAssembly memory instance. + + In order to read elements as a different data type, you need to perform an + explicit cast *after* calling this method. For example, in order to read + single-precision floating-point numbers contained in a Float32Array as + signed 32-bit integers, you must convert the Float32Array to an Int32Array + after reading memory values using this method. + + If provided an output array having an unknown or "generic" data type, + elements are read as double-precision floating-point numbers. + + Parameters + ---------- + byteOffset: integer + Byte offset at which to start reading values. + + out: ArrayLikeObject + Output array for storing read values. + + Returns + ------- + mod: Module + Module wrapper instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ); + > mod.write( 0, [ 1, 2, 3, 4 ] ); + > var out = [ 0, 0, 0, 0 ]; + > mod.read( 0, out ); + > out + [ 1, 2, 3, 4 ] + + +{{alias}}.Module.prototype.main( N, xp, sx, yp, sy ) + Copies values from `x` into `y`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + xp: integer + Input array pointer (i.e., byte offset). + + sx: integer + Index increment for `x`. + + yp: integer + Output array pointer (i.e., byte offset). + + sy: integer + Index increment for `y`. + + Returns + ------- + yp: integer + Output 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 "pointers" (i.e., byte offsets) into module memory: + > var xptr = 0; + > var yptr = 40; + + // Write data to module memory: + > mod.write( xptr, {{alias:@stdlib/array/one-to}}( 5, 'float64' ) ); + > mod.write( yptr, {{alias:@stdlib/array/ones}}( 5, 'float64' ) ); + + // Perform computation: + > mod.main( 5, xptr, 1, yptr, 1 ); + + // Extract results from module memory: + > var view = {{alias:@stdlib/array/zeros}}( 5, 'float64' ); + > mod.read( yptr, view ); + > view + [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + + +{{alias}}.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy ) + Copies values from `x` into `y` using alternative indexing semantics. + + Parameters + ---------- + N: integer + Number of indexed elements. + + xp: integer + Input array pointer (i.e., byte offset). + + sx: integer + Index increment for `x`. + + ox: integer + Starting index for `x`. + + yp: integer + Output array pointer (i.e., byte offset). + + sy: integer + Index increment for `y`. + + oy: integer + Starting index for `y`. + + Returns + ------- + oy: integer + Output 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 "pointers" (i.e., byte offsets) into module memory: + > var xptr = 0; + > var yptr = 40; + + // Write data to module memory: + > mod.write( xptr, {{alias:@stdlib/array/one-to}}( 5, 'float64' ) ); + > mod.write( yptr, {{alias:@stdlib/array/ones}}( 5, 'float64' ) ); + + // Perform computation: + > mod.ndarray( 5, xptr, 1, 0, yptr, 1, 0 ); + + // Extract results from module memory: + > var view = {{alias:@stdlib/array/zeros}}( 5, 'float64' ); + > mod.read( yptr, view ); + > view + [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/docs/types/index.d.ts new file mode 100644 index 00000000000..a3f46d66b0e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/docs/types/index.d.ts @@ -0,0 +1,397 @@ +/* +* @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 dcopy.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float64'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointers (i.e., byte offsets) for storing two vectors: + * var xptr = 0; + * var yptr = N * bytesPerElement( dtype ); + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.main( N, xptr, 1, yptr, 1 ); + * // returns + * + * var bool = ( ptr === yptr ); + * // returns true + * + * // Read out the results: + * var view = zeros( N, dtype ); + * mod.read( yptr, view ); + * // view => [ 1.0, 2.0, 3.0, 4.0, 5.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 = dcopy.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float64'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointers (i.e., byte offsets) for storing two vectors: + * var xptr = 0; + * var yptr = N * bytesPerElement( dtype ); + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.main( N, xptr, 1, yptr, 1 ); + * // returns + * + * var bool = ( ptr === yptr ); + * // returns true + * + * // Read out the results: + * var view = zeros( N, dtype ); + * mod.read( yptr, view ); + * // view => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + ( mem: Memory ): Module; // callable +} + +/** +* Interface describing a `dcopy` WebAssembly module. +*/ +interface Module extends ModuleWrapper { + /** + * Copies values from `x` into `y`. + * + * @param N - number of indexed elements + * @param xptr - input array pointer (i.e., byte offset) + * @param strideX - `x` stride length + * @param yptr - output array pointer (i.e., byte offset) + * @param strideY - `y` stride length + * @returns 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 mod = new dcopy.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float64'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointers (i.e., byte offsets) for storing two vectors: + * var xptr = 0; + * var yptr = N * bytesPerElement( dtype ); + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.main( N, xptr, 1, yptr, 1 ); + * // returns + * + * var bool = ( ptr === yptr ); + * // returns true + * + * // Read out the results: + * var view = zeros( N, dtype ); + * mod.read( yptr, view ); + * // view => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + main( N: number, xptr: number, strideX: number, yptr: number, strideY: number ): number; + + /** + * Copies values from `x` into `y` using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param xptr - input array pointer (i.e., byte offset) + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @param yptr - output array pointer (i.e., byte offset) + * @param strideY - `y` stride length + * @param offsetY - starting index for `y` + * @returns 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 mod = new dcopy.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float64'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointers (i.e., byte offsets) for storing two vectors: + * var xptr = 0; + * var yptr = N * bytesPerElement( dtype ); + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); + * // returns + * + * var bool = ( ptr === yptr ); + * // returns true + * + * // Read out the results: + * var view = zeros( N, dtype ); + * mod.read( yptr, view ); + * // view => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + ndarray( N: number, xptr: number, strideX: number, offsetX: number, yptr: number, strideY: number, offsetY: number ): number; +} + +/** +* Interface describing `dcopy`. +*/ +interface Routine extends ModuleWrapper { + /** + * Copies values from `x` into `y`. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - `x` stride length + * @param y - output array + * @param strideY - `y` stride length + * @returns output array + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + * + * dcopy.main( x.length, x, 1, y, 1 ); + * // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + main( N: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number ): Float64Array; + + /** + * Copies values from `x` into `y` using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @param y - output array + * @param strideY - `y` stride length + * @param offsetY - starting index for `y` + * @returns output array + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + * + * dcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); + * // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, y: Float64Array, strideY: number, offsetY: number ): Float64Array; + + /** + * Returns a new WebAssembly module wrapper instance which uses the provided WebAssembly memory instance as its underlying memory. + * + * @param mem - WebAssembly memory instance + * @returns module wrapper instance + * + * @example + * var Memory = require( '@stdlib/wasm/memory' ); + * var oneTo = require( '@stdlib/array/one-to' ); + * var ones = require( '@stdlib/array/ones' ); + * var zeros = require( '@stdlib/array/zeros' ); + * var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); + * + * // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): + * var mem = new Memory({ + * 'initial': 10, + * 'maximum': 100 + * }); + * + * // Create a BLAS routine: + * var mod = new dcopy.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float64'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointers (i.e., byte offsets) for storing two vectors: + * var xptr = 0; + * var yptr = N * bytesPerElement( dtype ); + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.main( N, xptr, 1, yptr, 1 ); + * // returns + * + * var bool = ( ptr === yptr ); + * // returns true + * + * // Read out the results: + * var view = zeros( N, dtype ); + * mod.read( yptr, view ); + * // view => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + Module: ModuleConstructor; +} + +/** +* Copies values from `x` into `y`. +* +* @param N - number of indexed elements +* @param x - input array +* @param strideX - `x` stride length +* @param y - output array +* @param strideY - `y` stride length +* @returns output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* dcopy.main( x.length, x, 1, y, 1 ); +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* dcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +declare var dcopy: Routine; + + +// EXPORTS // + +export = dcopy; diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/docs/types/test.ts new file mode 100644 index 00000000000..d069963c732 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/docs/types/test.ts @@ -0,0 +1,528 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/* eslint-disable space-in-parens */ + +import Memory = require( '@stdlib/wasm/memory' ); +import dcopy = require( './index' ); + + +// TESTS // + +// Attached to the main export is a `main` method which returns a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.main( x.length, x, 1, y, 1 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the `main` method is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.main( '10', x, 1, y, 1 ); // $ExpectError + dcopy.main( true, x, 1, y, 1 ); // $ExpectError + dcopy.main( false, x, 1, y, 1 ); // $ExpectError + dcopy.main( null, x, 1, y, 1 ); // $ExpectError + dcopy.main( undefined, x, 1, y, 1 ); // $ExpectError + dcopy.main( [], x, 1, y, 1 ); // $ExpectError + dcopy.main( {}, x, 1, y, 1 ); // $ExpectError + dcopy.main( ( x: number ): number => x, x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a second argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.main( x.length, 10, 1, y, 1 ); // $ExpectError + dcopy.main( x.length, '10', 1, y, 1 ); // $ExpectError + dcopy.main( x.length, true, 1, y, 1 ); // $ExpectError + dcopy.main( x.length, false, 1, y, 1 ); // $ExpectError + dcopy.main( x.length, null, 1, y, 1 ); // $ExpectError + dcopy.main( x.length, undefined, 1, y, 1 ); // $ExpectError + dcopy.main( x.length, [], 1, y, 1 ); // $ExpectError + dcopy.main( x.length, {}, 1, y, 1 ); // $ExpectError + dcopy.main( x.length, ( x: number ): number => x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.main( x.length, x, '10', y, 1 ); // $ExpectError + dcopy.main( x.length, x, true, y, 1 ); // $ExpectError + dcopy.main( x.length, x, false, y, 1 ); // $ExpectError + dcopy.main( x.length, x, null, y, 1 ); // $ExpectError + dcopy.main( x.length, x, undefined, y, 1 ); // $ExpectError + dcopy.main( x.length, x, [], y, 1 ); // $ExpectError + dcopy.main( x.length, x, {}, y, 1 ); // $ExpectError + dcopy.main( x.length, x, ( x: number ): number => x, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a fourth argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + dcopy.main( x.length, x, 1, 10, 1 ); // $ExpectError + dcopy.main( x.length, x, 1, '10', 1 ); // $ExpectError + dcopy.main( x.length, x, 1, true, 1 ); // $ExpectError + dcopy.main( x.length, x, 1, false, 1 ); // $ExpectError + dcopy.main( x.length, x, 1, null, 1 ); // $ExpectError + dcopy.main( x.length, x, 1, undefined, 1 ); // $ExpectError + dcopy.main( x.length, x, 1, [], 1 ); // $ExpectError + dcopy.main( x.length, x, 1, {}, 1 ); // $ExpectError + dcopy.main( x.length, x, 1, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a fifth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.main( x.length, x, 1, y, '10' ); // $ExpectError + dcopy.main( x.length, x, 1, y, true ); // $ExpectError + dcopy.main( x.length, x, 1, y, false ); // $ExpectError + dcopy.main( x.length, x, 1, y, null ); // $ExpectError + dcopy.main( x.length, x, 1, y, undefined ); // $ExpectError + dcopy.main( x.length, x, 1, y, [] ); // $ExpectError + dcopy.main( x.length, x, 1, y, {} ); // $ExpectError + dcopy.main( x.length, x, 1, y, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.main(); // $ExpectError + dcopy.main( x.length ); // $ExpectError + dcopy.main( x.length, x ); // $ExpectError + dcopy.main( x.length, x, 1 ); // $ExpectError + dcopy.main( x.length, x, 1, y ); // $ExpectError + dcopy.main( x.length, x, 1, y, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.ndarray( '10', x, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( true, x, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( false, x, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( null, x, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( undefined, x, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( [], x, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( {}, x, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( ( x: number ): number => x, x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.ndarray( x.length, 10, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, '10', 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, true, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, false, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, null, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, undefined, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, [], 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, {}, 1, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, ( x: number ): number => x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.ndarray( x.length, x, '10', 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, true, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, false, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, null, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, undefined, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, [], 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, {}, 0, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, ( x: number ): number => x, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.ndarray( x.length, x, 1, '10', y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, true, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, false, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, null, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, undefined, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, [], y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, {}, y, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, ( x: number ): number => x, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + + dcopy.ndarray( x.length, x, 1, 0, 10, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, '10', 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, true, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, false, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, null, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, undefined, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, [], 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, {}, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.ndarray( x.length, x, 1, 0, y, '10', 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, true, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, false, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, null, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, undefined, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, [], 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, {}, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.ndarray( x.length, x, 1, 0, y, 1, '10' ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, 1, true ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, 1, false ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, 1, null ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, 1, undefined ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, 1, [] ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, 1, {} ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dcopy.ndarray(); // $ExpectError + dcopy.ndarray( x.length ); // $ExpectError + dcopy.ndarray( x.length, x ); // $ExpectError + dcopy.ndarray( x.length, x, 1 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError + dcopy.ndarray( x.length, x, 1, 0, y, 1, 0, 10 ); // $ExpectError +} + +// Attached to the main export is a `Module` constructor which returns a module... +{ + const mem = new Memory({ + 'initial': 0 + }); + + dcopy.Module( mem ); // $ExpectType Module +} + +// The compiler throws an error if the `Module` constructor is not provided a WebAssembly memory instance... +{ + dcopy.Module( '10' ); // $ExpectError + dcopy.Module( true ); // $ExpectError + dcopy.Module( false ); // $ExpectError + dcopy.Module( null ); // $ExpectError + dcopy.Module( undefined ); // $ExpectError + dcopy.Module( [] ); // $ExpectError + dcopy.Module( {} ); // $ExpectError + dcopy.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 = dcopy.Module( mem ); + + mod.main( 10, 0, 1, 80, 1 ); // $ExpectType number +} + +// The compiler throws an error if the `main` method of a module instance is provided a first argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.main( '10', 10, 1, 80, 1 ); // $ExpectError + mod.main( true, 10, 1, 80, 1 ); // $ExpectError + mod.main( false, 10, 1, 80, 1 ); // $ExpectError + mod.main( null, 10, 1, 80, 1 ); // $ExpectError + mod.main( undefined, 10, 1, 80, 1 ); // $ExpectError + mod.main( [], 10, 1, 80, 1 ); // $ExpectError + mod.main( {}, 10, 1, 80, 1 ); // $ExpectError + mod.main( ( x: number ): number => x, 10, 1, 80, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided a second argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.main( 10, '10', 1, 80, 1 ); // $ExpectError + mod.main( 10, true, 1, 80, 1 ); // $ExpectError + mod.main( 10, false, 1, 80, 1 ); // $ExpectError + mod.main( 10, null, 1, 80, 1 ); // $ExpectError + mod.main( 10, undefined, 1, 80, 1 ); // $ExpectError + mod.main( 10, [], 1, 80, 1 ); // $ExpectError + mod.main( 10, {}, 1, 80, 1 ); // $ExpectError + mod.main( 10, ( x: number ): number => x, 1, 80, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided a third argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.main( 10, 0, '10', 80, 1 ); // $ExpectError + mod.main( 10, 0, true, 80, 1 ); // $ExpectError + mod.main( 10, 0, false, 80, 1 ); // $ExpectError + mod.main( 10, 0, null, 80, 1 ); // $ExpectError + mod.main( 10, 0, undefined, 80, 1 ); // $ExpectError + mod.main( 10, 0, [], 80, 1 ); // $ExpectError + mod.main( 10, 0, {}, 80, 1 ); // $ExpectError + mod.main( 10, 0, ( x: number ): number => x, 80, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided a fourth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.main( 10, 0, 1, '10', 1 ); // $ExpectError + mod.main( 10, 0, 1, true, 1 ); // $ExpectError + mod.main( 10, 0, 1, false, 1 ); // $ExpectError + mod.main( 10, 0, 1, null, 1 ); // $ExpectError + mod.main( 10, 0, 1, undefined, 1 ); // $ExpectError + mod.main( 10, 0, 1, [], 1 ); // $ExpectError + mod.main( 10, 0, 1, {}, 1 ); // $ExpectError + mod.main( 10, 0, 1, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided a fifth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.main( 10, 0, 1, 80, '10' ); // $ExpectError + mod.main( 10, 0, 1, 80, true ); // $ExpectError + mod.main( 10, 0, 1, 80, false ); // $ExpectError + mod.main( 10, 0, 1, 80, null ); // $ExpectError + mod.main( 10, 0, 1, 80, undefined ); // $ExpectError + mod.main( 10, 0, 1, 80, [] ); // $ExpectError + mod.main( 10, 0, 1, 80, {} ); // $ExpectError + mod.main( 10, 0, 1, 80, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided an unsupported number of arguments... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.main(); // $ExpectError + mod.main( 10 ); // $ExpectError + mod.main( 10, 0 ); // $ExpectError + mod.main( 10, 0, 1 ); // $ExpectError + mod.main( 10, 0, 1, 80 ); // $ExpectError + mod.main( 10, 0, 1, 80, 1, 10 ); // $ExpectError +} + +// The `Module` constructor returns a module instance having an `ndarray` method which returns a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.ndarray( 10, 0, 1, 0, 80, 1, 0 ); // $ExpectType number +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a first argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.ndarray( '10', 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( true, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( false, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( null, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( undefined, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( [], 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( {}, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( ( x: number ): number => x, 0, 1, 0, 80, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a second argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.ndarray( 10, '10', 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, true, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, false, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, null, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, undefined, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, [], 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, {}, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, ( x: number ): number => x, 1, 0, 80, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a third argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.ndarray( 10, 0, '10', 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, true, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, false, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, null, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, undefined, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, [], 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, {}, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, ( x: number ): number => x, 0, 80, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a fourth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.ndarray( 10, 0, 1, '10', 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, true, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, false, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, null, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, undefined, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, [], 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, {}, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, ( x: number ): number => x, 80, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a fifth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.ndarray( 10, 0, 1, 0, '10', 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, true, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, false, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, null, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, undefined, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, [], 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, {}, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a sixth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.ndarray( 10, 0, 1, 0, 80, '10', 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, true, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, false, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, null, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, undefined, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, [], 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, {}, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a seventh argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.ndarray( 10, 0, 1, 0, 80, 1, '10' ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, true ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, false ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, null ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, undefined ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, [] ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, {} ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided an unsupported number of arguments... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dcopy.Module( mem ); + + mod.ndarray(); // $ExpectError + mod.ndarray( 10 ); // $ExpectError + mod.ndarray( 10, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/examples/index.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/examples/index.js new file mode 100644 index 00000000000..823f058cdc7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/examples/index.js @@ -0,0 +1,46 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var oneTo = require( '@stdlib/array/one-to' ); +var ones = require( '@stdlib/array/ones' ); +var dcopy = require( './../lib' ); + +function main() { + if ( !hasWebAssemblySupport() ) { + console.error( 'Environment does not support WebAssembly.' ); + return; + } + // Specify a vector length: + var N = 5; + + // Create two arrays: + var x = oneTo( N, 'float64' ); + var y = ones( N, 'float64' ); + + // Perform computation: + dcopy.ndarray( N, x, 1, 0, y, 1, 0 ); + + // Print the results: + console.log( y ); + // => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/examples/little_endian_array.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/examples/little_endian_array.js new file mode 100644 index 00000000000..3f0d9de7da4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/examples/little_endian_array.js @@ -0,0 +1,74 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var Memory = require( '@stdlib/wasm/memory' ); +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; +var gfill = require( '@stdlib/blas/ext/base/gfill' ); +var gfillBy = require( '@stdlib/blas/ext/base/gfill-by' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +var Float64ArrayLE = require( '@stdlib/array/little-endian-float64' ); +var dcopy = 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 dcopy.Module( mem ); + // returns + + // Initialize the routine: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Define a vector data type: + var dtype = 'float64'; + + // Specify a vector length: + var N = 5; + + // Define pointers (i.e., byte offsets) for storing two vectors: + var xptr = 0; + var yptr = N * bytesPerElement( dtype ); + + // Create typed array views over module memory: + var x = new Float64ArrayLE( mod.memory.buffer, xptr, N ); + var y = new Float64ArrayLE( mod.memory.buffer, yptr, N ); + + // Write values to module memory: + gfillBy( N, x, 1, discreteUniform( -10.0, 10.0 ) ); + gfill( N, 1.0, y, 1 ); + + // Perform computation: + mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); + + // Print the results: + console.log( 'x[:] = [%s]', x.toString() ); + console.log( 'y[:] = [%s]', y.toString() ); +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/examples/module.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/examples/module.js new file mode 100644 index 00000000000..6b2bdc15fa6 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/examples/module.js @@ -0,0 +1,72 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var Memory = require( '@stdlib/wasm/memory' ); +var oneTo = require( '@stdlib/array/one-to' ); +var ones = require( '@stdlib/array/ones' ); +var zeros = require( '@stdlib/array/zeros' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +var dcopy = 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 dcopy.Module( mem ); + // returns + + // Initialize the routine: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Define a vector data type: + var dtype = 'float64'; + + // Specify a vector length: + var N = 5; + + // Define pointers (i.e., byte offsets) for storing two vectors: + var xptr = 0; + var yptr = N * bytesPerElement( dtype ); + + // Write vector values to module memory: + mod.write( xptr, oneTo( N, dtype ) ); + mod.write( yptr, ones( N, dtype ) ); + + // Perform computation: + mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); + + // Read out the results: + var view = zeros( N, dtype ); + mod.read( yptr, view ); + + console.log( view ); + // => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/binary.browser.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/binary.browser.js new file mode 100644 index 00000000000..abbc2704e08 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-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( 'AGFzbQEAAAAADwhkeWxpbmsuMAEEAAAAAAEWA2AAAGAFf39/f38AYAd/f39/f39/AAIPAQNlbnYGbWVtb3J5AgAAAwQDAAECB0wEEV9fd2FzbV9jYWxsX2N0b3JzAAAYX193YXNtX2FwcGx5X2RhdGFfcmVsb2NzAAAHY19kY29weQABD2NfZGNvcHlfbmRhcnJheQACCsYFAwMAAQs7AQJ+IAAgASACIAKsIgVCASAArCIGfX5CACAFQgBXG6cgAyAEIASsIgVCASAGfX5CACAFQgBXG6cQAguDBQEJfwJAIABBAEwNACACQQFGIAVBAUZxRQRAIABBBE8EQCAAQfz///8HcSEIIAUgBWoiCSAFaiIKIAVqIQsgAiACaiIMIAJqIg0gAmohDgNAIAQgBkEDdGogASADQQN0aisDADkDACAEIAUgBmpBA3RqIAEgAiADakEDdGorAwA5AwAgBCAGIAlqQQN0aiABIAMgDGpBA3RqKwMAOQMAIAQgBiAKakEDdGogASADIA1qQQN0aisDADkDACAGIAtqIQYgAyAOaiEDIAdBBGoiByAIRw0ACwsgAEEDcSIARQ0BQQAhBwNAIAQgBkEDdGogASADQQN0aisDADkDACAFIAZqIQYgAiADaiEDIAdBAWoiByAARw0ACwwBCyAAQQdwIgIiBwRAIAJBAWtBA08EQCAEQRhqIQkgAUEYaiEKIARBEGohCyABQRBqIQwgBEEIaiENIAFBCGohDiAHQQRxIQ8DQCAEIAZBA3QiAmogASADQQN0IgVqKwMAOQMAIAIgDWogBSAOaisDADkDACACIAtqIAUgDGorAwA5AwAgAiAJaiAFIApqKwMAOQMAIAZBBGohBiADQQRqIQMgCEEEaiIIIA9HDQALCyAHQQNxIgUEQEEAIQIDQCAEIAZBA3RqIAEgA0EDdGorAwA5AwAgBkEBaiEGIANBAWohAyACQQFqIgIgBUcNAAsLIABBB0gNAQsgACAHTA0AIAQgBkEDdGohAiABIANBA3RqIQEDQCACIAErAwA5AwAgAiABKwMIOQMIIAIgASsDEDkDECACIAErAxg5AxggAiABKwMgOQMgIAIgASsDKDkDKCACIAErAzA5AzAgB0EHaiIHIABIDQALCws=' ); + + +// EXPORTS // + +module.exports = wasm; diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/binary.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/binary.js new file mode 100644 index 00000000000..6f02393f96e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-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/dcopy-wasm/lib/index.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/index.js new file mode 100644 index 00000000000..b6dd58e4713 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/index.js @@ -0,0 +1,112 @@ +/** +* @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 copy values from `x` into `y`. +* +* @module @stdlib/blas/base/dcopy-wasm +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var dcopy = require( '@stdlib/blas/base/dcopy-wasm' ); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* dcopy.main( x.length, x, 1, y, 1 ); +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var dcopy = require( '@stdlib/blas/base/dcopy-wasm' ); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* dcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.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 dcopy = require( '@stdlib/blas/base/dcopy-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 dcopy.Module( mem ); +* // returns +* +* // Initialize the routine: +* mod.initializeSync(); +* +* // Define a vector data type: +* var dtype = 'float64'; +* +* // Specify a vector length: +* var N = 5; +* +* // Define pointers (i.e., byte offsets) for storing two vectors: +* var xptr = 0; +* var yptr = N * bytesPerElement( dtype ); +* +* // Write vector values to module memory: +* mod.write( xptr, oneTo( N, dtype ) ); +* mod.write( yptr, ones( N, dtype ) ); +* +* // Perform computation: +* mod.main( N, xptr, 1, yptr, 1 ); +* +* // Read out the results: +* var view = zeros( N, dtype ); +* mod.read( yptr, view ); +* +* console.log( view ); +* // => [ 1.0, 2.0, 3.0, 4.0, 5.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/dcopy-wasm/lib/main.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/main.js new file mode 100644 index 00000000000..67a14a191b6 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/main.js @@ -0,0 +1,62 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var Routine = require( './routine.js' ); + + +// MAIN // + +/** +* WebAssembly module to copy values from `x` into `y`. +* +* @name dcopy +* @type {Routine} +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* dcopy.main( x.length, x, 1, y, 1 ); +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* dcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +var dcopy = new Routine(); +dcopy.initializeSync(); // eslint-disable-line node/no-sync + + +// EXPORTS // + +module.exports = dcopy; diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/module.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/module.js new file mode 100644 index 00000000000..d3d15267184 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/module.js @@ -0,0 +1,244 @@ +/** +* @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 dcopy = new Module( mem ); +* // returns +* +* // Initialize the routine: +* dcopy.initializeSync(); +* +* // Define a vector data type: +* var dtype = 'float64'; +* +* // Specify a vector length: +* var N = 5; +* +* // Define pointers (i.e., byte offsets) for storing two vectors: +* var xptr = 0; +* var yptr = N * bytesPerElement( dtype ); +* +* // Write vector values to module memory: +* dcopy.write( xptr, oneTo( N, dtype ) ); +* dcopy.write( yptr, ones( N, dtype ) ); +* +* // Perform computation: +* var ptr = dcopy.main( N, xptr, 1, yptr, 1 ); +* // returns +* +* var bool = ( ptr === yptr ); +* // returns true +* +* // Read out the results: +* var view = zeros( N, dtype ); +* dcopy.read( yptr, view ); +* // view => [ 1.0, 2.0, 3.0, 4.0, 5.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 ); + +/** +* Copies values from `x` into `y`. +* +* @name main +* @memberof Module.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {NonNegativeInteger} xptr - input array pointer (i.e., byte offset) +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} yptr - output array pointer (i.e., byte offset) +* @param {integer} strideY - `y` stride length +* @returns {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 dcopy = new Module( mem ); +* // returns +* +* // Initialize the routine: +* dcopy.initializeSync(); +* +* // Define a vector data type: +* var dtype = 'float64'; +* +* // Specify a vector length: +* var N = 5; +* +* // Define pointers (i.e., byte offsets) for storing two vectors: +* var xptr = 0; +* var yptr = N * bytesPerElement( dtype ); +* +* // Write vector values to module memory: +* dcopy.write( xptr, oneTo( N, dtype ) ); +* dcopy.write( yptr, ones( N, dtype ) ); +* +* // Perform computation: +* var ptr = dcopy.main( N, xptr, 1, yptr, 1 ); +* // returns +* +* var bool = ( ptr === yptr ); +* // returns true +* +* // Read out the results: +* var view = zeros( N, dtype ); +* dcopy.read( yptr, view ); +* // view => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +setReadOnly( Module.prototype, 'main', function dcopy( N, xptr, strideX, yptr, strideY ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point + this._instance.exports.c_dcopy( N, xptr, strideX, yptr, strideY ); + return yptr; +}); + +/** +* Copies values from `x` into `y` using alternative indexing semantics. +* +* @name ndarray +* @memberof Module.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {NonNegativeInteger} xptr - input array pointer (i.e., byte offset) +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting `x` index +* @param {NonNegativeInteger} yptr - output array pointer (i.e., byte offset) +* @param {integer} strideY - `y` stride length +* @param {NonNegativeInteger} offsetY - starting `y` index +* @returns {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 dcopy = new Module( mem ); +* // returns +* +* // Initialize the routine: +* dcopy.initializeSync(); +* +* // Define a vector data type: +* var dtype = 'float64'; +* +* // Specify a vector length: +* var N = 5; +* +* // Define pointers (i.e., byte offsets) for storing two vectors: +* var xptr = 0; +* var yptr = N * bytesPerElement( dtype ); +* +* // Write vector values to module memory: +* dcopy.write( xptr, oneTo( N, dtype ) ); +* dcopy.write( yptr, ones( N, dtype ) ); +* +* // Perform computation: +* var ptr = dcopy.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); +* // returns +* +* var bool = ( ptr === yptr ); +* // returns true +* +* // Read out the results: +* var view = zeros( N, dtype ); +* dcopy.read( yptr, view ); +* // view => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +setReadOnly( Module.prototype, 'ndarray', function dcopy( N, xptr, strideX, offsetX, yptr, strideY, offsetY ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point + this._instance.exports.c_dcopy_ndarray( N, xptr, strideX, offsetX, yptr, strideY, offsetY ); // eslint-disable-line max-len + return yptr; +}); + + +// EXPORTS // + +module.exports = Module; diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/routine.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/routine.js new file mode 100644 index 00000000000..d314927e0e0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/lib/routine.js @@ -0,0 +1,185 @@ +/** +* @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 dcopy = new Routine(); +* +* // Initialize the module: +* dcopy.initializeSync(); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* dcopy.main( x.length, x, 1, y, 1 ); +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Create a new routine: +* var dcopy = new Routine(); +* +* // Initialize the module: +* dcopy.initializeSync(); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* dcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.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 ); + +/** +* Copies values from `x` into `y`. +* +* @name main +* @memberof Routine.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {Float64Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {Float64Array} y - output array +* @param {integer} strideY - `y` stride length +* @returns {Float64Array} output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Create a new routine: +* var dcopy = new Routine(); +* +* // Initialize the module: +* dcopy.initializeSync(); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* dcopy.main( x.length, x, 1, y, 1 ); +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +setReadOnly( Routine.prototype, 'main', function dcopy( N, x, strideX, y, strideY ) { + return this.ndarray( N, x, strideX, stride2offset( N, strideX ), y, strideY, stride2offset( N, strideY ) ); // eslint-disable-line max-len +}); + +/** +* Copies values from `x` into `y` using alternative indexing semantics. +* +* @name ndarray +* @memberof Routine.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {Float64Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting `x` index +* @param {Float64Array} y - output array +* @param {integer} strideY - `y` stride length +* @param {NonNegativeInteger} offsetY - starting `y` index +* @returns {Float64Array} output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* // Create a new routine: +* var dcopy = new Routine(); +* +* // Initialize the module: +* dcopy.initializeSync(); +* +* // Define strided arrays: +* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* dcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +setReadOnly( Routine.prototype, 'ndarray', function dcopy( N, x, strideX, offsetX, y, strideY, offsetY ) { + var ptrs; + var p0; + var p1; + + // Convert the input arrays to "pointers" in the module's memory: + ptrs = arrays2ptrs( this, [ + strided2object( N, x, strideX, offsetX ), + strided2object( N, y, strideY, offsetY ) + ]); + p0 = ptrs[ 0 ]; + p1 = ptrs[ 1 ]; + + // Perform computation by calling the corresponding parent method: + Module.prototype.ndarray.call( this, N, p0.ptr, p0.stride, p0.offset, p1.ptr, p1.stride, p1.offset ); // eslint-disable-line max-len + + // If the output array data had to be copied to module memory, copy the results to the provided output array... + if ( p1.copy ) { + readDataView( N, this.view, p1.stride*p1.BYTES_PER_ELEMENT, p1.ptr, y, strideY, offsetY, true ); // eslint-disable-line max-len + } + return y; +}); + + +// EXPORTS // + +module.exports = Routine; diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/manifest.json b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/manifest.json new file mode 100644 index 00000000000..6fa00568497 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-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/dcopy" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/package.json b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/package.json new file mode 100644 index 00000000000..db0068fce42 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/package.json @@ -0,0 +1,80 @@ +{ + "name": "@stdlib/blas/base/dcopy-wasm", + "version": "0.0.0", + "description": "Copy values from `x` into `y`.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "browser": { + "./lib/binary.js": "./lib/binary.browser.js" + }, + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "scripts": "./scripts", + "src": "./src", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "blas", + "level 1", + "dcopy", + "linear", + "algebra", + "subroutines", + "copy", + "vector", + "array", + "ndarray", + "float64", + "double", + "float64array", + "webassembly", + "wasm" + ], + "__stdlib__": { + "wasm": true + } +} diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/scripts/build.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/scripts/build.js new file mode 100644 index 00000000000..348354d7029 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-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/dcopy-wasm/scripts/template.txt b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/scripts/template.txt new file mode 100644 index 00000000000..12996dd89e3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-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/dcopy-wasm/src/Makefile b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/src/Makefile new file mode 100644 index 00000000000..0a3fc509ec1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-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_dcopy','_c_dcopy_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/dcopy-wasm/src/main.wasm b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/src/main.wasm new file mode 100755 index 0000000000000000000000000000000000000000..a1e47938ae6efd7a73665584f7365e94489aea0d GIT binary patch literal 863 zcmZ`%J&W5w5S`u8YGuo^ohBI4%x-lM2yR6h%WxmXLCTb}uw6vw?=uN5a#!4sNprs= zzbfF&NS1vBqGD#=47{25R!}@H74X-KW{1VM)x)Qu3Iwb7I02ZLXZc`atIU<|DV(pq zhs*hLy*p?C3=ovI_rbe7|G{kev{)?i>3+R?1Q?up#b&cO`*|=CkQ~ za{$#lRrzXG>~_Tgbo;kKW{p29{X{^DH0f7w#){z8hd-ajKxPbIKl~!3fP#ATw%^zB zi&3p-JtD~9J^|91x*@}1dmTtK_)?`m$K%m%T||aV>01)o99%3bOW%=@aBy85@v1Px zeaZKrLA1mc)) z$E}C!L}lRYf3K38m_hET7?d!8Fm#k~*p1iTvIlI;Lx$o;kPS-LA|i`r+0L^c}b_3meJ|eswzq`s(bwu`*k%)aZp#3 XBGuJZidS_tOmWE8*vjcUd8_y@t#6GU literal 0 HcmV?d00001 diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/src/main.wat b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/src/main.wat new file mode 100644 index 00000000000..abf7198d615 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/src/main.wat @@ -0,0 +1,416 @@ +;; @license Apache-2.0 +;; +;; Copyright (c) 2024 The Stdlib Authors. +;; +;; Licensed under the Apache License, Version 2.0 (the "License"); +;; you may not use this file except in compliance with the License. +;; You may obtain a copy of the License at +;; +;; http://www.apache.org/licenses/LICENSE-2.0 +;; +;; Unless required by applicable law or agreed to in writing, software +;; distributed under the License is distributed on an "AS IS" BASIS, +;; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +;; See the License for the specific language governing permissions and +;; limitations under the License. + +(module + (type (;0;) (func)) + (type (;1;) (func (param i32 i32 i32 i32 i32))) + (type (;2;) (func (param i32 i32 i32 i32 i32 i32 i32))) + (import "env" "memory" (memory (;0;) 0)) + (func (;0;) (type 0) + nop) + (func (;1;) (type 1) (param i32 i32 i32 i32 i32) + (local i64 i64) + local.get 0 + local.get 1 + local.get 2 + local.get 2 + i64.extend_i32_s + local.tee 5 + i64.const 1 + local.get 0 + i64.extend_i32_s + local.tee 6 + i64.sub + i64.mul + i64.const 0 + local.get 5 + i64.const 0 + i64.le_s + select + i32.wrap_i64 + local.get 3 + local.get 4 + local.get 4 + i64.extend_i32_s + local.tee 5 + i64.const 1 + local.get 6 + i64.sub + i64.mul + i64.const 0 + local.get 5 + i64.const 0 + i64.le_s + select + i32.wrap_i64 + call 2) + (func (;2;) (type 2) (param i32 i32 i32 i32 i32 i32 i32) + (local i32 i32 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 2 + i32.const 1 + i32.eq + local.get 5 + i32.const 1 + i32.eq + i32.and + i32.eqz + if ;; label = @2 + local.get 0 + i32.const 4 + i32.ge_u + if ;; label = @3 + local.get 0 + i32.const 2147483644 + i32.and + local.set 8 + local.get 5 + local.get 5 + i32.add + local.tee 9 + local.get 5 + i32.add + local.tee 10 + local.get 5 + i32.add + local.set 11 + local.get 2 + local.get 2 + i32.add + local.tee 12 + local.get 2 + i32.add + local.tee 13 + local.get 2 + i32.add + local.set 14 + loop ;; label = @4 + local.get 4 + local.get 6 + i32.const 3 + i32.shl + i32.add + local.get 1 + local.get 3 + i32.const 3 + i32.shl + i32.add + f64.load + f64.store + local.get 4 + local.get 5 + local.get 6 + i32.add + i32.const 3 + i32.shl + i32.add + local.get 1 + local.get 2 + local.get 3 + i32.add + i32.const 3 + i32.shl + i32.add + f64.load + f64.store + local.get 4 + local.get 6 + local.get 9 + i32.add + i32.const 3 + i32.shl + i32.add + local.get 1 + local.get 3 + local.get 12 + i32.add + i32.const 3 + i32.shl + i32.add + f64.load + f64.store + local.get 4 + local.get 6 + local.get 10 + i32.add + i32.const 3 + i32.shl + i32.add + local.get 1 + local.get 3 + local.get 13 + i32.add + i32.const 3 + i32.shl + i32.add + f64.load + f64.store + local.get 6 + local.get 11 + i32.add + local.set 6 + local.get 3 + local.get 14 + i32.add + local.set 3 + local.get 7 + i32.const 4 + i32.add + local.tee 7 + local.get 8 + 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 7 + loop ;; label = @3 + local.get 4 + local.get 6 + i32.const 3 + i32.shl + i32.add + local.get 1 + local.get 3 + i32.const 3 + i32.shl + i32.add + f64.load + f64.store + local.get 5 + local.get 6 + i32.add + local.set 6 + local.get 2 + local.get 3 + i32.add + local.set 3 + local.get 7 + i32.const 1 + i32.add + local.tee 7 + local.get 0 + i32.ne + br_if 0 (;@3;) + end + br 1 (;@1;) + end + local.get 0 + i32.const 7 + i32.rem_u + local.tee 2 + local.tee 7 + if ;; label = @2 + local.get 2 + i32.const 1 + i32.sub + i32.const 3 + i32.ge_u + if ;; label = @3 + local.get 4 + i32.const 24 + i32.add + local.set 9 + local.get 1 + i32.const 24 + i32.add + local.set 10 + local.get 4 + i32.const 16 + i32.add + local.set 11 + local.get 1 + i32.const 16 + i32.add + local.set 12 + local.get 4 + i32.const 8 + i32.add + local.set 13 + local.get 1 + i32.const 8 + i32.add + local.set 14 + local.get 7 + i32.const 4 + i32.and + local.set 15 + loop ;; label = @4 + local.get 4 + local.get 6 + i32.const 3 + i32.shl + local.tee 2 + i32.add + local.get 1 + local.get 3 + i32.const 3 + i32.shl + local.tee 5 + i32.add + f64.load + f64.store + local.get 2 + local.get 13 + i32.add + local.get 5 + local.get 14 + i32.add + f64.load + f64.store + local.get 2 + local.get 11 + i32.add + local.get 5 + local.get 12 + i32.add + f64.load + f64.store + local.get 2 + local.get 9 + i32.add + local.get 5 + local.get 10 + i32.add + f64.load + f64.store + local.get 6 + i32.const 4 + i32.add + local.set 6 + local.get 3 + i32.const 4 + i32.add + local.set 3 + local.get 8 + i32.const 4 + i32.add + local.tee 8 + local.get 15 + i32.ne + br_if 0 (;@4;) + end + end + local.get 7 + i32.const 3 + i32.and + local.tee 5 + if ;; label = @3 + i32.const 0 + local.set 2 + loop ;; label = @4 + local.get 4 + local.get 6 + i32.const 3 + i32.shl + i32.add + local.get 1 + local.get 3 + i32.const 3 + i32.shl + i32.add + f64.load + f64.store + local.get 6 + i32.const 1 + i32.add + local.set 6 + local.get 3 + i32.const 1 + i32.add + local.set 3 + local.get 2 + i32.const 1 + i32.add + local.tee 2 + local.get 5 + i32.ne + br_if 0 (;@4;) + end + end + local.get 0 + i32.const 7 + i32.lt_s + br_if 1 (;@1;) + end + local.get 0 + local.get 7 + i32.le_s + br_if 0 (;@1;) + local.get 4 + local.get 6 + i32.const 3 + i32.shl + i32.add + local.set 2 + local.get 1 + local.get 3 + i32.const 3 + i32.shl + i32.add + local.set 1 + loop ;; label = @2 + local.get 2 + local.get 1 + f64.load + f64.store + local.get 2 + local.get 1 + f64.load offset=8 + f64.store offset=8 + local.get 2 + local.get 1 + f64.load offset=16 + f64.store offset=16 + local.get 2 + local.get 1 + f64.load offset=24 + f64.store offset=24 + local.get 2 + local.get 1 + f64.load offset=32 + f64.store offset=32 + local.get 2 + local.get 1 + f64.load offset=40 + f64.store offset=40 + local.get 2 + local.get 1 + f64.load offset=48 + f64.store offset=48 + local.get 7 + i32.const 7 + i32.add + local.tee 7 + 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_dcopy" (func 1)) + (export "c_dcopy_ndarray" (func 2))) diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.js new file mode 100644 index 00000000000..b1b2bdebff6 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-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 dcopy = require( './../lib' ); + + +// TESTS // + +tape( 'main export is an object', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcopy, 'object', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is a `main` method', function test( t ) { + t.strictEqual( typeof dcopy.main, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is an `ndarray` method', function test( t ) { + t.strictEqual( typeof dcopy.ndarray, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is a `Module` constructor', function test( t ) { + t.strictEqual( typeof dcopy.Module, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'the main export is a `Module` instance', function test( t ) { + t.strictEqual( dcopy instanceof dcopy.Module, true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.main.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.main.js new file mode 100644 index 00000000000..21f633857b3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.main.js @@ -0,0 +1,259 @@ +/** +* @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 dcopy = require( './../lib' ); + + +// TESTS // + +tape( 'main export is an object', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcopy, 'object', 'main export is an object' ); + t.end(); +}); + +tape( 'the `main` method has an arity of 5', function test( t ) { + t.strictEqual( dcopy.main.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method copies values from `x` into `y`', function test( t ) { + var x; + var y; + + x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + + dcopy.main( x.length, x, 1, y, 1 ); + + t.deepEqual( y, x, 'returns expected value' ); + + // Short datasets: + x = new Float64Array( [ 1.0, 2.0 ] ); + y = new Float64Array( [ 1.0, 1.0 ] ); + + dcopy.main( x.length, x, 1, y, 1 ); + + t.deepEqual( y, x, 'returns expected value' ); + + t.end(); +}); + +tape( 'the `main` method supports an `x` stride', function test( t ) { + var expected; + var x; + var y; + var N; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + y = new Float64Array([ + 1.0, // 0 + 1.0, // 1 + 1.0, // 2 + 1.0, + 1.0 + ]); + N = 3; + + dcopy.main( N, x, 2, y, 1 ); + + expected = new Float64Array( [ 1.0, 3.0, 5.0, 1.0, 1.0 ] ); + + t.deepEqual( y, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method supports a `y` stride', function test( t ) { + var expected; + var x; + var y; + var N; + + x = new Float64Array([ + 1.0, // 0 + 2.0, // 1 + 3.0, // 2 + 4.0, + 5.0 + ]); + y = new Float64Array([ + 1.0, // 0 + 1.0, + 1.0, // 1 + 1.0, + 1.0 // 2 + ]); + N = 3; + + dcopy.main( N, x, 1, y, 2 ); + + expected = new Float64Array( [ 1.0, 1.0, 2.0, 1.0, 3.0 ] ); + + t.deepEqual( y, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method returns a reference to the output array', function test( t ) { + var out; + var x; + var y; + + x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + y = new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + + out = dcopy.main( x.length, x, 1, y, 1 ); + + t.strictEqual( out, y, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the `main` method returns the output array unchanged', function test( t ) { + var expected; + var x; + var y; + + x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + y = new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + + expected = new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + + dcopy.main( -1, x, 1, y, 1 ); + t.deepEqual( y, expected, 'returns expected value' ); + + dcopy.main( 0, x, 1, y, 1 ); + t.deepEqual( y, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the `main` method supports negative strides', function test( t ) { + var expected; + var x; + var y; + var N; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + y = new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ]); + N = 3; + + dcopy.main( N, x, -2, y, -1 ); + + expected = new Float64Array( [ 1.0, 3.0, 5.0, 9.0, 10.0 ] ); + + t.deepEqual( y, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method supports complex access patterns', function test( t ) { + var expected; + var x; + var y; + var N; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0, // 2 + 6.0 + ]); + y = new Float64Array([ + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 + 10.0, + 11.0, + 12.0 + ]); + N = 3; + + dcopy.main( N, x, 2, y, -1 ); + + expected = new Float64Array( [ 5.0, 3.0, 1.0, 10.0, 11.0, 12.0 ] ); + + t.deepEqual( y, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method supports view offsets', function test( t ) { + var expected; + var x0; + var y0; + var x1; + var y1; + + // Initial arrays... + x0 = new Float64Array([ + 1.0, + 2.0, // 2 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 0 + ]); + y0 = new Float64Array([ + 7.0, + 8.0, + 9.0, + 10.0, // 0 + 11.0, // 1 + 12.0 // 2 + ]); + + // Create offset views... + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // begin at 2nd element + y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // begin at the 4th element + + dcopy.main( 3, x1, -2, y1, 1 ); + expected = new Float64Array([ + 7.0, + 8.0, + 9.0, + 6.0, + 4.0, + 2.0 + ]); + + t.deepEqual( y0, expected, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.module.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.module.js new file mode 100644 index 00000000000..9adcb07e22f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-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/dcopy-wasm/test/test.module.main.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.module.main.js new file mode 100644 index 00000000000..b27dde88c69 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.module.main.js @@ -0,0 +1,337 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/* eslint-disable node/no-sync */ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Memory = require( '@stdlib/wasm/memory' ); +var Float64Array = require( '@stdlib/array/float64' ); +var Module = require( './../lib' ).Module; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof Module, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'a module instance has a `main` method which has an arity of 5', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = new Module( mem ); + t.strictEqual( mod.main.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'a module instance has a `main` method which copies values from `x` into `y`', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + mod.write( yp, new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ) ); + + expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + mod.main( 5, xp, 1, yp, 1 ); + + actual = new Float64Array( 5 ); + mod.read( yp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + // Short datasets: + xp = 0; + yp = 16; + + mod.write( xp, new Float64Array( [ 1.0, 2.0 ] ) ); + mod.write( yp, new Float64Array( [ 1.0, 1.0 ] ) ); + + expected = new Float64Array( [ 1.0, 2.0 ] ); + + mod.main( 2, xp, 1, yp, 1 ); + + actual = new Float64Array( 2 ); + mod.read( yp, 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 yp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ])); + mod.write( yp, new Float64Array([ + 1.0, // 0 + 1.0, // 1 + 1.0, // 2 + 1.0, + 1.0 + ])); + N = 3; + + mod.main( N, xp, 2, yp, 1 ); + + expected = new Float64Array( [ 1.0, 3.0, 5.0, 1.0, 1.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( yp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which supports a `y` stride', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var yp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, // 1 + 3.0, // 2 + 4.0, + 5.0 + ])); + mod.write( yp, new Float64Array([ + 1.0, // 0 + 1.0, + 1.0, // 1 + 1.0, + 1.0 // 2 + ])); + N = 3; + + mod.main( N, xp, 1, yp, 2 ); + + expected = new Float64Array( [ 1.0, 1.0, 2.0, 1.0, 3.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( yp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which returns a pointer to the output array', function test( t ) { + var out; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + mod.write( yp, new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ) ); + + out = mod.main( 5, xp, 1, yp, 1 ); + + t.strictEqual( out, yp, '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 output array unchanged', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + mod.write( yp, new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ) ); + + expected = new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + + mod.main( -1, xp, 1, yp, 1 ); + actual = new Float64Array( 5 ); + mod.read( yp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + mod.main( 0, xp, 1, yp, 1 ); + actual = new Float64Array( 5 ); + mod.read( yp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which supports negative strides', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var yp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ])); + mod.write( yp, new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ])); + N = 3; + + mod.main( N, xp, -2, yp, -1 ); + + expected = new Float64Array( [ 1.0, 3.0, 5.0, 9.0, 10.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( yp, 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 yp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 48; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0, // 2 + 6.0 + ])); + mod.write( 48, new Float64Array([ + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 + 10.0, + 11.0, + 12.0 + ])); + N = 3; + + mod.main( N, xp, 2, yp, -1 ); + + expected = new Float64Array( [ 5.0, 3.0, 1.0, 10.0, 11.0, 12.0 ] ); + + actual = new Float64Array( 6 ); + mod.read( yp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.module.ndarray.js new file mode 100644 index 00000000000..2d1eb2d7040 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.module.ndarray.js @@ -0,0 +1,427 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/* eslint-disable node/no-sync */ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Memory = require( '@stdlib/wasm/memory' ); +var Float64Array = require( '@stdlib/array/float64' ); +var Module = require( './../lib' ).Module; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof Module, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which has an arity of 7', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = new Module( mem ); + t.strictEqual( mod.ndarray.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which copies values from `x` into `y`', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + mod.write( yp, new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ) ); + + expected = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + mod.ndarray( 5, xp, 1, 0, yp, 1, 0 ); + + actual = new Float64Array( 5 ); + mod.read( yp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + // Short datasets: + xp = 0; + yp = 16; + + mod.write( xp, new Float64Array( [ 1.0, 2.0 ] ) ); + mod.write( yp, new Float64Array( [ 1.0, 1.0 ] ) ); + + expected = new Float64Array( [ 1.0, 2.0 ] ); + + mod.ndarray( 2, xp, 1, 0, yp, 1, 0 ); + + actual = new Float64Array( 2 ); + mod.read( yp, 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 yp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ])); + mod.write( yp, new Float64Array([ + 1.0, // 0 + 1.0, // 1 + 1.0, // 2 + 1.0, + 1.0 + ])); + N = 3; + + mod.ndarray( N, xp, 2, 0, yp, 1, 0 ); + + expected = new Float64Array( [ 1.0, 3.0, 5.0, 1.0, 1.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( yp, 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 yp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 1.0, + 2.0, + 3.0, // 0 + 4.0, // 1 + 5.0 // 2 + ])); + mod.write( yp, new Float64Array([ + 6.0, // 0 + 7.0, // 1 + 8.0, // 2 + 9.0, + 10.0 + ])); + N = 3; + + mod.ndarray( N, xp, 1, 2, yp, 1, 0 ); + + expected = new Float64Array( [ 3.0, 4.0, 5.0, 9.0, 10.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( yp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports a `y` stride', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var yp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, // 1 + 3.0, // 2 + 4.0, + 5.0 + ])); + mod.write( yp, new Float64Array([ + 1.0, // 0 + 1.0, + 1.0, // 1 + 1.0, + 1.0 // 2 + ])); + N = 3; + + mod.ndarray( N, xp, 1, 0, yp, 2, 0 ); + + expected = new Float64Array( [ 1.0, 1.0, 2.0, 1.0, 3.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( yp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports a `y` offset', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var yp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, // 1 + 3.0, // 2 + 4.0, + 5.0 + ])); + mod.write( yp, new Float64Array([ + 6.0, + 7.0, + 8.0, // 0 + 9.0, // 1 + 10.0 // 2 + ])); + N = 3; + + mod.ndarray( N, xp, 1, 0, yp, 1, 2 ); + + expected = new Float64Array( [ 6.0, 7.0, 1.0, 2.0, 3.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( yp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which returns a pointer to the output array', function test( t ) { + var out; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + mod.write( yp, new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ) ); + + out = mod.ndarray( 5, xp, 1, 0, yp, 1, 0 ); + + t.strictEqual( out, yp, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, a module instance has an `ndarray` method which leaves the output array unchanged', function test( t ) { + var expected; + var actual; + var mem; + var mod; + var xp; + var yp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) ); + mod.write( yp, new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ) ); + + expected = new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + + mod.ndarray( -1, xp, 1, 0, yp, 1, 0 ); + actual = new Float64Array( 5 ); + mod.read( yp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + mod.ndarray( 0, xp, 1, 0, yp, 1, 0 ); + actual = new Float64Array( 5 ); + mod.read( yp, 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 yp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 40; + + mod.write( xp, new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ])); + mod.write( yp, new Float64Array([ + 6.0, // 2 + 7.0, // 1 + 8.0, // 0 + 9.0, + 10.0 + ])); + N = 3; + + mod.ndarray( N, xp, -2, 4, yp, -1, 2 ); + + expected = new Float64Array( [ 1.0, 3.0, 5.0, 9.0, 10.0 ] ); + + actual = new Float64Array( 5 ); + mod.read( yp, 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 yp; + var N; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + yp = 48; + + mod.write( xp, new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0, // 2 + 6.0 + ])); + mod.write( yp, new Float64Array([ + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 + 10.0, + 11.0, + 12.0 + ])); + N = 3; + + mod.ndarray( N, xp, 2, 0, yp, -1, 2 ); + + expected = new Float64Array( [ 5.0, 3.0, 1.0, 10.0, 11.0, 12.0 ] ); + + actual = new Float64Array( 6 ); + mod.read( yp, actual ); + t.deepEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.ndarray.js new file mode 100644 index 00000000000..21683f631cd --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.ndarray.js @@ -0,0 +1,276 @@ +/** +* @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 dcopy = require( './../lib' ); + + +// TESTS // + +tape( 'main export is an object', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcopy, 'object', 'main export is an object' ); + t.end(); +}); + +tape( 'the `ndarray` method has an arity of 7', function test( t ) { + t.strictEqual( dcopy.ndarray.length, 7, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method copies values from `x` into `y`', function test( t ) { + var x; + var y; + + x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + + dcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); + + t.deepEqual( y, x, 'returns expected value' ); + + // Short datasets: + x = new Float64Array( [ 1.0, 2.0 ] ); + y = new Float64Array( [ 1.0, 1.0 ] ); + + dcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); + + t.deepEqual( y, x, 'returns expected value' ); + + t.end(); +}); + +tape( 'the `ndarray` method supports an `x` stride', function test( t ) { + var expected; + var x; + var y; + var N; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 2 + ]); + y = new Float64Array([ + 1.0, // 0 + 1.0, // 1 + 1.0, // 2 + 1.0, + 1.0 + ]); + N = 3; + + dcopy.ndarray( N, x, 2, 0, y, 1, 0 ); + + expected = new Float64Array( [ 1.0, 3.0, 5.0, 1.0, 1.0 ] ); + + t.deepEqual( y, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method supports an `x` offset', function test( t ) { + var expected; + var x; + var y; + var N; + + x = new Float64Array([ + 1.0, + 2.0, + 3.0, // 0 + 4.0, // 1 + 5.0 // 2 + ]); + y = new Float64Array([ + 6.0, // 0 + 7.0, // 1 + 8.0, // 2 + 9.0, + 10.0 + ]); + N = 3; + + dcopy.ndarray( N, x, 1, 2, y, 1, 0 ); + + expected = new Float64Array( [ 3.0, 4.0, 5.0, 9.0, 10.0 ] ); + + t.deepEqual( y, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method supports a `y` stride', function test( t ) { + var expected; + var x; + var y; + var N; + + x = new Float64Array([ + 1.0, // 0 + 2.0, // 1 + 3.0, // 2 + 4.0, + 5.0 + ]); + y = new Float64Array([ + 1.0, // 0 + 1.0, + 1.0, // 1 + 1.0, + 1.0 // 2 + ]); + N = 3; + + dcopy.ndarray( N, x, 1, 0, y, 2, 0 ); + + expected = new Float64Array( [ 1.0, 1.0, 2.0, 1.0, 3.0 ] ); + + t.deepEqual( y, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method supports a `y` offset', function test( t ) { + var expected; + var x; + var y; + var N; + + x = new Float64Array([ + 1.0, // 0 + 2.0, // 1 + 3.0, // 2 + 4.0, + 5.0 + ]); + y = new Float64Array([ + 6.0, + 7.0, + 8.0, // 0 + 9.0, // 1 + 10.0 // 2 + ]); + N = 3; + + dcopy.ndarray( N, x, 1, 0, y, 1, 2 ); + + expected = new Float64Array( [ 6.0, 7.0, 1.0, 2.0, 3.0 ] ); + + t.deepEqual( y, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method returns a reference to the output array', function test( t ) { + var out; + var x; + var y; + + x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + y = new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + + out = dcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); + + t.strictEqual( out, y, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the `ndarray` method returns the output array unchanged', function test( t ) { + var expected; + var x; + var y; + + x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + y = new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + + expected = new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + + dcopy.ndarray( -1, x, 1, 0, y, 1, 0 ); + t.deepEqual( y, expected, 'returns expected value' ); + + dcopy.ndarray( 0, x, 1, 0, y, 1, 0 ); + t.deepEqual( y, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the `ndarray` method supports negative strides', function test( t ) { + var expected; + var x; + var y; + var N; + + x = new Float64Array([ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]); + y = new Float64Array([ + 6.0, + 7.0, // 2 + 8.0, // 1 + 9.0, // 0 + 10.0 + ]); + N = 3; + + dcopy.ndarray( N, x, -2, x.length-1, y, -1, y.length-2 ); + + expected = new Float64Array( [ 6.0, 1.0, 3.0, 5.0, 10.0 ] ); + + t.deepEqual( y, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method supports complex access patterns', function test( t ) { + var expected; + var x; + var y; + var N; + + x = new Float64Array([ + 1.0, + 2.0, // 0 + 3.0, + 4.0, // 1 + 5.0, + 6.0 // 2 + ]); + y = new Float64Array([ + 7.0, + 8.0, + 9.0, + 10.0, // 2 + 11.0, // 1 + 12.0 // 0 + ]); + N = 3; + + dcopy.ndarray( N, x, 2, 1, y, -1, y.length-1 ); + + expected = new Float64Array( [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ] ); + + t.deepEqual( y, expected, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.routine.js b/lib/node_modules/@stdlib/blas/base/dcopy-wasm/test/test.routine.js new file mode 100644 index 00000000000..56a4b67daaf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dcopy-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(); +});