-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add blas/base/ndarray/daxpy
#11318
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 all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
e7d9db4
feat: add blas/base/ndarray/daxpy
MeKaustubh07 5a05b11
fix description
MeKaustubh07 d9d8fe3
update imports
MeKaustubh07 87ab080
update link
MeKaustubh07 d2790e8
update link
MeKaustubh07 97e51d5
adjust variable order
MeKaustubh07 edc21a6
style: re-wrap text
kgryte 61bc633
Apply suggestions from code review
kgryte d79be4e
docs: update example
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
124 changes: 124 additions & 0 deletions
124
lib/node_modules/@stdlib/blas/base/ndarray/daxpy/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,124 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # daxpy | ||
|
|
||
| > Multiply a one-dimensional double-precision floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional double-precision floating-point ndarray `y`. | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var daxpy = require( '@stdlib/blas/base/ndarray/daxpy' ); | ||
| ``` | ||
|
|
||
| #### daxpy( arrays ) | ||
|
|
||
| Multiplies a one-dimensional double-precision floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional double-precision floating-point ndarray `y`. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
| var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); | ||
| var ndarray = require( '@stdlib/ndarray/base/ctor' ); | ||
|
|
||
| var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); | ||
| var x = new ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); | ||
|
|
||
| var ybuf = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); | ||
| var y = new ndarray( 'float64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' ); | ||
|
|
||
| var alpha = scalar2ndarray( 5.0, 'float64', 'row-major' ); | ||
| var z = daxpy( [ x, y, alpha ] ); | ||
| // returns <ndarray>[ 6.0, 11.0, 16.0, 21.0, 26.0 ] | ||
|
|
||
| var bool = ( y === z ); | ||
| // returns true | ||
| ``` | ||
|
|
||
| The function has the following parameters: | ||
|
|
||
| - **arrays**: array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); | ||
| var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); | ||
| var ndarray = require( '@stdlib/ndarray/base/ctor' ); | ||
| var ndarray2array = require( '@stdlib/ndarray/to-array' ); | ||
| var daxpy = require( '@stdlib/blas/base/ndarray/daxpy' ); | ||
|
|
||
| var opts = { | ||
| 'dtype': 'float64' | ||
| }; | ||
|
|
||
| var xbuf = discreteUniform( 10, 0, 100, opts ); | ||
| var x = new ndarray( opts.dtype, xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); | ||
| console.log( ndarray2array( x ) ); | ||
|
|
||
| var ybuf = discreteUniform( xbuf.length, 0, 10, opts ); | ||
| var y = new ndarray( opts.dtype, ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' ); | ||
| console.log( ndarray2array( y ) ); | ||
|
|
||
| var alpha = scalar2ndarray( 5.0, opts ); | ||
| var out = daxpy( [ x, y, alpha ] ); | ||
| console.log( ndarray2array( out ) ); | ||
| ``` | ||
|
|
||
| </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"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> | ||
118 changes: 118 additions & 0 deletions
118
lib/node_modules/@stdlib/blas/base/ndarray/daxpy/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,118 @@ | ||
| /** | ||
| * @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 ndarray = require( '@stdlib/ndarray/base/ctor' ); | ||
| var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); | ||
| var format = require( '@stdlib/string/format' ); | ||
| var pkg = require( './../package.json' ).name; | ||
| var daxpy = require( './../lib' ); | ||
|
|
||
|
|
||
| // VARIABLES // | ||
|
|
||
| var options = { | ||
| 'dtype': 'float64' | ||
| }; | ||
|
|
||
|
|
||
| // FUNCTIONS // | ||
|
|
||
| /** | ||
| * Creates a benchmark function. | ||
| * | ||
| * @private | ||
| * @param {PositiveInteger} len - array length | ||
| * @returns {Function} benchmark function | ||
| */ | ||
| function createBenchmark( len ) { | ||
| var alpha; | ||
| var xbuf; | ||
| var ybuf; | ||
| var x; | ||
| var y; | ||
|
|
||
| xbuf = uniform( len, -100.0, 100.0, options ); | ||
| x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); | ||
|
|
||
| ybuf = uniform( len, -100.0, 100.0, options ); | ||
| y = new ndarray( options.dtype, ybuf, [ len ], [ 1 ], 0, 'row-major' ); | ||
|
|
||
| alpha = scalar2ndarray( 5.0, options.dtype, 'row-major' ); | ||
|
|
||
| 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 = daxpy( [ x, y, alpha ] ); | ||
| if ( typeof z !== 'object' ) { | ||
| b.fail( 'should not return NaN' ); | ||
| } | ||
| } | ||
| b.toc(); | ||
| if ( isnan( z.get( i%len ) ) ) { | ||
| 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(); |
40 changes: 40 additions & 0 deletions
40
lib/node_modules/@stdlib/blas/base/ndarray/daxpy/docs/repl.txt
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,40 @@ | ||
|
|
||
| {{alias}}( arrays ) | ||
| Multiplies a one-dimensional double-precision floating-point ndarray `x` | ||
| by a constant `alpha` and adds the result to a one-dimensional double- | ||
| precision floating-point ndarray `y`. | ||
|
|
||
| If provided an empty input ndarray, the function returns the output ndarray | ||
| unchanged. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| arrays: ArrayLikeObject<ndarray> | ||
| Array-like object containing an input ndarray, an output ndarray, and | ||
| a zero-dimensional ndarray containing a scalar constant `alpha`. | ||
|
|
||
| Returns | ||
| ------- | ||
| out: ndarray | ||
| Output ndarray. | ||
|
|
||
| Examples | ||
| -------- | ||
| > var xbuf = new {{alias:@stdlib/array/float64}}( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); | ||
| > var ybuf = new {{alias:@stdlib/array/float64}}( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); | ||
| > var dt = 'float64'; | ||
| > var sh = [ xbuf.length ]; | ||
| > var st = [ 1 ]; | ||
| > var oo = 0; | ||
| > var ord = 'row-major'; | ||
| > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord ); | ||
| > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord ); | ||
| > var alpha = {{alias:@stdlib/ndarray/base/from-scalar}}( 5.0, dt, ord ); | ||
|
|
||
| > {{alias}}( [ x, y, alpha ] ); | ||
| > y | ||
| <ndarray>[ 22.0, 16.0, -16.0, 21.0, 3.0 ] | ||
|
|
||
| See Also | ||
| -------- | ||
|
|
55 changes: 55 additions & 0 deletions
55
lib/node_modules/@stdlib/blas/base/ndarray/daxpy/docs/types/index.d.ts
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,55 @@ | ||
| /* | ||
| * @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 | ||
|
|
||
| /// <reference types="@stdlib/types"/> | ||
|
|
||
| import { float64ndarray } from '@stdlib/types/ndarray'; | ||
|
|
||
| /** | ||
| * Multiplies a one-dimensional double-precision floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional double-precision floating-point ndarray `y`. | ||
| * | ||
| * @param arrays - array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant | ||
| * @returns output ndarray | ||
| * | ||
| * @example | ||
| * var Float64Array = require( '@stdlib/array/float64' ); | ||
| * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); | ||
| * var ndarray = require( '@stdlib/ndarray/base/ctor' ); | ||
| * | ||
| * var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); | ||
| * var x = new ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); | ||
| * | ||
| * var ybuf = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); | ||
| * var y = new ndarray( 'float64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' ); | ||
| * | ||
| * var alpha = scalar2ndarray( 5.0, 'float64', 'row-major' ); | ||
| * | ||
| * var z = daxpy( [ x, y, alpha ] ); | ||
| * // returns <ndarray>[ 6.0, 11.0, 16.0, 21.0, 26.0 ] | ||
| * | ||
| * var bool = ( z === y ); | ||
| * // returns true | ||
| */ | ||
| declare function daxpy( arrays: [ float64ndarray, float64ndarray, float64ndarray ] ): float64ndarray; | ||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| export = daxpy; |
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.