Skip to content

Commit beecc92

Browse files
anandkaranubcanandkaranubc
authored
feat: add blas/ext/base/ndarray/dxsy
PR-URL: #13045 Reviewed-by: Athan Reines <kgryte@gmail.com> Closes: stdlib-js/metr-issue-tracker#805
1 parent b1fbd01 commit beecc92

10 files changed

Lines changed: 838 additions & 0 deletions

File tree

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/dxsy/README.md‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2026 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# dxsy
22+
23+
> Subtract the elements of an output one-dimensional double-precision floating-point ndarray from the corresponding elements in an input one-dimensional double-precision floating-point ndarray and assign the results to the output ndarray.
24+
25+
<section class="intro">
26+
27+
This BLAS extension implements the operation
28+
29+
<!-- <equation class="equation" label="eq:xsy" align="center" raw="\mathbf{y} = \mathbf{x} - \mathbf{y}" alt="Equation for xsy operation."> -->
30+
31+
```math
32+
\mathbf{y} = \mathbf{x} - \mathbf{y}
33+
```
34+
35+
<!-- </equation> -->
36+
37+
This API is a specialized version of the package [`@stdlib/blas/ext/base/ndarray/daxpby`][@stdlib/blas/ext/base/ndarray/daxpby] with `α = 1` and `β = -1` and performs element-wise subtraction between two vectors.
38+
39+
</section>
40+
41+
<!-- /.intro -->
42+
43+
<section class="usage">
44+
45+
## Usage
46+
47+
```javascript
48+
var dxsy = require( '@stdlib/blas/ext/base/ndarray/dxsy' );
49+
```
50+
51+
#### dxsy( arrays )
52+
53+
Subtracts the elements of an output one-dimensional double-precision floating-point ndarray from the corresponding elements in an input one-dimensional double-precision floating-point ndarray and assigns the results to the output ndarray.
54+
55+
```javascript
56+
var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
57+
58+
var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
59+
var y = new Float64Vector( [ 2.0, 4.0, 6.0, 8.0, 10.0 ] );
60+
61+
dxsy( [ x, y ] );
62+
// y => <ndarray>[ -1.0, -2.0, -3.0, -4.0, -5.0 ]
63+
```
64+
65+
The function has the following parameters:
66+
67+
- **arrays**: array-like object containing the following ndarrays:
68+
69+
- a one-dimensional input ndarray.
70+
- a one-dimensional output ndarray.
71+
72+
</section>
73+
74+
<!-- /.usage -->
75+
76+
<section class="notes">
77+
78+
## Notes
79+
80+
- The output ndarray is modified **in-place** (i.e., the output ndarray is **mutated**).
81+
82+
</section>
83+
84+
<!-- /.notes -->
85+
86+
<section class="examples">
87+
88+
## Examples
89+
90+
<!-- eslint no-undef: "error" -->
91+
92+
```javascript
93+
var discreteUniform = require( '@stdlib/random/discrete-uniform' );
94+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
95+
var dxsy = require( '@stdlib/blas/ext/base/ndarray/dxsy' );
96+
97+
var opts = {
98+
'dtype': 'float64'
99+
};
100+
101+
var x = discreteUniform( [ 10 ], -100, 100, opts );
102+
console.log( ndarray2array( x ) );
103+
104+
var y = discreteUniform( [ 10 ], -100, 100, opts );
105+
console.log( ndarray2array( y ) );
106+
107+
dxsy( [ x, y ] );
108+
console.log( ndarray2array( y ) );
109+
```
110+
111+
</section>
112+
113+
<!-- /.examples -->
114+
115+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
116+
117+
<section class="related">
118+
119+
</section>
120+
121+
<!-- /.related -->
122+
123+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
124+
125+
<section class="links">
126+
127+
[@stdlib/blas/ext/base/ndarray/daxpby]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/@stdlib/blas/ext/base/ndarray/daxpby
128+
129+
</section>
130+
131+
<!-- /.links -->

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/dxsy/benchmark/benchmark.js‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var uniform = require( '@stdlib/random/uniform' );
25+
var pow = require( '@stdlib/math/base/special/pow' );
26+
var format = require( '@stdlib/string/format' );
27+
var pkg = require( './../package.json' ).name;
28+
var dxsy = require( './../lib' );
29+
30+
31+
// VARIABLES //
32+
33+
var options = {
34+
'dtype': 'float64'
35+
};
36+
37+
38+
// FUNCTIONS //
39+
40+
/**
41+
* Creates a benchmark function.
42+
*
43+
* @private
44+
* @param {PositiveInteger} len - ndarray length
45+
* @returns {Function} benchmark function
46+
*/
47+
function createBenchmark( len ) {
48+
var x = uniform( [ len ], -100.0, 100.0, options );
49+
var y = uniform( [ len ], -100.0, 100.0, options );
50+
return benchmark;
51+
52+
/**
53+
* Benchmark function.
54+
*
55+
* @private
56+
* @param {Benchmark} b - benchmark instance
57+
*/
58+
function benchmark( b ) {
59+
var out;
60+
var i;
61+
62+
b.tic();
63+
for ( i = 0; i < b.iterations; i++ ) {
64+
out = dxsy( [ x, y ] );
65+
if ( typeof out !== 'object' ) {
66+
b.fail( 'should return an ndarray' );
67+
}
68+
}
69+
b.toc();
70+
if ( typeof out !== 'object' ) {
71+
b.fail( 'should return an ndarray' );
72+
}
73+
b.pass( 'benchmark finished' );
74+
b.end();
75+
}
76+
}
77+
78+
79+
// MAIN //
80+
81+
/**
82+
* Main execution sequence.
83+
*
84+
* @private
85+
*/
86+
function main() {
87+
var len;
88+
var min;
89+
var max;
90+
var f;
91+
var i;
92+
93+
min = 1; // 10^min
94+
max = 6; // 10^max
95+
96+
for ( i = min; i <= max; i++ ) {
97+
len = pow( 10, i );
98+
f = createBenchmark( len );
99+
bench( format( '%s:len=%d', pkg, len ), f );
100+
}
101+
}
102+
103+
main();

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/dxsy/docs/repl.txt‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
{{alias}}( arrays )
3+
Subtracts the elements of an output one-dimensional double-precision
4+
floating-point ndarray from the corresponding elements in an input one-
5+
dimensional double-precision floating-point ndarray and assigns the results
6+
to the output ndarray.
7+
8+
The output ndarray is modified *in-place* (i.e., the output ndarray is
9+
*mutated*).
10+
11+
Parameters
12+
----------
13+
arrays: ArrayLikeObject<ndarray>
14+
Array-like object containing the following ndarrays:
15+
16+
- a one-dimensional input ndarray.
17+
- a one-dimensional output ndarray.
18+
19+
Returns
20+
-------
21+
out: ndarray
22+
Output ndarray.
23+
24+
Examples
25+
--------
26+
> var xbuf = [ 1.0, 2.0, 3.0, 4.0 ];
27+
> var x = new {{alias:@stdlib/ndarray/vector/float64}}( xbuf );
28+
> var ybuf = [ 2.0, 4.0, 6.0, 8.0 ];
29+
> var y = new {{alias:@stdlib/ndarray/vector/float64}}( ybuf );
30+
> {{alias}}( [ x, y ] )
31+
<ndarray>[ -1.0, -2.0, -3.0, -4.0 ]
32+
33+
See Also
34+
--------
35+

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/dxsy/docs/types/index.d.ts‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 4.1
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
import { float64ndarray } from '@stdlib/types/ndarray';
24+
25+
/**
26+
* Subtracts the elements of an output one-dimensional double-precision floating-point ndarray from the corresponding elements in an input one-dimensional double-precision floating-point ndarray and assigns the results to the output ndarray.
27+
*
28+
* ## Notes
29+
*
30+
* - The function expects the following ndarrays:
31+
*
32+
* - a one-dimensional input ndarray.
33+
* - a one-dimensional output ndarray.
34+
*
35+
* @param arrays - array-like object containing ndarrays
36+
* @returns output ndarray
37+
*
38+
* @example
39+
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
40+
*
41+
* var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
42+
* var y = new Float64Vector( [ 2.0, 4.0, 6.0, 8.0, 10.0 ] );
43+
*
44+
* var out = dxsy( [ x, y ] );
45+
* // returns <ndarray>[ -1.0, -2.0, -3.0, -4.0, -5.0 ]
46+
*/
47+
declare function dxsy( arrays: [ float64ndarray, float64ndarray ] ): float64ndarray;
48+
49+
50+
// EXPORTS //
51+
52+
export = dxsy;

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/dxsy/docs/types/test.ts‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
/* eslint-disable space-in-parens */
20+
21+
import zeros = require( '@stdlib/ndarray/zeros' );
22+
import dxsy = require( './index' );
23+
24+
25+
// TESTS //
26+
27+
// The function returns an ndarray...
28+
{
29+
const x = zeros( [ 10 ], {
30+
'dtype': 'float64'
31+
});
32+
const y = zeros( [ 10 ], {
33+
'dtype': 'float64'
34+
});
35+
36+
dxsy( [ x, y ] ); // $ExpectType float64ndarray
37+
}
38+
39+
// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
40+
{
41+
dxsy( '10' ); // $ExpectError
42+
dxsy( 5 ); // $ExpectError
43+
dxsy( true ); // $ExpectError
44+
dxsy( false ); // $ExpectError
45+
dxsy( null ); // $ExpectError
46+
dxsy( undefined ); // $ExpectError
47+
dxsy( [] ); // $ExpectError
48+
dxsy( {} ); // $ExpectError
49+
dxsy( ( x: number ): number => x ); // $ExpectError
50+
}
51+
52+
// The compiler throws an error if the function is provided an unsupported number of arguments...
53+
{
54+
const x = zeros( [ 10 ], {
55+
'dtype': 'float64'
56+
});
57+
const y = zeros( [ 10 ], {
58+
'dtype': 'float64'
59+
});
60+
61+
dxsy(); // $ExpectError
62+
dxsy( [ x, y ], {} ); // $ExpectError
63+
}

0 commit comments

Comments
 (0)