-
-
Notifications
You must be signed in to change notification settings - Fork 869
feat: add blas/base/ndarray/ddot
#7906
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 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
134 changes: 134 additions & 0 deletions
134
lib/node_modules/@stdlib/blas/base/ndarray/ddot/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,134 @@ | ||
<!-- | ||
|
||
@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. | ||
|
||
--> | ||
|
||
# ddot | ||
|
||
> Calculate the dot product of two one-dimensional double-precision floating-point ndarrays. | ||
|
||
<section class="intro"> | ||
|
||
The [dot product][dot-product] (or scalar product) is defined as | ||
|
||
<!-- <equation class="equation" label="eq:dot_product" align="center" raw="\mathbf{x}\cdot\mathbf{y} = \sum_{i=0}^{N-1} x_i y_i = x_0 y_0 + x_1 y_1 + \ldots + x_{N-1} y_{N-1}" alt="Dot product definition."> --> | ||
|
||
```math | ||
\mathbf{x}\cdot\mathbf{y} = \sum_{i=0}^{N-1} x_i y_i = x_0 y_0 + x_1 y_1 + \ldots + x_{N-1} y_{N-1} | ||
``` | ||
|
||
<!-- <div class="equation" align="center" data-raw-text="\mathbf{x}\cdot\mathbf{y} = \sum_{i=0}^{N-1} x_i y_i = x_0 y_0 + x_1 y_1 + \ldots + x_{N-1} y_{N-1}" data-equation="eq:dot_product"> | ||
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@6cf4829ce9c06ba9fa207a2ea3b395266f86a259/lib/node_modules/@stdlib/blas/base/ndarray/ddot/docs/img/equation_dot_product.svg" alt="Dot product definition."> | ||
<br> | ||
</div> --> | ||
|
||
<!-- </equation> --> | ||
|
||
</section> | ||
|
||
<!-- /.intro --> | ||
|
||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var ddot = require( '@stdlib/blas/base/ndarray/ddot' ); | ||
``` | ||
|
||
#### ddot( arrays ) | ||
|
||
Computes the dot product of two one-dimensional double-precision floating-point ndarrays. | ||
|
||
```javascript | ||
var Float64Array = require( '@stdlib/array/float64' ); | ||
var ndarray = require( '@stdlib/ndarray/base/ctor' ); | ||
|
||
var xbuf = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); | ||
var x = new ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); | ||
|
||
var ybuf = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); | ||
var y = new ndarray( 'float64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' ); | ||
|
||
var z = ddot( [ x, y ] ); | ||
// returns -5.0 | ||
``` | ||
|
||
The function has the following parameters: | ||
|
||
- **arrays**: array-like object containing two one-dimensional input ndarrays. | ||
|
||
</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 ndarray = require( '@stdlib/ndarray/base/ctor' ); | ||
var ndarray2array = require( '@stdlib/ndarray/to-array' ); | ||
var ddot = require( '@stdlib/blas/base/ndarray/ddot' ); | ||
|
||
var opts = { | ||
'dtype': 'float64' | ||
}; | ||
|
||
var xbuf = discreteUniform( 10, 0, 500, opts ); | ||
var x = new ndarray( opts.dtype, xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); | ||
console.log( ndarray2array( x ) ); | ||
|
||
var ybuf = discreteUniform( 10, 0, 255, opts ); | ||
var y = new ndarray( opts.dtype, ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' ); | ||
console.log( ndarray2array( y ) ); | ||
|
||
var out = ddot( [ x, y ] ); | ||
console.log( 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"> | ||
|
||
[dot-product]: https://en.wikipedia.org/wiki/Dot_product | ||
|
||
</section> | ||
|
||
<!-- /.links --> |
113 changes: 113 additions & 0 deletions
113
lib/node_modules/@stdlib/blas/base/ndarray/ddot/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,113 @@ | ||
/** | ||
* @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. | ||
*/ | ||
|
||
'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 pkg = require( './../package.json' ).name; | ||
var ddot = 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 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' ); | ||
|
||
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 = ddot( [ x, y ] ); | ||
if ( isnan( z ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( isnan( z ) ) { | ||
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( pkg+':len='+len, f ); | ||
} | ||
} | ||
|
||
main(); |
83 changes: 83 additions & 0 deletions
83
lib/node_modules/@stdlib/blas/base/ndarray/ddot/docs/img/equation_dot_product.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions
35
lib/node_modules/@stdlib/blas/base/ndarray/ddot/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,35 @@ | ||
|
||
{{alias}}( arrays ) | ||
Computes the dot product of two one-dimensional double-precision floating- | ||
point ndarrays. | ||
|
||
If provided an empty input ndarray, the function returns `0.0`. | ||
|
||
Parameters | ||
---------- | ||
arrays: ArrayLikeObject<ndarray> | ||
Array-like object containing two one-dimensional input ndarrays. | ||
|
||
Returns | ||
------- | ||
out: number | ||
The dot product. | ||
|
||
Examples | ||
-------- | ||
// Standard usage: | ||
> 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 ); | ||
> {{alias}}( [ x, y ] ) | ||
-5.0 | ||
|
||
See Also | ||
-------- | ||
|
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.