From 65037f6155fb567837c2e6fa633891995d1130b4 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Thu, 1 Oct 2026 20:10:39 -0700 Subject: [PATCH] feat: add `blas/ext/base/ndarray/dwxmy` --- 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/dwxmy/README.md | 131 ++++++++ .../base/ndarray/dwxmy/benchmark/benchmark.js | 104 +++++++ .../blas/ext/base/ndarray/dwxmy/docs/repl.txt | 33 ++ .../base/ndarray/dwxmy/docs/types/index.d.ts | 54 ++++ .../ext/base/ndarray/dwxmy/docs/types/test.ts | 69 +++++ .../ext/base/ndarray/dwxmy/examples/index.js | 38 +++ .../blas/ext/base/ndarray/dwxmy/lib/index.js | 45 +++ .../blas/ext/base/ndarray/dwxmy/lib/main.js | 67 ++++ .../blas/ext/base/ndarray/dwxmy/package.json | 72 +++++ .../blas/ext/base/ndarray/dwxmy/test/test.js | 292 ++++++++++++++++++ 10 files changed, 905 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/README.md create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/package.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/test/test.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/README.md new file mode 100644 index 000000000000..207045f9b92e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/README.md @@ -0,0 +1,131 @@ + + +# dwxmy + +> Multiply elements of a one-dimensional double-precision floating-point ndarray by the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assign the results to elements in a third one-dimensional double-precision floating-point ndarray. + +
+ +This BLAS extension implements the operation + + + +```math +\mathbf{w} = \mathbf{x} \odot \mathbf{y} +``` + + + +where `⊙` denotes the [Hadamard product][hadamard-product]. + +
+ + + +
+ +## Usage + +```javascript +var dwxmy = require( '@stdlib/blas/ext/base/ndarray/dwxmy' ); +``` + +#### dwxmy( arrays ) + +Multiplies elements of a one-dimensional double-precision floating-point ndarray by the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assigns the results to elements in a third one-dimensional double-precision floating-point ndarray. + +```javascript +var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); + +var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +var y = new Float64Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var w = new Float64Vector( 5 ); + +dwxmy( [ x, y, w ] ); +// w => [ 2.0, 6.0, 12.0, 20.0, 30.0 ] +``` + +The function has the following parameters: + +- **arrays**: array-like object containing the following ndarrays: + + - first one-dimensional input ndarray. + - second one-dimensional input ndarray. + - a one-dimensional output ndarray. + +
+ + + +
+ +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/discrete-uniform' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var dwxmy = require( '@stdlib/blas/ext/base/ndarray/dwxmy' ); + +var opts = { + 'dtype': 'float64' +}; + +var x = discreteUniform( [ 10 ], -100, 100, opts ); +console.log( ndarray2array( x ) ); + +var y = discreteUniform( [ 10 ], -100, 100, opts ); +console.log( ndarray2array( y ) ); + +var w = discreteUniform( [ 10 ], -100, 100, opts ); + +dwxmy( [ x, y, w ] ); +console.log( ndarray2array( w ) ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/benchmark/benchmark.js new file mode 100644 index 000000000000..38b1ba67f2e1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/benchmark/benchmark.js @@ -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/uniform' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var dwxmy = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// 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 ); + var w = 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 = dwxmy( [ x, y, w ] ); + 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/dwxmy/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/docs/repl.txt new file mode 100644 index 000000000000..d8725723a140 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/docs/repl.txt @@ -0,0 +1,33 @@ + +{{alias}}( arrays ) + Multiplies elements of a one-dimensional double-precision floating-point + ndarray by the corresponding elements of a second one-dimensional double- + precision floating-point ndarray and assigns the results to elements in a + third one-dimensional double-precision floating-point ndarray. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing the following ndarrays: + + - first one-dimensional input ndarray. + - second 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 = new {{alias:@stdlib/ndarray/vector/float64}}( xbuf ); + > var ybuf = [ 2.0, 3.0, 4.0, 5.0 ]; + > var y = new {{alias:@stdlib/ndarray/vector/float64}}( ybuf ); + > var w = new {{alias:@stdlib/ndarray/vector/float64}}( 4 ); + > {{alias}}( [ x, y, w ] ) + [ 2.0, 6.0, 12.0, 20.0 ] + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/docs/types/index.d.ts new file mode 100644 index 000000000000..f35f85e10648 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/docs/types/index.d.ts @@ -0,0 +1,54 @@ +/* +* @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 { float64ndarray } from '@stdlib/types/ndarray'; + +/** +* Multiplies elements of a one-dimensional double-precision floating-point ndarray by the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assigns the results to elements in a third one-dimensional double-precision floating-point ndarray. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - first one-dimensional input ndarray. +* - second one-dimensional input ndarray. +* - a one-dimensional output ndarray. +* +* @param arrays - array-like object containing ndarrays +* @returns output ndarray +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* +* var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var w = new Float64Vector( 5 ); +* +* var out = dwxmy( [ x, y, w ] ); +* // returns [ 2.0, 6.0, 12.0, 20.0, 30.0 ] +*/ +declare function dwxmy( arrays: [ float64ndarray, float64ndarray, float64ndarray ] ): float64ndarray; + + +// EXPORTS // + +export = dwxmy; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/docs/types/test.ts new file mode 100644 index 000000000000..a015f2a5052e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/docs/types/test.ts @@ -0,0 +1,69 @@ +/* +* @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 dwxmy = require( './index' ); + + +// TESTS // + +// The function returns an ndarray... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float64' + }); + const y = zeros( [ 10 ], { + 'dtype': 'float64' + }); + const w = zeros( [ 10 ], { + 'dtype': 'float64' + }); + + dwxmy( [ x, y, w ] ); // $ExpectType float64ndarray +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + dwxmy( '10' ); // $ExpectError + dwxmy( 5 ); // $ExpectError + dwxmy( true ); // $ExpectError + dwxmy( false ); // $ExpectError + dwxmy( null ); // $ExpectError + dwxmy( undefined ); // $ExpectError + dwxmy( [] ); // $ExpectError + dwxmy( {} ); // $ExpectError + dwxmy( ( 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': 'float64' + }); + const y = zeros( [ 10 ], { + 'dtype': 'float64' + }); + const w = zeros( [ 10 ], { + 'dtype': 'float64' + }); + + dwxmy(); // $ExpectError + dwxmy( [ x, y, w ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/examples/index.js new file mode 100644 index 000000000000..a4618d2083f4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/examples/index.js @@ -0,0 +1,38 @@ +/** +* @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 dwxmy = require( './../lib' ); + +var opts = { + 'dtype': 'float64' +}; + +var x = discreteUniform( [ 10 ], -100, 100, opts ); +console.log( ndarray2array( x ) ); + +var y = discreteUniform( [ 10 ], -100, 100, opts ); +console.log( ndarray2array( y ) ); + +var w = discreteUniform( [ 10 ], -100, 100, opts ); + +dwxmy( [ x, y, w ] ); +console.log( ndarray2array( w ) ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/lib/index.js new file mode 100644 index 000000000000..508ef0744b70 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/lib/index.js @@ -0,0 +1,45 @@ +/** +* @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'; + +/** +* Multiply elements of a one-dimensional double-precision floating-point ndarray by the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assign the results to elements in a third one-dimensional double-precision floating-point ndarray. +* +* @module @stdlib/blas/ext/base/ndarray/dwxmy +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* var dwxmy = require( '@stdlib/blas/ext/base/ndarray/dwxmy' ); +* +* var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var w = new Float64Vector( 5 ); +* +* var out = dwxmy( [ x, y, w ] ); +* // returns [ 2.0, 6.0, 12.0, 20.0, 30.0 ] +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/lib/main.js new file mode 100644 index 000000000000..a24dc9593d01 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/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/dwxmy' ).ndarray; + + +// MAIN // + +/** +* Multiplies elements of a one-dimensional double-precision floating-point ndarray by the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assigns the results to elements in a third one-dimensional double-precision floating-point ndarray. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - first one-dimensional input ndarray. +* - second one-dimensional input ndarray. +* - a one-dimensional output ndarray. +* +* @param {ArrayLikeObject} arrays - array-like object containing ndarrays +* @returns {ndarray} output ndarray +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* +* var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float64Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var w = new Float64Vector( 5 ); +* +* var out = dwxmy( [ x, y, w ] ); +* // returns [ 2.0, 6.0, 12.0, 20.0, 30.0 ] +*/ +function dwxmy( arrays ) { + var x = arrays[ 0 ]; + var y = arrays[ 1 ]; + var w = arrays[ 2 ]; + strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ), getData( y ), getStride( y, 0 ), getOffset( y ), getData( w ), getStride( w, 0 ), getOffset( w ) ); // eslint-disable-line max-len + return w; +} + + +// EXPORTS // + +module.exports = dwxmy; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/package.json new file mode 100644 index 000000000000..1cfedadb2ef9 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/package.json @@ -0,0 +1,72 @@ +{ + "name": "@stdlib/blas/ext/base/ndarray/dwxmy", + "version": "0.0.0", + "description": "Multiply elements of a one-dimensional double-precision floating-point ndarray by the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assign the results to elements in a third one-dimensional double-precision floating-point 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", + "dwxmy", + "wxmy", + "multiply", + "multiplication", + "vector", + "strided", + "array", + "ndarray", + "float64", + "double", + "double-precision" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/test/test.js new file mode 100644 index 000000000000..d6a3c2a06b60 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dwxmy/test/test.js @@ -0,0 +1,292 @@ +/** +* @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 Float64Array = require( '@stdlib/array/float64' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var dwxmy = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {Float64Array} 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( 'float64', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dwxmy, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( dwxmy.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function multiplies `x` by `y` and assigns the results to `w`', function test( t ) { + var expected; + var actual; + var wbuf; + var xbuf; + var ybuf; + var w; + var x; + var y; + + xbuf = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0 ] ); + ybuf = new Float64Array( [ 1.0, 2.0, -3.0, 4.0, -1.0 ] ); + wbuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + x = vector( xbuf, 5, 1, 0 ); + y = vector( ybuf, 5, 1, 0 ); + w = vector( wbuf, 5, 1, 0 ); + expected = new Float64Array([ + -2.0, // -2.0 * 1.0 + 2.0, // 1.0 * 2.0 + -9.0, // 3.0 * (-3.0) + -20.0, // -5.0 * 4.0 + -4.0 // 4.0 * (-1.0) + ]); + + actual = dwxmy( [ x, y, w ] ); + t.strictEqual( actual, w, 'returns expected value' ); + t.deepEqual( wbuf, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports ndarrays having non-unit strides', function test( t ) { + var expected; + var actual; + var wbuf; + var xbuf; + var ybuf; + var w; + var x; + var y; + + xbuf = new Float64Array([ + -2.0, // 0 + 1.0, + 3.0, // 1 + -5.0, + 4.0, // 2 + 0.0, + -1.0, // 3 + -3.0 + ]); + ybuf = new Float64Array([ + 1.0, // 0 + 2.0, + -3.0, // 1 + 4.0, + -1.0, // 2 + 0.0, + 3.0, // 3 + 2.0 + ]); + wbuf = new Float64Array( [ 0.0, 10.0, 0.0, 10.0, 0.0, 10.0, 0.0, 10.0 ] ); + x = vector( xbuf, 4, 2, 0 ); + y = vector( ybuf, 4, 2, 0 ); + w = vector( wbuf, 4, 2, 0 ); + expected = new Float64Array([ + -2.0, // -2.0 * 1.0 + 10.0, + -9.0, // 3.0 * (-3.0) + 10.0, + -4.0, // 4.0 * (-1.0) + 10.0, + -3.0, // -1.0 * 3.0 + 10.0 + ]); + + actual = dwxmy( [ x, y, w ] ); + t.strictEqual( actual, w, 'returns expected value' ); + t.deepEqual( wbuf, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports ndarrays having negative strides', function test( t ) { + var expected; + var actual; + var wbuf; + var xbuf; + var ybuf; + var w; + var x; + var y; + + xbuf = new Float64Array([ + -2.0, // 4 + 1.0, // 3 + 3.0, // 2 + -5.0, // 1 + 4.0 // 0 + ]); + ybuf = new Float64Array([ + 1.0, // 4 + 2.0, // 3 + -3.0, // 2 + 4.0, // 1 + -1.0 // 0 + ]); + wbuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + x = vector( xbuf, 5, -1, 4 ); + y = vector( ybuf, 5, -1, 4 ); + w = vector( wbuf, 5, -1, 4 ); + expected = new Float64Array([ + -2.0, // -2.0 * 1.0 + 2.0, // 1.0 * 2.0 + -9.0, // 3.0 * (-3.0) + -20.0, // -5.0 * 4.0 + -4.0 // 4.0 * (-1.0) + ]); + + actual = dwxmy( [ x, y, w ] ); + t.strictEqual( actual, w, 'returns expected value' ); + t.deepEqual( wbuf, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports ndarrays having non-zero offsets', function test( t ) { + var expected; + var actual; + var wbuf; + var xbuf; + var ybuf; + var w; + var x; + var y; + + xbuf = new Float64Array([ + 1.0, + -2.0, + 3.0, // 0 + -5.0, // 1 + 4.0, // 2 + 0.0 + ]); + ybuf = new Float64Array([ + 1.0, + -2.0, + 0.0, // 0 + 4.0, // 1 + -1.0, // 2 + 0.0 + ]); + wbuf = new Float64Array( [ 10.0, 10.0, 0.0, 0.0, 0.0, 10.0 ] ); + x = vector( xbuf, 3, 1, 2 ); + y = vector( ybuf, 3, 1, 2 ); + w = vector( wbuf, 3, 1, 2 ); + expected = new Float64Array([ + 10.0, + 10.0, + 0.0, // 3.0 * 0.0 + -20.0, // -5.0 * 4.0 + -4.0, // 4.0 * (-1.0) + 10.0 + ]); + + actual = dwxmy( [ x, y, w ] ); + t.strictEqual( actual, w, 'returns expected value' ); + t.deepEqual( wbuf, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports ndarrays having different strides and offsets', function test( t ) { + var expected; + var actual; + var wbuf; + var xbuf; + var ybuf; + var w; + var x; + var y; + + xbuf = new Float64Array( [ 1.0, 100.0, 2.0, 100.0, 3.0, 100.0, 4.0 ] ); + ybuf = new Float64Array( [ 40.0, 30.0, 20.0, 10.0 ] ); + wbuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + x = vector( xbuf, 4, 2, 0 ); + y = vector( ybuf, 4, -1, 3 ); + w = vector( wbuf, 4, 3, 1 ); + expected = new Float64Array([ + 0.0, + 10.0, + 0.0, + 0.0, + 40.0, + 0.0, + 0.0, + 90.0, + 0.0, + 0.0, + 160.0, + 0.0 + ]); + + actual = dwxmy( [ x, y, w ] ); + t.strictEqual( actual, w, 'returns expected value' ); + t.deepEqual( wbuf, 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 wbuf; + var xbuf; + var ybuf; + var w; + var x; + var y; + + xbuf = new Float64Array( [] ); + ybuf = new Float64Array( [] ); + wbuf = new Float64Array( [] ); + x = vector( xbuf, 0, 1, 0 ); + y = vector( ybuf, 0, 1, 0 ); + w = vector( wbuf, 0, 1, 0 ); + expected = new Float64Array( [] ); + + actual = dwxmy( [ x, y, w ] ); + t.strictEqual( actual, w, 'returns expected value' ); + t.deepEqual( wbuf, expected, 'returns expected value' ); + + t.end(); +});