From 8bf5fea0b7169dd94f2a7fb3c3289cc7227fa82c Mon Sep 17 00:00:00 2001 From: kaustubh Date: Wed, 10 Jun 2026 23:51:17 +0530 Subject: [PATCH 1/3] feat: add blas/base/ndarray/dgemv --- 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 --- --- .../@stdlib/blas/base/ndarray/dgemv/README.md | 135 ++++++++ .../base/ndarray/dgemv/benchmark/benchmark.js | 116 +++++++ .../blas/base/ndarray/dgemv/docs/repl.txt | 40 +++ .../base/ndarray/dgemv/docs/types/index.d.ts | 69 ++++ .../base/ndarray/dgemv/docs/types/test.ts | 81 +++++ .../blas/base/ndarray/dgemv/examples/index.js | 41 +++ .../blas/base/ndarray/dgemv/lib/index.js | 58 ++++ .../blas/base/ndarray/dgemv/lib/main.js | 85 +++++ .../blas/base/ndarray/dgemv/package.json | 72 ++++ .../blas/base/ndarray/dgemv/test/test.js | 313 ++++++++++++++++++ 10 files changed, 1010 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dgemv/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dgemv/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dgemv/package.json create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dgemv/test/test.js diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md new file mode 100644 index 000000000000..bad2d43f3dcb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md @@ -0,0 +1,135 @@ + + +# dgemv + +> Perform the matrix-vector operation `y = alpha*A*x + beta*y`. + +
+ +
+ + + +
+ +## Usage + +```javascript +var dgemv = require( '@stdlib/blas/base/ndarray/dgemv' ); +``` + +#### dgemv( arrays ) + +Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix. + +```javascript +var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var Float64Array = require( '@stdlib/array/float64' ); + +var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), [ 2, 3 ], [ 3, 1 ], 0, 'row-major' ); +var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); +var y = new Float64Vector( [ 4.0, 5.0 ] ); + +var alpha = scalar2ndarray( 3.0, { + 'dtype': 'float64' +}); +var beta = scalar2ndarray( 2.0, { + 'dtype': 'float64' +}); + +var out = dgemv( [ A, x, y, alpha, beta ] ); +// returns [ 50.0, 106.0 ] + +var bool = ( out === y ); +// returns true +``` + +The function has the following parameters: + +- **arrays**: array-like object containing the following ndarrays: + + - a two-dimensional input ndarray. + - first one-dimensional input ndarray. + - second one-dimensional input/output ndarray. + - first zero-dimensional ndarray containing a scalar constant. + - second zero-dimensional ndarray containing a scalar constant. + +
+ + + +
+ +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var Float64Array = require( '@stdlib/array/float64' ); +var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var dgemv = require( '@stdlib/blas/base/ndarray/dgemv' ); + +var opts = { + 'dtype': 'float64' +}; + +var A = new ndarray( 'float64', new Float64Array( discreteUniform( 12, 0, 10, opts ) ), [ 3, 4 ], [ 4, 1 ], 0, 'row-major' ); +var x = new Float64Vector( discreteUniform( 4, 0, 10, opts ) ); +var y = new Float64Vector( discreteUniform( 3, 0, 10, opts ) ); + +var alpha = scalar2ndarray( 3.0, opts ); +var beta = scalar2ndarray( 2.0, opts ); + +var out = dgemv( [ A, x, y, alpha, beta ] ); +console.log( ndarray2array( out ) ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/benchmark/benchmark.js new file mode 100644 index 000000000000..946bf28e4822 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/benchmark/benchmark.js @@ -0,0 +1,116 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var dgemv = 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 beta; + var x; + var y; + var A; + + A = uniform( [ len, len ], -100.0, 100.0, options ); + x = uniform( [ len ], -100.0, 100.0, options ); + y = uniform( [ len ], -100.0, 100.0, options ); + + alpha = scalar2ndarray( 1.0, options ); + beta = scalar2ndarray( 1.0, options ); + + 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 = dgemv( [ A, x, y, alpha, beta ] ); + if ( typeof z !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + } + 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 = 3; // 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/base/ndarray/dgemv/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/repl.txt new file mode 100644 index 000000000000..c9210aafeca6 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/repl.txt @@ -0,0 +1,40 @@ + +{{alias}}( arrays ) + Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where + `alpha` and `beta` are scalars, `x` and `y` are vectors, and `A` is + an `M` by `N` matrix. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing the following ndarrays: + + - a two-dimensional input ndarray. + - first one-dimensional input ndarray. + - second one-dimensional input/output ndarray. + - first zero-dimensional ndarray containing a scalar constant. + - second zero-dimensional ndarray containing a scalar constant. + + Returns + ------- + out: ndarray + Output ndarray. + + Examples + -------- + > var buf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > var sh = [ 2, 3 ]; + > var st = [ 3, 1 ]; + > var A = new {{alias:@stdlib/ndarray/base/ctor}}( 'float64', buf, sh, st, 0, 'row-major' ); + > var x = new {{alias:@stdlib/ndarray/vector/float64}}( [ 1.0, 2.0, 3.0 ] ); + > var y = new {{alias:@stdlib/ndarray/vector/float64}}( [ 4.0, 5.0 ] ); + > var alpha = {{alias:@stdlib/ndarray/from-scalar}}( 3.0, { 'dtype': 'float64' }); + > var beta = {{alias:@stdlib/ndarray/from-scalar}}( 2.0, { 'dtype': 'float64' }); + + > {{alias}}( [ A, x, y, alpha, beta ] ); + > y + [ 50.0, 106.0 ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.ts new file mode 100644 index 000000000000..a38e45351f67 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.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. +*/ + +// TypeScript Version: 4.1 + +/// + +import { float64ndarray } from '@stdlib/types/ndarray'; + +/** +* Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a two-dimensional input ndarray. +* - first one-dimensional input ndarray. +* - second one-dimensional input/output ndarray. +* - first zero-dimensional ndarray containing a scalar constant. +* - second zero-dimensional ndarray containing a scalar constant. +* +* @param arrays - array-like object containing ndarrays +* @returns output ndarray +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), [ 2, 3 ], [ 3, 1 ], 0, 'row-major' ); +* var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); +* var y = new Float64Vector( [ 4.0, 5.0 ] ); +* +* var alpha = scalar2ndarray( 3.0, { +* 'dtype': 'float64' +* }); +* var beta = scalar2ndarray( 2.0, { +* 'dtype': 'float64' +* }); +* +* var z = dgemv( [ A, x, y, alpha, beta ] ); +* // returns [ 50.0, 106.0 ] +* +* var bool = ( z === y ); +* // returns true +*/ +declare function dgemv( arrays: [ float64ndarray, float64ndarray, float64ndarray, float64ndarray, float64ndarray ] ): float64ndarray; + + +// EXPORTS // + +export = dgemv; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/test.ts new file mode 100644 index 000000000000..c545d2cc3aaf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/test.ts @@ -0,0 +1,81 @@ +/* +* @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 dgemv = require( '@stdlib/blas/base/ndarray/dgemv' ); + + +// TESTS // + +// The function returns an ndarray... +{ + const A = zeros( [ 2, 3 ], { + 'dtype': 'float64' + }); + const x = zeros( [ 3 ], { + 'dtype': 'float64' + }); + const y = zeros( [ 2 ], { + 'dtype': 'float64' + }); + const alpha = zeros( [], { + 'dtype': 'float64' + }); + const beta = zeros( [], { + 'dtype': 'float64' + }); + + dgemv( [ A, x, y, alpha, beta ] ); // $ExpectType float64ndarray +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + dgemv( '10' ); // $ExpectError + dgemv( 10 ); // $ExpectError + dgemv( true ); // $ExpectError + dgemv( false ); // $ExpectError + dgemv( null ); // $ExpectError + dgemv( undefined ); // $ExpectError + dgemv( [] ); // $ExpectError + dgemv( {} ); // $ExpectError + dgemv( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const A = zeros( [ 2, 3 ], { + 'dtype': 'float64' + }); + const x = zeros( [ 3 ], { + 'dtype': 'float64' + }); + const y = zeros( [ 2 ], { + 'dtype': 'float64' + }); + const alpha = zeros( [], { + 'dtype': 'float64' + }); + const beta = zeros( [], { + 'dtype': 'float64' + }); + + dgemv(); // $ExpectError + dgemv( [ A, x, y, alpha, beta ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/examples/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/examples/index.js new file mode 100644 index 000000000000..ec2702dc17de --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/examples/index.js @@ -0,0 +1,41 @@ +/** +* @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/array/discrete-uniform' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var Float64Array = require( '@stdlib/array/float64' ); +var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var dgemv = require( './../lib' ); + +var opts = { + 'dtype': 'float64' +}; + +var A = new ndarray( 'float64', new Float64Array( discreteUniform( 12, 0, 10, opts ) ), [ 3, 4 ], [ 4, 1 ], 0, 'row-major' ); +var x = new Float64Vector( discreteUniform( 4, 0, 10, opts ) ); +var y = new Float64Vector( discreteUniform( 3, 0, 10, opts ) ); + +var alpha = scalar2ndarray( 3.0, opts ); +var beta = scalar2ndarray( 2.0, opts ); + +var out = dgemv( [ A, x, y, alpha, beta ] ); +console.log( ndarray2array( out ) ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/index.js new file mode 100644 index 000000000000..08377deb9c5f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/index.js @@ -0,0 +1,58 @@ +/** +* @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'; + +/** +* BLAS level 2 routine to perform the matrix-vector operation `y = alpha*A*x + beta*y`. +* +* @module @stdlib/blas/base/ndarray/dgemv +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var Float64Array = require( '@stdlib/array/float64' ); +* var dgemv = require( '@stdlib/blas/base/ndarray/dgemv' ); +* +* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), [ 2, 3 ], [ 3, 1 ], 0, 'row-major' ); +* var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); +* var y = new Float64Vector( [ 4.0, 5.0 ] ); +* +* var alpha = scalar2ndarray( 3.0, { +* 'dtype': 'float64' +* }); +* var beta = scalar2ndarray( 2.0, { +* 'dtype': 'float64' +* }); +* +* var out = dgemv( [ A, x, y, alpha, beta ] ); +* // returns [ 50.0, 106.0 ] +* +* var bool = ( out === y ); +* // returns true +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js new file mode 100644 index 000000000000..81c03f67a047 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js @@ -0,0 +1,85 @@ +/** +* @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 ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' ); +var strided = require( '@stdlib/blas/base/dgemv' ).ndarray; + + +// MAIN // + +/** +* Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a two-dimensional input ndarray. +* - first one-dimensional input ndarray. +* - second one-dimensional input/output ndarray. +* - first zero-dimensional ndarray containing a scalar constant. +* - second zero-dimensional ndarray containing a scalar constant. +* +* @param {ArrayLikeObject} arrays - array-like object containing ndarrays +* @returns {Object} output ndarray +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), [ 2, 3 ], [ 3, 1 ], 0, 'row-major' ); +* var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); +* var y = new Float64Vector( [ 4.0, 5.0 ] ); +* +* var alpha = scalar2ndarray( 3.0, { +* 'dtype': 'float64' +* }); +* var beta = scalar2ndarray( 2.0, { +* 'dtype': 'float64' +* }); +* +* var z = dgemv( [ A, x, y, alpha, beta ] ); +* // returns [ 50.0, 106.0 ] +* +* var bool = ( z === y ); +* // returns true +*/ +function dgemv( arrays ) { + var alpha = ndarraylike2scalar( arrays[ 3 ] ); + var beta = ndarraylike2scalar( arrays[ 4 ] ); + var A = arrays[ 0 ]; + var x = arrays[ 1 ]; + var y = arrays[ 2 ]; + strided( 'no-transpose', numelDimension( A, 0 ), numelDimension( A, 1 ), alpha, getData( A ), getStride( A, 0 ), getStride( A, 1 ), getOffset( A ), getData( x ), getStride( x, 0 ), getOffset( x ), beta, getData( y ), getStride( y, 0 ), getOffset( y ) ); + return y; +} + + +// EXPORTS // + +module.exports = dgemv; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/package.json b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/package.json new file mode 100644 index 000000000000..75871071bbae --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/package.json @@ -0,0 +1,72 @@ +{ + "name": "@stdlib/blas/base/ndarray/dgemv", + "version": "0.0.0", + "description": "Perform the matrix-vector operation `y = alpha*A*x + beta*y`.", + "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", + "level 2", + "dgemv", + "linear", + "algebra", + "subroutines", + "matrix-vector", + "multiply", + "vector", + "matrix", + "array", + "ndarray", + "float64", + "double", + "float64array" + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/test/test.js b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/test/test.js new file mode 100644 index 000000000000..82a403960a64 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/test/test.js @@ -0,0 +1,313 @@ +/** +* @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 isSameFloat64Array = require( '@stdlib/assert/is-same-float64array' ); +var Float64Array = require( '@stdlib/array/float64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var getData = require( '@stdlib/ndarray/data-buffer' ); +var dgemv = 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( 'float64', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + +/** +* Returns a two-dimensional ndarray. +* +* @private +* @param {Collection} buffer - underlying data buffer +* @param {NonNegativeInteger} M - number of rows +* @param {NonNegativeInteger} N - number of columns +* @param {integer} stride0 - stride of the first dimension +* @param {integer} stride1 - stride of the second dimension +* @param {NonNegativeInteger} offset - index offset +* @returns {ndarray} two-dimensional ndarray +*/ +function matrix( buffer, M, N, stride0, stride1, offset ) { + return new ndarray( 'float64', buffer, [ M, N ], [ stride0, stride1 ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dgemv, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( dgemv.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function performs the matrix-vector operation `y = alpha*A*x + beta*y`', function test( t ) { + var expected; + var alpha; + var beta; + var xbuf; + var ybuf; + var Abuf; + var x; + var y; + var A; + var v; + + xbuf = new Float64Array( [ 1.0, 2.0 ] ); + ybuf = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + A = matrix( Abuf, 3, 2, 2, 1, 0 ); + x = vector( xbuf, 2, 1, 0 ); + y = vector( ybuf, 3, 1, 0 ); + alpha = scalar2ndarray( 1.0, { + 'dtype': 'float64' + }); + beta = scalar2ndarray( 1.0, { + 'dtype': 'float64' + }); + + v = dgemv( [ A, x, y, alpha, beta ] ); + + expected = new Float64Array( [ 6.0, 13.0, 20.0 ] ); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + + xbuf = new Float64Array( [ 1.0, 1.0, 1.0 ] ); + ybuf = new Float64Array( [ 1.0, 1.0 ] ); + Abuf = new Float64Array( [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] ); + A = matrix( Abuf, 2, 3, 1, 2, 0 ); + x = vector( xbuf, 3, 1, 0 ); + y = vector( ybuf, 2, 1, 0 ); + alpha = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + beta = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + + v = dgemv( [ A, x, y, alpha, beta ] ); + + expected = new Float64Array( [ 14.0, 32.0 ] ); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `alpha` is `0`, the function returns `beta*y`', function test( t ) { + var expected; + var alpha; + var beta; + var xbuf; + var ybuf; + var Abuf; + var x; + var y; + var A; + var v; + + xbuf = new Float64Array( [ 1.0, 2.0 ] ); + ybuf = new Float64Array( [ 3.0, 4.0, 5.0 ] ); + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + A = matrix( Abuf, 3, 2, 2, 1, 0 ); + x = vector( xbuf, 2, 1, 0 ); + y = vector( ybuf, 3, 1, 0 ); + alpha = scalar2ndarray( 0.0, { + 'dtype': 'float64' + }); + beta = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + + v = dgemv( [ A, x, y, alpha, beta ] ); + + expected = new Float64Array( [ 6.0, 8.0, 10.0 ] ); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports ndarrays having non-unit strides', function test( t ) { + var expected; + var alpha; + var beta; + var xbuf; + var ybuf; + var Abuf; + var x; + var y; + var A; + var v; + + Abuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + A = matrix( Abuf, 2, 3, 3, 1, 0 ); + + xbuf = new Float64Array([ + 1.0, // 0 + 0.0, + 2.0, // 1 + 0.0, + 3.0 // 2 + ]); + x = vector( xbuf, 3, 2, 0 ); + + ybuf = new Float64Array([ + 1.0, // 0 + 0.0, + 2.0 // 1 + ]); + y = vector( ybuf, 2, 2, 0 ); + + alpha = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + beta = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + + v = dgemv( [ A, x, y, alpha, beta ] ); + + expected = new Float64Array( [ 2.0, 0.0, 4.0 ] ); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports ndarrays having negative strides', function test( t ) { + var expected; + var alpha; + var beta; + var xbuf; + var ybuf; + var Abuf; + var x; + var y; + var A; + var v; + + Abuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + A = matrix( Abuf, 2, 3, 3, 1, 0 ); + + xbuf = new Float64Array([ + 3.0, // 2 + 2.0, // 1 + 1.0 // 0 + ]); + x = vector( xbuf, 3, -1, 2 ); + + ybuf = new Float64Array([ + 2.0, // 1 + 1.0 // 0 + ]); + y = vector( ybuf, 2, -1, 1 ); + + alpha = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + beta = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + + v = dgemv( [ A, x, y, alpha, beta ] ); + + expected = new Float64Array( [ 4.0, 2.0 ] ); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports ndarrays having non-zero offsets', function test( t ) { + var expected; + var alpha; + var beta; + var xbuf; + var ybuf; + var Abuf; + var x; + var y; + var A; + var v; + + Abuf = new Float64Array([ + 999.0, + 999.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0 + ]); + A = matrix( Abuf, 2, 3, 3, 1, 2 ); + + xbuf = new Float64Array([ + 0.0, + 0.0, + 1.0, // 0 + 2.0, // 1 + 3.0 // 2 + ]); + x = vector( xbuf, 3, 1, 2 ); + + ybuf = new Float64Array([ + 0.0, + 1.0, // 0 + 0.0, + 2.0 // 1 + ]); + y = vector( ybuf, 2, 2, 1 ); + + alpha = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + beta = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + + v = dgemv( [ A, x, y, alpha, beta ] ); + + expected = new Float64Array([ + 0.0, + 2.0, + 0.0, + 4.0 + ]); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); From 1528eca5cd6cafc228cf6762cbedec0e5cb7b1a2 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Thu, 11 Jun 2026 00:16:00 +0530 Subject: [PATCH 2/3] fix: description --- 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: na - 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 --- --- lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md | 2 +- lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/repl.txt | 2 +- .../@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.ts | 2 +- lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md index bad2d43f3dcb..9b5e4758e52c 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md @@ -38,7 +38,7 @@ var dgemv = require( '@stdlib/blas/base/ndarray/dgemv' ); #### dgemv( arrays ) -Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix. +Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are ndarrays, and `A` is an `M` by `N` matrix. ```javascript var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/repl.txt index c9210aafeca6..6bf443dbeadc 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( arrays ) Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where - `alpha` and `beta` are scalars, `x` and `y` are vectors, and `A` is + `alpha` and `beta` are scalars, `x` and `y` are ndarrays, and `A` is an `M` by `N` matrix. Parameters diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.ts index a38e45351f67..ee420db1e4f9 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { float64ndarray } from '@stdlib/types/ndarray'; /** -* Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix. +* Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are ndarrays, and `A` is an `M` by `N` matrix. * * ## Notes * diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js index 81c03f67a047..c77b77eec63b 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js @@ -31,7 +31,7 @@ var strided = require( '@stdlib/blas/base/dgemv' ).ndarray; // MAIN // /** -* Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix. +* Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are ndarrays, and `A` is an `M` by `N` matrix. * * ## Notes * From 3777122aa29e416b0559a059a2bdb54eeea7eeb9 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Wed, 8 Jul 2026 11:35:53 +0530 Subject: [PATCH 3/3] chore: use float64Matrix and cleanup --- 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 --- --- .../@stdlib/blas/base/ndarray/dgemv/README.md | 49 ++-- .../base/ndarray/dgemv/benchmark/benchmark.js | 9 +- .../blas/base/ndarray/dgemv/docs/repl.txt | 49 ++-- .../base/ndarray/dgemv/docs/types/index.d.ts | 34 +-- .../base/ndarray/dgemv/docs/types/test.ts | 10 +- .../blas/base/ndarray/dgemv/examples/index.js | 15 +- .../blas/base/ndarray/dgemv/lib/index.js | 19 +- .../blas/base/ndarray/dgemv/lib/main.js | 61 +++-- .../blas/base/ndarray/dgemv/package.json | 2 +- .../blas/base/ndarray/dgemv/test/test.js | 220 +++++++++++++++--- 10 files changed, 337 insertions(+), 131 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md index 9b5e4758e52c..6bd5ec0dfea3 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/README.md @@ -20,7 +20,7 @@ limitations under the License. # dgemv -> Perform the matrix-vector operation `y = alpha*A*x + beta*y`. +> Perform one of the matrix-vector operations `y = alpha*A*x + beta*y`, `y = alpha*A^T*x + beta*y`, or `y = alpha*A^H*x + beta*y`.
@@ -38,27 +38,31 @@ var dgemv = require( '@stdlib/blas/base/ndarray/dgemv' ); #### dgemv( arrays ) -Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are ndarrays, and `A` is an `M` by `N` matrix. +Performs one of the matrix-vector operations `y = alpha*A*x + beta*y`, `y = alpha*A^T*x + beta*y`, or `y = alpha*A^H*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are one-dimensional ndarrays, and `A` is an `M` by `N` matrix. ```javascript +/* eslint-disable max-len */ +var Float64Matrix = require( '@stdlib/ndarray/matrix/float64' ); var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); -var ndarray = require( '@stdlib/ndarray/base/ctor' ); -var Float64Array = require( '@stdlib/array/float64' ); +var resolveEnum = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); -var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), [ 2, 3 ], [ 3, 1 ], 0, 'row-major' ); +var A = new Float64Matrix( [ [ 1.0, 2.0, 3.0 ], [ 4.0, 5.0, 6.0 ] ] ); var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); var y = new Float64Vector( [ 4.0, 5.0 ] ); -var alpha = scalar2ndarray( 3.0, { +var trans = scalar2ndarray( resolveEnum( 'no-transpose' ), { + 'dtype': 'int8' +}); +var alpha = scalar2ndarray( 1.0, { 'dtype': 'float64' }); -var beta = scalar2ndarray( 2.0, { +var beta = scalar2ndarray( 1.0, { 'dtype': 'float64' }); -var out = dgemv( [ A, x, y, alpha, beta ] ); -// returns [ 50.0, 106.0 ] +var out = dgemv( [ A, x, y, trans, alpha, beta ] ); +// returns [ 18.0, 37.0 ] var bool = ( out === y ); // returns true @@ -68,11 +72,12 @@ The function has the following parameters: - **arrays**: array-like object containing the following ndarrays: - - a two-dimensional input ndarray. - - first one-dimensional input ndarray. - - second one-dimensional input/output ndarray. - - first zero-dimensional ndarray containing a scalar constant. - - second zero-dimensional ndarray containing a scalar constant. + - a two-dimensional input ndarray corresponding to `A`. + - a one-dimensional input ndarray corresponding to `x`. + - a one-dimensional input/output ndarray corresponding to `y`. + - a zero-dimensional ndarray specifying whether `A` should be transposed, conjugate-transposed, or not transposed. + - a zero-dimensional ndarray containing a scalar constant corresponding to `alpha`. + - a zero-dimensional ndarray containing a scalar constant corresponding to `beta`.
@@ -91,11 +96,12 @@ The function has the following parameters: ```javascript +/* eslint-disable max-len */ var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); -var ndarray = require( '@stdlib/ndarray/base/ctor' ); -var Float64Array = require( '@stdlib/array/float64' ); +var Float64Matrix = require( '@stdlib/ndarray/matrix/float64' ); var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var resolveEnum = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dgemv = require( '@stdlib/blas/base/ndarray/dgemv' ); @@ -103,14 +109,17 @@ var opts = { 'dtype': 'float64' }; -var A = new ndarray( 'float64', new Float64Array( discreteUniform( 12, 0, 10, opts ) ), [ 3, 4 ], [ 4, 1 ], 0, 'row-major' ); +var A = new Float64Matrix( discreteUniform( 12, 0, 10, opts ).buffer, 0, [ 3, 4 ] ); var x = new Float64Vector( discreteUniform( 4, 0, 10, opts ) ); var y = new Float64Vector( discreteUniform( 3, 0, 10, opts ) ); -var alpha = scalar2ndarray( 3.0, opts ); -var beta = scalar2ndarray( 2.0, opts ); +var trans = scalar2ndarray( resolveEnum( 'no-transpose' ), { + 'dtype': 'int8' +}); +var alpha = scalar2ndarray( 1.0, opts ); +var beta = scalar2ndarray( 1.0, opts ); -var out = dgemv( [ A, x, y, alpha, beta ] ); +var out = dgemv( [ A, x, y, trans, alpha, beta ] ); console.log( ndarray2array( out ) ); ``` diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/benchmark/benchmark.js index 946bf28e4822..530f8e8792e2 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/benchmark/benchmark.js @@ -25,6 +25,7 @@ var uniform = require( '@stdlib/random/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var resolveEnum = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); var format = require( '@stdlib/string/format' ); var pkg = require( './../package.json' ).name; var dgemv = require( './../lib' ); @@ -47,11 +48,12 @@ var options = { * @returns {Function} benchmark function */ function createBenchmark( len ) { + var trans; var alpha; var beta; + var A; var x; var y; - var A; A = uniform( [ len, len ], -100.0, 100.0, options ); x = uniform( [ len ], -100.0, 100.0, options ); @@ -59,6 +61,9 @@ function createBenchmark( len ) { alpha = scalar2ndarray( 1.0, options ); beta = scalar2ndarray( 1.0, options ); + trans = scalar2ndarray( resolveEnum( 'no-transpose' ), { + 'dtype': 'int8' + }); return benchmark; @@ -74,7 +79,7 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - z = dgemv( [ A, x, y, alpha, beta ] ); + z = dgemv( [ A, x, y, trans, alpha, beta ] ); if ( typeof z !== 'object' ) { b.fail( 'should return an ndarray' ); } diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/repl.txt index 6bf443dbeadc..9c88233fddfd 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/repl.txt @@ -1,19 +1,24 @@ {{alias}}( arrays ) - Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where - `alpha` and `beta` are scalars, `x` and `y` are ndarrays, and `A` is - an `M` by `N` matrix. + Performs one of the matrix-vector operations `y = alpha*A*x + beta*y`, + `y = alpha*A^T*x + beta*y`, or `y = alpha*A^H*x + beta*y`, where `alpha` + and `beta` are scalars, `x` and `y` are one-dimensional ndarrays, and `A` + is an `M` by `N` matrix. Parameters ---------- arrays: ArrayLikeObject Array-like object containing the following ndarrays: - - a two-dimensional input ndarray. - - first one-dimensional input ndarray. - - second one-dimensional input/output ndarray. - - first zero-dimensional ndarray containing a scalar constant. - - second zero-dimensional ndarray containing a scalar constant. + - a two-dimensional input ndarray corresponding to `A`. + - a one-dimensional input ndarray corresponding to `x`. + - a one-dimensional input/output ndarray corresponding to `y`. + - a zero-dimensional ndarray specifying whether `A` should be + transposed, conjugate-transposed, or not transposed. + - a zero-dimensional ndarray containing a scalar constant corresponding + to `alpha`. + - a zero-dimensional ndarray containing a scalar constant corresponding + to `beta`. Returns ------- @@ -22,18 +27,24 @@ Examples -------- - > var buf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); - > var sh = [ 2, 3 ]; - > var st = [ 3, 1 ]; - > var A = new {{alias:@stdlib/ndarray/base/ctor}}( 'float64', buf, sh, st, 0, 'row-major' ); - > var x = new {{alias:@stdlib/ndarray/vector/float64}}( [ 1.0, 2.0, 3.0 ] ); - > var y = new {{alias:@stdlib/ndarray/vector/float64}}( [ 4.0, 5.0 ] ); - > var alpha = {{alias:@stdlib/ndarray/from-scalar}}( 3.0, { 'dtype': 'float64' }); - > var beta = {{alias:@stdlib/ndarray/from-scalar}}( 2.0, { 'dtype': 'float64' }); - - > {{alias}}( [ A, x, y, alpha, beta ] ); + > var abuf = [ [ 1.0, 2.0, 3.0 ], [ 4.0, 5.0, 6.0 ] ]; + > var A = new {{alias:@stdlib/ndarray/matrix/float64}}( abuf ); + + > var xbuf = [ 1.0, 2.0, 3.0 ]; + > var x = new {{alias:@stdlib/ndarray/vector/float64}}( xbuf ); + + > var ybuf = [ 4.0, 5.0 ]; + > var y = new {{alias:@stdlib/ndarray/vector/float64}}( ybuf ); + + > var opts = { 'dtype': 'float64' }; + > var alpha = {{alias:@stdlib/ndarray/from-scalar}}( 1.0, opts ); + > var beta = {{alias:@stdlib/ndarray/from-scalar}}( 1.0, opts ); + + > var trans = {{alias:@stdlib/ndarray/from-scalar}}( 'no-transpose' ); + + > {{alias}}( [ A, x, y, trans, alpha, beta ] ); > y - [ 50.0, 106.0 ] + [ 18.0, 37.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.ts index ee420db1e4f9..b890985b5bb2 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/index.d.ts @@ -20,48 +20,52 @@ /// -import { float64ndarray } from '@stdlib/types/ndarray'; +import { float64ndarray, ndarray } from '@stdlib/types/ndarray'; /** -* Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are ndarrays, and `A` is an `M` by `N` matrix. +* Performs one of the matrix-vector operations `y = alpha*A*x + beta*y`, `y = alpha*A^T*x + beta*y`, or `y = alpha*A^H*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are one-dimensional ndarrays, and `A` is an `M` by `N` matrix. * * ## Notes * * - The function expects the following ndarrays: * -* - a two-dimensional input ndarray. -* - first one-dimensional input ndarray. -* - second one-dimensional input/output ndarray. -* - first zero-dimensional ndarray containing a scalar constant. -* - second zero-dimensional ndarray containing a scalar constant. +* - a two-dimensional input ndarray corresponding to `A`. +* - a one-dimensional input ndarray corresponding to `x`. +* - a one-dimensional input/output ndarray corresponding to `y`. +* - a zero-dimensional ndarray specifying whether `A` should be transposed, conjugate-transposed, or not transposed. +* - a zero-dimensional ndarray containing a scalar constant corresponding to `alpha`. +* - a zero-dimensional ndarray containing a scalar constant corresponding to `beta`. * * @param arrays - array-like object containing ndarrays * @returns output ndarray * * @example +* var Float64Matrix = require( '@stdlib/ndarray/matrix/float64' ); * var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); -* var ndarray = require( '@stdlib/ndarray/base/ctor' ); -* var Float64Array = require( '@stdlib/array/float64' ); +* var resolveEnum = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); * -* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), [ 2, 3 ], [ 3, 1 ], 0, 'row-major' ); +* var A = new Float64Matrix( [ [ 1.0, 2.0, 3.0 ], [ 4.0, 5.0, 6.0 ] ] ); * var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); * var y = new Float64Vector( [ 4.0, 5.0 ] ); * -* var alpha = scalar2ndarray( 3.0, { +* var trans = scalar2ndarray( resolveEnum( 'no-transpose' ), { +* 'dtype': 'int8' +* }); +* var alpha = scalar2ndarray( 1.0, { * 'dtype': 'float64' * }); -* var beta = scalar2ndarray( 2.0, { +* var beta = scalar2ndarray( 1.0, { * 'dtype': 'float64' * }); * -* var z = dgemv( [ A, x, y, alpha, beta ] ); -* // returns [ 50.0, 106.0 ] +* var z = dgemv( [ A, x, y, trans, alpha, beta ] ); +* // returns [ 18.0, 37.0 ] * * var bool = ( z === y ); * // returns true */ -declare function dgemv( arrays: [ float64ndarray, float64ndarray, float64ndarray, float64ndarray, float64ndarray ] ): float64ndarray; +declare function dgemv( arrays: [ float64ndarray, float64ndarray, float64ndarray, ndarray, float64ndarray, float64ndarray ] ): float64ndarray; // EXPORTS // diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/test.ts index c545d2cc3aaf..3a8b5222504f 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/docs/types/test.ts @@ -35,6 +35,9 @@ import dgemv = require( '@stdlib/blas/base/ndarray/dgemv' ); const y = zeros( [ 2 ], { 'dtype': 'float64' }); + const trans = zeros( [], { + 'dtype': 'int8' + }); const alpha = zeros( [], { 'dtype': 'float64' }); @@ -42,7 +45,7 @@ import dgemv = require( '@stdlib/blas/base/ndarray/dgemv' ); 'dtype': 'float64' }); - dgemv( [ A, x, y, alpha, beta ] ); // $ExpectType float64ndarray + dgemv( [ A, x, y, trans, alpha, beta ] ); // $ExpectType float64ndarray } // The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... @@ -69,6 +72,9 @@ import dgemv = require( '@stdlib/blas/base/ndarray/dgemv' ); const y = zeros( [ 2 ], { 'dtype': 'float64' }); + const trans = zeros( [], { + 'dtype': 'int8' + }); const alpha = zeros( [], { 'dtype': 'float64' }); @@ -77,5 +83,5 @@ import dgemv = require( '@stdlib/blas/base/ndarray/dgemv' ); }); dgemv(); // $ExpectError - dgemv( [ A, x, y, alpha, beta ], {} ); // $ExpectError + dgemv( [ A, x, y, trans, alpha, beta ], {} ); // $ExpectError } diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/examples/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/examples/index.js index ec2702dc17de..aaf581e6adea 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/examples/index.js @@ -19,10 +19,10 @@ 'use strict'; var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); -var ndarray = require( '@stdlib/ndarray/base/ctor' ); -var Float64Array = require( '@stdlib/array/float64' ); +var Float64Matrix = require( '@stdlib/ndarray/matrix/float64' ); var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var resolveEnum = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dgemv = require( './../lib' ); @@ -30,12 +30,15 @@ var opts = { 'dtype': 'float64' }; -var A = new ndarray( 'float64', new Float64Array( discreteUniform( 12, 0, 10, opts ) ), [ 3, 4 ], [ 4, 1 ], 0, 'row-major' ); +var A = new Float64Matrix( discreteUniform( 12, 0, 10, opts ).buffer, 0, [ 3, 4 ] ); var x = new Float64Vector( discreteUniform( 4, 0, 10, opts ) ); var y = new Float64Vector( discreteUniform( 3, 0, 10, opts ) ); -var alpha = scalar2ndarray( 3.0, opts ); -var beta = scalar2ndarray( 2.0, opts ); +var trans = scalar2ndarray( resolveEnum( 'no-transpose' ), { + 'dtype': 'int8' +}); +var alpha = scalar2ndarray( 1.0, opts ); +var beta = scalar2ndarray( 1.0, opts ); -var out = dgemv( [ A, x, y, alpha, beta ] ); +var out = dgemv( [ A, x, y, trans, alpha, beta ] ); console.log( ndarray2array( out ) ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/index.js index 08377deb9c5f..348f065cfe67 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/index.js @@ -19,30 +19,33 @@ 'use strict'; /** -* BLAS level 2 routine to perform the matrix-vector operation `y = alpha*A*x + beta*y`. +* BLAS level 2 routine to perform one of the matrix-vector operations `y = alpha*A*x + beta*y`, `y = alpha*A^T*x + beta*y`, or `y = alpha*A^H*x + beta*y`. * * @module @stdlib/blas/base/ndarray/dgemv * * @example +* var Float64Matrix = require( '@stdlib/ndarray/matrix/float64' ); * var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); -* var ndarray = require( '@stdlib/ndarray/base/ctor' ); -* var Float64Array = require( '@stdlib/array/float64' ); +* var resolveEnum = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); * var dgemv = require( '@stdlib/blas/base/ndarray/dgemv' ); * -* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), [ 2, 3 ], [ 3, 1 ], 0, 'row-major' ); +* var A = new Float64Matrix( [ [ 1.0, 2.0, 3.0 ], [ 4.0, 5.0, 6.0 ] ] ); * var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); * var y = new Float64Vector( [ 4.0, 5.0 ] ); * -* var alpha = scalar2ndarray( 3.0, { +* var trans = scalar2ndarray( resolveEnum( 'no-transpose' ), { +* 'dtype': 'int8' +* }); +* var alpha = scalar2ndarray( 1.0, { * 'dtype': 'float64' * }); -* var beta = scalar2ndarray( 2.0, { +* var beta = scalar2ndarray( 1.0, { * 'dtype': 'float64' * }); * -* var out = dgemv( [ A, x, y, alpha, beta ] ); -* // returns [ 50.0, 106.0 ] +* var out = dgemv( [ A, x, y, trans, alpha, beta ] ); +* // returns [ 18.0, 37.0 ] * * var bool = ( out === y ); * // returns true diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js index c77b77eec63b..4ab1651d2b25 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/lib/main.js @@ -20,7 +20,8 @@ // MODULES // -var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var getShape = require( '@stdlib/ndarray/base/shape' ); +var getStrides = require( '@stdlib/ndarray/base/strides' ); var getStride = require( '@stdlib/ndarray/base/stride' ); var getOffset = require( '@stdlib/ndarray/base/offset' ); var getData = require( '@stdlib/ndarray/base/data-buffer' ); @@ -31,51 +32,71 @@ var strided = require( '@stdlib/blas/base/dgemv' ).ndarray; // MAIN // /** -* Performs the matrix-vector operation `y = alpha*A*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are ndarrays, and `A` is an `M` by `N` matrix. +* Performs one of the matrix-vector operations `y = alpha*A*x + beta*y`, `y = alpha*A^T*x + beta*y`, or `y = alpha*A^H*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are one-dimensional ndarrays, and `A` is an `M` by `N` matrix. * * ## Notes * * - The function expects the following ndarrays: * -* - a two-dimensional input ndarray. -* - first one-dimensional input ndarray. -* - second one-dimensional input/output ndarray. -* - first zero-dimensional ndarray containing a scalar constant. -* - second zero-dimensional ndarray containing a scalar constant. +* - a two-dimensional input ndarray corresponding to `A`. +* - a one-dimensional input ndarray corresponding to `x`. +* - a one-dimensional input/output ndarray corresponding to `y`. +* - a zero-dimensional ndarray specifying whether `A` should be transposed, conjugate-transposed, or not transposed. +* - a zero-dimensional ndarray containing a scalar constant corresponding to `alpha`. +* - a zero-dimensional ndarray containing a scalar constant corresponding to `beta`. * * @param {ArrayLikeObject} arrays - array-like object containing ndarrays * @returns {Object} output ndarray * * @example +* var Float64Matrix = require( '@stdlib/ndarray/matrix/float64' ); * var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); -* var ndarray = require( '@stdlib/ndarray/base/ctor' ); -* var Float64Array = require( '@stdlib/array/float64' ); +* var resolveEnum = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); * -* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ), [ 2, 3 ], [ 3, 1 ], 0, 'row-major' ); +* var A = new Float64Matrix( [ [ 1.0, 2.0, 3.0 ], [ 4.0, 5.0, 6.0 ] ] ); * var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); * var y = new Float64Vector( [ 4.0, 5.0 ] ); * -* var alpha = scalar2ndarray( 3.0, { +* var trans = scalar2ndarray( resolveEnum( 'no-transpose' ), { +* 'dtype': 'int8' +* }); +* var alpha = scalar2ndarray( 1.0, { * 'dtype': 'float64' * }); -* var beta = scalar2ndarray( 2.0, { +* var beta = scalar2ndarray( 1.0, { * 'dtype': 'float64' * }); * -* var z = dgemv( [ A, x, y, alpha, beta ] ); -* // returns [ 50.0, 106.0 ] +* var z = dgemv( [ A, x, y, trans, alpha, beta ] ); +* // returns [ 18.0, 37.0 ] * * var bool = ( z === y ); * // returns true */ function dgemv( arrays ) { - var alpha = ndarraylike2scalar( arrays[ 3 ] ); - var beta = ndarraylike2scalar( arrays[ 4 ] ); - var A = arrays[ 0 ]; - var x = arrays[ 1 ]; - var y = arrays[ 2 ]; - strided( 'no-transpose', numelDimension( A, 0 ), numelDimension( A, 1 ), alpha, getData( A ), getStride( A, 0 ), getStride( A, 1 ), getOffset( A ), getData( x ), getStride( x, 0 ), getOffset( x ), beta, getData( y ), getStride( y, 0 ), getOffset( y ) ); + var trans; + var alpha; + var beta; + var sh; + var st; + var A; + var x; + var y; + + A = arrays[ 0 ]; + x = arrays[ 1 ]; + y = arrays[ 2 ]; + + trans = ndarraylike2scalar( arrays[ 3 ] ); + alpha = ndarraylike2scalar( arrays[ 4 ] ); + beta = ndarraylike2scalar( arrays[ 5 ] ); + + sh = getShape( A, false ); + st = getStrides( A, false ); + + strided( trans, sh[ 0 ], sh[ 1 ], alpha, getData( A ), st[ 0 ], st[ 1 ], getOffset( A ), getData( x ), getStride( x, 0 ), getOffset( x ), beta, getData( y ), getStride( y, 0 ), getOffset( y ) ); + return y; } diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/package.json b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/package.json index 75871071bbae..c5e5a7770936 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/package.json +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/base/ndarray/dgemv", "version": "0.0.0", - "description": "Perform the matrix-vector operation `y = alpha*A*x + beta*y`.", + "description": "Perform one of the matrix-vector operations `y = alpha*A*x + beta*y`, `y = alpha*A^T*x + beta*y`, or `y = alpha*A^H*x + beta*y`.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/test/test.js b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/test/test.js index 82a403960a64..b31de09684ba 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/test/test.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dgemv/test/test.js @@ -24,6 +24,7 @@ var tape = require( 'tape' ); var isSameFloat64Array = require( '@stdlib/assert/is-same-float64array' ); var Float64Array = require( '@stdlib/array/float64' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var resolveEnum = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var getData = require( '@stdlib/ndarray/data-buffer' ); var dgemv = require( './../lib' ); @@ -77,6 +78,7 @@ tape( 'the function has an arity of 1', function test( t ) { tape( 'the function performs the matrix-vector operation `y = alpha*A*x + beta*y`', function test( t ) { var expected; + var trans; var alpha; var beta; var xbuf; @@ -87,8 +89,15 @@ tape( 'the function performs the matrix-vector operation `y = alpha*A*x + beta*y var A; var v; - xbuf = new Float64Array( [ 1.0, 2.0 ] ); - ybuf = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + xbuf = new Float64Array([ + 1.0, // 0 + 2.0 // 1 + ]); + ybuf = new Float64Array([ + 1.0, // 0 + 2.0, // 1 + 3.0 // 2 + ]); Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); A = matrix( Abuf, 3, 2, 2, 1, 0 ); x = vector( xbuf, 2, 1, 0 ); @@ -100,15 +109,26 @@ tape( 'the function performs the matrix-vector operation `y = alpha*A*x + beta*y 'dtype': 'float64' }); - v = dgemv( [ A, x, y, alpha, beta ] ); + trans = scalar2ndarray( resolveEnum( 'no-transpose' ), { + 'dtype': 'int8' + }); + + v = dgemv( [ A, x, y, trans, alpha, beta ] ); expected = new Float64Array( [ 6.0, 13.0, 20.0 ] ); t.strictEqual( v, y, 'returns expected value' ); t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); - xbuf = new Float64Array( [ 1.0, 1.0, 1.0 ] ); - ybuf = new Float64Array( [ 1.0, 1.0 ] ); - Abuf = new Float64Array( [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] ); + xbuf = new Float64Array([ + 1.0, // 0 + 2.0, // 1 + 3.0 // 2 + ]); + ybuf = new Float64Array([ + 1.0, // 0 + 2.0 // 1 + ]); + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); A = matrix( Abuf, 2, 3, 1, 2, 0 ); x = vector( xbuf, 3, 1, 0 ); y = vector( ybuf, 2, 1, 0 ); @@ -119,9 +139,103 @@ tape( 'the function performs the matrix-vector operation `y = alpha*A*x + beta*y 'dtype': 'float64' }); - v = dgemv( [ A, x, y, alpha, beta ] ); + trans = scalar2ndarray( resolveEnum( 'no-transpose' ), { + 'dtype': 'int8' + }); + + v = dgemv( [ A, x, y, trans, alpha, beta ] ); + + expected = new Float64Array( [ 46.0, 60.0 ] ); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function performs the matrix-vector operation `y = alpha*A^T*x + beta*y`', function test( t ) { + var expected; + var trans; + var alpha; + var beta; + var xbuf; + var ybuf; + var Abuf; + var x; + var y; + var A; + var v; + + xbuf = new Float64Array([ + 1.0, // 0 + 2.0 // 1 + ]); + ybuf = new Float64Array([ + 1.0, // 0 + 2.0 // 1 + ]); + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); + A = matrix( Abuf, 2, 2, 2, 1, 0 ); + x = vector( xbuf, 2, 1, 0 ); + y = vector( ybuf, 2, 1, 0 ); + alpha = scalar2ndarray( 1.0, { + 'dtype': 'float64' + }); + beta = scalar2ndarray( 1.0, { + 'dtype': 'float64' + }); + + trans = scalar2ndarray( resolveEnum( 'transpose' ), { + 'dtype': 'int8' + }); + + v = dgemv( [ A, x, y, trans, alpha, beta ] ); + + expected = new Float64Array( [ 8.0, 12.0 ] ); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function performs the matrix-vector operation `y = alpha*A^H*x + beta*y`', function test( t ) { + var expected; + var trans; + var alpha; + var beta; + var xbuf; + var ybuf; + var Abuf; + var x; + var y; + var A; + var v; + + xbuf = new Float64Array([ + 1.0, // 0 + 2.0 // 1 + ]); + ybuf = new Float64Array([ + 1.0, // 0 + 2.0 // 1 + ]); + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); + A = matrix( Abuf, 2, 2, 2, 1, 0 ); + x = vector( xbuf, 2, 1, 0 ); + y = vector( ybuf, 2, 1, 0 ); + alpha = scalar2ndarray( 1.0, { + 'dtype': 'float64' + }); + beta = scalar2ndarray( 1.0, { + 'dtype': 'float64' + }); + + trans = scalar2ndarray( resolveEnum( 'conjugate-transpose' ), { + 'dtype': 'int8' + }); + + v = dgemv( [ A, x, y, trans, alpha, beta ] ); - expected = new Float64Array( [ 14.0, 32.0 ] ); + expected = new Float64Array( [ 8.0, 12.0 ] ); t.strictEqual( v, y, 'returns expected value' ); t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); @@ -130,6 +244,7 @@ tape( 'the function performs the matrix-vector operation `y = alpha*A*x + beta*y tape( 'if `alpha` is `0`, the function returns `beta*y`', function test( t ) { var expected; + var trans; var alpha; var beta; var xbuf; @@ -140,8 +255,15 @@ tape( 'if `alpha` is `0`, the function returns `beta*y`', function test( t ) { var A; var v; - xbuf = new Float64Array( [ 1.0, 2.0 ] ); - ybuf = new Float64Array( [ 3.0, 4.0, 5.0 ] ); + xbuf = new Float64Array([ + 1.0, // 0 + 2.0 // 1 + ]); + ybuf = new Float64Array([ + 1.0, // 0 + 2.0, // 1 + 3.0 // 2 + ]); Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); A = matrix( Abuf, 3, 2, 2, 1, 0 ); x = vector( xbuf, 2, 1, 0 ); @@ -153,17 +275,22 @@ tape( 'if `alpha` is `0`, the function returns `beta*y`', function test( t ) { 'dtype': 'float64' }); - v = dgemv( [ A, x, y, alpha, beta ] ); + trans = scalar2ndarray( resolveEnum( 'no-transpose' ), { + 'dtype': 'int8' + }); + + v = dgemv( [ A, x, y, trans, alpha, beta ] ); - expected = new Float64Array( [ 6.0, 8.0, 10.0 ] ); + expected = new Float64Array( [ 2.0, 4.0, 6.0 ] ); t.strictEqual( v, y, 'returns expected value' ); t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); t.end(); }); -tape( 'the function supports ndarrays having non-unit strides', function test( t ) { +tape( 'the function supports ndarrays having non-unit strides (transpose)', function test( t ) { var expected; + var trans; var alpha; var beta; var xbuf; @@ -174,24 +301,24 @@ tape( 'the function supports ndarrays having non-unit strides', function test( t var A; var v; - Abuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); A = matrix( Abuf, 2, 3, 3, 1, 0 ); xbuf = new Float64Array([ 1.0, // 0 0.0, - 2.0, // 1 - 0.0, - 3.0 // 2 + 2.0 // 1 ]); - x = vector( xbuf, 3, 2, 0 ); + x = vector( xbuf, 2, 2, 0 ); ybuf = new Float64Array([ 1.0, // 0 0.0, - 2.0 // 1 + 2.0, // 1 + 0.0, + 3.0 // 2 ]); - y = vector( ybuf, 2, 2, 0 ); + y = vector( ybuf, 3, 2, 0 ); alpha = scalar2ndarray( 2.0, { 'dtype': 'float64' @@ -200,16 +327,21 @@ tape( 'the function supports ndarrays having non-unit strides', function test( t 'dtype': 'float64' }); - v = dgemv( [ A, x, y, alpha, beta ] ); + trans = scalar2ndarray( resolveEnum( 'transpose' ), { + 'dtype': 'int8' + }); - expected = new Float64Array( [ 2.0, 0.0, 4.0 ] ); + v = dgemv( [ A, x, y, trans, alpha, beta ] ); + + expected = new Float64Array( [ 20.0, 0.0, 28.0, 0.0, 36.0 ] ); t.strictEqual( v, y, 'returns expected value' ); t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); t.end(); }); -tape( 'the function supports ndarrays having negative strides', function test( t ) { +tape( 'the function supports ndarrays having negative strides (transpose)', function test( t ) { var expected; + var trans; var alpha; var beta; var xbuf; @@ -220,21 +352,24 @@ tape( 'the function supports ndarrays having negative strides', function test( t var A; var v; - Abuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); A = matrix( Abuf, 2, 3, 3, 1, 0 ); xbuf = new Float64Array([ - 3.0, // 2 2.0, // 1 + 0.0, 1.0 // 0 ]); - x = vector( xbuf, 3, -1, 2 ); + x = vector( xbuf, 2, -2, 2 ); ybuf = new Float64Array([ + 3.0, // 2 + 0.0, 2.0, // 1 + 0.0, 1.0 // 0 ]); - y = vector( ybuf, 2, -1, 1 ); + y = vector( ybuf, 3, -2, 4 ); alpha = scalar2ndarray( 2.0, { 'dtype': 'float64' @@ -243,9 +378,13 @@ tape( 'the function supports ndarrays having negative strides', function test( t 'dtype': 'float64' }); - v = dgemv( [ A, x, y, alpha, beta ] ); + trans = scalar2ndarray( resolveEnum( 'transpose' ), { + 'dtype': 'int8' + }); + + v = dgemv( [ A, x, y, trans, alpha, beta ] ); - expected = new Float64Array( [ 4.0, 2.0 ] ); + expected = new Float64Array( [ 36.0, 0.0, 28.0, 0.0, 20.0 ] ); t.strictEqual( v, y, 'returns expected value' ); t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); t.end(); @@ -253,6 +392,7 @@ tape( 'the function supports ndarrays having negative strides', function test( t tape( 'the function supports ndarrays having non-zero offsets', function test( t ) { var expected; + var trans; var alpha; var beta; var xbuf; @@ -264,14 +404,14 @@ tape( 'the function supports ndarrays having non-zero offsets', function test( t var v; Abuf = new Float64Array([ - 999.0, - 999.0, - 0.0, - 0.0, - 0.0, 0.0, 0.0, - 0.0 + 1.0, + 2.0, + 3.0, + 4.0, + 5.0, + 6.0 ]); A = matrix( Abuf, 2, 3, 3, 1, 2 ); @@ -299,13 +439,17 @@ tape( 'the function supports ndarrays having non-zero offsets', function test( t 'dtype': 'float64' }); - v = dgemv( [ A, x, y, alpha, beta ] ); + trans = scalar2ndarray( resolveEnum( 'no-transpose' ), { + 'dtype': 'int8' + }); + + v = dgemv( [ A, x, y, trans, alpha, beta ] ); expected = new Float64Array([ 0.0, - 2.0, + 30.0, 0.0, - 4.0 + 68.0 ]); t.strictEqual( v, y, 'returns expected value' ); t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' );