-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add blas/ext/base/gwxsa
#12385
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
+2,157
−0
Merged
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,195 @@ | ||
| <!-- | ||
|
|
||
| @license Apache-2.0 | ||
|
|
||
| Copyright (c) 2026 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. | ||
|
|
||
| --> | ||
|
|
||
| # gwxsa | ||
|
|
||
| > Subtract a scalar constant from each element in a strided array `x` and assign the results to elements in a strided array `y`. | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| This BLAS extension implements the operation | ||
|
|
||
| <!-- <equation class="equation" label="eq:wxsa" align="center" raw="\mathbf{y} = \mathbf{x} - \alpha" alt="Equation for wxsa operation."> --> | ||
|
|
||
| ```math | ||
| \mathbf{y} = \mathbf{x} - \alpha | ||
| ``` | ||
|
|
||
| <!-- </equation> --> | ||
|
|
||
| This API is complementary to the package [`@stdlib/blas/ext/base/gwapx`][@stdlib/blas/ext/base/gwapx]. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var gwxsa = require( '@stdlib/blas/ext/base/gwxsa' ); | ||
| ``` | ||
|
|
||
| #### gwxsa( N, alpha, x, strideX, y, strideY ) | ||
|
|
||
| Subtracts a scalar constant from each element in a strided array `x` and assigns the results to elements in a strided array `y`. | ||
|
|
||
| ```javascript | ||
| var x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ]; | ||
| var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ]; | ||
|
|
||
| gwxsa( x.length, 5.0, x, 1, y, 1 ); | ||
| // y => [ -4.0, -3.0, -2.0, -1.0, 0.0 ] | ||
| ``` | ||
|
|
||
| The function has the following parameters: | ||
|
|
||
| - **N**: number of indexed elements. | ||
| - **alpha**: scalar constant. | ||
| - **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. | ||
| - **strideX**: stride length for `x`. | ||
| - **y**: output [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. | ||
| - **strideY**: stride length for `y`. | ||
|
|
||
| The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to subtract `alpha` from every other element in `x` and assign the results to every other element in `y`: | ||
|
|
||
| ```javascript | ||
| var x = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; | ||
| var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]; | ||
|
|
||
| gwxsa( 3, 5.0, x, 2, y, 2 ); | ||
| // y => [ -4.0, 0.0, -2.0, 0.0, 0.0, 0.0 ] | ||
| ``` | ||
|
|
||
| Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| // Initial arrays... | ||
| var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); | ||
| var y0 = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); | ||
|
|
||
| // Create offset views... | ||
| var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element | ||
| var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // start at 3rd element | ||
|
|
||
| gwxsa( 3, 5.0, x1, 1, y1, 1 ); | ||
| // y0 => <Float64Array>[ 0.0, 0.0, -3.0, -2.0, -1.0, 0.0 ] | ||
| ``` | ||
|
|
||
| #### gwxsa.ndarray( N, alpha, x, strideX, offsetX, y, strideY, offsetY ) | ||
|
|
||
| Subtracts a scalar constant from each element in a strided array `x` and assigns the results to elements in a strided array `y` using alternative indexing semantics. | ||
|
|
||
| ```javascript | ||
| var x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ]; | ||
| var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ]; | ||
|
|
||
| gwxsa.ndarray( x.length, 5.0, x, 1, 0, y, 1, 0 ); | ||
| // y => [ -4.0, -3.0, -2.0, -1.0, 0.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 subtract `alpha` from the last three elements of `x` and assign the results to the last three elements of `y`: | ||
|
|
||
| ```javascript | ||
| var x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ]; | ||
| var y = [ 0.0, 0.0, 0.0, 0.0, 0.0 ]; | ||
|
|
||
| gwxsa.ndarray( 3, 5.0, x, 1, x.length-3, y, 1, y.length-3 ); | ||
| // y => [ 0.0, 0.0, -2.0, -1.0, 0.0 ] | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - If `N <= 0`, both functions return `y` unchanged. | ||
| - Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]). | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); | ||
| var gwxsa = require( '@stdlib/blas/ext/base/gwxsa' ); | ||
|
|
||
| var x = discreteUniform( 10, -100, 100, { | ||
| 'dtype': 'float64' | ||
| }); | ||
| console.log( x ); | ||
|
|
||
| var y = discreteUniform( 10, -100, 100, { | ||
| 'dtype': 'float64' | ||
| }); | ||
| console.log( y ); | ||
|
|
||
| gwxsa( x.length, 5.0, x, 1, y, 1 ); | ||
| console.log( y ); | ||
| ``` | ||
|
|
||
| </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-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array | ||
|
|
||
| [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray | ||
|
|
||
| [@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor | ||
|
|
||
| [@stdlib/blas/ext/base/gwapx]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gwapx | ||
|
|
||
| <!-- <related-links> --> | ||
|
|
||
| <!-- </related-links> --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> | ||
104 changes: 104 additions & 0 deletions
104
lib/node_modules/@stdlib/blas/ext/base/gwxsa/benchmark/benchmark.js
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,104 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2026 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 uniform = require( '@stdlib/random/array/uniform' ); | ||
| var isnan = require( '@stdlib/math/base/assert/is-nan' ); | ||
| var pow = require( '@stdlib/math/base/special/pow' ); | ||
| var format = require( '@stdlib/string/format' ); | ||
| var pkg = require( './../package.json' ).name; | ||
| var gwxsa = require( './../lib/main.js' ); | ||
|
|
||
|
|
||
| // VARIABLES // | ||
|
|
||
| var options = { | ||
| 'dtype': 'generic' | ||
| }; | ||
|
|
||
|
|
||
| // FUNCTIONS // | ||
|
|
||
| /** | ||
| * Create a benchmark function. | ||
| * | ||
| * @private | ||
| * @param {PositiveInteger} len - array length | ||
| * @returns {Function} benchmark function | ||
| */ | ||
| function createBenchmark( len ) { | ||
| var x = uniform( len, -100, 100, options ); | ||
| var y = uniform( len, -100, 100, options ); | ||
| return benchmark; | ||
|
|
||
| /** | ||
| * Benchmark function. | ||
| * | ||
| * @private | ||
| * @param {Benchmark} b - benchmark instance | ||
| */ | ||
| function benchmark( b ) { | ||
| var z; | ||
| var i; | ||
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| z = gwxsa( x.length, 5.0, x, 1, y, 1 ); | ||
| if ( isnan( z[ i%x.length ] ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( isnan( z[ i%x.length ] ) ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| b.pass( 'benchmark finished' ); | ||
| b.end(); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| /** | ||
| * Main execution sequence. | ||
| * | ||
| * @private | ||
| */ | ||
| function main() { | ||
| var len; | ||
| var min; | ||
| var max; | ||
| var f; | ||
| var i; | ||
|
|
||
| min = 1; // 10^min | ||
| max = 6; // 10^max | ||
|
|
||
| for ( i = min; i <= max; i++ ) { | ||
| len = pow( 10, i ); | ||
| f = createBenchmark( len ); | ||
| bench( format( '%s:len=%d', pkg, len ), f ); | ||
| } | ||
| } | ||
|
|
||
| main(); |
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.