From 51b34ff7ae44e0887a11a3b3a26141d331d3f3f4 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 21 Jun 2026 20:23:46 -0700 Subject: [PATCH 1/3] feat: add `blas/ext/base/ndarray/gxsy` --- 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_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - 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 --- --- .../blas/ext/base/ndarray/gxsy/README.md | 131 ++++++++++ .../base/ndarray/gxsy/benchmark/benchmark.js | 103 ++++++++ .../blas/ext/base/ndarray/gxsy/docs/repl.txt | 34 +++ .../base/ndarray/gxsy/docs/types/index.d.ts | 52 ++++ .../ext/base/ndarray/gxsy/docs/types/test.ts | 63 +++++ .../ext/base/ndarray/gxsy/examples/index.js | 36 +++ .../blas/ext/base/ndarray/gxsy/lib/index.js | 44 ++++ .../blas/ext/base/ndarray/gxsy/lib/main.js | 67 +++++ .../blas/ext/base/ndarray/gxsy/package.json | 70 ++++++ .../blas/ext/base/ndarray/gxsy/test/test.js | 233 ++++++++++++++++++ 10 files changed, 833 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/README.md create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/package.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/test/test.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/README.md new file mode 100644 index 000000000000..a33b2805fdb5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/README.md @@ -0,0 +1,131 @@ + + +# gxsy + +> Subtract elements of a one-dimensional ndarray from the corresponding elements of a second one-dimensional ndarray and assign the results to the second ndarray. + +
+ +This BLAS extension implements the operation + + + +```math +\mathbf{y} = \mathbf{x} - \mathbf{y} +``` + + + +This API is a specialized version of the package [`@stdlib/blas/ext/base/ndarray/gaxpby`][@stdlib/blas/ext/base/ndarray/gaxpby] with `α = 1` and `β = -1` and performs element-wise subtraction between two vectors. + +
+ + + +
+ +## Usage + +```javascript +var gxsy = require( '@stdlib/blas/ext/base/ndarray/gxsy' ); +``` + +#### gxsy( arrays ) + +Subtracts elements of a one-dimensional ndarray from the corresponding elements of a second one-dimensional ndarray and assigns the results to the second ndarray. + +```javascript +var vector = require( '@stdlib/ndarray/vector/ctor' ); + +var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' ); +var y = vector( [ 5.0, 4.0, 3.0, 2.0, 1.0 ], 'generic' ); + +gxsy( [ x, y ] ); +// y => [ -4.0, -2.0, 0.0, 2.0, 4.0 ] +``` + +The function has the following parameters: + +- **arrays**: array-like object containing the following ndarrays: + + - a one-dimensional input ndarray. + - a one-dimensional output ndarray. + +
+ + + +
+ +## Notes + +- The output ndarray is modified **in-place** (i.e., the output ndarray is **mutated**). + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/discrete-uniform' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var gxsy = require( '@stdlib/blas/ext/base/ndarray/gxsy' ); + +var opts = { + 'dtype': 'generic' +}; + +var x = discreteUniform( [ 10 ], -100, 100, opts ); +console.log( ndarray2array( x ) ); + +var y = discreteUniform( [ 10 ], -100, 100, opts ); +console.log( ndarray2array( y ) ); + +gxsy( [ x, y ] ); +console.log( ndarray2array( y ) ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/benchmark/benchmark.js new file mode 100644 index 000000000000..c16280a1061b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/benchmark/benchmark.js @@ -0,0 +1,103 @@ +/** +* @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/uniform' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var gxsy = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - ndarray 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 out; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = gxsy( [ x, y ] ); + if ( typeof out !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + } + b.toc(); + if ( typeof out !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + 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(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt new file mode 100644 index 000000000000..34752f52098a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt @@ -0,0 +1,34 @@ + +{{alias}}( arrays ) + Subtracts elements of a one-dimensional ndarray from the corresponding + elements of a second one-dimensional ndarray and assigns the results to the + second ndarray. + + The output ndarray is modified *in-place* (i.e., the output ndarray is + *mutated*). + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing the following ndarrays: + + - a one-dimensional input ndarray. + - a one-dimensional output ndarray. + + Returns + ------- + out: ndarray + Output ndarray. + + Examples + -------- + > var xbuf = [ 1.0, 2.0, 3.0, 4.0 ]; + > var x = {{alias:@stdlib/ndarray/vector/ctor}}( xbuf, 'generic' ); + > var ybuf = [ 5.0, 4.0, 3.0, 2.0 ]; + > var y = {{alias:@stdlib/ndarray/vector/ctor}}( ybuf, 'generic' ); + > {{alias}}( [ x, y ] ) + [ -4.0, -2.0, 0.0, 2.0 ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts new file mode 100644 index 000000000000..95aedaeab3ce --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts @@ -0,0 +1,52 @@ +/* +* @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. +*/ + +// TypeScript Version: 4.1 + +/// + +import { typedndarray } from '@stdlib/types/ndarray'; + +/** +* Subtracts elements of a one-dimensional ndarray from the corresponding elements of a second one-dimensional ndarray and assigns the results to the second ndarray. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a one-dimensional input ndarray. +* - a one-dimensional output ndarray. +* +* @param arrays - array-like object containing ndarrays +* @returns output ndarray +* +* @example +* var vector = require( '@stdlib/ndarray/vector/ctor' ); +* +* var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' ); +* var y = vector( [ 5.0, 4.0, 3.0, 2.0, 1.0 ], 'generic' ); +* +* var out = gxsy( [ x, y ] ); +* // returns [ -4.0, -2.0, 0.0, 2.0, 4.0 ] +*/ +declare function gxsy = typedndarray>( arrays: [ typedndarray, T ] ): T; + + +// EXPORTS // + +export = gxsy; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/test.ts new file mode 100644 index 000000000000..328447170374 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/test.ts @@ -0,0 +1,63 @@ +/* +* @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. +*/ + +/* eslint-disable space-in-parens */ + +import zeros = require( '@stdlib/ndarray/zeros' ); +import gxsy = require( './index' ); + + +// TESTS // + +// The function returns an ndarray... +{ + const x = zeros( [ 10 ], { + 'dtype': 'generic' + }); + const y = zeros( [ 10 ], { + 'dtype': 'generic' + }); + + gxsy( [ x, y ] ); // $ExpectType genericndarray +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + gxsy( '10' ); // $ExpectError + gxsy( 5 ); // $ExpectError + gxsy( true ); // $ExpectError + gxsy( false ); // $ExpectError + gxsy( null ); // $ExpectError + gxsy( undefined ); // $ExpectError + gxsy( [] ); // $ExpectError + gxsy( {} ); // $ExpectError + gxsy( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = zeros( [ 10 ], { + 'dtype': 'generic' + }); + const y = zeros( [ 10 ], { + 'dtype': 'generic' + }); + + gxsy(); // $ExpectError + gxsy( [ x, y ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/examples/index.js new file mode 100644 index 000000000000..5466ea0cd252 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/examples/index.js @@ -0,0 +1,36 @@ +/** +* @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'; + +var discreteUniform = require( '@stdlib/random/discrete-uniform' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var gxsy = require( './../lib' ); + +var opts = { + 'dtype': 'generic' +}; + +var x = discreteUniform( [ 10 ], -100, 100, opts ); +console.log( ndarray2array( x ) ); + +var y = discreteUniform( [ 10 ], -100, 100, opts ); +console.log( ndarray2array( y ) ); + +gxsy( [ x, y ] ); +console.log( ndarray2array( y ) ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/index.js new file mode 100644 index 000000000000..b670d31ae1d0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/index.js @@ -0,0 +1,44 @@ +/** +* @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'; + +/** +* Subtract elements of a one-dimensional ndarray from the corresponding elements of a second one-dimensional ndarray and assign the results to the second ndarray. +* +* @module @stdlib/blas/ext/base/ndarray/gxsy +* +* @example +* var vector = require( '@stdlib/ndarray/vector/ctor' ); +* var gxsy = require( '@stdlib/blas/ext/base/ndarray/gxsy' ); +* +* var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' ); +* var y = vector( [ 5.0, 4.0, 3.0, 2.0, 1.0 ], 'generic' ); +* +* var out = gxsy( [ x, y ] ); +* // returns [ -4.0, -2.0, 0.0, 2.0, 4.0 ] +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js new file mode 100644 index 000000000000..700914d93c23 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js @@ -0,0 +1,67 @@ +/** +* @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 numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var getStride = require( '@stdlib/ndarray/base/stride' ); +var getOffset = require( '@stdlib/ndarray/base/offset' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var strided = require( '@stdlib/blas/ext/base/gxsy' ).ndarray; + + +// MAIN // + +/** +* Subtracts elements of a one-dimensional ndarray from the corresponding elements of a second one-dimensional ndarray and assigns the results to the second ndarray. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a one-dimensional input ndarray. +* - a one-dimensional output ndarray. +* +* @param {ArrayLikeObject} arrays - array-like object containing ndarrays +* @returns {ndarray} output ndarray +* +* @example +* var vector = require( '@stdlib/ndarray/vector/ctor' ); +* +* var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' ); +* var y = vector( [ 5.0, 4.0, 3.0, 2.0, 1.0 ], 'generic' ); +* +* var out = gxsy( [ x, y ] ); +* // returns [ -4.0, -2.0, 0.0, 2.0, 4.0 ] +*/ +function gxsy( arrays ) { + var x; + var y; + + x = arrays[ 0 ]; + y = arrays[ 1 ]; + strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ), getData( y ), getStride( y, 0 ), getOffset( y ) ); // eslint-disable-line max-len + return y; +} + + +// EXPORTS // + +module.exports = gxsy; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/package.json new file mode 100644 index 000000000000..00af5236f34e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/package.json @@ -0,0 +1,70 @@ +{ + "name": "@stdlib/blas/ext/base/ndarray/gxsy", + "version": "0.0.0", + "description": "Subtract elements of a one-dimensional ndarray from the corresponding elements of a second one-dimensional ndarray and assign the results to the second ndarray.", + "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", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "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", + "extended", + "ext", + "gxsy", + "xsy", + "subtract", + "subtraction", + "vector", + "strided", + "array", + "ndarray", + "generic" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/test/test.js new file mode 100644 index 000000000000..7d217385207e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/test/test.js @@ -0,0 +1,233 @@ +/** +* @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 tape = require( 'tape' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var gxsy = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {Collection} buffer - underlying data buffer +* @param {NonNegativeInteger} length - number of indexed elements +* @param {integer} stride - stride length +* @param {NonNegativeInteger} offset - index offset +* @returns {ndarray} one-dimensional ndarray +*/ +function vector( buffer, length, stride, offset ) { + return new ndarray( 'generic', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof gxsy, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( gxsy.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function subtracts `y` from `x` and assigns the results to `y`', function test( t ) { + var expected; + var actual; + var xbuf; + var ybuf; + var x; + var y; + + xbuf = [ -2.0, 1.0, 3.0, -5.0, 4.0 ]; + ybuf = [ 1.0, 2.0, -3.0, 4.0, -1.0 ]; + x = vector( xbuf, 5, 1, 0 ); + y = vector( ybuf, 5, 1, 0 ); + expected = [ + -3.0, // -2.0 - 1.0 + -1.0, // 1.0 - 2.0 + 6.0, // 3.0 - (-3.0) + -9.0, // -5.0 - 4.0 + 5.0 // 4.0 - (-1.0) + ]; + + actual = gxsy( [ x, y ] ); + t.strictEqual( actual, y, 'returns expected value' ); + t.deepEqual( ybuf, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports input ndarrays having non-unit strides', function test( t ) { + var expected; + var actual; + var xbuf; + var ybuf; + var x; + var y; + + xbuf = [ + -2.0, // 0 + 1.0, + 3.0, // 1 + -5.0, + 4.0, // 2 + 0.0, + -1.0, // 3 + -3.0 + ]; + ybuf = [ + 1.0, // 0 + 2.0, + -3.0, // 1 + 4.0, + -1.0, // 2 + 0.0, + 3.0, // 3 + 2.0 + ]; + x = vector( xbuf, 4, 2, 0 ); + y = vector( ybuf, 4, 2, 0 ); + expected = [ + -3.0, // -2.0 - 1.0 + 2.0, + 6.0, // 3.0 - (-3.0) + 4.0, + 5.0, // 4.0 - (-1.0) + 0.0, + -4.0, // -1.0 - 3.0 + 2.0 + ]; + + actual = gxsy( [ x, y ] ); + t.strictEqual( actual, y, 'returns expected value' ); + t.deepEqual( ybuf, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports input ndarrays having negative strides', function test( t ) { + var expected; + var actual; + var xbuf; + var ybuf; + var x; + var y; + + xbuf = [ + -2.0, // 4 + 1.0, // 3 + 3.0, // 2 + -5.0, // 1 + 4.0 // 0 + ]; + ybuf = [ + 1.0, // 4 + 2.0, // 3 + -3.0, // 2 + 4.0, // 1 + -1.0 // 0 + ]; + x = vector( xbuf, 5, -1, 4 ); + y = vector( ybuf, 5, -1, 4 ); + expected = [ + -3.0, // -2.0 - 1.0 + -1.0, // 1.0 - 2.0 + 6.0, // 3.0 - (-3.0) + -9.0, // -5.0 - 4.0 + 5.0 // 4.0 - (-1.0) + ]; + + actual = gxsy( [ x, y ] ); + t.strictEqual( actual, y, 'returns expected value' ); + t.deepEqual( ybuf, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports input ndarrays having non-zero offsets', function test( t ) { + var expected; + var actual; + var xbuf; + var ybuf; + var x; + var y; + + xbuf = [ + 1.0, + -2.0, + 3.0, // 0 + -5.0, // 1 + 4.0, // 2 + 0.0 + ]; + ybuf = [ + 1.0, + -2.0, + 0.0, // 0 + 4.0, // 1 + -1.0, // 2 + 0.0 + ]; + x = vector( xbuf, 3, 1, 2 ); + y = vector( ybuf, 3, 1, 2 ); + expected = [ + 1.0, + -2.0, + 3.0, // 3.0 - 0.0 + -9.0, // -5.0 - 4.0 + 5.0, // 4.0 - (-1.0) + 0.0 + ]; + + actual = gxsy( [ x, y ] ); + t.strictEqual( actual, y, 'returns expected value' ); + t.deepEqual( ybuf, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the output ndarray unchanged when the input ndarrays are empty', function test( t ) { + var expected; + var actual; + var xbuf; + var ybuf; + var x; + var y; + + xbuf = []; + ybuf = []; + x = vector( xbuf, 0, 1, 0 ); + y = vector( ybuf, 0, 1, 0 ); + expected = []; + + actual = gxsy( [ x, y ] ); + t.strictEqual( actual, y, 'returns expected value' ); + t.deepEqual( ybuf, expected, 'returns expected value' ); + + t.end(); +}); From 4abbb1d9c98ef8fc23bc314bd68a1b33638b5386 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 21 Jun 2026 21:03:54 -0700 Subject: [PATCH 2/3] chore: apply suggestions from review --- 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_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - 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: 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: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../@stdlib/blas/ext/base/ndarray/gxsy/README.md | 4 ++-- .../@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt | 5 ++--- .../@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts | 2 +- .../@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js | 2 +- .../@stdlib/blas/ext/base/ndarray/gxsy/package.json | 2 +- 5 files changed, 7 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/README.md index a33b2805fdb5..c81c4061e91e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/README.md @@ -20,7 +20,7 @@ limitations under the License. # gxsy -> Subtract elements of a one-dimensional ndarray from the corresponding elements of a second one-dimensional ndarray and assign the results to the second ndarray. +> Subtract the second one-dimensional ndarray from the first one-dimensional ndarray and assign the results to the second ndarray.
@@ -50,7 +50,7 @@ var gxsy = require( '@stdlib/blas/ext/base/ndarray/gxsy' ); #### gxsy( arrays ) -Subtracts elements of a one-dimensional ndarray from the corresponding elements of a second one-dimensional ndarray and assigns the results to the second ndarray. +Subtracts the second one-dimensional ndarray from the first one-dimensional ndarray and assigns the results to the second ndarray. ```javascript var vector = require( '@stdlib/ndarray/vector/ctor' ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt index 34752f52098a..ec1b489ac514 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt @@ -1,8 +1,7 @@ {{alias}}( arrays ) - Subtracts elements of a one-dimensional ndarray from the corresponding - elements of a second one-dimensional ndarray and assigns the results to the - second ndarray. + Subtracts the second one-dimensional ndarray from the first one-dimensional + ndarray and assigns the results to the second ndarray. The output ndarray is modified *in-place* (i.e., the output ndarray is *mutated*). diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts index 95aedaeab3ce..1fb4b4cfb90a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { typedndarray } from '@stdlib/types/ndarray'; /** -* Subtracts elements of a one-dimensional ndarray from the corresponding elements of a second one-dimensional ndarray and assigns the results to the second ndarray. +* Subtracts the second one-dimensional ndarray from the first one-dimensional ndarray and assigns the results to the second ndarray. * * ## Notes * diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js index 700914d93c23..78e46ec5a5f4 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js @@ -30,7 +30,7 @@ var strided = require( '@stdlib/blas/ext/base/gxsy' ).ndarray; // MAIN // /** -* Subtracts elements of a one-dimensional ndarray from the corresponding elements of a second one-dimensional ndarray and assigns the results to the second ndarray. +* Subtracts the second one-dimensional ndarray from the first one-dimensional ndarray and assigns the results to the second ndarray. * * ## Notes * diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/package.json index 00af5236f34e..f3e2120a6876 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/package.json +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/ext/base/ndarray/gxsy", "version": "0.0.0", - "description": "Subtract elements of a one-dimensional ndarray from the corresponding elements of a second one-dimensional ndarray and assign the results to the second ndarray.", + "description": "Subtract the second one-dimensional ndarray from the first one-dimensional ndarray and assign the results to the second ndarray.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", From 1de42700623732b5f1e36715b7c5bd652fcf8510 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Mon, 22 Jun 2026 10:01:05 -0700 Subject: [PATCH 3/3] chore: apply suggestions from review --- 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_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - 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: 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: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../@stdlib/blas/ext/base/ndarray/gxsy/README.md | 4 ++-- .../@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt | 5 +++-- .../@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts | 2 +- .../@stdlib/blas/ext/base/ndarray/gxsy/lib/index.js | 2 +- .../@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js | 2 +- .../@stdlib/blas/ext/base/ndarray/gxsy/package.json | 2 +- 6 files changed, 9 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/README.md index c81c4061e91e..3ee47ee95761 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/README.md @@ -20,7 +20,7 @@ limitations under the License. # gxsy -> Subtract the second one-dimensional ndarray from the first one-dimensional ndarray and assign the results to the second ndarray. +> Subtract the elements of an output one-dimensional ndarray from the corresponding elements in an input one-dimensional ndarray and assign the results to the output ndarray.
@@ -50,7 +50,7 @@ var gxsy = require( '@stdlib/blas/ext/base/ndarray/gxsy' ); #### gxsy( arrays ) -Subtracts the second one-dimensional ndarray from the first one-dimensional ndarray and assigns the results to the second ndarray. +Subtracts the elements of an output one-dimensional ndarray from the corresponding elements in an input one-dimensional ndarray and assigns the results to the output ndarray. ```javascript var vector = require( '@stdlib/ndarray/vector/ctor' ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt index ec1b489ac514..de2b29e7f15c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/repl.txt @@ -1,7 +1,8 @@ {{alias}}( arrays ) - Subtracts the second one-dimensional ndarray from the first one-dimensional - ndarray and assigns the results to the second ndarray. + Subtracts the elements of an output one-dimensional ndarray from the + corresponding elements in an input one-dimensional ndarray and assigns the + results to the output ndarray. The output ndarray is modified *in-place* (i.e., the output ndarray is *mutated*). diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts index 1fb4b4cfb90a..7b2287ea1045 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { typedndarray } from '@stdlib/types/ndarray'; /** -* Subtracts the second one-dimensional ndarray from the first one-dimensional ndarray and assigns the results to the second ndarray. +* Subtracts the elements of an output one-dimensional ndarray from the corresponding elements in an input one-dimensional ndarray and assigns the results to the output ndarray. * * ## Notes * diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/index.js index b670d31ae1d0..f961023af8ee 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Subtract elements of a one-dimensional ndarray from the corresponding elements of a second one-dimensional ndarray and assign the results to the second ndarray. +* Subtract the elements of an output one-dimensional ndarray from the corresponding elements in an input one-dimensional ndarray and assign the results to the output ndarray. * * @module @stdlib/blas/ext/base/ndarray/gxsy * diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js index 78e46ec5a5f4..9694a369760c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/lib/main.js @@ -30,7 +30,7 @@ var strided = require( '@stdlib/blas/ext/base/gxsy' ).ndarray; // MAIN // /** -* Subtracts the second one-dimensional ndarray from the first one-dimensional ndarray and assigns the results to the second ndarray. +* Subtracts the elements of an output one-dimensional ndarray from the corresponding elements in an input one-dimensional ndarray and assigns the results to the output ndarray. * * ## Notes * diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/package.json index f3e2120a6876..af32dc24050f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/package.json +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gxsy/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/ext/base/ndarray/gxsy", "version": "0.0.0", - "description": "Subtract the second one-dimensional ndarray from the first one-dimensional ndarray and assign the results to the second ndarray.", + "description": "Subtract the elements of an output one-dimensional ndarray from the corresponding elements in an input one-dimensional ndarray and assign the results to the output ndarray.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors",