From cd637a4e36caf00585d8a53c20a0ec610c45c236 Mon Sep 17 00:00:00 2001 From: ShabiShett07 Date: Sun, 6 Apr 2025 16:27:42 +0530 Subject: [PATCH 1/6] feat: add blas/base/wasm/sswap --- 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/sswap/README.md | 347 +++++++++++ .../base/wasm/sswap/benchmark/benchmark.js | 106 ++++ .../wasm/sswap/benchmark/benchmark.module.js | 66 +++ .../sswap/benchmark/benchmark.module.main.js | 138 +++++ .../benchmark/benchmark.module.ndarray.js | 138 +++++ .../wasm/sswap/benchmark/benchmark.ndarray.js | 106 ++++ .../blas/base/wasm/sswap/docs/repl.txt | 547 ++++++++++++++++++ .../base/wasm/sswap/docs/types/index.d.ts | 415 +++++++++++++ .../blas/base/wasm/sswap/docs/types/test.ts | 528 +++++++++++++++++ .../blas/base/wasm/sswap/examples/index.js | 49 ++ .../sswap/examples/little_endian_array.js | 74 +++ .../blas/base/wasm/sswap/examples/module.js | 77 +++ .../base/wasm/sswap/lib/binary.browser.js | 33 ++ .../blas/base/wasm/sswap/lib/binary.js | 34 ++ .../@stdlib/blas/base/wasm/sswap/lib/index.js | 119 ++++ .../@stdlib/blas/base/wasm/sswap/lib/main.js | 64 ++ .../blas/base/wasm/sswap/lib/module.js | 253 ++++++++ .../blas/base/wasm/sswap/lib/routine.js | 192 ++++++ .../blas/base/wasm/sswap/manifest.json | 36 ++ .../@stdlib/blas/base/wasm/sswap/package.json | 80 +++ .../blas/base/wasm/sswap/scripts/build.js | 66 +++ .../blas/base/wasm/sswap/scripts/template.txt | 33 ++ .../@stdlib/blas/base/wasm/sswap/src/Makefile | 243 ++++++++ .../blas/base/wasm/sswap/src/exports.json | 4 + .../blas/base/wasm/sswap/src/main.wasm | Bin 0 -> 502 bytes .../@stdlib/blas/base/wasm/sswap/src/main.wat | 207 +++++++ .../@stdlib/blas/base/wasm/sswap/test/test.js | 53 ++ .../blas/base/wasm/sswap/test/test.main.js | 282 +++++++++ .../blas/base/wasm/sswap/test/test.module.js | 154 +++++ .../base/wasm/sswap/test/test.module.main.js | 398 +++++++++++++ .../wasm/sswap/test/test.module.ndarray.js | 504 ++++++++++++++++ .../blas/base/wasm/sswap/test/test.ndarray.js | 308 ++++++++++ .../blas/base/wasm/sswap/test/test.routine.js | 71 +++ 33 files changed, 5725 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/README.md create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/little_endian_array.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/module.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/binary.browser.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/binary.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/module.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/routine.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/manifest.json create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/package.json create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/scripts/build.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/scripts/template.txt create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/src/Makefile create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/src/exports.json create mode 100755 lib/node_modules/@stdlib/blas/base/wasm/sswap/src/main.wasm create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/src/main.wat create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.module.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.module.main.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.module.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.routine.js diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/README.md b/lib/node_modules/@stdlib/blas/base/wasm/sswap/README.md new file mode 100644 index 000000000000..af216f8bb0ba --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/README.md @@ -0,0 +1,347 @@ + + +# sswap + +> Interchange two single-precision floating point vectors. + +
+ +## Usage + +```javascript +var sswap = require( '@stdlib/blas/base/wasm/sswap' ); +``` + +#### sswap.main( N, x, strideX, y, strideY ) + +Interchanges two single-precision floating point vectors. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + +sswap.main( x.length, x, 1, y, 1 ); +// x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +// y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **x**: input [`Float32Array`][@stdlib/array/float32]. +- **strideX**: index increment for `x`. +- **y**: input [`Float32Array`][@stdlib/array/float32]. +- **strideY**: index increment for `y`. + +The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to swap every other element from `x` with elements `y` in reverse order, + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + +sswap.main( 3, x, 2, y, -1 ); +// y => [ 5.0, 3.0, 1.0, 1.0, 1.0, 1.0 ] +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + + + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +// Initial arrays... +var x0 = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var y0 = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + +// Create offset views... +var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element +var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element + +sswap.main( 3, x1, -2, y1, 1 ); +// y0 => [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ] +``` + +#### sswap.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + +Interchanges two single-precision floating point vectors using alternative indexing semantics. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + +sswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); +// x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +// y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +``` + +The function has the following additional parameters: + +- **offsetX**: starting index for `x`. +- **offsetY**: starting index for `y`. + +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to swap every other value in `x` starting from the second value with the last `N` elements in `y`,..., + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var y = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + +sswap.ndarray( 3, x, 2, 1, y, -1, y.length-1 ); +// x => [ 1.0, 12.0, 3.0, 11.0, 5.0, 10.0 ] +// y => [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ] +``` + +* * * + +### Module + +#### sswap.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 sswap.Module( mem ); +// returns + +// Initialize the routine: +mod.initializeSync(); +``` + +#### sswap.Module.prototype.main( N, xp, sx, yp, sy ) + +Interchanges two single-precision floating point vectors. + + + +```javascript +var Memory = require( '@stdlib/wasm/memory' ); +var oneTo = require( '@stdlib/array/one-to' ); +var ones = require( '@stdlib/array/ones' ); +var zeros = require( '@stdlib/array/zeros' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); + +// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): +var mem = new Memory({ + 'initial': 10, + 'maximum': 100 +}); + +// Create a BLAS routine: +var mod = new sswap.Module( mem ); +// returns + +// Initialize the routine: +mod.initializeSync(); + +// Define a vector data type: +var dtype = 'float32'; + +// Specify a vector length: +var N = 5; + +// Define pointers (i.e., byte offsets) for storing two vectors: +var xptr = 0; +var yptr = N * bytesPerElement( dtype ); + +// Write vector values to module memory: +mod.write( xptr, oneTo( N, dtype ) ); +mod.write( yptr, ones( N, dtype ) ); + +// Perform computation: +mod.main( N, xptr, 1, yptr, 1 ); + +// Read out the results: +var viewX = zeros( N, dtype ); +var viewY = zeros( N, dtype ); +mod.read( xptr, viewX ); +mod.read( yptr, viewY ); + +console.log( viewX ); +// => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] + +console.log( viewY ); +// => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **xp**: input [`Float32Array`][@stdlib/array/float32] pointer (i.e., byte offset). +- **sx**: index increment for `x`. +- **yp**: input [`Float32Array`][@stdlib/array/float32] pointer (i.e., byte offset). +- **sy**: index increment for `y`. + +#### sswap.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy ) + +Interchanges two single-precision floating point vectors using alternative indexing semantics. + + + +```javascript +var Memory = require( '@stdlib/wasm/memory' ); +var oneTo = require( '@stdlib/array/one-to' ); +var ones = require( '@stdlib/array/ones' ); +var zeros = require( '@stdlib/array/zeros' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); + +// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): +var mem = new Memory({ + 'initial': 10, + 'maximum': 100 +}); + +// Create a BLAS routine: +var mod = new sswap.Module( mem ); +// returns + +// Initialize the routine: +mod.initializeSync(); + +// Define a vector data type: +var dtype = 'float32'; + +// Specify a vector length: +var N = 5; + +// Define pointers (i.e., byte offsets) for storing two vectors: +var xptr = 0; +var yptr = N * bytesPerElement( dtype ); + +// Write vector values to module memory: +mod.write( xptr, oneTo( N, dtype ) ); +mod.write( yptr, ones( N, dtype ) ); + +// Perform computation: +mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); + +// Read out the results: +var viewX = zeros( N, dtype ); +var viewY = zeros( N, dtype ); +mod.read( xptr, viewX ); +mod.read( yptr, viewY ); + +console.log( viewX ); +// => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] + +console.log( viewY ); +// => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +``` + +The function has the following additional parameters: + +- **ox**: starting index for `x`. +- **oy**: starting index for `y`. + +
+ + + +
+ +* * * + +## Notes + +- If `N <= 0`, both vectors are unchanged. +- This package implements routines using WebAssembly. When provided arrays which are not allocated on a `sswap` 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/sswap`][@stdlib/blas/base/sswap]. 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/sswap`][@stdlib/blas/base/sswap]. 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. +- `sswap()` corresponds to the [BLAS][blas] level 1 function [`sswap`][sswap]. + +
+ + + +
+ +* * * + +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var sswap = require( '@stdlib/blas/base/wasm/sswap' ); + +var opts = { + 'dtype': 'float32' +}; +var x = discreteUniform( 10, 0, 100, opts ); +console.log( x ); + +var y = discreteUniform( x.length, 0, 10, opts ); +console.log( y ); + +sswap.ndarray( x.length, x, 1, 0, y, -1, y.length-1 ); +console.log( y ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[blas]: http://www.netlib.org/blas + +[sswap]: https://www.netlib.org/lapack/explore-html/d7/d51/group__swap_ga9aa6d829e36b30c1f4c0e8f5346defa5.html + +[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray + +[@stdlib/array/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float32 + +[@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/sswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sswap + +
+ + diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.js new file mode 100644 index 000000000000..ee4d795dc0b1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.js @@ -0,0 +1,106 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var sswap = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + sswap.main( x.length, x, 1, y, 1 ); + if ( isnan( y[ i%y.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y[ i%y.length ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.js new file mode 100644 index 000000000000..5c25cc40d86a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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 sswap = 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 sswap.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/sswap/benchmark/benchmark.module.main.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.main.js new file mode 100644 index 000000000000..126a691d671f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.main.js @@ -0,0 +1,138 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var Memory = require( '@stdlib/wasm/memory' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var sswap = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var byteOffset; + var view; + var xptr; + var yptr; + var mod; + var mem; + var nb; + var i; + + // Create a new BLAS routine interface: + mem = new Memory({ + 'initial': 0 + }); + mod = new sswap.Module( mem ); + + // Initialize the module: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Reallocate the underlying memory to allow storing two vectors: + nb = bytesPerElement( options.dtype ); + mod.realloc( len*2*nb ); + + // Define pointers (i.e., byte offsets) to the first vector elements: + xptr = 0; + yptr = len * nb; + + // Write random values to module memory: + mod.write( xptr, uniform( len, -100.0, 100.0, options ) ); + mod.write( yptr, uniform( len, -100.0, 100.0, options ) ); + + // Retrieve a DataView of module memory: + view = mod.view; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + mod.main( len, xptr, 1, yptr, 1 ); + byteOffset = yptr + ( (i%len)*nb ); + if ( isnan( view.getFloat32( byteOffset, true ) ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( view.getFloat32( 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/sswap/benchmark/benchmark.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.ndarray.js new file mode 100644 index 000000000000..3f83f359ac0a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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 sswap = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var byteOffset; + var view; + var xptr; + var yptr; + var mod; + var mem; + var nb; + var i; + + // Create a new BLAS routine interface: + mem = new Memory({ + 'initial': 0 + }); + mod = new sswap.Module( mem ); + + // Initialize the module: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Reallocate the underlying memory to allow storing two vectors: + nb = bytesPerElement( options.dtype ); + mod.realloc( len*2*nb ); + + // Define pointers (i.e., byte offsets) to the first vector elements: + xptr = 0; + yptr = len * nb; + + // Write random values to module memory: + mod.write( xptr, uniform( len, -100.0, 100.0, options ) ); + mod.write( yptr, uniform( len, -100.0, 100.0, options ) ); + + // Retrieve a DataView of module memory: + view = mod.view; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + mod.ndarray( len, xptr, 1, 0, yptr, 1, 0 ); + byteOffset = yptr + ( (i%len)*nb ); + if ( isnan( view.getFloat32( byteOffset, true ) ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( view.getFloat32( 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/sswap/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..82cd97824894 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.ndarray.js @@ -0,0 +1,106 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var pkg = require( './../package.json' ).name; +var sswap = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasWebAssemblySupport() +}; +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( len, -100.0, 100.0, options ); + var y = uniform( len, -100.0, 100.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + sswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); + if ( isnan( y[ i%y.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y[ i%y.length ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':ndarray:len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/repl.txt new file mode 100644 index 000000000000..eee2ae2fda95 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/repl.txt @@ -0,0 +1,547 @@ + +{{alias}}.main( N, x, strideX, y, strideY ) + Interchanges two single-precision floating-point vectors. + + The `N` and stride parameters determine how values from `x` are swapped with + values from `y`. + + Indexing is relative to the first index. To introduce an offset, use typed + array views. + + If `N` is less than or equal to `0`, the vectors are unchanged. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float32Array + First input array. + + strideX: integer + Index increment for `x`. + + y: Float32Array + Second input array. + + strideY: integer + Index increment for `y`. + + Returns + ------- + y: Float32Array + Second input array. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + > var y = new {{alias:@stdlib/array/float32}}( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + > {{alias}}.main( x.length, x, 1, y, 1 ) + [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + + // Using `N` and stride parameters: + > x = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float32}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + > {{alias}}.main( 3, x, 2, y, -1 ) + [ 5.0, 3.0, 1.0, 1.0, 1.0, 1.0 ] + + // Using view offsets: + > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > var y0 = new {{alias:@stdlib/array/float32}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > var y1 = new {{alias:@stdlib/array/float32}}( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); + > {{alias}}.main( 3, x1, -2, y1, 1 ) + [ 6.0, 4.0, 2.0 ] + > y0 + [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ] + + +{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + Interchanges two single-precision floating-point vectors 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: Float32Array + First input array. + + strideX: integer + Index increment for `x`. + + offsetX: integer + Starting index for `x`. + + y: Float32Array + Second input array. + + strideY: integer + Index increment for `y`. + + offsetY: integer + Starting index for `y`. + + Returns + ------- + y: Float32Array + Second input array. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + > var y = new {{alias:@stdlib/array/float32}}( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + > {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ) + [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + + // Advanced indexing: + > x = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/float32}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + > {{alias}}.ndarray( 3, x, 2, 1, y, -1, y.length-1 ) + [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ] + + +{{alias}}.Module( memory ) + Returns a new WebAssembly module wrapper which uses the provided WebAssembly + memory instance as its underlying memory. + + Parameters + ---------- + memory: Memory + WebAssembly memory instance. + + Returns + ------- + mod: Module + WebAssembly module wrapper. + + Examples + -------- + // Create a new memory instance: + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + + // Create a new routine: + > var mod = new {{alias}}.Module( mem ); + + // Initialize the routine: + > mod.initializeSync(); + + +{{alias}}.Module.prototype.binary + Read-only property which returns WebAssembly binary code. + + Returns + ------- + out: Uint8Array + WebAssembly binary code. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.binary + + + +{{alias}}.Module.prototype.memory + Read-only property which returns WebAssembly memory. + + Returns + ------- + mem: Memory|null + WebAssembly memory. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.memory + + + +{{alias}}.Module.prototype.buffer + Read-only property which returns a WebAssembly memory buffer as a + Uint8Array. + + Returns + ------- + buf: Uint8Array|null + WebAssembly memory buffer. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.buffer + + + +{{alias}}.Module.prototype.view + Read-only property which returns a WebAsssembly memory buffer as a DataView. + + Returns + ------- + view: DataView|null + WebAssembly memory view. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.view + + + +{{alias}}.Module.prototype.exports + Read-only property which returns "raw" WebAssembly module exports. + + Returns + ------- + out: Object|null + WebAssembly module exports. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.exports + {...} + + +{{alias}}.Module.prototype.initialize() + Asynchronously initializes a WebAssembly module instance. + + Returns + ------- + p: Promise + Promise which resolves upon initializing a WebAssembly module instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initialize(); + + +{{alias}}.Module.prototype.initializeAsync( clbk ) + Asynchronously initializes a WebAssembly module instance. + + Parameters + ---------- + clbk: Function + Callback to invoke upon initializing a WebAssembly module instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > function clbk() { console.log( 'done' ) }; + > mod.initializeAsync( clbk ); + + +{{alias}}.Module.prototype.initializeSync() + Synchronously initializes a WebAssembly module instance. + + In web browsers, JavaScript engines may raise an exception when attempting + to synchronously compile large WebAssembly binaries due to concerns about + blocking the main thread. Hence, to initialize WebAssembly modules having + large binaries (e.g., >4KiB), consider using asynchronous initialization + methods in browser contexts. + + Returns + ------- + mod: Module + Module wrapper instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + + +{{alias}}.Module.prototype.realloc( nbytes ) + Reallocates the underlying WebAssembly memory instance to a specified number + of bytes. + + WebAssembly memory can only *grow*, not shrink. Hence, if provided a number + of bytes which is less than or equal to the size of the current memory, the + function does nothing. + + When non-shared memory is resized, the underlying the `ArrayBuffer` is + detached, consequently invalidating any associated typed array views. Before + resizing non-shared memory, ensure that associated typed array views no + longer need byte access and can be garbage collected. + + Parameters + ---------- + nbytes: integer + Memory size (in bytes). + + Returns + ------- + bool: boolean + Boolean indicating whether the resize operation was successful. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ) + + + +{{alias}}.Module.prototype.hasCapacity( byteOffset, values ) + Returns a boolean indicating whether the underlying WebAssembly memory + instance has the capacity to store a provided list of values starting from a + specified byte offset. + + Parameters + ---------- + byteOffset: integer + Byte offset at which to start writing values. + + values: ArrayLikeObject + Input array containing values to write. + + Returns + ------- + bool: boolean + Boolean indicating whether the underlying WebAssembly memory instance + has enough capacity. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ); + > mod.hasCapacity( 0, [ 1, 2, 3, 4 ] ) + true + + +{{alias}}.Module.prototype.isView( values ) + Returns a boolean indicating whether a provided list of values is a view of + the underlying memory of the WebAssembly module. + + Parameters + ---------- + values: ArrayLikeObject + Input array. + + Returns + ------- + bool: boolean + Boolean indicating whether the list is a memory view. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ); + > mod.isView( [ 1, 2, 3, 4 ] ) + false + + +{{alias}}.Module.prototype.write( byteOffset, values ) + Writes values to the underlying WebAssembly memory instance. + + The function infers element size (i.e., number of bytes per element) from + the data type of the input array. For example, if provided a Float32Array, + the function writes each element as a single-precision floating-point number + to the underlying WebAssembly memory instance. + + In order to write elements as a different data type, you need to perform an + explicit cast *before* calling this method. For example, in order to write + single-precision floating-point numbers contained in a Float32Array as + signed 32-bit integers, you must first convert the Float32Array to an + Int32Array before passing the values to this method. + + If provided an array having an unknown or "generic" data type, elements are + written as single-precision floating-point numbers. + + Parameters + ---------- + byteOffset: integer + Byte offset at which to start writing values. + + values: ArrayLikeObject + Input array containing values to write. + + Returns + ------- + mod: Module + Module wrapper instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ); + > mod.write( 0, [ 1, 2, 3, 4 ] ); + + +{{alias}}.Module.prototype.read( byteOffset, out ) + Reads values from the underlying WebAssembly memory instance. + + The function infers element size (i.e., number of bytes per element) from + the data type of the output array. For example, if provided a Float32Array, + the function reads each element as a single-precision floating-point number + from the underlying WebAssembly memory instance. + + In order to read elements as a different data type, you need to perform an + explicit cast *after* calling this method. For example, in order to read + single-precision floating-point numbers contained in a Float32Array as + signed 32-bit integers, you must convert the Float32Array to an Int32Array + after reading memory values using this method. + + If provided an output array having an unknown or "generic" data type, + elements are read as single-precision floating-point numbers. + + Parameters + ---------- + byteOffset: integer + Byte offset at which to start reading values. + + out: ArrayLikeObject + Output array for storing read values. + + Returns + ------- + mod: Module + Module wrapper instance. + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 0 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + > mod.realloc( 100 ); + > mod.write( 0, [ 1, 2, 3, 4 ] ); + > var out = [ 0, 0, 0, 0 ]; + > mod.read( 0, out ); + > out + [ 1, 2, 3, 4 ] + + +{{alias}}.Module.prototype.main( N, xp, sx, yp, sy ) + Interchanges two single-precision floating point vectors. + + Parameters + ---------- + N: integer + Number of indexed elements. + + xp: integer + First input array pointer (i.e., byte offset). + + sx: integer + Index increment for `x`. + + yp: integer + Second input array pointer (i.e., byte offset). + + sy: integer + Index increment for `y`. + + Returns + ------- + yp: integer + Second input array pointer (i.e., byte offset). + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 1 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + + // Define "pointers" (i.e., byte offsets) into module memory: + > var xptr = 0; + > var yptr = 40; + + // Write data to module memory: + > mod.write( xptr, {{alias:@stdlib/array/one-to}}( 5, 'float32' ) ); + > mod.write( yptr, {{alias:@stdlib/array/ones}}( 5, 'float32' ) ); + + // Perform computation: + > mod.main( 5, xptr, 1, yptr, 1 ); + + // Extract results from module memory: + > var view = {{alias:@stdlib/array/zeros}}( 5, 'float32' ); + > mod.read( yptr, view ); + > view + [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + + +{{alias}}.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy ) + Interchanges two single-precision floating point vectors using alternative + indexing semantics. + + Parameters + ---------- + N: integer + Number of indexed elements. + + xp: integer + First input array pointer (i.e., byte offset). + + sx: integer + Index increment for `x`. + + ox: integer + Starting index for `x`. + + yp: integer + Second input array pointer (i.e., byte offset). + + sy: integer + Index increment for `y`. + + oy: integer + Starting index for `y`. + + Returns + ------- + oy: integer + Second input array pointer (i.e., byte offset). + + Examples + -------- + > var mem = new {{alias:@stdlib/wasm/memory}}( { 'initial': 1 } ); + > var mod = new {{alias}}.Module( mem ); + > mod.initializeSync(); + + // Define "pointers" (i.e., byte offsets) into module memory: + > var xptr = 0; + > var yptr = 40; + + // Write data to module memory: + > mod.write( xptr, {{alias:@stdlib/array/one-to}}( 5, 'float32' ) ); + > mod.write( yptr, {{alias:@stdlib/array/ones}}( 5, 'float32' ) ); + + // Perform computation: + > mod.ndarray( 5, xptr, 1, 0, yptr, 1, 0 ); + + // Extract results from module memory: + > var view = {{alias:@stdlib/array/zeros}}( 5, 'float32' ); + > mod.read( yptr, view ); + > view + [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/types/index.d.ts new file mode 100644 index 000000000000..205b60ce3f18 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/types/index.d.ts @@ -0,0 +1,415 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/// + +import { ModuleWrapper, Memory } from '@stdlib/types/wasm'; + +/** +* Interface defining a module constructor which is both "newable" and "callable". +*/ +interface ModuleConstructor { + /** + * Returns a new WebAssembly module wrapper instance which uses the provided WebAssembly memory instance as its underlying memory. + * + * @param mem - WebAssembly memory instance + * @returns module wrapper instance + * + * @example + * var Memory = require( '@stdlib/wasm/memory' ); + * var oneTo = require( '@stdlib/array/one-to' ); + * var ones = require( '@stdlib/array/ones' ); + * var zeros = require( '@stdlib/array/zeros' ); + * var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); + * + * // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): + * var mem = new Memory({ + * 'initial': 10, + * 'maximum': 100 + * }); + * + * // Create a BLAS routine: + * var mod = new sswap.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float32'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointers (i.e., byte offsets) for storing two vectors: + * var xptr = 0; + * var yptr = N * bytesPerElement( dtype ); + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.main( N, xptr, 1, yptr, 1 ); + * // returns + * + * var bool = ( ptr === yptr ); + * // returns true + * + * // Read out the results: + * var viewX = zeros( N, dtype ); + * var viewY = zeros( n, dtype ); + * mod.read( xptr, viewX ) + * mod.read( yptr, viewY ); + * // viewX => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] + * // viewY => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + new( mem: Memory ): Module; // newable + + /** + * Returns a new WebAssembly module wrapper instance which uses the provided WebAssembly memory instance as its underlying memory. + * + * @param mem - WebAssembly memory instance + * @returns module wrapper instance + * + * @example + * var Memory = require( '@stdlib/wasm/memory' ); + * var oneTo = require( '@stdlib/array/one-to' ); + * var ones = require( '@stdlib/array/ones' ); + * var zeros = require( '@stdlib/array/zeros' ); + * var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); + * + * // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): + * var mem = new Memory({ + * 'initial': 10, + * 'maximum': 100 + * }); + * + * // Create a BLAS routine: + * var mod = sswap.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float32'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointers (i.e., byte offsets) for storing two vectors: + * var xptr = 0; + * var yptr = N * bytesPerElement( dtype ); + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.main( N, xptr, 1, yptr, 1 ); + * // returns + * + * var bool = ( ptr === yptr ); + * // returns true + * + * // Read out the results: + * var viewX = zeros( N, dtype ); + * var viewY = zeros( n, dtype ); + * mod.read( xptr, viewX ) + * mod.read( yptr, viewY ); + * // viewX => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] + * // viewY => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + ( mem: Memory ): Module; // callable +} + +/** +* Interface describing a `sswap` WebAssembly module. +*/ +interface Module extends ModuleWrapper { + /** + * Interchanges two single-precision floating point vectors. + * + * @param N - number of indexed elements + * @param xptr - first input array pointer (i.e., byte offset) + * @param strideX - `x` stride length + * @param yptr - second input array pointer (i.e., byte offset) + * @param strideY - `y` stride length + * @returns second input array pointer (i.e., byte offset) + * + * @example + * var Memory = require( '@stdlib/wasm/memory' ); + * var oneTo = require( '@stdlib/array/one-to' ); + * var ones = require( '@stdlib/array/ones' ); + * var zeros = require( '@stdlib/array/zeros' ); + * var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); + * + * // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): + * var mem = new Memory({ + * 'initial': 10, + * 'maximum': 100 + * }); + * + * // Create a BLAS routine: + * var mod = new sswap.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float32'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointers (i.e., byte offsets) for storing two vectors: + * var xptr = 0; + * var yptr = N * bytesPerElement( dtype ); + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.main( N, xptr, 1, yptr, 1 ); + * // returns + * + * var bool = ( ptr === yptr ); + * // returns true + * + * // Read out the results: + * var viewX = zeros( N, dtype ); + * var viewY = zeros( n, dtype ); + * mod.read( xptr, viewX ) + * mod.read( yptr, viewY ); + * // viewX => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] + * // viewY => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + main( N: number, xptr: number, strideX: number, yptr: number, strideY: number ): number; + + /** + * Interchanges two single-precision floating point vectors using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param xptr - first input array pointer (i.e., byte offset) + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @param yptr - second input array pointer (i.e., byte offset) + * @param strideY - `y` stride length + * @param offsetY - starting index for `y` + * @returns second input array pointer (i.e., byte offset) + * + * @example + * var Memory = require( '@stdlib/wasm/memory' ); + * var oneTo = require( '@stdlib/array/one-to' ); + * var ones = require( '@stdlib/array/ones' ); + * var zeros = require( '@stdlib/array/zeros' ); + * var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); + * + * // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): + * var mem = new Memory({ + * 'initial': 10, + * 'maximum': 100 + * }); + * + * // Create a BLAS routine: + * var mod = new sswap.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float32'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointers (i.e., byte offsets) for storing two vectors: + * var xptr = 0; + * var yptr = N * bytesPerElement( dtype ); + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); + * // returns + * + * var bool = ( ptr === yptr ); + * // returns true + * + * // Read out the results: + * var viewX = zeros( N, dtype ); + * var viewY = zeros( n, dtype ); + * mod.read( xptr, viewX ) + * mod.read( yptr, viewY ); + * // viewX => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] + * // viewY => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + ndarray( N: number, xptr: number, strideX: number, offsetX: number, yptr: number, strideY: number, offsetY: number ): number; +} + +/** +* Interface describing `sswap`. +*/ +interface Routine extends ModuleWrapper { + /** + * Interchanges two single-precision floating point vectors. + * + * @param N - number of indexed elements + * @param x - first input array + * @param strideX - `x` stride length + * @param y - second input array + * @param strideY - `y` stride length + * @returns second input array + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + * + * sswap.main( x.length, x, 1, y, 1 ); + * // x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] + * // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + main( N: number, x: Float32Array, strideX: number, y: Float32Array, strideY: number ): Float32Array; + + /** + * Interchanges two single-precision floating point vectors using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param x - first input array + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @param y - second input array + * @param strideY - `y` stride length + * @param offsetY - starting index for `y` + * @returns second input array + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + * + * sswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); + * // x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] + * // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + ndarray( N: number, x: Float32Array, strideX: number, offsetX: number, y: Float32Array, strideY: number, offsetY: number ): Float32Array; + + /** + * Returns a new WebAssembly module wrapper instance which uses the provided WebAssembly memory instance as its underlying memory. + * + * @param mem - WebAssembly memory instance + * @returns module wrapper instance + * + * @example + * var Memory = require( '@stdlib/wasm/memory' ); + * var oneTo = require( '@stdlib/array/one-to' ); + * var ones = require( '@stdlib/array/ones' ); + * var zeros = require( '@stdlib/array/zeros' ); + * var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); + * + * // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): + * var mem = new Memory({ + * 'initial': 10, + * 'maximum': 100 + * }); + * + * // Create a BLAS routine: + * var mod = new sswap.Module( mem ); + * // returns + * + * // Initialize the routine: + * mod.initializeSync(); + * + * // Define a vector data type: + * var dtype = 'float32'; + * + * // Specify a vector length: + * var N = 5; + * + * // Define pointers (i.e., byte offsets) for storing two vectors: + * var xptr = 0; + * var yptr = N * bytesPerElement( dtype ); + * + * // Write vector values to module memory: + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); + * + * // Perform computation: + * var ptr = mod.main( N, xptr, 1, yptr, 1 ); + * // returns + * + * var bool = ( ptr === yptr ); + * // returns true + * + * // Read out the results: + * var viewX = zeros( N, dtype ); + * var viewY = zeros( n, dtype ); + * mod.read( xptr, viewX ) + * mod.read( yptr, viewY ); + * // viewX => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] + * // viewY => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] + */ + Module: ModuleConstructor; +} + +/** +* Interchanges two single-precision floating point vectors. +* +* @param N - number of indexed elements +* @param x - first input array +* @param strideX - `x` stride length +* @param y - second input array +* @param strideY - `y` stride length +* @returns second input array +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* sswap.main( x.length, x, 1, y, 1 ); +* // x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* sswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +declare var sswap: Routine; + + +// EXPORTS // + +export = sswap; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/types/test.ts new file mode 100644 index 000000000000..bcccb80c2910 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/types/test.ts @@ -0,0 +1,528 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/* eslint-disable space-in-parens */ + +import Memory = require( '@stdlib/wasm/memory' ); +import sswap = require( './index' ); + + +// TESTS // + +// Attached to the main export is a `main` method which returns a Float32Array... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.main( x.length, x, 1, y, 1 ); // $ExpectType Float32Array +} + +// The compiler throws an error if the `main` method is provided a first argument which is not a number... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.main( '10', x, 1, y, 1 ); // $ExpectError + sswap.main( true, x, 1, y, 1 ); // $ExpectError + sswap.main( false, x, 1, y, 1 ); // $ExpectError + sswap.main( null, x, 1, y, 1 ); // $ExpectError + sswap.main( undefined, x, 1, y, 1 ); // $ExpectError + sswap.main( [], x, 1, y, 1 ); // $ExpectError + sswap.main( {}, x, 1, y, 1 ); // $ExpectError + sswap.main( ( x: number ): number => x, x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a second argument which is not a Float32Array... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.main( x.length, 10, 1, y, 1 ); // $ExpectError + sswap.main( x.length, '10', 1, y, 1 ); // $ExpectError + sswap.main( x.length, true, 1, y, 1 ); // $ExpectError + sswap.main( x.length, false, 1, y, 1 ); // $ExpectError + sswap.main( x.length, null, 1, y, 1 ); // $ExpectError + sswap.main( x.length, undefined, 1, y, 1 ); // $ExpectError + sswap.main( x.length, [], 1, y, 1 ); // $ExpectError + sswap.main( x.length, {}, 1, y, 1 ); // $ExpectError + sswap.main( x.length, ( x: number ): number => x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a third argument which is not a number... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.main( x.length, x, '10', y, 1 ); // $ExpectError + sswap.main( x.length, x, true, y, 1 ); // $ExpectError + sswap.main( x.length, x, false, y, 1 ); // $ExpectError + sswap.main( x.length, x, null, y, 1 ); // $ExpectError + sswap.main( x.length, x, undefined, y, 1 ); // $ExpectError + sswap.main( x.length, x, [], y, 1 ); // $ExpectError + sswap.main( x.length, x, {}, y, 1 ); // $ExpectError + sswap.main( x.length, x, ( x: number ): number => x, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a fourth argument which is not a Float32Array... +{ + const x = new Float32Array( 10 ); + + sswap.main( x.length, x, 1, 10, 1 ); // $ExpectError + sswap.main( x.length, x, 1, '10', 1 ); // $ExpectError + sswap.main( x.length, x, 1, true, 1 ); // $ExpectError + sswap.main( x.length, x, 1, false, 1 ); // $ExpectError + sswap.main( x.length, x, 1, null, 1 ); // $ExpectError + sswap.main( x.length, x, 1, undefined, 1 ); // $ExpectError + sswap.main( x.length, x, 1, [], 1 ); // $ExpectError + sswap.main( x.length, x, 1, {}, 1 ); // $ExpectError + sswap.main( x.length, x, 1, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided a fifth argument which is not a number... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.main( x.length, x, 1, y, '10' ); // $ExpectError + sswap.main( x.length, x, 1, y, true ); // $ExpectError + sswap.main( x.length, x, 1, y, false ); // $ExpectError + sswap.main( x.length, x, 1, y, null ); // $ExpectError + sswap.main( x.length, x, 1, y, undefined ); // $ExpectError + sswap.main( x.length, x, 1, y, [] ); // $ExpectError + sswap.main( x.length, x, 1, y, {} ); // $ExpectError + sswap.main( x.length, x, 1, y, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `main` method is provided an unsupported number of arguments... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.main(); // $ExpectError + sswap.main( x.length ); // $ExpectError + sswap.main( x.length, x ); // $ExpectError + sswap.main( x.length, x, 1 ); // $ExpectError + sswap.main( x.length, x, 1, y ); // $ExpectError + sswap.main( x.length, x, 1, y, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Float32Array... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectType Float32Array +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.ndarray( '10', x, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( true, x, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( false, x, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( null, x, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( undefined, x, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( [], x, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( {}, x, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( ( x: number ): number => x, x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Float32Array... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.ndarray( x.length, 10, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, '10', 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, true, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, false, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, null, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, undefined, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, [], 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, {}, 1, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, ( x: number ): number => x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.ndarray( x.length, x, '10', 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, true, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, false, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, null, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, undefined, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, [], 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, {}, 0, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, ( x: number ): number => x, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.ndarray( x.length, x, 1, '10', y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, true, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, false, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, null, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, undefined, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, [], y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, {}, y, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, ( x: number ): number => x, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a Float32Array... +{ + const x = new Float32Array( 10 ); + + sswap.ndarray( x.length, x, 1, 0, 10, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, '10', 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, true, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, false, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, null, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, undefined, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, [], 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, {}, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.ndarray( x.length, x, 1, 0, y, '10', 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, true, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, false, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, null, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, undefined, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, [], 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, {}, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.ndarray( x.length, x, 1, 0, y, 1, '10' ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, 1, true ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, 1, false ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, 1, null ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, 1, undefined ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, 1, [] ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, 1, {} ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const x = new Float32Array( 10 ); + const y = new Float32Array( 10 ); + + sswap.ndarray(); // $ExpectError + sswap.ndarray( x.length ); // $ExpectError + sswap.ndarray( x.length, x ); // $ExpectError + sswap.ndarray( x.length, x, 1 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError + sswap.ndarray( x.length, x, 1, 0, y, 1, 0, 10 ); // $ExpectError +} + +// Attached to the main export is a `Module` constructor which returns a module... +{ + const mem = new Memory({ + 'initial': 0 + }); + + sswap.Module( mem ); // $ExpectType Module +} + +// The compiler throws an error if the `Module` constructor is not provided a WebAssembly memory instance... +{ + sswap.Module( '10' ); // $ExpectError + sswap.Module( true ); // $ExpectError + sswap.Module( false ); // $ExpectError + sswap.Module( null ); // $ExpectError + sswap.Module( undefined ); // $ExpectError + sswap.Module( [] ); // $ExpectError + sswap.Module( {} ); // $ExpectError + sswap.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 = sswap.Module( mem ); + + mod.main( 10, 0, 1, 80, 1 ); // $ExpectType number +} + +// The compiler throws an error if the `main` method of a module instance is provided a first argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.main( '10', 10, 1, 80, 1 ); // $ExpectError + mod.main( true, 10, 1, 80, 1 ); // $ExpectError + mod.main( false, 10, 1, 80, 1 ); // $ExpectError + mod.main( null, 10, 1, 80, 1 ); // $ExpectError + mod.main( undefined, 10, 1, 80, 1 ); // $ExpectError + mod.main( [], 10, 1, 80, 1 ); // $ExpectError + mod.main( {}, 10, 1, 80, 1 ); // $ExpectError + mod.main( ( x: number ): number => x, 10, 1, 80, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided a second argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.main( 10, '10', 1, 80, 1 ); // $ExpectError + mod.main( 10, true, 1, 80, 1 ); // $ExpectError + mod.main( 10, false, 1, 80, 1 ); // $ExpectError + mod.main( 10, null, 1, 80, 1 ); // $ExpectError + mod.main( 10, undefined, 1, 80, 1 ); // $ExpectError + mod.main( 10, [], 1, 80, 1 ); // $ExpectError + mod.main( 10, {}, 1, 80, 1 ); // $ExpectError + mod.main( 10, ( x: number ): number => x, 1, 80, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided a third argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.main( 10, 0, '10', 80, 1 ); // $ExpectError + mod.main( 10, 0, true, 80, 1 ); // $ExpectError + mod.main( 10, 0, false, 80, 1 ); // $ExpectError + mod.main( 10, 0, null, 80, 1 ); // $ExpectError + mod.main( 10, 0, undefined, 80, 1 ); // $ExpectError + mod.main( 10, 0, [], 80, 1 ); // $ExpectError + mod.main( 10, 0, {}, 80, 1 ); // $ExpectError + mod.main( 10, 0, ( x: number ): number => x, 80, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided a fourth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.main( 10, 0, 1, '10', 1 ); // $ExpectError + mod.main( 10, 0, 1, true, 1 ); // $ExpectError + mod.main( 10, 0, 1, false, 1 ); // $ExpectError + mod.main( 10, 0, 1, null, 1 ); // $ExpectError + mod.main( 10, 0, 1, undefined, 1 ); // $ExpectError + mod.main( 10, 0, 1, [], 1 ); // $ExpectError + mod.main( 10, 0, 1, {}, 1 ); // $ExpectError + mod.main( 10, 0, 1, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided a fifth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.main( 10, 0, 1, 80, '10' ); // $ExpectError + mod.main( 10, 0, 1, 80, true ); // $ExpectError + mod.main( 10, 0, 1, 80, false ); // $ExpectError + mod.main( 10, 0, 1, 80, null ); // $ExpectError + mod.main( 10, 0, 1, 80, undefined ); // $ExpectError + mod.main( 10, 0, 1, 80, [] ); // $ExpectError + mod.main( 10, 0, 1, 80, {} ); // $ExpectError + mod.main( 10, 0, 1, 80, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `main` method of a module instance is provided an unsupported number of arguments... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.main(); // $ExpectError + mod.main( 10 ); // $ExpectError + mod.main( 10, 0 ); // $ExpectError + mod.main( 10, 0, 1 ); // $ExpectError + mod.main( 10, 0, 1, 80 ); // $ExpectError + mod.main( 10, 0, 1, 80, 1, 10 ); // $ExpectError +} + +// The `Module` constructor returns a module instance having an `ndarray` method which returns a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.ndarray( 10, 0, 1, 0, 80, 1, 0 ); // $ExpectType number +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a first argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.ndarray( '10', 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( true, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( false, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( null, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( undefined, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( [], 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( {}, 0, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( ( x: number ): number => x, 0, 1, 0, 80, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a second argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.ndarray( 10, '10', 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, true, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, false, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, null, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, undefined, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, [], 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, {}, 1, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, ( x: number ): number => x, 1, 0, 80, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a third argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.ndarray( 10, 0, '10', 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, true, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, false, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, null, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, undefined, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, [], 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, {}, 0, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, ( x: number ): number => x, 0, 80, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a fourth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.ndarray( 10, 0, 1, '10', 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, true, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, false, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, null, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, undefined, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, [], 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, {}, 80, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, ( x: number ): number => x, 80, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a fifth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.ndarray( 10, 0, 1, 0, '10', 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, true, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, false, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, null, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, undefined, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, [], 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, {}, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a sixth argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.ndarray( 10, 0, 1, 0, 80, '10', 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, true, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, false, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, null, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, undefined, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, [], 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, {}, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided a seventh argument which is not a number... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.ndarray( 10, 0, 1, 0, 80, 1, '10' ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, true ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, false ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, null ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, undefined ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, [] ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, {} ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method of a module instance is provided an unsupported number of arguments... +{ + const mem = new Memory({ + 'initial': 1 + }); + const mod = sswap.Module( mem ); + + mod.ndarray(); // $ExpectError + mod.ndarray( 10 ); // $ExpectError + mod.ndarray( 10, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1 ); // $ExpectError + mod.ndarray( 10, 0, 1, 0, 80, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/index.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/index.js new file mode 100644 index 000000000000..8fb2aec65058 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/index.js @@ -0,0 +1,49 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var oneTo = require( '@stdlib/array/one-to' ); +var ones = require( '@stdlib/array/ones' ); +var sswap = require( './../lib' ); + +function main() { + if ( !hasWebAssemblySupport() ) { + console.error( 'Environment does not support WebAssembly.' ); + return; + } + // Specify a vector length: + var N = 5; + + // Create two arrays: + var x = oneTo( N, 'float32' ); + var y = ones( N, 'float32' ); + + // Perform computation: + sswap.ndarray( N, x, 1, 0, y, 1, 0 ); + + // Print the results: + console.log( x ); + // => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] + + console.log( y ); + // => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/little_endian_array.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/little_endian_array.js new file mode 100644 index 000000000000..05d11efde379 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/little_endian_array.js @@ -0,0 +1,74 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var Memory = require( '@stdlib/wasm/memory' ); +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; +var gfill = require( '@stdlib/blas/ext/base/gfill' ); +var gfillBy = require( '@stdlib/blas/ext/base/gfill-by' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +var Float32ArrayLE = require( '@stdlib/array/little-endian-float32' ); +var sswap = 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 sswap.Module( mem ); + // returns + + // Initialize the routine: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Define a vector data type: + var dtype = 'float32'; + + // Specify a vector length: + var N = 5; + + // Define pointers (i.e., byte offsets) for storing two vectors: + var xptr = 0; + var yptr = N * bytesPerElement( dtype ); + + // Create typed array views over module memory: + var x = new Float32ArrayLE( mod.memory.buffer, xptr, N ); + var y = new Float32ArrayLE( mod.memory.buffer, yptr, N ); + + // Write values to module memory: + gfillBy( N, x, 1, discreteUniform( -10.0, 10.0 ) ); + gfill( N, 1.0, y, 1 ); + + // Perform computation: + mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); + + // Print the results: + console.log( 'x[:] = [%s]', x.toString() ); + console.log( 'y[:] = [%s]', y.toString() ); +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/module.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/module.js new file mode 100644 index 000000000000..3ed45926c5dd --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/module.js @@ -0,0 +1,77 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var hasWebAssemblySupport = require( '@stdlib/assert/has-wasm-support' ); +var Memory = require( '@stdlib/wasm/memory' ); +var oneTo = require( '@stdlib/array/one-to' ); +var ones = require( '@stdlib/array/ones' ); +var zeros = require( '@stdlib/array/zeros' ); +var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +var sswap = 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 sswap.Module( mem ); + // returns + + // Initialize the routine: + mod.initializeSync(); // eslint-disable-line node/no-sync + + // Define a vector data type: + var dtype = 'float32'; + + // Specify a vector length: + var N = 5; + + // Define pointers (i.e., byte offsets) for storing two vectors: + var xptr = 0; + var yptr = N * bytesPerElement( dtype ); + + // Write vector values to module memory: + mod.write( xptr, oneTo( N, dtype ) ); + mod.write( yptr, ones( N, dtype ) ); + + // Perform computation: + mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); + + // Read out the results: + var viewX = zeros( N, dtype ); + var viewY = zeros( N, dtype ); + mod.read( xptr, viewX ); + mod.read( yptr, viewY ); + + console.log( viewX ); + // => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] + + console.log( viewY ); + // => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/binary.browser.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/binary.browser.js new file mode 100644 index 000000000000..f17378873bab --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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( 'AGFzbQEAAAAADwhkeWxpbmsuMAEEAAAAAAEWA2AAAGAFf39/f38AYAd/f39/f39/AAIPAQNlbnYGbWVtb3J5AgAAAwQDAAECBzEDEV9fd2FzbV9jYWxsX2N0b3JzAAAHY19zc3dhcAABD2Nfc3N3YXBfbmRhcnJheQACCvgCAwMAAQstACAAIAEgAkEBIABrIgAgAmxBACACQQBMGyADIAQgACAEbEEAIARBAEwbEAILwwICAX0CfwJAIABBAEwNACACQQFHIAVBAUdyRQRAIABBA3AiCARAQQAhAgNAIAIgCEZFBEAgASADQQJ0aiIFKgIAIQcgBSAEIAZBAnRqIgUqAgA4AgAgBSAHOAIAIAJBAWohAiAGQQFqIQYgA0EBaiEDDAELCyAAQQNIDQILA0AgACAITA0CIAEgA0ECdGoiAioCACEHIAIgBCAGQQJ0aiIFKgIAOAIAIAUgBzgCACACKgIEIQcgAiAFKgIEOAIEIAUgBzgCBCACKgIIIQcgAiAFKgIIOAIIIAUgBzgCCCAIQQNqIQggBkEDaiEGIANBA2ohAwwACwALA0AgACAIRg0BIAEgA0ECdGoiCSoCACEHIAkgBCAGQQJ0aiIJKgIAOAIAIAkgBzgCACAIQQFqIQggBSAGaiEGIAIgA2ohAwwACwALCw==' ); + + +// EXPORTS // + +module.exports = wasm; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/binary.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/binary.js new file mode 100644 index 000000000000..6f02393f96e5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/lib/index.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/index.js new file mode 100644 index 000000000000..22edbf12ad08 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/index.js @@ -0,0 +1,119 @@ +/** +* @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 interchange two single-precision floating-point vectors. +* +* @module @stdlib/blas/base/wasm/sswap +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var sswap = require( '@stdlib/blas/base/wasm/sswap' ); +* +* // Define strided arrays: +* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* sswap.main( x.length, x, 1, y, 1 ); +* // x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var sswap = require( '@stdlib/blas/base/wasm/sswap' ); +* +* // Define strided arrays: +* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* sswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +* +* @example +* var Memory = require( '@stdlib/wasm/memory' ); +* var oneTo = require( '@stdlib/array/one-to' ); +* var ones = require( '@stdlib/array/ones' ); +* var zeros = require( '@stdlib/array/zeros' ); +* var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +* var sswap = require( '@stdlib/blas/base/wasm/sswap' ); +* +* // 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 sswap.Module( mem ); +* // returns +* +* // Initialize the routine: +* mod.initializeSync(); +* +* // Define a vector data type: +* var dtype = 'float32'; +* +* // Specify a vector length: +* var N = 5; +* +* // Define pointers (i.e., byte offsets) for storing two vectors: +* var xptr = 0; +* var yptr = N * bytesPerElement( dtype ); +* +* // Write vector values to module memory: +* mod.write( xptr, oneTo( N, dtype ) ); +* mod.write( yptr, ones( N, dtype ) ); +* +* // Perform computation: +* mod.main( N, xptr, 1, yptr, 1 ); +* +* // Read out the results: +* var viewX = zeros( N, dtype ); +* var viewY = zeros( N, dtype ); +* mod.read( xptr, viewX ); +* mod.read( yptr, viewY ); +* +* console.log( viewX ); +* // => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* +* console.log( viewY ); +* // => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ + +// MODULES // + +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var main = require( './main.js' ); +var Module = require( './module.js' ); + + +// MAIN // + +setReadOnly( main, 'Module', Module ); + + +// EXPORTS // + +module.exports = main; + +// exports: { "Module": "main.Module" } diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/main.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/main.js new file mode 100644 index 000000000000..dd138ccb2b9e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/main.js @@ -0,0 +1,64 @@ +/** +* @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 interchange two single-precision floating-point vectors. +* +* @name sswap +* @type {Routine} +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* // Define strided arrays: +* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* sswap.main( x.length, x, 1, y, 1 ); +* // x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* // Define strided arrays: +* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* sswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +var sswap = new Routine(); +sswap.initializeSync(); // eslint-disable-line node/no-sync + + +// EXPORTS // + +module.exports = sswap; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/module.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/module.js new file mode 100644 index 000000000000..8301af57ae46 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/module.js @@ -0,0 +1,253 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/* eslint-disable no-restricted-syntax, no-invalid-this */ + +'use strict'; + +// MODULES // + +var isWebAssemblyMemory = require( '@stdlib/assert/is-wasm-memory' ); +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var inherits = require( '@stdlib/utils/inherit' ); +var WasmModule = require( '@stdlib/wasm/module-wrapper' ); +var format = require( '@stdlib/string/format' ); +var wasmBinary = require( './binary.js' ); + + +// MAIN // + +/** +* BLAS routine WebAssembly module wrapper constructor. +* +* @constructor +* @param {Object} memory - WebAssembly memory instance +* @throws {TypeError} must provide a WebAssembly memory instance +* @returns {Module} module instance +* +* @example +* var Memory = require( '@stdlib/wasm/memory' ); +* var oneTo = require( '@stdlib/array/one-to' ); +* var ones = require( '@stdlib/array/ones' ); +* var zeros = require( '@stdlib/array/zeros' ); +* var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +* +* // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): +* var mem = new Memory({ +* 'initial': 10, +* 'maximum': 100 +* }); +* +* // Create a BLAS routine: +* var sswap = new Module( mem ); +* // returns +* +* // Initialize the routine: +* sswap.initializeSync(); +* +* // Define a vector data type: +* var dtype = 'float32'; +* +* // Specify a vector length: +* var N = 5; +* +* // Define pointers (i.e., byte offsets) for storing two vectors: +* var xptr = 0; +* var yptr = N * bytesPerElement( dtype ); +* +* // Write vector values to module memory: +* sswap.write( xptr, oneTo( N, dtype ) ); +* sswap.write( yptr, ones( N, dtype ) ); +* +* // Perform computation: +* var ptr = sswap.main( N, xptr, 1, yptr, 1 ); +* // returns +* +* var bool = ( ptr === yptr ); +* // returns true +* +* // Read out the results: +* var viewX = zeros( N, dtype ); +* var viewY = zeros( N, dtype ); +* sswap.read( xptr, viewX ); +* sswap.read( yptr, viewY ); +* // viewX => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* // viewY => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +function Module( memory ) { + if ( !( this instanceof Module ) ) { + return new Module( memory ); + } + if ( !isWebAssemblyMemory( memory ) ) { + throw new TypeError( format( 'invalid argument. Must provide a WebAssembly memory instance. Value: `%s`.', memory ) ); + } + // Call the parent constructor: + WasmModule.call( this, wasmBinary, memory, { + 'env': { + 'memory': memory + } + }); + + return this; +} + +// Inherit from the parent constructor: +inherits( Module, WasmModule ); + +/** +* Interchanges two single-precision floating-point vectors. +* +* @name main +* @memberof Module.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {NonNegativeInteger} xptr - first input array pointer (i.e., byte offset) +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} yptr - second input array pointer (i.e., byte offset) +* @param {integer} strideY - `y` stride length +* @returns {NonNegativeInteger} second input array pointer (i.e., byte offset) +* +* @example +* var Memory = require( '@stdlib/wasm/memory' ); +* var oneTo = require( '@stdlib/array/one-to' ); +* var ones = require( '@stdlib/array/ones' ); +* var zeros = require( '@stdlib/array/zeros' ); +* var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +* +* // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): +* var mem = new Memory({ +* 'initial': 10, +* 'maximum': 100 +* }); +* +* // Create a BLAS routine: +* var sswap = new Module( mem ); +* // returns +* +* // Initialize the routine: +* sswap.initializeSync(); +* +* // Define a vector data type: +* var dtype = 'float32'; +* +* // Specify a vector length: +* var N = 5; +* +* // Define pointers (i.e., byte offsets) for storing two vectors: +* var xptr = 0; +* var yptr = N * bytesPerElement( dtype ); +* +* // Write vector values to module memory: +* sswap.write( xptr, oneTo( N, dtype ) ); +* sswap.write( yptr, ones( N, dtype ) ); +* +* // Perform computation: +* var ptr = sswap.main( N, xptr, 1, yptr, 1 ); +* // returns +* +* var bool = ( ptr === yptr ); +* // returns true +* +* // Read out the results: +* var viewX = zeros( N, dtype ); +* var viewY = zeros( N, dtype ); +* sswap.read( xptr, viewX ); +* sswap.read( yptr, viewY ); +* // viewX => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* // viewY => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +setReadOnly( Module.prototype, 'main', function sswap( N, xptr, strideX, yptr, strideY ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point + this._instance.exports.c_sswap( N, xptr, strideX, yptr, strideY ); + return yptr; +}); + +/** +* Interchanges two single-precision floating-point vectors using alternative indexing semantics. +* +* @name ndarray +* @memberof Module.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {NonNegativeInteger} xptr - first input array pointer (i.e., byte offset) +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting `x` index +* @param {NonNegativeInteger} yptr - second input array pointer (i.e., byte offset) +* @param {integer} strideY - `y` stride length +* @param {NonNegativeInteger} offsetY - starting `y` index +* @returns {NonNegativeInteger} second input array pointer (i.e., byte offset) +* +* @example +* var Memory = require( '@stdlib/wasm/memory' ); +* var oneTo = require( '@stdlib/array/one-to' ); +* var ones = require( '@stdlib/array/ones' ); +* var zeros = require( '@stdlib/array/zeros' ); +* var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' ); +* +* // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB): +* var mem = new Memory({ +* 'initial': 10, +* 'maximum': 100 +* }); +* +* // Create a BLAS routine: +* var sswap = new Module( mem ); +* // returns +* +* // Initialize the routine: +* sswap.initializeSync(); +* +* // Define a vector data type: +* var dtype = 'float32'; +* +* // Specify a vector length: +* var N = 5; +* +* // Define pointers (i.e., byte offsets) for storing two vectors: +* var xptr = 0; +* var yptr = N * bytesPerElement( dtype ); +* +* // Write vector values to module memory: +* sswap.write( xptr, oneTo( N, dtype ) ); +* sswap.write( yptr, ones( N, dtype ) ); +* +* // Perform computation: +* var ptr = sswap.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); +* // returns +* +* var bool = ( ptr === yptr ); +* // returns true +* +* // Read out the results: +* var viewX = zeros( N, dtype ); +* var viewY = zeros( N, dtype ); +* sswap.read( xptr, viewX ); +* sswap.read( yptr, viewY ); +* // viewX => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* // viewY => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +setReadOnly( Module.prototype, 'ndarray', function sswap( N, xptr, strideX, offsetX, yptr, strideY, offsetY ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point + this._instance.exports.c_sswap_ndarray( N, xptr, strideX, offsetX, yptr, strideY, offsetY ); // eslint-disable-line max-len + return yptr; +}); + + +// EXPORTS // + +module.exports = Module; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/routine.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/routine.js new file mode 100644 index 000000000000..772318748fd6 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/routine.js @@ -0,0 +1,192 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/* eslint-disable no-restricted-syntax, no-invalid-this */ + +'use strict'; + +// MODULES // + +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var inherits = require( '@stdlib/utils/inherit' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var readDataView = require( '@stdlib/strided/base/read-dataview' ).ndarray; +var Memory = require( '@stdlib/wasm/memory' ); +var arrays2ptrs = require( '@stdlib/wasm/base/arrays2ptrs' ); +var strided2object = require( '@stdlib/wasm/base/strided2object' ); +var Module = require( './module.js' ); + + +// MAIN // + +/** +* Routine constructor. +* +* @private +* @constructor +* @returns {Routine} routine instance +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* // Create a new routine: +* var sswap = new Routine(); +* +* // Initialize the module: +* sswap.initializeSync(); +* +* // Define strided arrays: +* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* sswap.main( x.length, x, 1, y, 1 ); +* // x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* // Create a new routine: +* var sswap = new Routine(); +* +* // Initialize the module: +* sswap.initializeSync(); +* +* // Define strided arrays: +* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* sswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +function Routine() { + if ( !( this instanceof Routine ) ) { + return new Routine(); + } + Module.call( this, new Memory({ + 'initial': 0 + })); + return this; +} + +// Inherit from the parent constructor: +inherits( Routine, Module ); + +/** +* Interchanges two single-precision floating-point vectors. +* +* @name main +* @memberof Routine.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {Float32Array} x - first input array +* @param {integer} strideX - `x` stride length +* @param {Float32Array} y - second input array +* @param {integer} strideY - `y` stride length +* @returns {Float32Array} second input array +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* // Create a new routine: +* var sswap = new Routine(); +* +* // Initialize the module: +* sswap.initializeSync(); +* +* // Define strided arrays: +* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* sswap.main( x.length, x, 1, y, 1 ); +* // x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +setReadOnly( Routine.prototype, 'main', function sswap( N, x, strideX, y, strideY ) { + return this.ndarray( N, x, strideX, stride2offset( N, strideX ), y, strideY, stride2offset( N, strideY ) ); // eslint-disable-line max-len +}); + +/** +* Interchanges two single-precision floating-point vectors using alternative indexing semantics. +* +* @name ndarray +* @memberof Routine.prototype +* @readonly +* @type {Function} +* @param {PositiveInteger} N - number of indexed elements +* @param {Float32Array} x - first input array +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting `x` index +* @param {Float32Array} y - second input array +* @param {integer} strideY - `y` stride length +* @param {NonNegativeInteger} offsetY - starting `y` index +* @returns {Float32Array} second input array +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* // Create a new routine: +* var sswap = new Routine(); +* +* // Initialize the module: +* sswap.initializeSync(); +* +* // Define strided arrays: +* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); +* +* // Perform operation: +* sswap.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* // x => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] +*/ +setReadOnly( Routine.prototype, 'ndarray', function sswap( N, x, strideX, offsetX, y, strideY, offsetY ) { + var ptrs; + var p0; + var p1; + + // Convert the input arrays to "pointers" in the module's memory: + ptrs = arrays2ptrs( this, [ + strided2object( N, x, strideX, offsetX ), + strided2object( N, y, strideY, offsetY ) + ]); + p0 = ptrs[ 0 ]; + p1 = ptrs[ 1 ]; + + // Perform computation by calling the corresponding parent method: + Module.prototype.ndarray.call( this, N, p0.ptr, p0.stride, p0.offset, p1.ptr, p1.stride, p1.offset ); // eslint-disable-line max-len + + // If the arrays data had to be copied to module memory, copy the results to the provided corresponding output arrays... + if ( p0.copy ) { + readDataView( N, this.view, p0.stride*p0.BYTES_PER_ELEMENT, p0.ptr, x, strideX, offsetX, true ); // eslint-disable-line max-len + } + if ( p1.copy ) { + readDataView( N, this.view, p1.stride*p1.BYTES_PER_ELEMENT, p1.ptr, y, strideY, offsetY, true ); // eslint-disable-line max-len + } + return y; +}); + + +// EXPORTS // + +module.exports = Routine; diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/manifest.json b/lib/node_modules/@stdlib/blas/base/wasm/sswap/manifest.json new file mode 100644 index 000000000000..a23edb896747 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/package.json b/lib/node_modules/@stdlib/blas/base/wasm/sswap/package.json new file mode 100644 index 000000000000..12bde33dfc5a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/package.json @@ -0,0 +1,80 @@ +{ + "name": "@stdlib/blas/base/wasm/sswap", + "version": "0.0.0", + "description": "Interchange two single-precision floating-point vectors.", + "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", + "sswap", + "linear", + "algebra", + "subroutines", + "swap", + "vector", + "array", + "ndarray", + "float32", + "single", + "float32array", + "webassembly", + "wasm" + ], + "__stdlib__": { + "wasm": true + } + } diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/scripts/build.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/scripts/build.js new file mode 100644 index 000000000000..66bf9650b6d6 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/scripts/template.txt b/lib/node_modules/@stdlib/blas/base/wasm/sswap/scripts/template.txt new file mode 100644 index 000000000000..f66cdb9735b1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/src/Makefile b/lib/node_modules/@stdlib/blas/base/wasm/sswap/src/Makefile new file mode 100644 index 000000000000..eb51121eec4c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/src/exports.json b/lib/node_modules/@stdlib/blas/base/wasm/sswap/src/exports.json new file mode 100644 index 000000000000..fd3bf8bb3f5f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/src/exports.json @@ -0,0 +1,4 @@ +[ + "_c_sswap", + "_c_sswap_ndarray" +] diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/src/main.wasm b/lib/node_modules/@stdlib/blas/base/wasm/sswap/src/main.wasm new file mode 100755 index 0000000000000000000000000000000000000000..fbc6ebe14376a1c17ecb2376dbd9379c36bc43e3 GIT binary patch literal 502 zcmZ{fy;8$45QI-F*;Y_Ifrf_WoH8>o(4~wE0!7}z@gylooS(5XWKu9Z94|%59S-hL zp*^j1-=3&!wuWR4{PJAA?KTgO#_8GI+BwlY`qV}9IUi`}zzb>ns^0 zPxhuLPC_ddWmOf6 Date: Sun, 6 Apr 2025 11:05:46 +0000 Subject: [PATCH 2/6] chore: update copyright years --- lib/node_modules/@stdlib/blas/base/wasm/sswap/README.md | 2 +- .../@stdlib/blas/base/wasm/sswap/benchmark/benchmark.js | 2 +- .../@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.js | 2 +- .../blas/base/wasm/sswap/benchmark/benchmark.module.main.js | 2 +- .../blas/base/wasm/sswap/benchmark/benchmark.module.ndarray.js | 2 +- .../@stdlib/blas/base/wasm/sswap/benchmark/benchmark.ndarray.js | 2 +- .../@stdlib/blas/base/wasm/sswap/docs/types/index.d.ts | 2 +- .../@stdlib/blas/base/wasm/sswap/docs/types/test.ts | 2 +- lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/index.js | 2 +- .../blas/base/wasm/sswap/examples/little_endian_array.js | 2 +- .../@stdlib/blas/base/wasm/sswap/examples/module.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/binary.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/index.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/main.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/module.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/routine.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/sswap/src/Makefile | 2 +- lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.js | 2 +- lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.main.js | 2 +- .../@stdlib/blas/base/wasm/sswap/test/test.module.js | 2 +- .../@stdlib/blas/base/wasm/sswap/test/test.module.main.js | 2 +- .../@stdlib/blas/base/wasm/sswap/test/test.module.ndarray.js | 2 +- .../@stdlib/blas/base/wasm/sswap/test/test.ndarray.js | 2 +- .../@stdlib/blas/base/wasm/sswap/test/test.routine.js | 2 +- 24 files changed, 24 insertions(+), 24 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/README.md b/lib/node_modules/@stdlib/blas/base/wasm/sswap/README.md index af216f8bb0ba..0cce73bae09c 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/README.md +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.js index ee4d795dc0b1..0e987e7d1bdf 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/benchmark/benchmark.module.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.js index 5c25cc40d86a..38ab98136b36 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/benchmark/benchmark.module.main.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.main.js index 126a691d671f..8b6b60f73089 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/benchmark/benchmark.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.ndarray.js index 3f83f359ac0a..8c6994495887 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.module.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.ndarray.js index 82cd97824894..6f896a37285a 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/types/index.d.ts index 205b60ce3f18..f2fe05c7f591 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/types/test.ts index bcccb80c2910..faf0f65eca04 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/examples/index.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/index.js index 8fb2aec65058..9151b67f8645 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/examples/little_endian_array.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/little_endian_array.js index 05d11efde379..82323b4cab18 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/little_endian_array.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/little_endian_array.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/sswap/examples/module.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/module.js index 3ed45926c5dd..0c50cd30fdb3 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/examples/module.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/lib/binary.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/binary.js index 6f02393f96e5..2b83fe651780 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/binary.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/lib/index.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/index.js index 22edbf12ad08..d44d75f1353c 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/lib/main.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/main.js index dd138ccb2b9e..dbbb3399fe73 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/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/sswap/lib/module.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/module.js index 8301af57ae46..bd9ee6572a3b 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/module.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/lib/routine.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/routine.js index 772318748fd6..ca832c802fd3 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/routine.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/src/Makefile b/lib/node_modules/@stdlib/blas/base/wasm/sswap/src/Makefile index eb51121eec4c..1b1f35347760 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/src/Makefile +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/test/test.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.js index b34395dc639e..45a1efa95f72 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/test/test.main.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.main.js index 30d3346ebb72..f6c08bd8e0f9 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/test/test.module.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.module.js index 9adcb07e22fa..0cdcd97ef151 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.module.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/test/test.module.main.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.module.main.js index 5f9d2af4d3d7..29171be97751 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.module.main.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/test/test.module.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.module.ndarray.js index 1cd9e6e9315c..8ab8cc9c8790 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.module.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.ndarray.js index ad5fec53081b..7b9769fd37b2 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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/sswap/test/test.routine.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.routine.js index 56a4b67daaf0..d90a5804a8e1 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/test/test.routine.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/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 d7ea194464674b0a33cb71ec7da6d57d1ba8898d Mon Sep 17 00:00:00 2001 From: ShabiShett07 Date: Sun, 6 Apr 2025 16:37:23 +0530 Subject: [PATCH 3/6] fix: lint errors --- 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: passed - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - 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 --- --- .../@stdlib/blas/base/wasm/sswap/package.json | 150 +++++++++--------- 1 file changed, 75 insertions(+), 75 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/package.json b/lib/node_modules/@stdlib/blas/base/wasm/sswap/package.json index 12bde33dfc5a..b9582075c68c 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/package.json +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/package.json @@ -1,80 +1,80 @@ { - "name": "@stdlib/blas/base/wasm/sswap", - "version": "0.0.0", - "description": "Interchange two single-precision floating-point vectors.", - "license": "Apache-2.0", - "author": { + "name": "@stdlib/blas/base/wasm/sswap", + "version": "0.0.0", + "description": "Interchange two single-precision floating-point vectors.", + "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" - }, - "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", - "sswap", - "linear", - "algebra", - "subroutines", - "swap", - "vector", - "array", - "ndarray", - "float32", - "single", - "float32array", - "webassembly", - "wasm" - ], - "__stdlib__": { - "wasm": true } + ], + "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", + "sswap", + "linear", + "algebra", + "subroutines", + "swap", + "vector", + "array", + "ndarray", + "float32", + "single", + "float32array", + "webassembly", + "wasm" + ], + "__stdlib__": { + "wasm": true } +} From f292ca18b7ba7c544bcf22ee2e774414f6454b08 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 18 Apr 2025 17:37:09 -0700 Subject: [PATCH 4/6] Apply suggestions from code review Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/repl.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/repl.txt index eee2ae2fda95..79e846ee5d33 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/docs/repl.txt @@ -372,7 +372,7 @@ Int32Array before passing the values to this method. If provided an array having an unknown or "generic" data type, elements are - written as single-precision floating-point numbers. + written as double-precision floating-point numbers. Parameters ---------- @@ -411,7 +411,7 @@ after reading memory values using this method. If provided an output array having an unknown or "generic" data type, - elements are read as single-precision floating-point numbers. + elements are read as double-precision floating-point numbers. Parameters ---------- From 2db7443b63f47c82bfee09b2ba7e1f77f9e70531 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 18 Apr 2025 17:44:11 -0700 Subject: [PATCH 5/6] docs: update examples Signed-off-by: Athan --- .../@stdlib/blas/base/wasm/sswap/lib/module.js | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/module.js b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/module.js index bd9ee6572a3b..0863463f5cc6 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/module.js +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/lib/module.js @@ -83,10 +83,11 @@ var wasmBinary = require( './binary.js' ); * * // Read out the results: * var viewX = zeros( N, dtype ); -* var viewY = zeros( N, dtype ); * sswap.read( xptr, viewX ); -* sswap.read( yptr, viewY ); * // viewX => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* +* var viewY = zeros( N, dtype ); +* sswap.read( yptr, viewY ); * // viewY => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] */ function Module( memory ) { @@ -166,10 +167,11 @@ inherits( Module, WasmModule ); * * // Read out the results: * var viewX = zeros( N, dtype ); -* var viewY = zeros( N, dtype ); * sswap.read( xptr, viewX ); -* sswap.read( yptr, viewY ); * // viewX => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* +* var viewY = zeros( N, dtype ); +* sswap.read( yptr, viewY ); * // viewY => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] */ setReadOnly( Module.prototype, 'main', function sswap( N, xptr, strideX, yptr, strideY ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point @@ -236,10 +238,11 @@ setReadOnly( Module.prototype, 'main', function sswap( N, xptr, strideX, yptr, s * * // Read out the results: * var viewX = zeros( N, dtype ); -* var viewY = zeros( N, dtype ); * sswap.read( xptr, viewX ); -* sswap.read( yptr, viewY ); * // viewX => [ 1.0, 1.0, 1.0, 1.0, 1.0 ] +* +* var viewY = zeros( N, dtype ); +* sswap.read( yptr, viewY ); * // viewY => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] */ setReadOnly( Module.prototype, 'ndarray', function sswap( N, xptr, strideX, offsetX, yptr, strideY, offsetY ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point From b97ba9d75eca1cbfaebc665c99fe35bea7ad66f7 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 18 Apr 2025 17:48:02 -0700 Subject: [PATCH 6/6] docs: add missing license header Signed-off-by: Athan --- .../@stdlib/blas/base/wasm/sswap/src/main.wat | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/base/wasm/sswap/src/main.wat b/lib/node_modules/@stdlib/blas/base/wasm/sswap/src/main.wat index cd4b5fe26677..47173ba5b056 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/sswap/src/main.wat +++ b/lib/node_modules/@stdlib/blas/base/wasm/sswap/src/main.wat @@ -1,3 +1,19 @@ +;; @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. + (module (type (;0;) (func)) (type (;1;) (func (param i32 i32 i32 i32 i32)))