-
-
Notifications
You must be signed in to change notification settings - Fork 825
feat: add blas/ext/base/wasm/dapx
#5643
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
b2f445f
chore: initial setup
0PrashantYadav0 905427e
chore: add benchmark and examples
0PrashantYadav0 a31317e
chore: add tests and minor bug fixes
0PrashantYadav0 9057a3f
chore: update copyright years
stdlib-bot af074a1
chore: add docs
0PrashantYadav0 e192bb3
chore: resolve lint error
0PrashantYadav0 c2d0dec
chore: self code review changes
0PrashantYadav0 3007d11
Merge remote-tracking branch 'upstream/develop' into wasm-dapx
stdlib-bot e46416b
docs: fix links
kgryte e851b37
docs: fix missing blank line
kgryte f3680e3
chore: changes according to code review
0PrashantYadav0 a1e8864
Apply suggestions from code review
kgryte File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
306 changes: 306 additions & 0 deletions
306
lib/node_modules/@stdlib/blas/ext/base/wasm/dapx/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,306 @@ | ||
<!-- | ||
|
||
@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. | ||
|
||
--> | ||
|
||
# dapx | ||
|
||
> Add a scalar constant to each element in a double-precision floating-point strided array. | ||
|
||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var dapx = require( '@stdlib/blas/ext/base/wasm/dapx' ); | ||
``` | ||
|
||
#### dapx.main( N, alpha, x, strideX ) | ||
|
||
Adds a scalar constant to each element in a double-precision floating-point strided array. | ||
|
||
```javascript | ||
var Float64Array = require( '@stdlib/array/float64' ); | ||
|
||
var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); | ||
|
||
dapx.main( x.length, 5.0, x, 1 ); | ||
// x => <Float64Array>[ 3.0, 6.0, 8.0, 0.0, 9.0, 5.0, 4.0, 2.0 ] | ||
``` | ||
|
||
The function has the following parameters: | ||
|
||
- **N**: number of indexed elements. | ||
- **alpha**: scalar constant. | ||
- **x**: input [`Float64Array`][@stdlib/array/float64]. | ||
- **strideX**: stride length. | ||
|
||
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to add a constant to every other element: | ||
|
||
```javascript | ||
var Float64Array = require( '@stdlib/array/float64' ); | ||
|
||
var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); | ||
|
||
dapx.main( 4, 5.0, x, 2 ); | ||
// x => <Float64Array>[ 3.0, 1.0, 8.0, -5.0, 9.0, 0.0, 4.0, -3.0 ] | ||
``` | ||
|
||
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. | ||
|
||
```javascript | ||
var Float64Array = require( '@stdlib/array/float64' ); | ||
|
||
// Initial array... | ||
var x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); | ||
|
||
// Create an offset view... | ||
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element | ||
|
||
// Add a constant to every other element... | ||
dapx.main( 3, 5.0, x1, 2 ); | ||
// x0 => <Float64Array>[ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ] | ||
``` | ||
|
||
#### dapx.ndarray( N, alpha, x, strideX, offsetX ) | ||
|
||
Adds a scalar constant to each element in a double-precision floating-point strided array using alternative indexing semantics. | ||
|
||
```javascript | ||
var Float64Array = require( '@stdlib/array/float64' ); | ||
|
||
var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); | ||
|
||
dapx.ndarray( x.length, 5.0, x, 1, 0 ); | ||
// x => <Float64Array>[ 3.0, 6.0, 8.0, 0.0, 9.0, 5.0, 4.0, 2.0 ] | ||
``` | ||
|
||
The function has the following additional parameters: | ||
|
||
- **offsetX**: starting index. | ||
|
||
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements: | ||
|
||
```javascript | ||
var Float64Array = require( '@stdlib/array/float64' ); | ||
|
||
var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); | ||
|
||
dapx.ndarray( 3, 5.0, x, 1, x.length-3 ); | ||
// x => <Float64Array>[ 1.0, -2.0, 3.0, 1.0, 10.0, -1.0 ] | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<section class="notes"> | ||
|
||
* * * | ||
|
||
### Module | ||
|
||
#### dapx.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. | ||
|
||
<!-- eslint-disable node/no-sync --> | ||
|
||
```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 dapx.Module( mem ); | ||
// returns <Module> | ||
|
||
// Initialize the routine: | ||
mod.initializeSync(); | ||
``` | ||
|
||
#### dapx.Module.prototype.main( N, alpha, xp, sx ) | ||
|
||
Adds a scalar constant to each element in a double-precision floating-point strided array. | ||
|
||
<!-- eslint-disable node/no-sync --> | ||
|
||
```javascript | ||
var Memory = require( '@stdlib/wasm/memory' ); | ||
var oneTo = require( '@stdlib/array/one-to' ); | ||
var zeros = require( '@stdlib/array/zeros' ); | ||
var dapx = require( '@stdlib/blas/ext/base/wasm/dapx' ); | ||
|
||
// 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 dapx.Module( mem ); | ||
// returns <Module> | ||
|
||
// Initialize the routine: | ||
mod.initializeSync(); | ||
|
||
// Define a vector data type: | ||
var dtype = 'float64'; | ||
|
||
// Specify a vector length: | ||
var N = 3; | ||
|
||
// Define a pointer (i.e., byte offset) for storing the input vector: | ||
var xptr = 0; | ||
|
||
// Write vector values to module memory: | ||
mod.write( xptr, oneTo( N, dtype ) ); | ||
|
||
// Perform computation: | ||
mod.main( N, 5.0, xptr, 1 ); | ||
|
||
var view = zeros( N, dtype ); | ||
mod.read( xptr, view ); | ||
|
||
// view => <Float64Array>[ 6.0, 7.0, 8.0 ] | ||
``` | ||
|
||
The function has the following parameters: | ||
|
||
- **N**: number of indexed elements. | ||
- **alpha**: scalar constant. | ||
- **xp**: input [`Float64Array`][@stdlib/array/float64] pointer (i.e., byte offset). | ||
- **sx**: stride length for `x`. | ||
|
||
#### dapx.Module.prototype.ndarray( N, alpha, xp, sx, ox ) | ||
|
||
Adds a scalar constant to each element in a double-precision floating-point strided array using alternative indexing semantics. | ||
|
||
<!-- eslint-disable node/no-sync --> | ||
|
||
```javascript | ||
var Memory = require( '@stdlib/wasm/memory' ); | ||
var oneTo = require( '@stdlib/array/one-to' ); | ||
var zeros = require( '@stdlib/array/zeros' ); | ||
var dapx = require( '@stdlib/blas/ext/base/wasm/dapx' ); | ||
|
||
// 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 dapx.Module( mem ); | ||
// returns <Module> | ||
|
||
// Initialize the routine: | ||
mod.initializeSync(); | ||
|
||
// Define a vector data type: | ||
var dtype = 'float64'; | ||
|
||
// Specify a vector length: | ||
var N = 3; | ||
|
||
// Define a pointer (i.e., byte offset) for storing the input vector: | ||
var xptr = 0; | ||
|
||
// Write vector values to module memory: | ||
mod.write( xptr, oneTo( N, dtype ) ); | ||
|
||
// Perform computation: | ||
mod.ndarray( N, 5.0, xptr, 1, 0 ); | ||
|
||
var view = zeros( N, dtype ); | ||
mod.read( xptr, view ); | ||
// view => <Float64Array>[ 6.0, 7.0, 8.0 ] | ||
``` | ||
|
||
The function has the following additional parameters: | ||
|
||
- **ox**: starting index for `x`. | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<section class="notes"> | ||
|
||
* * * | ||
|
||
## Notes | ||
|
||
- If `N <= 0`, both functions return the strided array unchanged. | ||
- This package implements routines using WebAssembly. When provided arrays which are not allocated on a `dapx` 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/dapx`][@stdlib/blas/ext/base/dapx]. 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/dapx`][@stdlib/blas/ext/base/dapx]. 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.. | ||
|
||
</section> | ||
|
||
<!-- /.notes --> | ||
|
||
<section class="examples"> | ||
|
||
## Examples | ||
|
||
<!-- eslint no-undef: "error" --> | ||
|
||
```javascript | ||
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); | ||
var dapx = require( '@stdlib/blas/ext/base/wasm/dapx' ); | ||
|
||
var x = discreteUniform( 10, -100, 100, { | ||
'dtype': 'float64' | ||
}); | ||
console.log( x ); | ||
|
||
dapx.main( x.length, 5.0, x, 1 ); | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.examples --> | ||
|
||
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
|
||
<section class="related"> | ||
|
||
</section> | ||
|
||
<!-- /.related --> | ||
|
||
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
||
<section class="links"> | ||
|
||
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray | ||
|
||
[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 | ||
|
||
[@stdlib/wasm/memory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/wasm/memory | ||
|
||
[@stdlib/wasm/module-wrapper]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/wasm/module-wrapper | ||
|
||
[@stdlib/blas/ext/base/dapx]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dapx | ||
|
||
</section> | ||
|
||
<!-- /.links --> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.