From 512592bca7297d7e7689e7e529da5735b7307b1c Mon Sep 17 00:00:00 2001 From: ShabiShett07 Date: Wed, 23 Apr 2025 14:49:55 +0530 Subject: [PATCH 1/3] feat: add blas/base/wasm/dznrm2 --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../@stdlib/blas/base/wasm/dznrm2/README.md | 315 +++++++++++ .../base/wasm/dznrm2/benchmark/benchmark.js | 111 ++++ .../wasm/dznrm2/benchmark/benchmark.module.js | 66 +++ .../dznrm2/benchmark/benchmark.module.main.js | 138 +++++ .../benchmark/benchmark.module.ndarray.js | 138 +++++ .../dznrm2/benchmark/benchmark.ndarray.js | 111 ++++ .../blas/base/wasm/dznrm2/docs/repl.txt | 499 ++++++++++++++++++ .../base/wasm/dznrm2/docs/types/index.d.ts | 322 +++++++++++ .../blas/base/wasm/dznrm2/docs/types/test.ts | 348 ++++++++++++ .../blas/base/wasm/dznrm2/examples/index.js | 50 ++ .../dznrm2/examples/little_endian_arrays.js | 65 +++ .../blas/base/wasm/dznrm2/examples/module.js | 63 +++ .../base/wasm/dznrm2/lib/binary.browser.js | 33 ++ .../blas/base/wasm/dznrm2/lib/binary.js | 34 ++ .../blas/base/wasm/dznrm2/lib/index.js | 99 ++++ .../@stdlib/blas/base/wasm/dznrm2/lib/main.js | 61 +++ .../blas/base/wasm/dznrm2/lib/module.js | 198 +++++++ .../blas/base/wasm/dznrm2/lib/routine.js | 166 ++++++ .../blas/base/wasm/dznrm2/manifest.json | 36 ++ .../blas/base/wasm/dznrm2/package.json | 79 +++ .../blas/base/wasm/dznrm2/scripts/build.js | 66 +++ .../base/wasm/dznrm2/scripts/template.txt | 33 ++ .../blas/base/wasm/dznrm2/src/Makefile | 243 +++++++++ .../blas/base/wasm/dznrm2/src/exports.json | 4 + .../blas/base/wasm/dznrm2/src/main.wasm | Bin 0 -> 719 bytes .../blas/base/wasm/dznrm2/src/main.wat | 261 +++++++++ .../blas/base/wasm/dznrm2/test/test.js | 53 ++ .../blas/base/wasm/dznrm2/test/test.main.js | 170 ++++++ .../blas/base/wasm/dznrm2/test/test.module.js | 154 ++++++ .../base/wasm/dznrm2/test/test.module.main.js | 197 +++++++ .../wasm/dznrm2/test/test.module.ndarray.js | 232 ++++++++ .../base/wasm/dznrm2/test/test.ndarray.js | 168 ++++++ .../base/wasm/dznrm2/test/test.routine.js | 71 +++ 33 files changed, 4584 insertions(+) create mode 100755 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/README.md create mode 100755 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.js create mode 100755 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.js create mode 100755 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.main.js create mode 100755 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.ndarray.js create mode 100755 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.ndarray.js create mode 100755 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/repl.txt create mode 100755 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/index.d.ts create mode 100755 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/little_endian_arrays.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/module.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/binary.browser.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/binary.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/module.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/routine.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/manifest.json create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/package.json create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/scripts/build.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/scripts/template.txt create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/Makefile create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/exports.json create mode 100755 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/main.wasm create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/main.wat create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.routine.js diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/README.md b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/README.md new file mode 100755 index 000000000000..289f300a1fa3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/README.md @@ -0,0 +1,315 @@ + + +# dznrm2 + +> Calculate the L2-norm of a complex double-precision floating-point vector. + +
+ +## Usage + +```javascript +var dznrm2 = require( '@stdlib/blas/base/wasm/dznrm2' ); +``` + +#### dznrm2.main( N, x, strideX ) + +Calculates the L2-norm of a complex double-precision floating-point vector. + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); + +var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + +var z = dznrm2.main( 3, x, 1 ); +// returns ~9.54 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **x**: input [`Complex128Array`][@stdlib/array/complex128]. +- **strideX**: index increment for `x`. + +The `N` and stride parameters determine which elements in the input strided array are accessed at runtime. For example, to compute the L2-norm of every other element in `x`, + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); + +var x = new Complex128Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); + +var z = dznrm2.main( 2, x, 2 ); +// returns ~4.24 +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + + + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); + +// Initial array: +var x0 = new Complex128Array( [ 2.0, 1.0, 2.0, 2.0, -2.0, -2.0, 2.0, 3.0 ] ); + +// Create a typed array view: +var x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +var z = dznrm2.main( 2, x1, 2 ); +// returns ~4.58 +``` + +#### dznrm2.ndarray( N, x, strideX, offsetX ) + +Calculates the L2-norm of a complex double-precision floating-point vector using alternative indexing semantics. + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); + +var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + +var z = dznrm2.ndarray( 3, x, 1, 0 ); +// returns ~9.54 +``` + +The function has the following additional parameters: + +- **offsetX**: starting index for `x`. + +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the L2-norm for every other value in `x` starting from the second value, + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); + +var x = new Complex128Array( [ 2.0, 1.0, 2.0, 2.0, -2.0, -2.0, 2.0, 3.0 ] ); + +var z = dznrm2.ndarray( 2, x, 2, 1 ); +// returns ~4.58 +``` + +* * * + +### Module + +#### dznrm2.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 dznrm2.Module( mem ); +// returns + +// Initialize the routine: +mod.initializeSync(); +``` + +#### dznrm2.Module.prototype.main( N, xp, sx ) + +Computes the L2-norm of a complex double-precision floating-point vector. + + + +```javascript +var Memory = require( '@stdlib/wasm/memory' ); +var oneTo = require( '@stdlib/array/one-to' ); +var Complex128Array = require( '@stdlib/array/complex128' ); + +// 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 dznrm2.Module( mem ); +// returns + +// Initialize the routine: +mod.initializeSync(); + +// Define a vector data type: +var dtype = 'complex128'; + +// Specify a vector length: +var N = 5; + +// Define a pointer (i.e., byte offset) for storing the input vector: +var xptr = 0; + +// Write vector values to module memory: +var xbuf = oneTo( N*2, 'float64' ); +var x = new Complex128Array( xbuf.buffer ); +mod.write( xptr, x ); + +// Perform computation: +var out = mod.main( N, xptr, 1 ); +// returns ~19.62 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **xp**: input [`Complex128Array`][@stdlib/array/complex128] pointer (i.e., byte offset). +- **sx**: index increment for `x`. + +#### dznrm2.Module.prototype.ndarray( N, xp, sx, ox ) + +Computes the L2-norm of a complex double-precision floating-point vector using alternative indexing semantics. + + + +```javascript +var Memory = require( '@stdlib/wasm/memory' ); +var oneTo = require( '@stdlib/array/one-to' ); +var Complex128Array = require( '@stdlib/array/complex128' ); + +// 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 dznrm2.Module( mem ); +// returns + +// Initialize the routine: +mod.initializeSync(); + +// Define a vector data type: +var dtype = 'complex128'; + +// Specify a vector length: +var N = 5; + +// Define a pointer (i.e., byte offset) for storing the input vector: +var xptr = 0; + +// Write vector values to module memory: +var xbuf = oneTo( N*2, 'float64' ); +var x = new Complex128Array( xbuf.buffer ); +mod.write( xptr, x ); + +// Perform computation: +var out = mod.ndarray( N, xptr, 1, 0 ); +// returns ~19.62 +``` + +The function has the following additional parameters: + +- **ox**: starting index for `x`. + +
+ + + +
+ +* * * + +## Notes + +- If `N <= 0`, both `main` and `ndarray` methods return `0.0`. +- This package implements routines using WebAssembly. When provided arrays which are not allocated on a `dznrm2` 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/dznrm2`][@stdlib/blas/base/dznrm2]. 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/dznrm2`][@stdlib/blas/base/dznrm2]. 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. +- `dznrm2()` corresponds to the [BLAS][blas] level 1 function [`dznrm2`][dznrm2]. + +
+ + + +
+ +* * * + +## Examples + + + +```javascript +var oneTo = require( '@stdlib/array/one-to' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var dznrm2 = require( '@stdlib/blas/base/wasm/dznrm2' ); + +function main() { + var xbuf; + var out; + var x; + var N; + + // Specify a vector length: + N = 5; + + // Create an input array: + xbuf = oneTo( N*2, 'float64' ); + x = new Complex128Array( xbuf.buffer ); + + // Perform computation: + out = dznrm2.ndarray( N, x, 1, 0 ); + + // Print the result: + console.log( out ); +} +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[blas]: http://www.netlib.org/blas + +[dznrm2]: https://www.netlib.org/lapack/explore-html/d1/d2a/group__nrm2_ga7f9f9febc6dc1836c9f5e7c1aa00b743.html + +[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray + +[@stdlib/array/complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex128 + +[@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/dznrm2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dznrm2 + +
+ + diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.js new file mode 100755 index 000000000000..f5f2e305e89c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.js @@ -0,0 +1,111 @@ +/** +* @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 Complex128Array = require( '@stdlib/array/complex128' ); +var pkg = require( './../package.json' ).name; +var dznrm2 = 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 xbuf; + var x; + + xbuf = uniform( len*2, -100.0, 100.0, options ); + x = new Complex128Array( xbuf.buffer ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + dznrm2.main( x.length, x, 1 ); + if ( isnan( xbuf[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( xbuf[ i%(len*2) ] ) ) { + 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/wasm/dznrm2/benchmark/benchmark.module.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.js new file mode 100755 index 000000000000..0f4fa6393e38 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/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 dznrm2 = 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 dznrm2.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/wasm/dznrm2/benchmark/benchmark.module.main.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.main.js new file mode 100755 index 000000000000..baa567091c76 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/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 isnanf = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var dznrm2 = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var byteOffset; + var view; + var xptr; + var mod; + var mem; + var nb; + var N; + var i; + + N = len * 2; + + // Create a new BLAS routine interface: + mem = new Memory({ + 'initial': 0 + }); + mod = new dznrm2.Module( mem ); + + // Initialize the module: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Reallocate the underlying memory to allow storing one vector and a complex number: + nb = bytesPerElement( 'complex128' ); + mod.realloc( (N*nb)+nb ); + + // Define a pointer (i.e., byte offset) to the first vector element: + xptr = 0; + + // Write random values to module memory: + mod.write( xptr, uniform( N, -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 ); + byteOffset = xptr + ( (i%len)*nb ); + if ( isnanf( view.getFloat64( byteOffset, true ) ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( 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/wasm/dznrm2/benchmark/benchmark.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.ndarray.js new file mode 100755 index 000000000000..880969922ebe --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/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 dznrm2 = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var byteOffset; + var view; + var xptr; + var mod; + var mem; + var nb; + var N; + var i; + + N = len * 2; + + // Create a new BLAS routine interface: + mem = new Memory({ + 'initial': 0 + }); + mod = new dznrm2.Module( mem ); + + // Initialize the module: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Reallocate the underlying memory to allow storing one vector and a complex number: + nb = bytesPerElement( 'complex128' ); + mod.realloc( (N*nb)+nb ); + + // Define a pointer (i.e., byte offset) to the first vector element: + xptr = 0; + + // Write random values to module memory: + mod.write( xptr, uniform( N, -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 ); + byteOffset = xptr + ( (i%len)*nb ); + if ( isnan( view.getFloat64( byteOffset, true ) ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( view.getFloat64( byteOffset, true ) ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+'::module,pointers:ndarray:len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.ndarray.js new file mode 100755 index 000000000000..e15510512872 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.ndarray.js @@ -0,0 +1,111 @@ +/** +* @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 Complex128Array = require( '@stdlib/array/complex128' ); +var pkg = require( './../package.json' ).name; +var dznrm2 = 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 xbuf; + var x; + + xbuf = uniform( len*2, -100.0, 100.0, options ); + x = new Complex128Array( xbuf.buffer ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + dznrm2.ndarray( x.length, x, 1, 0 ); + if ( isnan( xbuf[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( xbuf[ i%(len*2) ] ) ) { + 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/wasm/dznrm2/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/repl.txt new file mode 100755 index 000000000000..3ca8d994b08a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/repl.txt @@ -0,0 +1,499 @@ + +{{alias}}.main( N, x, strideX ) + Computes the L2-norm of a complex double-precision floating-point vector. + + The `N` and stride parameters determine which elements in the strided arrays + are accessed at runtime. + + Indexing is relative to the first index. To introduce an offset, use typed + array views. + + If `N <= 0`, the function returns `0.0`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Complex128Array + Input array. + + strideX: integer + Index increment for `x`. + + Returns + ------- + out: number + The L2-norm. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, -2.0, 2.0, 1.0 ] ); + > var out = {{alias}}.main( x.length, x, 1 ) + ~3.16 + + // Using `N` and stride parameters: + > x = new {{alias:@stdlib/array/complex128}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] ); + > out = {{alias}}.main( 2, x, 2 ) + ~3.16 + + // Using view offsets: + > var x0 = new {{alias:@stdlib/array/complex128}}( [ 3.0, 2.0, 1.0, -2.0 ] ); + > var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > out = {{alias}}.main( 1, x1, 1 ) + ~2.24 + + +{{alias}}.ndarray( N, x, strideX, offsetX ) + Computes the L2-norm of a complex double-precision floating-point vector + 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: Complex128Array + Input array. + + strideX: integer + Index increment for `x`. + + offsetX: integer + Starting index for `x`. + + Returns + ------- + out: number + The L2-norm. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, -2.0, 2.0, 1.0 ] ); + > var out = {{alias}}.ndarray( x.length, x, 1, 0 ) + ~3.16 + + // Using offset parameter: + > var x = new {{alias:@stdlib/array/complex128}}( [ 3.0, 2.0, 3.0, 0.0 ] ); + > out = {{alias}}.ndarray( 1, x, 1, 1 ) + 3.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 double-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 + double-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 + Complex128Array, the function reads each element as a double-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 + double-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 ) + Computes the L2-norm of a complex double-precision floating-point vector. + + Parameters + ---------- + N: integer + Number of indexed elements. + + xp: integer + Input array pointer (i.e., byte offset). + + sx: integer + Index increment for `x`. + + Returns + ------- + out: number + The L2-norm. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 1 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + + // Define a "pointer" (i.e., byte offset) into module memory: + > var xptr = 0; + + // Write data to module memory: + > var xbuf = {{alias:@stdlib/array/one-to}}( 10, 'float64' ); + > var x = new {{alias:@stdlib/array/complex128}}( xbuf.buffer ); + > mod.write( xptr, x ); + + // Perform computation: + > var out = mod.main( 5, xptr, 1 ) + ~19.62 + + +{{alias}}.Module.prototype.ndarray( N, xp, sx, ox ) + Computes the L2-norm of a complex double-precision floating-point vector + 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`. + + Returns + ------- + out: number + The L2-norm. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 1 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + + // Define a "pointer" (i.e., byte offset) into module memory: + > var xptr = 0; + + // Write data to module memory: + > var xbuf = {{alias:@stdlib/array/one-to}}( 10, 'float64' ); + > var x = new {{alias:@stdlib/array/complex128}}( xbuf.buffer ); + > mod.write( xptr, x ); + + // Perform computation: + > var out = mod.ndarray( 5, xptr, 1, 0 ) + ~19.62 + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/index.d.ts new file mode 100755 index 000000000000..c133a8692814 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/index.d.ts @@ -0,0 +1,322 @@ +/* +* @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'; +import { Complex128Array } from '@stdlib/types/array'; + +/** +* 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 Complex128Array = require( '@stdlib/array/complex128' ); + * + * // 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 dznrm2.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointer (i.e., byte offsets) for storing two vectors: + * var xptr = 0; + * + * // Write vector values to module memory: + * var xbuf = oneTo( N*2, 'float64' ); + * var x = new Complex128Array( xbuf.buffer ); + * mod.write( xptr, x ); + * + * // Perform computation: + * var out = mod.main( N, xptr, 1 ); + * // returns ~19.62 + */ + 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 Complex128Array = require( '@stdlib/array/complex128' ); + * + * // 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 = dznrm2.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointer (i.e., byte offsets) for storing two vectors: + * var xptr = 0; + * + * // Write vector values to module memory: + * var xbuf = oneTo( N*2, 'float64' ); + * var x = new Complex128Array( xbuf.buffer ); + * mod.write( xptr, x ); + * + * // Perform computation: + * var out = mod.main( N, xptr, 1 ); + * // returns ~19.62 + */ + ( mem: Memory ): Module; // callable +} + +/** +* Interface describing a `dznrm2` WebAssembly module. +*/ +interface Module extends ModuleWrapper { + /** + * Computes the L2-norm of a complex double-precision floating-point vector. + * + * @param N - number of indexed elements + * @param xptr - input array pointer (i.e., byte offset) + * @param strideX - `x` stride length + * @returns L2-norm + * + * @example + * var Memory = require( '@stdlib/wasm/memory' ); + * var oneTo = require( '@stdlib/array/one-to' ); + * var Complex128Array = require( '@stdlib/array/complex128' ); + * + * // 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 dznrm2.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointer (i.e., byte offsets) for storing the input vector: + * var xptr = 0; + * + * // Write vector values to module memory: + * var xbuf = oneTo( N*2, 'float64' ); + * var x = new Complex128Array( xbuf.buffer ); + * mod.write( xptr, x ); + * + * // Perform computation: + * var out = mod.main( N, xptr, 1 ); + * // returns ~19.62 + */ + main( N: number, xptr: number, strideX: number ): number; + + /** + * Computes the L2-norm of a complex double-precision floating-point vector 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` + * @returns L2-norm + * + * @example + * var Memory = require( '@stdlib/wasm/memory' ); + * var oneTo = require( '@stdlib/array/one-to' ); + * var Complex128Array = require( '@stdlib/array/complex128' ); + * + * // 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 dznrm2.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointer (i.e., byte offsets) for storing the input vector: + * var xptr = 0; + * + * // Write vector values to module memory: + * var xbuf = oneTo( N*2, 'float64' ); + * var x = new Complex128Array( xbuf.buffer ); + * mod.write( xptr, x ); + * + * // Perform computation: + * var out = mod.ndarray( N, xptr, 1, 0 ); + * // returns ~19.62 + */ + ndarray( N: number, xptr: number, strideX: number, offsetX: number ): number; +} + +/** +* Interface describing `dznrm2`. +*/ +interface Routine extends ModuleWrapper { + /** + * Computes the L2-norm of a complex double-precision floating-point vector. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - `x` stride length + * @returns L2-norm + * + * @example + * var Complex128Array = require( '@stdlib/array/complex128' ); + * + * // Define a strided array: + * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * + * // Perform operation: + * var out = dznrm2.main( x.length, x, 1 ); + * // returns ~9.53 + */ + main( N: number, x: Complex128Array, strideX: number ): number; + + /** + * Computes the L2-norm of a complex double-precision floating-point vector 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` + * @returns L2-norm + * + * @example + * var Complex128Array = require( '@stdlib/array/complex128' ); + * + * // Define a strided array: + * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * + * var out = dznrm2.ndarray( x.length, x, 1, 0 ); + * // returns ~9.53 + */ + ndarray( N: number, x: Complex128Array, strideX: number, offsetX: number ): number; + + /** + * 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 Complex128Array = require( '@stdlib/array/complex128' ); + * + * // 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 dznrm2.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointer (i.e., byte offsets) for storing the input vector: + * var xptr = 0; + * + * // Write vector values to module memory: + * var xbuf = oneTo( N*2, 'float64' ); + * var x = new Complex128Array( xbuf.buffer ); + * mod.write( xptr, x ); + * + * // Perform computation: + * var out = mod.main( N, xptr, 1 ); + * // returns ~19.62 + */ + Module: ModuleConstructor; +} + +/** +* Computes the L2-norm of a complex double-precision floating-point vector. +* +* @param N - number of indexed elements +* @param x - input array +* @param strideX - `x` stride length +* @returns L2-norm +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* +* // Define a strided array: +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* var out = dznrm2.main( x.length, x, 1 ); +* // returns ~9.53 +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* +* // Define a strided array: +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* var out = dznrm2.ndarray( x.length, x, 1, 0 ); +* // returns ~9.53 +*/ +declare var dznrm2: Routine; + + +// EXPORTS // + +export = dznrm2; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/test.ts new file mode 100755 index 000000000000..1771a9f1b3e9 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/test.ts @@ -0,0 +1,348 @@ +/* +* @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 Complex128Array = require( '@stdlib/array/complex128' ); +import Memory = require( '@stdlib/wasm/memory' ); +import dznrm2 = require( './index' ); + + +// TESTS // + +// Attached to the main export is a `main` method which returns a number... +{ + const x = new Complex128Array( 10 ); + + dznrm2.main( x.length, x, 1 ); // $ExpectType number +} + +// The compiler throws an error if the `main` method is provided a first argument which is not a number... +{ + const x = new Complex128Array( 10 ); + + dznrm2.main( '10', x, 1 ); // $ExpectError + dznrm2.main( true, x, 1 ); // $ExpectError + dznrm2.main( false, x, 1 ); // $ExpectError + dznrm2.main( null, x, 1 ); // $ExpectError + dznrm2.main( undefined, x, 1 ); // $ExpectError + dznrm2.main( [], x, 1 ); // $ExpectError + dznrm2.main( {}, x, 1 ); // $ExpectError + dznrm2.main( ( x: number ): number => x, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a second argument which is not a Complex128Array... +{ + const x = new Complex128Array( 10 ); + + dznrm2.main( x.length, 10, 1 ); // $ExpectError + dznrm2.main( x.length, '10', 1 ); // $ExpectError + dznrm2.main( x.length, true, 1 ); // $ExpectError + dznrm2.main( x.length, false, 1 ); // $ExpectError + dznrm2.main( x.length, null, 1 ); // $ExpectError + dznrm2.main( x.length, undefined, 1 ); // $ExpectError + dznrm2.main( x.length, [], 1 ); // $ExpectError + dznrm2.main( x.length, {}, 1 ); // $ExpectError + dznrm2.main( x.length, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a third argument which is not a number... +{ + const x = new Complex128Array( 10 ); + + dznrm2.main( x.length, x, '10' ); // $ExpectError + dznrm2.main( x.length, x, true ); // $ExpectError + dznrm2.main( x.length, x, false ); // $ExpectError + dznrm2.main( x.length, x, null ); // $ExpectError + dznrm2.main( x.length, x, undefined ); // $ExpectError + dznrm2.main( x.length, x, [] ); // $ExpectError + dznrm2.main( x.length, x, {} ); // $ExpectError + dznrm2.main( x.length, x, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided an unsupported number of arguments... +{ + const x = new Complex128Array( 10 ); + + dznrm2.main(); // $ExpectError + dznrm2.main( x.length ); // $ExpectError + dznrm2.main( x.length, x ); // $ExpectError + dznrm2.main( x.length, x, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a number... +{ + const x = new Complex128Array( 10 ); + + dznrm2.ndarray( x.length, x, 1, 0 ); // $ExpectType number +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Complex128Array( 10 ); + + dznrm2.ndarray( '10', x, 1, 0 ); // $ExpectError + dznrm2.ndarray( true, x, 1, 0 ); // $ExpectError + dznrm2.ndarray( false, x, 1, 0 ); // $ExpectError + dznrm2.ndarray( null, x, 1, 0 ); // $ExpectError + dznrm2.ndarray( undefined, x, 1, 0 ); // $ExpectError + dznrm2.ndarray( [], x, 1, 0 ); // $ExpectError + dznrm2.ndarray( {}, x, 1, 0 ); // $ExpectError + dznrm2.ndarray( ( x: number ): number => x, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Complex128Array... +{ + const x = new Complex128Array( 10 ); + + dznrm2.ndarray( x.length, 10, 1, 0 ); // $ExpectError + dznrm2.ndarray( x.length, '10', 1, 0 ); // $ExpectError + dznrm2.ndarray( x.length, true, 1, 0 ); // $ExpectError + dznrm2.ndarray( x.length, false, 1, 0 ); // $ExpectError + dznrm2.ndarray( x.length, null, 1, 0 ); // $ExpectError + dznrm2.ndarray( x.length, undefined, 1, 0 ); // $ExpectError + dznrm2.ndarray( x.length, [], 1, 0 ); // $ExpectError + dznrm2.ndarray( x.length, {}, 1, 0 ); // $ExpectError + dznrm2.ndarray( x.length, ( x: number ): number => x, 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 Complex128Array( 10 ); + + dznrm2.ndarray( x.length, x, '10', 0 ); // $ExpectError + dznrm2.ndarray( x.length, x, true, 0 ); // $ExpectError + dznrm2.ndarray( x.length, x, false, 0 ); // $ExpectError + dznrm2.ndarray( x.length, x, null, 0 ); // $ExpectError + dznrm2.ndarray( x.length, x, undefined, 0 ); // $ExpectError + dznrm2.ndarray( x.length, x, [], 0 ); // $ExpectError + dznrm2.ndarray( x.length, x, {}, 0 ); // $ExpectError + dznrm2.ndarray( x.length, x, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + const x = new Complex128Array( 10 ); + + dznrm2.ndarray( x.length, x, 1, '10' ); // $ExpectError + dznrm2.ndarray( x.length, x, 1, true ); // $ExpectError + dznrm2.ndarray( x.length, x, 1, false ); // $ExpectError + dznrm2.ndarray( x.length, x, 1, null ); // $ExpectError + dznrm2.ndarray( x.length, x, 1, undefined ); // $ExpectError + dznrm2.ndarray( x.length, x, 1, [] ); // $ExpectError + dznrm2.ndarray( x.length, x, 1, {} ); // $ExpectError + dznrm2.ndarray( x.length, x, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const x = new Complex128Array( 10 ); + + dznrm2.ndarray(); // $ExpectError + dznrm2.ndarray( x.length ); // $ExpectError + dznrm2.ndarray( x.length, x ); // $ExpectError + dznrm2.ndarray( x.length, x, 1 ); // $ExpectError + dznrm2.ndarray( x.length, x, 1, 0, 10 ); // $ExpectError +} + +// Attached to the main export is a `Module` constructor which returns a module... +{ + const mem = new Memory({ + 'initial': 0 + }); + + dznrm2.Module( mem ); // $ExpectType Module +} + +// The compiler throws an error if the `Module` constructor is not provided a WebAssembly memory instance... +{ + dznrm2.Module( '10' ); // $ExpectError + dznrm2.Module( true ); // $ExpectError + dznrm2.Module( false ); // $ExpectError + dznrm2.Module( null ); // $ExpectError + dznrm2.Module( undefined ); // $ExpectError + dznrm2.Module( [] ); // $ExpectError + dznrm2.Module( {} ); // $ExpectError + dznrm2.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 = dznrm2.Module( mem ); + + mod.main( 10, 0, 1 ); // $ExpectType number +} + +// The compiler throws an error if the `main` method of a module instance is provided a first argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dznrm2.Module( mem ); + + mod.main( '10', 0, 10 ); // $ExpectError + mod.main( true, 0, 10 ); // $ExpectError + mod.main( false, 0, 10 ); // $ExpectError + mod.main( null, 0, 10 ); // $ExpectError + mod.main( undefined, 0, 10 ); // $ExpectError + mod.main( [], 0, 10 ); // $ExpectError + mod.main( {}, 0, 10 ); // $ExpectError + mod.main( ( x: number ): number => x, 0, 10 ); // $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 = dznrm2.Module( mem ); + + mod.main( 10, '10', 1 ); // $ExpectError + mod.main( 10, true, 1 ); // $ExpectError + mod.main( 10, false, 1 ); // $ExpectError + mod.main( 10, null, 1 ); // $ExpectError + mod.main( 10, undefined, 1 ); // $ExpectError + mod.main( 10, [], 1 ); // $ExpectError + mod.main( 10, {}, 1 ); // $ExpectError + mod.main( 10, ( x: number ): number => x, 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 = dznrm2.Module( mem ); + + mod.main( 10, 0, '10' ); // $ExpectError + mod.main( 10, 0, true ); // $ExpectError + mod.main( 10, 0, false ); // $ExpectError + mod.main( 10, 0, null ); // $ExpectError + mod.main( 10, 0, undefined ); // $ExpectError + mod.main( 10, 0, [] ); // $ExpectError + mod.main( 10, 0, {} ); // $ExpectError + mod.main( 10, 0, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided an unsupported number of arguments... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dznrm2.Module( mem ); + + mod.main(); // $ExpectError + mod.main( 10 ); // $ExpectError + mod.main( 10, 0 ); // $ExpectError + mod.main( 10, 0, 1, 10 ); // $ExpectError +} + +// The `Module` constructor returns a module instance having an `ndarray` method which returns a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dznrm2.Module( mem ); + + mod.ndarray( 10, 0, 1, 0 ); // $ExpectType number +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a first argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dznrm2.Module( mem ); + + mod.ndarray( '10', 0, 1, 0 ); // $ExpectError + mod.ndarray( true, 0, 1, 0 ); // $ExpectError + mod.ndarray( false, 0, 1, 0 ); // $ExpectError + mod.ndarray( null, 0, 1, 0 ); // $ExpectError + mod.ndarray( undefined, 0, 1, 0 ); // $ExpectError + mod.ndarray( [], 0, 1, 0 ); // $ExpectError + mod.ndarray( {}, 0, 1, 0 ); // $ExpectError + mod.ndarray( ( x: number ): number => x, 0, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a second argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dznrm2.Module( mem ); + + mod.ndarray( 10, '10', 1, 0 ); // $ExpectError + mod.ndarray( 10, true, 1, 0 ); // $ExpectError + mod.ndarray( 10, false, 1, 0 ); // $ExpectError + mod.ndarray( 10, null, 1, 0 ); // $ExpectError + mod.ndarray( 10, undefined, 1, 0 ); // $ExpectError + mod.ndarray( 10, [], 1, 0 ); // $ExpectError + mod.ndarray( 10, {}, 1, 0 ); // $ExpectError + mod.ndarray( 10, ( x: number ): number => x, 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 = dznrm2.Module( mem ); + + mod.ndarray( 10, 0, '10', 0 ); // $ExpectError + mod.ndarray( 10, 0, true, 0 ); // $ExpectError + mod.ndarray( 10, 0, false, 0 ); // $ExpectError + mod.ndarray( 10, 0, null, 0 ); // $ExpectError + mod.ndarray( 10, 0, undefined, 0 ); // $ExpectError + mod.ndarray( 10, 0, [], 0 ); // $ExpectError + mod.ndarray( 10, 0, {}, 0 ); // $ExpectError + mod.ndarray( 10, 0, ( x: number ): number => x, 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 = dznrm2.Module( mem ); + + mod.ndarray( 10, 0, 1, '10' ); // $ExpectError + mod.ndarray( 10, 0, 1, true ); // $ExpectError + mod.ndarray( 10, 0, 1, false ); // $ExpectError + mod.ndarray( 10, 0, 1, null ); // $ExpectError + mod.ndarray( 10, 0, 1, undefined ); // $ExpectError + mod.ndarray( 10, 0, 1, [] ); // $ExpectError + mod.ndarray( 10, 0, 1, {} ); // $ExpectError + mod.ndarray( 10, 0, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided an unsupported number of arguments... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = dznrm2.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, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/index.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/index.js new file mode 100644 index 000000000000..74cf0e16b1cf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/index.js @@ -0,0 +1,50 @@ +/** +* @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 Complex128Array = require( '@stdlib/array/complex128' ); +var dznrm2 = require( './../lib' ); + +function main() { + var xbuf; + var out; + var x; + var N; + + if ( !hasWebAssemblySupport() ) { + console.error( 'Environment does not support WebAssembly.' ); + return; + } + // Specify a vector length: + N = 5; + + // Create an input array: + xbuf = oneTo( N*2, 'float64' ); + x = new Complex128Array( xbuf.buffer ); + + // Perform computation: + out = dznrm2.ndarray( N, x, 1, 0 ); + + // Print the result: + console.log( out ); +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/little_endian_arrays.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/little_endian_arrays.js new file mode 100644 index 000000000000..ed83931d9578 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/little_endian_arrays.js @@ -0,0 +1,65 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var Memory = require( '@stdlib/wasm/memory' ); +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; +var gfillBy = require( '@stdlib/blas/ext/base/gfill-by' ); +var Float64ArrayLE = require( '@stdlib/array/little-endian-float64' ); +var dznrm2 = 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 dznrm2.Module( mem ); + // returns + + // Initialize the routine: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Specify a vector length: + var N = 5; + + // Define a pointer (i.e., byte offset) for storing the input vector: + var xptr = 0; + + // Create a typed array view over module memory: + var x = new Float64ArrayLE( mod.memory.buffer, xptr, N*2 ); + + // Write values to module memory: + gfillBy( N*2, x, 1, discreteUniform( -10.0, 10.0 ) ); + + // Perform computation: + var out = mod.ndarray( N, xptr, 1, 0 ); + + // Print the result: + console.log( out ); +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/module.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/module.js new file mode 100644 index 000000000000..5304b8de809b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/module.js @@ -0,0 +1,63 @@ +/** +* @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 Complex128Array = require( '@stdlib/array/complex128' ); +var dznrm2 = 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 dznrm2.Module( mem ); + // returns + + // Initialize the routine: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Specify a vector length: + var N = 5; + + // Define a pointer (i.e., byte offset) for storing the input vector: + var xptr = 0; + + // Write vector values to module memory: + var xbuf = oneTo( N*2, 'float64' ); + var x = new Complex128Array( xbuf.buffer ); + mod.write( xptr, x ); + + // Perform computation: + var out = mod.ndarray( N, xptr, 1, 0 ); + + // Print the result: + console.log( out ); +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/binary.browser.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/binary.browser.js new file mode 100644 index 000000000000..76b00aba254b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/binary.browser.js @@ -0,0 +1,33 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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( 'AGFzbQEAAAAADwhkeWxpbmsuMAEEAAAAAAETA2AAAGADf39/AXxgBH9/f38BfAIPAQNlbnYGbWVtb3J5AgAAAwQDAAECBzMDEV9fd2FzbV9jYWxsX2N0b3JzAAAIY19kem5ybTIAARBjX2R6bnJtMl9uZGFycmF5AAIK0gQDAwABCxoAIAAgASACQQEgAGsgAmxBACACQQBMGxACC7AEAgV8BH8gAEEATARARAAAAAAAAAAADwsgA0EBdCEJIAJBAXQhC0EAIQNBASECA0AgACADRkUEQAJAIAEgCUEDdGoiDCsDACIGmSIIRAAAAAAAAFBeZARAIAcgCEQAAAAAAABQHqIiBiAGoqAhB0EAIQIMAQsgCEQAAAAAAAAAIGMEQCACQQFxIQpBACECIApFDQEgBCAIRAAAAAAAAIBhoiIEIASioCEEQQEhAgwBCyAFIAYgBqKgIQULAkAgDCsDCCIGmSIIRAAAAAAAAFBeZARAIAcgCEQAAAAAAABQHqIiBiAGoqAhB0EAIQIMAQsgCEQAAAAAAAAAIGMEQCACQQFxIQpBACECIApFDQEgBCAIRAAAAAAAAIBhoiIEIASioCEEQQEhAgwBCyAFIAYgBqKgIQULIANBAWohAyAJIAtqIQkMAQsLAnwgB0QAAAAAAAAAAGQEQCAFRAAAAAAAAFAeokQAAAAAAABQHqIgB6AiBCAHIAVE////////739kGyAEIAVEAAAAAAAAAABlGyEFRAAAAAAAAJBhDAELRAAAAAAAAPA/IAREAAAAAAAAAABkRQ0AGiAFRAAAAAAAAAAAZUUgBUT////////vf2RyRQRAIAQhBUQAAAAAAABgHgwBCyAEn0QAAAAAAABgHqIiBiAFnyIFIAUgBmMiABsiBCAEoiAFIAYgABsgBKMiBCAEokQAAAAAAADwP6CiIQVEAAAAAAAA8D8LIAWfogs=' ); + + +// EXPORTS // + +module.exports = wasm; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/binary.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/binary.js new file mode 100644 index 000000000000..6f02393f96e5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/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/wasm/dznrm2/lib/index.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/index.js new file mode 100644 index 000000000000..76ecfd90b65a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/index.js @@ -0,0 +1,99 @@ +/** +* @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 calculate the L2-norm of a complex double-precision floating-point vector. +* +* @module @stdlib/blas/base/wasm/dznrm2 +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var dznrm2 = require( '@stdlib/blas/base/wasm/dznrm2' ); +* +* // Define a strided array: +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* // Perform operation: +* var out = dznrm2.main( x.length, x, 1 ); +* // returns ~9.53 +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var dznrm2 = require( '@stdlib/blas/base/wasm/dznrm2' ); +* +* // Define a strided array: +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* // Perform operation: +* var out = dznrm2.ndarray( x.length, x, 1, 0 ); +* // returns ~9.53 +* +* @example +* var Memory = require( '@stdlib/wasm/memory' ); +* var oneTo = require( '@stdlib/array/one-to' ); +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var dznrm2 = require( '@stdlib/blas/base/wasm/dznrm2' ); +* +* // 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 dznrm2.Module( mem ); +* // returns +* +* // Initialize the routine: +* mod.initializeSync(); +* +* // Specify a vector length: +* var N = 5; +* +* // Define a pointer (i.e., byte offset) for storing the input vector: +* var xptr = 0; +* +* // Write vector values to module memory: +* var xbuf = oneTo( N*2, 'float64' ); +* var x = new Complex128Array( xbuf.buffer ); +* mod.write( xptr, x ); +* +* // Perform computation: +* var out = mod.main( N, xptr, 1 ); +* // returns ~19.62 +*/ + +// 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/wasm/dznrm2/lib/main.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/main.js new file mode 100644 index 000000000000..5f52d0798d5e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/main.js @@ -0,0 +1,61 @@ + +/** +* @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 calculate the L2-norm of a complex double-precision floating-point vector. +* +* @name dznrm2 +* @type {Routine} +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* +* // Define a strided array: +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* // Perform operation: +* var out = dznrm2.main( x.length, x, 1 ); +* // returns ~9.54 +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* +* // Define a strided array: +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* // Perform operation: +* var out = dznrm2.ndarray( x.length, x, 1, 0 ); +* // returns ~9.54 +*/ +var dznrm2 = new Routine(); +dznrm2.initializeSync(); // eslint-disable-line node/no-sync + + +// EXPORTS // + +module.exports = dznrm2; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/module.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/module.js new file mode 100644 index 000000000000..6f5658b163f0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/module.js @@ -0,0 +1,198 @@ +/** +* @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 Complex128Array = require( '@stdlib/array/complex128' ); +* +* // 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 dznrm2 = new Module( mem ); +* // returns +* +* // Initialize the routine: +* dznrm2.initializeSync(); +* +* // Specify a vector length: +* var N = 5; +* +* // Define a pointer (i.e., byte offset) for storing the input vector: +* var xptr = 0; +* +* // Write vector values to module memory: +* var xbuf = oneTo( N*2, 'float64' ); +* var x = new Complex128Array( xbuf.buffer ); +* dznrm2.write( xptr, x ); +* +* // Perform computation: +* var out = dznrm2.main( N, xptr, 1 ); +* // returns ~19.62 +*/ +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 ); + +/** +* Calculates the L2-norm of a complex double-precision floating-point vector. +* +* @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 +* @returns {number} the L2-norm +* +* @example +* var Memory = require( '@stdlib/wasm/memory' ); +* var oneTo = require( '@stdlib/array/one-to' ); +* var Complex128Array = require( '@stdlib/array/complex128' ); +* +* // 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 dznrm2 = new Module( mem ); +* // returns +* +* // Initialize the routine: +* dznrm2.initializeSync(); +* +* // Specify a vector length: +* var N = 5; +* +* // Define a pointer (i.e., byte offset) for storing the input vector: +* var xptr = 0; +* +* // Write vector values to module memory: +* var xbuf = oneTo( N*2, 'float64' ); +* var x = new Complex128Array( xbuf.buffer ); +* dznrm2.write( xptr, x ); +* +* // Perform computation: +* var out = dznrm2.main( N, xptr, 1 ); +* // returns ~19.62 +*/ +setReadOnly( Module.prototype, 'main', function dznrm2( N, xptr, strideX ) { + return this._instance.exports.c_dznrm2( N, xptr, strideX ); +}); + +/** +* Calculates the L2-norm of a complex double-precision floating-point vector 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 +* @returns {number} the L2-norm +* +* @example +* var Memory = require( '@stdlib/wasm/memory' ); +* var oneTo = require( '@stdlib/array/one-to' ); +* var Complex128Array = require( '@stdlib/array/complex128' ); +* +* // 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 dznrm2 = new Module( mem ); +* // returns +* +* // Initialize the routine: +* dznrm2.initializeSync(); +* +* // Specify a vector length: +* var N = 5; +* +* // Define a pointer (i.e., byte offset) for storing the input vector: +* var xptr = 0; +* +* // Write vector values to module memory: +* var xbuf = oneTo( N*2, 'float64' ); +* var x = new Complex128Array( xbuf.buffer ); +* dznrm2.write( xptr, x ); +* +* // Perform computation: +* var out = dznrm2.ndarray( N, xptr, 1, 0 ); +* // returns ~19.62 +*/ +setReadOnly( Module.prototype, 'ndarray', function dznrm2( N, xptr, strideX, offsetX ) { + return this._instance.exports.c_dznrm2_ndarray( N, xptr, strideX, offsetX ); +}); + + +// EXPORTS // + +module.exports = Module; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/routine.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/routine.js new file mode 100644 index 000000000000..4c60cd5383f4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/routine.js @@ -0,0 +1,166 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/* eslint-disable no-restricted-syntax, no-invalid-this */ + +'use strict'; + +// MODULES // + +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var inherits = require( '@stdlib/utils/inherit' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var Memory = require( '@stdlib/wasm/memory' ); +var arrays2ptrs = require( '@stdlib/wasm/base/arrays2ptrs' ); +var strided2object = require( '@stdlib/wasm/base/strided2object' ); +var Module = require( './module.js' ); + + +// MAIN // + +/** +* Routine constructor. +* +* @private +* @constructor +* @returns {Routine} routine instance +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* +* // Create a new routine: +* var dznrm2 = new Routine(); +* +* // Initialize the module: +* dznrm2.initializeSync(); +* +* // Define a strided array: +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* // Perform operation: +* var out = dznrm2.main( x.length, x, 1 ); +* // returns ~9.54 +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* +* // Create a new routine: +* var dznrm2 = new Routine(); +* +* // Initialize the module: +* dznrm2.initializeSync(); +* +* // Define strided arrays: +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* // Perform operation: +* var out = dznrm2.ndarray( x.length, x, 1, 0 ); +* // returns ~9.54 +*/ +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 ); + +/** +* Calculates the L2-norm of a complex double-precision floating-point vector. +* +* @name main +* @memberof Routine.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {Complex128Array} x - input array +* @param {integer} strideX - `x` stride length +* @returns {number} the L2-norm +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* +* // Create a new routine: +* var dznrm2 = new Routine(); +* +* // Initialize the module: +* dznrm2.initializeSync(); +* +* // Define a strided array: +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* // Perform operation: +* var out = dznrm2.main( x.length, x, 1 ); +* // returns ~9.54 +*/ +setReadOnly( Routine.prototype, 'main', function dznrm2( N, x, strideX ) { + return this.ndarray( N, x, strideX, stride2offset( N, strideX ) ); +}); + +/** +* Calculates the L2-norm of a complex double-precision floating-point vector using alternative indexing semantics. +* +* @name ndarray +* @memberof Routine.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {Complex128Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting `x` index +* @returns {number} the L2-norm +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* +* // Create a new routine: +* var dznrm2 = new Routine(); +* +* // Initialize the module: +* dznrm2.initializeSync(); +* +* // Define a strided array: +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* // Perform operation: +* var out = dznrm2.ndarray( x.length, x, 1, 0 ); +* // returns ~9.54 +*/ +setReadOnly( Routine.prototype, 'ndarray', function dznrm2( N, x, strideX, offsetX ) { + var ptrs; + var p0; + + // Convert the input array to "pointers" in the module's memory: + ptrs = arrays2ptrs( this, [ + strided2object( N, x, strideX, offsetX ) + ]); + p0 = ptrs[ 0 ]; + + // Perform computation by calling the corresponding parent method: + return Module.prototype.ndarray.call( this, N, p0.ptr, p0.stride, p0.offset ); // eslint-disable-line max-len +}); + + +// EXPORTS // + +module.exports = Routine; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/manifest.json b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/manifest.json new file mode 100644 index 000000000000..be2adf8b76b1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/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/dznrm2" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/package.json b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/package.json new file mode 100644 index 000000000000..000da33aacbf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/package.json @@ -0,0 +1,79 @@ +{ + "name": "@stdlib/blas/base/wasm/dznrm2", + "version": "0.0.0", + "description": "Multiply a vector `x` by a scalar `alpha`.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "browser": { + "./lib/binary.js": "./lib/binary.browser.js" + }, + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "scripts": "./scripts", + "src": "./src", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "blas", + "level 1", + "dznrm2", + "linear", + "algebra", + "subroutines", + "vector", + "array", + "ndarray", + "float64", + "float", + "float64array", + "webassembly", + "wasm" + ], + "__stdlib__": { + "wasm": true + } +} diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/scripts/build.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/scripts/build.js new file mode 100644 index 000000000000..66bf9650b6d6 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/scripts/build.js @@ -0,0 +1,66 @@ +#!/usr/bin/env node + +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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' ); +var currentYear = require( '@stdlib/time/current-year' ); + + +// 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}}'; +var YEAR = '{{YEAR}}'; + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var wasm; + var tmpl; + + wasm = readFile( wpath ); + tmpl = readFile( tpath, opts ); + + tmpl = replace( tmpl, YEAR, currentYear().toString() ); + tmpl = replace( tmpl, PLACEHOLDER, wasm.toString( 'base64' ) ); + + writeFile( opath, tmpl, opts ); +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/scripts/template.txt b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/scripts/template.txt new file mode 100644 index 000000000000..f66cdb9735b1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/scripts/template.txt @@ -0,0 +1,33 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) {{YEAR}} 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/wasm/dznrm2/src/Makefile b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/Makefile new file mode 100644 index 000000000000..eb51121eec4c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/Makefile @@ -0,0 +1,243 @@ +#/ +# @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 integer size: +ifdef CBLAS_INT + INT_TYPE := $(CBLAS_INT) +else + INT_TYPE := int32_t +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -flto \ + -Wall \ + -pedantic \ + -D CBLAS_INT=$(INT_TYPE) + +# Define the command-line options when compiling C files to WebAssembly and asm.js: +EMCCFLAGS ?= $(CFLAGS) + +# Define shared `emcc` flags: +EMCC_SHARED_FLAGS := \ + -Oz \ + -fwasm-exceptions \ + -s SUPPORT_LONGJMP=1 \ + -s SIDE_MODULE=2 \ + -s EXPORTED_FUNCTIONS="$(shell cat exports.json | tr -d ' \t\n' | sed s/\"/\'/g)" + +# Define WebAssembly `emcc` flags: +EMCC_WASM_FLAGS := $(EMCC_SHARED_FLAGS) \ + -s WASM=1 \ + -s WASM_BIGINT=0 + +# 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 $(browser_js_targets) + +.PHONY: clean-wasm + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-wasm + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/exports.json b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/exports.json new file mode 100644 index 000000000000..3c0bcc7b2128 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/exports.json @@ -0,0 +1,4 @@ +[ + "_c_dznrm2", + "_c_dznrm2_ndarray" +] diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/main.wasm b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/main.wasm new file mode 100755 index 0000000000000000000000000000000000000000..c61a3e9dcc2789ef29c592b18433e29e66ba1b4a GIT binary patch literal 719 zcmc&xO-{m45T5r_T6hpJ?jRxax-~II4?vrUD;J)?wrN?&Z!AQEA*n}j>k3jY;90zg z+(745DBQr=%zT;meKYeth~^Up6ip{tjvuC@^9v>oW~U+q2t}4EsevYhMP_Budk03B2|t1(8)7 z5Rf7F8Nvwp*axcNw$tM3Q*vu1GX%oYyM|pf6$+m%bk&d+TKS*}Yc4!e5;uM6aSs_* zeX$t2^)mr(<=u65^t<~+dT3*bySZDzO1{xH>F_#JWeYH-r!?bH*Gvy<{RTr>_Ftpi zl_-fS&3Hq#@K4K9v;vKG{$sRpXQ%~MQ4MvK)>3?hc4?ov-`cy;%?}mY8@k7)=1&pd zS<<0%_iq6P9lZx{5$W!z+aAh;dcOhfV^05AFQv~xS*nCxW13v=*kSP(*4njuV-mi1@3kunJRsaA1 literal 0 HcmV?d00001 diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/main.wat b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/main.wat new file mode 100644 index 000000000000..ad71d6c09cfe --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/main.wat @@ -0,0 +1,261 @@ +(module + (type (;0;) (func)) + (type (;1;) (func (param i32 i32 i32) (result f64))) + (type (;2;) (func (param i32 i32 i32 i32) (result f64))) + (import "env" "memory" (memory (;0;) 0)) + (func (;0;) (type 0) + nop) + (func (;1;) (type 1) (param i32 i32 i32) (result f64) + local.get 0 + local.get 1 + local.get 2 + i32.const 1 + local.get 0 + i32.sub + local.get 2 + i32.mul + i32.const 0 + local.get 2 + i32.const 0 + i32.le_s + select + call 2) + (func (;2;) (type 2) (param i32 i32 i32 i32) (result f64) + (local f64 f64 f64 f64 f64 i32 i32 i32 i32) + local.get 0 + i32.const 0 + i32.le_s + if ;; label = @1 + f64.const 0x0p+0 (;=0;) + return + end + local.get 3 + i32.const 1 + i32.shl + local.set 9 + local.get 2 + i32.const 1 + i32.shl + local.set 11 + i32.const 0 + local.set 3 + i32.const 1 + local.set 2 + loop ;; label = @1 + local.get 0 + local.get 3 + i32.eq + i32.eqz + if ;; label = @2 + block ;; label = @3 + local.get 1 + local.get 9 + i32.const 3 + i32.shl + i32.add + local.tee 12 + f64.load + local.tee 6 + f64.abs + local.tee 8 + f64.const 0x1p+486 (;=1.99792e+146;) + f64.gt + if ;; label = @4 + local.get 7 + local.get 8 + f64.const 0x1p-538 (;=1.11138e-162;) + f64.mul + local.tee 6 + local.get 6 + f64.mul + f64.add + local.set 7 + i32.const 0 + local.set 2 + br 1 (;@3;) + end + local.get 8 + f64.const 0x1p-511 (;=1.49167e-154;) + f64.lt + if ;; label = @4 + local.get 2 + i32.const 1 + i32.and + local.set 10 + i32.const 0 + local.set 2 + local.get 10 + i32.eqz + br_if 1 (;@3;) + local.get 4 + local.get 8 + f64.const 0x1p+537 (;=4.49891e+161;) + f64.mul + local.tee 4 + local.get 4 + f64.mul + f64.add + local.set 4 + i32.const 1 + local.set 2 + br 1 (;@3;) + end + local.get 5 + local.get 6 + local.get 6 + f64.mul + f64.add + local.set 5 + end + block ;; label = @3 + local.get 12 + f64.load offset=8 + local.tee 6 + f64.abs + local.tee 8 + f64.const 0x1p+486 (;=1.99792e+146;) + f64.gt + if ;; label = @4 + local.get 7 + local.get 8 + f64.const 0x1p-538 (;=1.11138e-162;) + f64.mul + local.tee 6 + local.get 6 + f64.mul + f64.add + local.set 7 + i32.const 0 + local.set 2 + br 1 (;@3;) + end + local.get 8 + f64.const 0x1p-511 (;=1.49167e-154;) + f64.lt + if ;; label = @4 + local.get 2 + i32.const 1 + i32.and + local.set 10 + i32.const 0 + local.set 2 + local.get 10 + i32.eqz + br_if 1 (;@3;) + local.get 4 + local.get 8 + f64.const 0x1p+537 (;=4.49891e+161;) + f64.mul + local.tee 4 + local.get 4 + f64.mul + f64.add + local.set 4 + i32.const 1 + local.set 2 + br 1 (;@3;) + end + local.get 5 + local.get 6 + local.get 6 + f64.mul + f64.add + local.set 5 + end + local.get 3 + i32.const 1 + i32.add + local.set 3 + local.get 9 + local.get 11 + i32.add + local.set 9 + br 1 (;@1;) + end + end + block (result f64) ;; label = @1 + local.get 7 + f64.const 0x0p+0 (;=0;) + f64.gt + if ;; label = @2 + local.get 5 + f64.const 0x1p-538 (;=1.11138e-162;) + f64.mul + f64.const 0x1p-538 (;=1.11138e-162;) + f64.mul + local.get 7 + f64.add + local.tee 4 + local.get 7 + local.get 5 + f64.const 0x1.fffffffffffffp+1023 (;=1.79769e+308;) + f64.gt + select + local.get 4 + local.get 5 + f64.const 0x0p+0 (;=0;) + f64.le + select + local.set 5 + f64.const 0x1p+538 (;=8.99783e+161;) + br 1 (;@1;) + end + f64.const 0x1p+0 (;=1;) + local.get 4 + f64.const 0x0p+0 (;=0;) + f64.gt + i32.eqz + br_if 0 (;@1;) + drop + local.get 5 + f64.const 0x0p+0 (;=0;) + f64.le + i32.eqz + local.get 5 + f64.const 0x1.fffffffffffffp+1023 (;=1.79769e+308;) + f64.gt + i32.or + i32.eqz + if ;; label = @2 + local.get 4 + local.set 5 + f64.const 0x1p-537 (;=2.22276e-162;) + br 1 (;@1;) + end + local.get 4 + f64.sqrt + f64.const 0x1p-537 (;=2.22276e-162;) + f64.mul + local.tee 6 + local.get 5 + f64.sqrt + local.tee 5 + local.get 5 + local.get 6 + f64.lt + local.tee 0 + select + local.tee 4 + local.get 4 + f64.mul + local.get 5 + local.get 6 + local.get 0 + select + local.get 4 + f64.div + local.tee 4 + local.get 4 + f64.mul + f64.const 0x1p+0 (;=1;) + f64.add + f64.mul + local.set 5 + f64.const 0x1p+0 (;=1;) + end + local.get 5 + f64.sqrt + f64.mul) + (export "__wasm_call_ctors" (func 0)) + (export "c_dznrm2" (func 1)) + (export "c_dznrm2_ndarray" (func 2))) diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.js new file mode 100644 index 000000000000..e2819694f681 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/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 dznrm2 = require( './../lib' ); + + +// TESTS // + +tape( 'main export is an object', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dznrm2, 'object', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is a `main` method', function test( t ) { + t.strictEqual( typeof dznrm2.main, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is an `ndarray` method', function test( t ) { + t.strictEqual( typeof dznrm2.ndarray, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is a `Module` constructor', function test( t ) { + t.strictEqual( typeof dznrm2.Module, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'the main export is a `Module` instance', function test( t ) { + t.strictEqual( dznrm2 instanceof dznrm2.Module, true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.main.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.main.js new file mode 100644 index 000000000000..3c204646e66a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.main.js @@ -0,0 +1,170 @@ +/** +* @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 Complex128Array = require( '@stdlib/array/complex128' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var dznrm2 = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Tests for element-wise approximate equality. +* +* @private +* @param {Object} t - test object +* @param {Collection} actual - actual values +* @param {Collection} expected - expected values +* @param {number} rtol - relative tolerance +*/ +function isApprox( t, actual, expected, rtol ) { + var delta; + var tol; + var i; + + t.strictEqual( actual.length, expected.length, 'returns expected value' ); + for ( i = 0; i < expected.length; i++ ) { + if ( actual[ i ] === expected[ i ] ) { + t.strictEqual( actual[ i ], expected[ i ], 'returns expected value' ); + } else { + delta = abs( actual[ i ] - expected[ i ] ); + tol = rtol * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. actual: '+actual[ i ]+'. expected: '+expected[ i ]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + } +} + + +// TESTS // + +tape( 'main export is an object', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dznrm2, 'object', 'main export is an object' ); + t.end(); +}); + +tape( 'the `main` method has an arity of 3', function test( t ) { + t.strictEqual( dznrm2.main.length, 3, 'returns expected value' ); + t.end(); +}); + +tape( 'the `main` method calculates the L2-norm of a vector', function test( t ) { + var nrm2; + var x; + + x = new Complex128Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + nrm2 = dznrm2.main( x.length, x, 1 ); + isApprox( t, nrm2, 7.4, 1.0 ); + + x = new Complex128Array( [ -4.0, 0.0 ] ); + + nrm2 = dznrm2.main( x.length, x, 1 ); + isApprox( t, nrm2, 4.0, 1.0 ); + + t.end(); +}); + +tape( 'the `main` method supports a `stride` parameter', function test( t ) { + var nrm2; + var x; + + x = new Complex128Array([ + 1.0, // 0 + 2.0, // 0 + 1.0, + 2.0, + -7.0, // 1 + -2.0, // 1 + 3.0, + 3.0, + 4.0, // 2 + 2.0 // 2 + ]); + + nrm2 = dznrm2.main( 3, x, 2 ); + isApprox( t, nrm2, 8.83, 1.0 ); + + t.end(); +}); + +tape( 'the `main` method supports a negative `stride` parameter', function test( t ) { + var nrm2; + var x; + + x = new Complex128Array([ + 2.0, // 2 + -7.0, // 2 + -2.0, + 3.0, + 4.0, // 1 + 2.0 // 1 + ]); + + nrm2 = dznrm2.main( 2, x, -2 ); + isApprox( t, nrm2, 8.54, 1.0 ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the `main` method returns `0`', function test( t ) { + var nrm2; + var x; + + x = new Complex128Array( [ 1.0, -2.0, -4.0, 5.0, 3.0, 6.0 ] ); + + nrm2 = dznrm2.main( 0, x, 1 ); + t.strictEqual( nrm2, 0.0, 'returns expected value' ); + + nrm2 = dznrm2.main( -1, x, 1 ); + t.strictEqual( nrm2, 0.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the `main` method supports view offsets', function test( t ) { + var nrm2; + var x0; + var x1; + + x0 = new Complex128Array([ + 1.0, + 1.0, + 2.0, + 2.0, + 1.0, // 1 + 2.0, // 1 + -2.0, + -2.0, + 2.0, // 2 + 3.0 // 2 + ]); + + x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*2 ); // start at 3rd element + + nrm2 = dznrm2.main( 4, x1, 2 ); + isApprox( t, nrm2, 4.24, 1.0 ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.js new file mode 100644 index 000000000000..9adcb07e22fa --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/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/wasm/dznrm2/test/test.module.main.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.main.js new file mode 100644 index 000000000000..04dcf99bd62a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.main.js @@ -0,0 +1,197 @@ +/** +* @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 Complex128Array = require( '@stdlib/array/complex128' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var Module = require( './../lib' ).Module; + + +// FUNCTIONS // + +/** +* Tests for element-wise approximate equality. +* +* @private +* @param {Object} t - test object +* @param {Collection} actual - actual values +* @param {Collection} expected - expected values +* @param {number} rtol - relative tolerance +*/ +function isApprox( t, actual, expected, rtol ) { + var delta; + var tol; + var i; + + t.strictEqual( actual.length, expected.length, 'returns expected value' ); + for ( i = 0; i < expected.length; i++ ) { + if ( actual[ i ] === expected[ i ] ) { + t.strictEqual( actual[ i ], expected[ i ], 'returns expected value' ); + } else { + delta = abs( actual[ i ] - expected[ i ] ); + tol = rtol * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. actual: '+actual[ i ]+'. expected: '+expected[ i ]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + } +} + + +// 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 3', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = new Module( mem ); + t.strictEqual( mod.main.length, 3, 'returns expected value' ); + t.end(); +}); + +tape( 'a module instance has a `main` method which calculates the L2-norm of a vector', function test( t ) { + var nrm2; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Complex128Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ) ); + + nrm2 = mod.main( 3, xp, 1 ); + isApprox( t, nrm2, 7.4, 1.0 ); + + // Short datasets: + xp = 0; + + mod.write( xp, new Complex128Array( [ -4.0, 0.0 ] ) ); + + nrm2 = mod.main( 1, xp, 1 ); + isApprox( t, nrm2, 4.0, 1.0 ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which supports a `stride` parameter', function test( t ) { + var nrm2; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Complex128Array([ + 1.0, // 0 + 2.0, // 0 + 2.0, + 2.0, + -7.0, // 1 + -2.0, // 1 + 3.0, + 3.0, + 4.0, // 2 + 2.0 // 2 + ])); + + nrm2 = mod.main( 3, xp, 2 ); + isApprox( t, nrm2, 8.83, 1.0 ); + + t.end(); +}); + +tape( 'a module instance has a `main` method which supports a negative `stride` parameter', function test( t ) { + var nrm2; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Complex128Array([ + -7.0, // 2 + -2.0, // 2 + 2.0, + 3.0, + 4.0, // 1 + 2.0 // 1 + ])); + + nrm2 = mod.main( 2, xp, -2 ); + isApprox( t, nrm2, 8.54, 1.0 ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, a module instance has a `main` method which returns `0`', function test( t ) { + var nrm2; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ) ); + + nrm2 = mod.main( -1, xp, 1 ); + t.strictEqual( nrm2, 0.0, 'returns expected value' ); + + nrm2 = mod.main( 0, xp, 1 ); + t.strictEqual( nrm2, 0.0, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js new file mode 100644 index 000000000000..e73d89f1c31e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js @@ -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. +*/ + +/* eslint-disable node/no-sync */ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Memory = require( '@stdlib/wasm/memory' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var Module = require( './../lib' ).Module; + + +// FUNCTIONS // + +/** +* Tests for element-wise approximate equality. +* +* @private +* @param {Object} t - test object +* @param {Collection} actual - actual values +* @param {Collection} expected - expected values +* @param {number} rtol - relative tolerance +*/ +function isApprox( t, actual, expected, rtol ) { + var delta; + var tol; + var i; + + t.strictEqual( actual.length, expected.length, 'returns expected value' ); + for ( i = 0; i < expected.length; i++ ) { + if ( actual[ i ] === expected[ i ] ) { + t.strictEqual( actual[ i ], expected[ i ], 'returns expected value' ); + } else { + delta = abs( actual[ i ] - expected[ i ] ); + tol = rtol * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. actual: '+actual[ i ]+'. expected: '+expected[ i ]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + } +} + + +// 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 4', function test( t ) { + var mem; + var mod; + + mem = new Memory({ + 'initial': 0 + }); + mod = new Module( mem ); + t.strictEqual( mod.ndarray.length, 4, 'returns expected value' ); + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which calculates the L2-norm of a vector', function test( t ) { + var nrm2; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Complex128Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ) ); + + nrm2 = mod.ndarray( 3, xp, 1, 0 ); + isApprox( t, nrm2, 7.4, 1.0 ); + + // Short datasets: + xp = 0; + + mod.write( xp, new Complex128Array( [ -4.0, 0.0 ] ) ); + + nrm2 = mod.ndarray( 1, xp, 1, 0 ); + isApprox( t, nrm2, 4.0, 1.0 ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports a `stride` parameter', function test( t ) { + var nrm2; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Complex128Array([ + 1.0, // 0 + 2.0, // 0 + 2.0, + 2.0, + -7.0, // 1 + -2.0, // 1 + 3.0, + 3.0, + 4.0, // 2 + 2.0 // 2 + ])); + + nrm2 = mod.ndarray( 3, xp, 2, 0 ); + isApprox( t, nrm2, 8.83, 1.0 ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports a negative `stride`', function test( t ) { + var nrm2; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Complex128Array([ + 1.0, // 2 + 2.0, // 2 + 2.0, + -7.0, + -2.0, // 1 + 3.0, // 1 + 4.0, + 2.0 + ])); + + nrm2 = mod.ndarray( 2, xp, -2, 3 ); + isApprox( t, nrm2, 4.24, 1.0 ); + + t.end(); +}); + +tape( 'a module instance has an `ndarray` method which supports an `x` offset', function test( t ) { + var nrm2; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Complex128Array([ + 1.0, + 1.0, + 2.0, + 2.0, + 1.0, // 1 + 2.0, // 1 + -2.0, + -2.0, + 2.0, // 2 + 3.0 // 2 + ])); + + nrm2 = mod.ndarray( 2, xp, 2, 2 ); + isApprox( t, nrm2, 4.24, 1.0 ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, a module instance has an `ndarray` method which returns `0`', function test( t ) { + var nrm2; + var mem; + var mod; + var xp; + + mem = new Memory({ + 'initial': 1 + }); + mod = new Module( mem ); + mod.initializeSync(); + + xp = 0; + + mod.write( xp, new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ) ); + + nrm2 = mod.ndarray( -1, xp, 1, 0 ); + t.strictEqual( nrm2, 0.0, 'returns expected value' ); + + nrm2 = mod.ndarray( 0, xp, 1, 0 ); + t.strictEqual( nrm2, 0.0, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js new file mode 100644 index 000000000000..ece3d9f55850 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js @@ -0,0 +1,168 @@ +/** +* @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 Complex128Array = require( '@stdlib/array/complex128' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var dznrm2 = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Tests for element-wise approximate equality. +* +* @private +* @param {Object} t - test object +* @param {Collection} actual - actual values +* @param {Collection} expected - expected values +* @param {number} rtol - relative tolerance +*/ +function isApprox( t, actual, expected, rtol ) { + var delta; + var tol; + var i; + + t.strictEqual( actual.length, expected.length, 'returns expected value' ); + for ( i = 0; i < expected.length; i++ ) { + if ( actual[ i ] === expected[ i ] ) { + t.strictEqual( actual[ i ], expected[ i ], 'returns expected value' ); + } else { + delta = abs( actual[ i ] - expected[ i ] ); + tol = rtol * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. actual: '+actual[ i ]+'. expected: '+expected[ i ]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + } +} + + +// TESTS // + +tape( 'main export is an object', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dznrm2, 'object', 'main export is an object' ); + t.end(); +}); + +tape( 'the `ndarray` method has an arity of 4', function test( t ) { + t.strictEqual( dznrm2.ndarray.length, 4, 'returns expected value' ); + t.end(); +}); + +tape( 'the `ndarray` method calculates the L2-norm of a vector', function test( t ) { + var nrm2; + var x; + + x = new Complex128Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + + nrm2 = dznrm2.ndarray( x.length, x, 1, 0 ); + isApprox( t, nrm2, 7.4, 2.0 ); + + // Short datasets: + x = new Complex128Array( [ -4.0, 0.0 ] ); + + nrm2 = dznrm2.ndarray( x.length, x, 1, 0 ); + isApprox( t, nrm2, 4.0, 1.0 ); + + t.end(); +}); + +tape( 'the `ndarray` method supports a `stride` parameter', function test( t ) { + var nrm2; + var x; + + x = new Complex128Array([ + 1.0, // 0 + 2.0, // 0 + 2.0, + 2.0, + -7.0, // 1 + -2.0, // 1 + 3.0, + 3.0, + 4.0, // 2 + 2.0 // 2 + ]); + + nrm2 = dznrm2.ndarray( 3, x, 2, 0 ); + isApprox( t, nrm2, 8.83, 1.0 ); + + t.end(); +}); + +tape( 'the `ndarray` method supports a negative stride parameter', function test( t ) { + var nrm2; + var x; + + x = new Complex128Array([ + 2.0, // 2 + -7.0, // 2 + -2.0, + 3.0, + 4.0, // 1 + 2.0 // 1 + ]); + + nrm2 = dznrm2.ndarray( 2, x, -2, x.length-2 ); + isApprox( t, nrm2, 8.54, 1.0 ); + + t.end(); +}); + +tape( 'the `ndarray` method supports an `offset` parameter', function test( t ) { + var nrm2; + var x; + + x = new Complex128Array([ + 1.0, + 1.0, + 2.0, + 2.0, + 1.0, // 1 + 2.0, // 1 + -2.0, + -2.0, + 2.0, // 2 + 3.0 // 2 + ]); + + nrm2 = dznrm2.ndarray( 2, x, 2, 2 ); + isApprox( t, nrm2, 4.24, 1.0 ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the `ndarray` method returns `0`', function test( t ) { + var nrm2; + var x; + + x = new Complex128Array( [ 1.0, -2.0, -4.0, 5.0, 3.0, 6.0 ] ); + + nrm2 = dznrm2.ndarray( 0, x, 1, 0 ); + t.strictEqual( nrm2, 0.0, 'returns expected value' ); + + nrm2 = dznrm2.ndarray( -1, x, 1, 0 ); + t.strictEqual( nrm2, 0.0, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.routine.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.routine.js new file mode 100644 index 000000000000..56a4b67daaf0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.routine.js @@ -0,0 +1,71 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var ModuleWrapper = require( '@stdlib/wasm/module-wrapper' ); +var Module = require( './../lib/module.js' ); +var Routine = require( './../lib/routine.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof Routine, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'the function is a constructor', function test( t ) { + var mod = new Routine(); + t.strictEqual( mod instanceof Routine, true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function is a constructor which does not require `new`', function test( t ) { + var mod = Routine(); // eslint-disable-line new-cap + t.strictEqual( mod instanceof Routine, true, 'returns expected value' ); + t.end(); +}); + +tape( 'the module instance returned by the constructor inherits from a module wrapper', function test( t ) { + var mod = new Routine(); + t.strictEqual( mod instanceof ModuleWrapper, true, 'returns expected value' ); + t.end(); +}); + +tape( 'the module instance returned by the constructor inherits from a BLAS routine module', function test( t ) { + var mod = new Routine(); + t.strictEqual( mod instanceof Module, true, 'returns expected value' ); + t.end(); +}); + +tape( 'attached to a module instance is a `main` method', function test( t ) { + var mod = new Routine(); + t.strictEqual( typeof mod.main, 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'attached to a module instance is an `ndarray` method', function test( t ) { + var mod = new Routine(); + t.strictEqual( typeof mod.ndarray, 'function', 'returns expected value' ); + t.end(); +}); From a71ff1d210526938443f56c0fd9330b6f3bca348 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Wed, 23 Apr 2025 09:43:27 +0000 Subject: [PATCH 2/3] chore: update copyright years --- lib/node_modules/@stdlib/blas/base/wasm/dznrm2/README.md | 2 +- .../@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.js | 2 +- .../@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.js | 2 +- .../blas/base/wasm/dznrm2/benchmark/benchmark.module.main.js | 2 +- .../blas/base/wasm/dznrm2/benchmark/benchmark.module.ndarray.js | 2 +- .../blas/base/wasm/dznrm2/benchmark/benchmark.ndarray.js | 2 +- .../@stdlib/blas/base/wasm/dznrm2/docs/types/index.d.ts | 2 +- .../@stdlib/blas/base/wasm/dznrm2/docs/types/test.ts | 2 +- .../@stdlib/blas/base/wasm/dznrm2/examples/index.js | 2 +- .../blas/base/wasm/dznrm2/examples/little_endian_arrays.js | 2 +- .../@stdlib/blas/base/wasm/dznrm2/examples/module.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/binary.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/index.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/main.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/module.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/routine.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/Makefile | 2 +- lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.js | 2 +- .../@stdlib/blas/base/wasm/dznrm2/test/test.main.js | 2 +- .../@stdlib/blas/base/wasm/dznrm2/test/test.module.js | 2 +- .../@stdlib/blas/base/wasm/dznrm2/test/test.module.main.js | 2 +- .../@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js | 2 +- .../@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js | 2 +- .../@stdlib/blas/base/wasm/dznrm2/test/test.routine.js | 2 +- 24 files changed, 24 insertions(+), 24 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/README.md b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/README.md index 289f300a1fa3..98f03a1d5b98 100755 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/README.md +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2024 The Stdlib Authors. +Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.js index f5f2e305e89c..bedf74264765 100755 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.js index 0f4fa6393e38..5edb49538f72 100755 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.main.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.main.js index baa567091c76..f0ddab308c83 100755 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.ndarray.js index 880969922ebe..2868e29a0452 100755 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.ndarray.js index e15510512872..b5388ec30705 100755 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/index.d.ts index c133a8692814..2342513c4958 100755 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/index.d.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/test.ts index 1771a9f1b3e9..3f1a4537f7b7 100755 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/types/test.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/index.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/index.js index 74cf0e16b1cf..3b17212faf9d 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/little_endian_arrays.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/little_endian_arrays.js index ed83931d9578..72ab216b22c6 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/little_endian_arrays.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/little_endian_arrays.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/module.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/module.js index 5304b8de809b..f6e6d8588698 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/module.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/examples/module.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/binary.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/binary.js index 6f02393f96e5..2b83fe651780 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/binary.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/binary.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/index.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/index.js index 76ecfd90b65a..6fc3c124c0f0 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/main.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/main.js index 5f52d0798d5e..d39f39d4c81f 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/main.js @@ -2,7 +2,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/module.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/module.js index 6f5658b163f0..e34c804a9b16 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/module.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/module.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/routine.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/routine.js index 4c60cd5383f4..80231ff73c10 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/routine.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/lib/routine.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/Makefile b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/Makefile index eb51121eec4c..1b1f35347760 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/Makefile +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/src/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2024 The Stdlib Authors. +# Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.js index e2819694f681..d9768c53b992 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.main.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.main.js index 3c204646e66a..6d259398e847 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.js index 9adcb07e22fa..0cdcd97ef151 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.main.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.main.js index 04dcf99bd62a..4d87b22122cb 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js index e73d89f1c31e..ae92f989f6fb 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js index ece3d9f55850..b3d5d93601d2 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.routine.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.routine.js index 56a4b67daaf0..d90a5804a8e1 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.routine.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.routine.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. From 8f4091b3f9c7a19f84ec07f4336f68281d77a78a Mon Sep 17 00:00:00 2001 From: ShabiShett07 Date: Sun, 22 Jun 2025 18:25:29 +0530 Subject: [PATCH 3/3] chore: fix test cases --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../dznrm2/benchmark/benchmark.module.main.js | 4 +- .../benchmark/benchmark.module.ndarray.js | 4 +- .../blas/base/wasm/dznrm2/docs/repl.txt | 2 +- .../blas/base/wasm/dznrm2/test/test.main.js | 48 +++------------ .../base/wasm/dznrm2/test/test.module.main.js | 42 ++----------- .../wasm/dznrm2/test/test.module.ndarray.js | 60 +++++-------------- .../base/wasm/dznrm2/test/test.ndarray.js | 48 +++------------ 7 files changed, 44 insertions(+), 164 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.main.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.main.js index f0ddab308c83..43ef2ca9d247 100755 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.main.js @@ -80,9 +80,9 @@ function createBenchmark( len ) { // Initialize the module: mod.initializeSync(); // eslint-disable-line node/no-sync - // Reallocate the underlying memory to allow storing one vector and a complex number: + // Reallocate the underlying memory to allow storing one vector: nb = bytesPerElement( 'complex128' ); - mod.realloc( (N*nb)+nb ); + mod.realloc( N*nb ); // Define a pointer (i.e., byte offset) to the first vector element: xptr = 0; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.ndarray.js index 2868e29a0452..ec3bdb7fb044 100755 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/benchmark/benchmark.module.ndarray.js @@ -80,9 +80,9 @@ function createBenchmark( len ) { // Initialize the module: mod.initializeSync(); // eslint-disable-line node/no-sync - // Reallocate the underlying memory to allow storing one vector and a complex number: + // Reallocate the underlying memory to allow storing one vector: nb = bytesPerElement( 'complex128' ); - mod.realloc( (N*nb)+nb ); + mod.realloc( N*nb ); // Define a pointer (i.e., byte offset) to the first vector element: xptr = 0; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/repl.txt index 3ca8d994b08a..fe19b9a337e0 100755 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/docs/repl.txt @@ -80,7 +80,7 @@ ~3.16 // Using offset parameter: - > var x = new {{alias:@stdlib/array/complex128}}( [ 3.0, 2.0, 3.0, 0.0 ] ); + > x = new {{alias:@stdlib/array/complex128}}( [ 3.0, 2.0, 3.0, 0.0 ] ); > out = {{alias}}.ndarray( 1, x, 1, 1 ) 3.0 diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.main.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.main.js index 6d259398e847..f3a7eb80cc96 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.main.js @@ -22,40 +22,10 @@ var tape = require( 'tape' ); var Complex128Array = require( '@stdlib/array/complex128' ); -var EPS = require( '@stdlib/constants/float64/eps' ); -var abs = require( '@stdlib/math/base/special/abs' ); +var sqrt = require( '@stdlib/math/base/special/sqrt' ); var dznrm2 = require( './../lib' ); -// FUNCTIONS // - -/** -* Tests for element-wise approximate equality. -* -* @private -* @param {Object} t - test object -* @param {Collection} actual - actual values -* @param {Collection} expected - expected values -* @param {number} rtol - relative tolerance -*/ -function isApprox( t, actual, expected, rtol ) { - var delta; - var tol; - var i; - - t.strictEqual( actual.length, expected.length, 'returns expected value' ); - for ( i = 0; i < expected.length; i++ ) { - if ( actual[ i ] === expected[ i ] ) { - t.strictEqual( actual[ i ], expected[ i ], 'returns expected value' ); - } else { - delta = abs( actual[ i ] - expected[ i ] ); - tol = rtol * EPS * abs( expected[ i ] ); - t.ok( delta <= tol, 'within tolerance. actual: '+actual[ i ]+'. expected: '+expected[ i ]+'. delta: '+delta+'. tol: '+tol+'.' ); - } - } -} - - // TESTS // tape( 'main export is an object', function test( t ) { @@ -73,15 +43,15 @@ tape( 'the `main` method calculates the L2-norm of a vector', function test( t ) var nrm2; var x; - x = new Complex128Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + x = new Complex128Array( [ 3.0, -4.0, -6.0, 8.0, 0.0, 3.0 ] ); nrm2 = dznrm2.main( x.length, x, 1 ); - isApprox( t, nrm2, 7.4, 1.0 ); + t.strictEqual( nrm2, sqrt( 134.0 ), 'returns expected value' ); x = new Complex128Array( [ -4.0, 0.0 ] ); nrm2 = dznrm2.main( x.length, x, 1 ); - isApprox( t, nrm2, 4.0, 1.0 ); + t.strictEqual( nrm2, 4.0, 'returns expected value' ); t.end(); }); @@ -104,7 +74,7 @@ tape( 'the `main` method supports a `stride` parameter', function test( t ) { ]); nrm2 = dznrm2.main( 3, x, 2 ); - isApprox( t, nrm2, 8.83, 1.0 ); + t.strictEqual( nrm2, sqrt( 78.0 ), 'returns expected value' ); t.end(); }); @@ -123,7 +93,7 @@ tape( 'the `main` method supports a negative `stride` parameter', function test( ]); nrm2 = dznrm2.main( 2, x, -2 ); - isApprox( t, nrm2, 8.54, 1.0 ); + t.strictEqual( nrm2, sqrt( 73.0 ), 'returns expected value' ); t.end(); }); @@ -158,13 +128,13 @@ tape( 'the `main` method supports view offsets', function test( t ) { -2.0, -2.0, 2.0, // 2 - 3.0 // 2 + 3.0 // 2 ]); x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*2 ); // start at 3rd element - nrm2 = dznrm2.main( 4, x1, 2 ); - isApprox( t, nrm2, 4.24, 1.0 ); + nrm2 = dznrm2.main( 2, x1, 2 ); + t.strictEqual( nrm2, sqrt( 18.0 ), 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.main.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.main.js index 4d87b22122cb..d9a46e03e1dd 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.main.js @@ -25,40 +25,10 @@ var tape = require( 'tape' ); var Memory = require( '@stdlib/wasm/memory' ); var Complex128Array = require( '@stdlib/array/complex128' ); -var EPS = require( '@stdlib/constants/float64/eps' ); -var abs = require( '@stdlib/math/base/special/abs' ); +var sqrt = require( '@stdlib/math/base/special/sqrt' ); var Module = require( './../lib' ).Module; -// FUNCTIONS // - -/** -* Tests for element-wise approximate equality. -* -* @private -* @param {Object} t - test object -* @param {Collection} actual - actual values -* @param {Collection} expected - expected values -* @param {number} rtol - relative tolerance -*/ -function isApprox( t, actual, expected, rtol ) { - var delta; - var tol; - var i; - - t.strictEqual( actual.length, expected.length, 'returns expected value' ); - for ( i = 0; i < expected.length; i++ ) { - if ( actual[ i ] === expected[ i ] ) { - t.strictEqual( actual[ i ], expected[ i ], 'returns expected value' ); - } else { - delta = abs( actual[ i ] - expected[ i ] ); - tol = rtol * EPS * abs( expected[ i ] ); - t.ok( delta <= tol, 'within tolerance. actual: '+actual[ i ]+'. expected: '+expected[ i ]+'. delta: '+delta+'. tol: '+tol+'.' ); - } - } -} - - // TESTS // tape( 'main export is a function', function test( t ) { @@ -93,10 +63,10 @@ tape( 'a module instance has a `main` method which calculates the L2-norm of a v xp = 0; - mod.write( xp, new Complex128Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ) ); + mod.write( xp, new Complex128Array( [ 3.0, -4.0, -6.0, 8.0, 0.0, 3.0 ] ) ); nrm2 = mod.main( 3, xp, 1 ); - isApprox( t, nrm2, 7.4, 1.0 ); + t.strictEqual( nrm2, sqrt( 134.0 ), 'returns expected value' ); // Short datasets: xp = 0; @@ -104,7 +74,7 @@ tape( 'a module instance has a `main` method which calculates the L2-norm of a v mod.write( xp, new Complex128Array( [ -4.0, 0.0 ] ) ); nrm2 = mod.main( 1, xp, 1 ); - isApprox( t, nrm2, 4.0, 1.0 ); + t.strictEqual( nrm2, 4.0, 'returns expected value' ); t.end(); }); @@ -137,7 +107,7 @@ tape( 'a module instance has a `main` method which supports a `stride` parameter ])); nrm2 = mod.main( 3, xp, 2 ); - isApprox( t, nrm2, 8.83, 1.0 ); + t.strictEqual( nrm2, sqrt( 78.0 ), 'returns expected value' ); t.end(); }); @@ -166,7 +136,7 @@ tape( 'a module instance has a `main` method which supports a negative `stride` ])); nrm2 = mod.main( 2, xp, -2 ); - isApprox( t, nrm2, 8.54, 1.0 ); + t.strictEqual( nrm2, sqrt( 73.0 ), 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js index ae92f989f6fb..714a74dbe4bb 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.module.ndarray.js @@ -25,40 +25,10 @@ var tape = require( 'tape' ); var Memory = require( '@stdlib/wasm/memory' ); var Complex128Array = require( '@stdlib/array/complex128' ); -var EPS = require( '@stdlib/constants/float64/eps' ); -var abs = require( '@stdlib/math/base/special/abs' ); +var sqrt = require( '@stdlib/math/base/special/sqrt' ); var Module = require( './../lib' ).Module; -// FUNCTIONS // - -/** -* Tests for element-wise approximate equality. -* -* @private -* @param {Object} t - test object -* @param {Collection} actual - actual values -* @param {Collection} expected - expected values -* @param {number} rtol - relative tolerance -*/ -function isApprox( t, actual, expected, rtol ) { - var delta; - var tol; - var i; - - t.strictEqual( actual.length, expected.length, 'returns expected value' ); - for ( i = 0; i < expected.length; i++ ) { - if ( actual[ i ] === expected[ i ] ) { - t.strictEqual( actual[ i ], expected[ i ], 'returns expected value' ); - } else { - delta = abs( actual[ i ] - expected[ i ] ); - tol = rtol * EPS * abs( expected[ i ] ); - t.ok( delta <= tol, 'within tolerance. actual: '+actual[ i ]+'. expected: '+expected[ i ]+'. delta: '+delta+'. tol: '+tol+'.' ); - } - } -} - - // TESTS // tape( 'main export is a function', function test( t ) { @@ -93,10 +63,10 @@ tape( 'a module instance has an `ndarray` method which calculates the L2-norm of xp = 0; - mod.write( xp, new Complex128Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ) ); + mod.write( xp, new Complex128Array( [ 3.0, -4.0, -6.0, 8.0, 0.0, 3.0 ] ) ); nrm2 = mod.ndarray( 3, xp, 1, 0 ); - isApprox( t, nrm2, 7.4, 1.0 ); + t.strictEqual( nrm2, sqrt( 134.0 ), 'returns expected value' ); // Short datasets: xp = 0; @@ -104,7 +74,7 @@ tape( 'a module instance has an `ndarray` method which calculates the L2-norm of mod.write( xp, new Complex128Array( [ -4.0, 0.0 ] ) ); nrm2 = mod.ndarray( 1, xp, 1, 0 ); - isApprox( t, nrm2, 4.0, 1.0 ); + t.strictEqual( nrm2, 4.0, 'returns expected value' ); t.end(); }); @@ -137,7 +107,7 @@ tape( 'a module instance has an `ndarray` method which supports a `stride` param ])); nrm2 = mod.ndarray( 3, xp, 2, 0 ); - isApprox( t, nrm2, 8.83, 1.0 ); + t.strictEqual( nrm2, sqrt( 78.0 ), 'returns expected value' ); t.end(); }); @@ -157,18 +127,18 @@ tape( 'a module instance has an `ndarray` method which supports a negative `stri xp = 0; mod.write( xp, new Complex128Array([ - 1.0, // 2 - 2.0, // 2 + 1.0, 2.0, - -7.0, - -2.0, // 1 - 3.0, // 1 - 4.0, - 2.0 + 2.0, // 2 + -7.0, // 2 + -2.0, + 3.0, + 4.0, // 1 + 2.0 // 1 ])); nrm2 = mod.ndarray( 2, xp, -2, 3 ); - isApprox( t, nrm2, 4.24, 1.0 ); + t.strictEqual( nrm2, sqrt( 73.0 ), 'returns expected value' ); t.end(); }); @@ -197,11 +167,11 @@ tape( 'a module instance has an `ndarray` method which supports an `x` offset', -2.0, -2.0, 2.0, // 2 - 3.0 // 2 + 3.0 // 2 ])); nrm2 = mod.ndarray( 2, xp, 2, 2 ); - isApprox( t, nrm2, 4.24, 1.0 ); + t.strictEqual( nrm2, sqrt( 18.0 ), 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js index b3d5d93601d2..2e021430a8df 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/dznrm2/test/test.ndarray.js @@ -22,40 +22,10 @@ var tape = require( 'tape' ); var Complex128Array = require( '@stdlib/array/complex128' ); -var EPS = require( '@stdlib/constants/float64/eps' ); -var abs = require( '@stdlib/math/base/special/abs' ); +var sqrt = require( '@stdlib/math/base/special/sqrt' ); var dznrm2 = require( './../lib' ); -// FUNCTIONS // - -/** -* Tests for element-wise approximate equality. -* -* @private -* @param {Object} t - test object -* @param {Collection} actual - actual values -* @param {Collection} expected - expected values -* @param {number} rtol - relative tolerance -*/ -function isApprox( t, actual, expected, rtol ) { - var delta; - var tol; - var i; - - t.strictEqual( actual.length, expected.length, 'returns expected value' ); - for ( i = 0; i < expected.length; i++ ) { - if ( actual[ i ] === expected[ i ] ) { - t.strictEqual( actual[ i ], expected[ i ], 'returns expected value' ); - } else { - delta = abs( actual[ i ] - expected[ i ] ); - tol = rtol * EPS * abs( expected[ i ] ); - t.ok( delta <= tol, 'within tolerance. actual: '+actual[ i ]+'. expected: '+expected[ i ]+'. delta: '+delta+'. tol: '+tol+'.' ); - } - } -} - - // TESTS // tape( 'main export is an object', function test( t ) { @@ -73,16 +43,16 @@ tape( 'the `ndarray` method calculates the L2-norm of a vector', function test( var nrm2; var x; - x = new Complex128Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + x = new Complex128Array( [ 3.0, -4.0, -6.0, 8.0, 0.0, 3.0 ] ); nrm2 = dznrm2.ndarray( x.length, x, 1, 0 ); - isApprox( t, nrm2, 7.4, 2.0 ); + t.strictEqual( nrm2, sqrt( 134.0 ), 'returns expected value' ); // Short datasets: x = new Complex128Array( [ -4.0, 0.0 ] ); nrm2 = dznrm2.ndarray( x.length, x, 1, 0 ); - isApprox( t, nrm2, 4.0, 1.0 ); + t.strictEqual( nrm2, 4.0, 'returns expected value' ); t.end(); }); @@ -105,7 +75,7 @@ tape( 'the `ndarray` method supports a `stride` parameter', function test( t ) { ]); nrm2 = dznrm2.ndarray( 3, x, 2, 0 ); - isApprox( t, nrm2, 8.83, 1.0 ); + t.strictEqual( nrm2, sqrt( 78.0 ), 'returns expected value' ); t.end(); }); @@ -123,8 +93,8 @@ tape( 'the `ndarray` method supports a negative stride parameter', function test 2.0 // 1 ]); - nrm2 = dznrm2.ndarray( 2, x, -2, x.length-2 ); - isApprox( t, nrm2, 8.54, 1.0 ); + nrm2 = dznrm2.ndarray( 2, x, -2, x.length-1 ); + t.strictEqual( nrm2, sqrt( 73.0 ), 'returns expected value' ); t.end(); }); @@ -143,11 +113,11 @@ tape( 'the `ndarray` method supports an `offset` parameter', function test( t ) -2.0, -2.0, 2.0, // 2 - 3.0 // 2 + 3.0 // 2 ]); nrm2 = dznrm2.ndarray( 2, x, 2, 2 ); - isApprox( t, nrm2, 4.24, 1.0 ); + t.strictEqual( nrm2, sqrt( 18.0 ), 'returns expected value' ); t.end(); });