From 4d35bb199eb6ad782f1a01d06bcf07ebe2f350c6 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Mon, 22 Jun 2026 22:41:54 +0530 Subject: [PATCH 1/4] feat: add blas/base/ndarray/dtrmv --- 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/dtrmv/README.md | 118 +++++++++++ .../base/ndarray/dtrmv/benchmark/benchmark.js | 108 ++++++++++ .../blas/base/ndarray/dtrmv/docs/repl.txt | 34 +++ .../base/ndarray/dtrmv/docs/types/index.d.ts | 57 +++++ .../base/ndarray/dtrmv/docs/types/test.ts | 63 ++++++ .../blas/base/ndarray/dtrmv/examples/index.js | 36 ++++ .../blas/base/ndarray/dtrmv/lib/index.js | 49 +++++ .../blas/base/ndarray/dtrmv/lib/main.js | 69 ++++++ .../blas/base/ndarray/dtrmv/package.json | 72 +++++++ .../blas/base/ndarray/dtrmv/test/test.js | 198 ++++++++++++++++++ 10 files changed, 804 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/README.md create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/package.json create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/README.md new file mode 100644 index 000000000000..61d14731f3e0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/README.md @@ -0,0 +1,118 @@ + + +# dtrmv + +> Perform one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. + +
+ +
+ + + +
+ +## Usage + +```javascript +var dtrmv = require( '@stdlib/blas/base/ndarray/dtrmv' ); +``` + +#### dtrmv( arrays ) + +Perform one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. + +```javascript +var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); +var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ), [ 3, 3 ], [ 3, 1 ], 0, 'row-major' ); + +var out = dtrmv( [ x, A ] ); +// x => [ 14.0, 8.0, 3.0 ] + +var bool = ( out === x ); +// returns true +``` + +The function has the following parameters: + +- **arrays**: array-like object containing the following ndarrays: + + - a one-dimensional input ndarray. + - a two-dimensional input ndarray. + +
+ + + +
+ +
+ + + +
+ +## 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 ndarray2array = require( '@stdlib/ndarray/to-array' ); +var dtrmv = require( '@stdlib/blas/base/ndarray/dtrmv' ); + +var opts = { + 'dtype': 'float64' +}; + +var x = new Float64Vector( discreteUniform( 3, 0, 10, opts ) ); +var A = new ndarray( 'float64', new Float64Array( discreteUniform( 9, 0, 10, opts ) ), [ 3, 3 ], [ 3, 1 ], 0, 'row-major' ); + +var out = dtrmv( [ x, A ] ); +console.log( ndarray2array( out ) ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js new file mode 100644 index 000000000000..30bdd2cada3b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js @@ -0,0 +1,108 @@ +/** +* @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 ones = require( '@stdlib/ndarray/ones' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var dtrmv = 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 x; + var A; + + x = ones( [ len ], options ); + A = ones( [ len, len ], 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 = dtrmv( [ x, A ] ); + 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/dtrmv/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/repl.txt new file mode 100644 index 000000000000..1d08443b482e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/repl.txt @@ -0,0 +1,34 @@ + +{{alias}}( arrays ) + Perform one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where + `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, + upper or lower triangular matrix. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing the following ndarrays: + + - a one-dimensional input ndarray. + - a two-dimensional input ndarray. + + Returns + ------- + out: ndarray + Output ndarray. + + Examples + -------- + > var x = new {{alias:@stdlib/ndarray/vector/float64}}( [ 1.0, 2.0 ] ); + > var buf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 0.0, 1.0 ] ); + > var sh = [ 2, 2 ]; + > var st = [ 2, 1 ]; + > var A = new {{alias:@stdlib/ndarray/base/ctor}}( 'float64', buf, sh, st, 0, 'row-major' ); + + > {{alias}}( [ x, A ] ); + > x + [ 5.0, 2.0 ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/index.d.ts new file mode 100644 index 000000000000..069d16ac8e35 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/index.d.ts @@ -0,0 +1,57 @@ +/* +* @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 one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a one-dimensional input ndarray. +* - a two-dimensional input ndarray. +* +* @param arrays - array-like object containing ndarrays +* @returns output ndarray +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); +* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ), [ 3, 3 ], [ 3, 1 ], 0, 'row-major' ); +* +* var out = dtrmv( [ x, A ] ); +* // returns [ 14.0, 8.0, 3.0 ] +* +* var bool = ( out === x ); +* // returns true +*/ +declare function dtrmv( arrays: [ float64ndarray, float64ndarray ] ): float64ndarray; + + +// EXPORTS // + +export = dtrmv; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/test.ts new file mode 100644 index 000000000000..220a9afc0fd0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/test.ts @@ -0,0 +1,63 @@ +/* +* @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 dtrmv = require( '@stdlib/blas/base/ndarray/dtrmv' ); + + +// TESTS // + +// The function returns an ndarray... +{ + const x = zeros( [ 3 ], { + 'dtype': 'float64' + }); + const A = zeros( [ 3, 3 ], { + 'dtype': 'float64' + }); + + dtrmv( [ x, A ] ); // $ExpectType float64ndarray +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + dtrmv( '10' ); // $ExpectError + dtrmv( 10 ); // $ExpectError + dtrmv( true ); // $ExpectError + dtrmv( false ); // $ExpectError + dtrmv( null ); // $ExpectError + dtrmv( undefined ); // $ExpectError + dtrmv( [] ); // $ExpectError + dtrmv( {} ); // $ExpectError + dtrmv( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = zeros( [ 3 ], { + 'dtype': 'float64' + }); + const A = zeros( [ 3, 3 ], { + 'dtype': 'float64' + }); + + dtrmv(); // $ExpectError + dtrmv( [ x, A ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/examples/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/examples/index.js new file mode 100644 index 000000000000..a197022c25b9 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/examples/index.js @@ -0,0 +1,36 @@ +/** +* @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 ndarray2array = require( '@stdlib/ndarray/to-array' ); +var dtrmv = require( './../lib' ); + +var opts = { + 'dtype': 'float64' +}; + +var x = new Float64Vector( discreteUniform( 3, 0, 10, opts ) ); +var A = new ndarray( 'float64', new Float64Array( discreteUniform( 9, 0, 10, opts ) ), [ 3, 3 ], [ 3, 1 ], 0, 'row-major' ); + +var out = dtrmv( [ x, A ] ); +console.log( ndarray2array( out ) ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/index.js new file mode 100644 index 000000000000..4329a4fc8545 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/index.js @@ -0,0 +1,49 @@ +/** +* @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 one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. +* +* @module @stdlib/blas/base/ndarray/dtrmv +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var Float64Array = require( '@stdlib/array/float64' ); +* var dtrmv = require( '@stdlib/blas/base/ndarray/dtrmv' ); +* +* var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); +* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ), [ 3, 3 ], [ 3, 1 ], 0, 'row-major' ); +* +* var out = dtrmv( [ x, A ] ); +* // returns [ 14.0, 8.0, 3.0 ] +* +* var bool = ( out === x ); +* // returns true +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/main.js new file mode 100644 index 000000000000..b74d7e152b52 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/main.js @@ -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. +*/ + +'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/base/dtrmv' ).ndarray; + + +// MAIN // + +/** +* Performs one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a one-dimensional input ndarray. +* - a two-dimensional input ndarray. +* +* @param {ArrayLikeObject} arrays - array-like object containing ndarrays +* @returns {Object} output ndarray +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); +* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ), [ 3, 3 ], [ 3, 1 ], 0, 'row-major' ); +* +* var out = dtrmv( [ x, A ] ); +* // returns [ 14.0, 8.0, 3.0 ] +* +* var bool = ( out === x ); +* // returns true +*/ +function dtrmv( arrays ) { + var x = arrays[ 0 ]; + var A = arrays[ 1 ]; + strided( 'upper', 'no-transpose', 'non-unit', numelDimension( A, 0 ), getData( A ), getStride( A, 0 ), getStride( A, 1 ), getOffset( A ), getData( x ), getStride( x, 0 ), getOffset( x ) ); + return x; +} + + +// EXPORTS // + +module.exports = dtrmv; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/package.json b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/package.json new file mode 100644 index 000000000000..63f91815d546 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/package.json @@ -0,0 +1,72 @@ +{ + "name": "@stdlib/blas/base/ndarray/dtrmv", + "version": "0.0.0", + "description": "Perform one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix.", + "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", + "dtrmv", + "linear", + "algebra", + "subroutines", + "triangular", + "multiplication", + "vector", + "matrix", + "array", + "ndarray", + "float64", + "double", + "float64array" + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js new file mode 100644 index 000000000000..d4e97c38d0a4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js @@ -0,0 +1,198 @@ +/** +* @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 ndarray = require( '@stdlib/ndarray/base/ctor' ); +var getData = require( '@stdlib/ndarray/data-buffer' ); +var dtrmv = 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} N - number of rows and 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, N, stride0, stride1, offset ) { + return new ndarray( 'float64', buffer, [ N, N ], [ stride0, stride1 ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dtrmv, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( dtrmv.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function performs the matrix-vector operation `x = A*x`', function test( t ) { + var expected; + var xbuf; + var Abuf; + var x; + var A; + var v; + + xbuf = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); + x = vector( xbuf, 3, 1, 0 ); + A = matrix( Abuf, 3, 3, 1, 0 ); + + v = dtrmv( [ x, A ] ); + + expected = new Float64Array( [ 14.0, 28.0, 27.0 ] ); + t.strictEqual( v, x, '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 xbuf; + var Abuf; + var x; + var A; + var v; + + xbuf = new Float64Array([ + 1.0, // 0 + 0.0, + 2.0, // 1 + 0.0, + 3.0 // 2 + ]); + x = vector( xbuf, 3, 2, 0 ); + + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); + A = matrix( Abuf, 3, 3, 1, 0 ); + + v = dtrmv( [ x, A ] ); + + expected = new Float64Array( [ 14.0, 0.0, 28.0, 0.0, 27.0 ] ); + t.strictEqual( v, x, '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 xbuf; + var Abuf; + var x; + var A; + var v; + + xbuf = new Float64Array([ + 3.0, // 2 + 2.0, // 1 + 1.0 // 0 + ]); + x = vector( xbuf, 3, -1, 2 ); + + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); + A = matrix( Abuf, 3, 3, 1, 0 ); + + v = dtrmv( [ x, A ] ); + + expected = new Float64Array( [ 27.0, 28.0, 14.0 ] ); + t.strictEqual( v, x, '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 xbuf; + var Abuf; + var x; + var A; + var v; + + xbuf = new Float64Array([ + 0.0, + 1.0, // 0 + 0.0, + 2.0, // 1 + 0.0, + 3.0 // 2 + ]); + x = vector( xbuf, 3, 2, 1 ); + + Abuf = new Float64Array([ + 999.0, + 999.0, + 1.0, + 2.0, + 3.0, + 4.0, + 5.0, + 6.0, + 7.0, + 8.0, + 9.0 + ]); + A = matrix( Abuf, 3, 3, 1, 2 ); + + v = dtrmv( [ x, A ] ); + + expected = new Float64Array([ + 0.0, + 14.0, + 0.0, + 28.0, + 0.0, + 27.0 + ]); + t.strictEqual( v, x, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); From 102d8add803707105a19bab2c08acb86c8043ba8 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Fri, 17 Jul 2026 20:21:00 +0530 Subject: [PATCH 2/4] feat: add 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/dtrmv/README.md | 58 ++++-- .../base/ndarray/dtrmv/benchmark/benchmark.js | 20 +- .../blas/base/ndarray/dtrmv/docs/repl.txt | 30 ++- .../base/ndarray/dtrmv/docs/types/index.d.ts | 36 +++- .../base/ndarray/dtrmv/docs/types/test.ts | 30 ++- .../blas/base/ndarray/dtrmv/examples/index.js | 22 ++- .../blas/base/ndarray/dtrmv/lib/index.js | 23 ++- .../blas/base/ndarray/dtrmv/lib/main.js | 59 ++++-- .../blas/base/ndarray/dtrmv/package.json | 2 +- .../blas/base/ndarray/dtrmv/test/test.js | 175 +++++++++++++++++- 10 files changed, 376 insertions(+), 79 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/README.md index 61d14731f3e0..f7d00807e906 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/README.md @@ -20,7 +20,7 @@ limitations under the License. # dtrmv -> Perform one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. +> Perform one of the matrix-vector operations `x = A*x` or `x = A^T*x` for a triangular matrix `A`.
@@ -38,18 +38,33 @@ var dtrmv = require( '@stdlib/blas/base/ndarray/dtrmv' ); #### dtrmv( arrays ) -Perform one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. +Performs one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is a one-dimensional ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. + + ```javascript +var Float64Matrix = require( '@stdlib/ndarray/matrix/float64' ); var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); -var ndarray = require( '@stdlib/ndarray/base/ctor' ); -var Float64Array = require( '@stdlib/array/float64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var resolveTriangle = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); +var resolveTranspose = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); +var resolveDiagonal = require( '@stdlib/blas/base/diagonal-type-resolve-enum' ); +var A = new Float64Matrix( [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ] ); var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); -var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ), [ 3, 3 ], [ 3, 1 ], 0, 'row-major' ); -var out = dtrmv( [ x, A ] ); -// x => [ 14.0, 8.0, 3.0 ] +var uplo = scalar2ndarray( resolveTriangle( 'upper' ), { + 'dtype': 'int32' +}); +var trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), { + 'dtype': 'int32' +}); +var diag = scalar2ndarray( resolveDiagonal( 'unit' ), { + 'dtype': 'int32' +}); + +var out = dtrmv( [ A, x, uplo, trans, diag ] ); +// returns [ 14.0, 8.0, 3.0 ] var bool = ( out === x ); // returns true @@ -59,8 +74,11 @@ The function has the following parameters: - **arrays**: array-like object containing the following ndarrays: - - a one-dimensional input ndarray. - - a two-dimensional input ndarray. + - a two-dimensional input ndarray corresponding to `A`. + - a one-dimensional input/output ndarray corresponding to `x`. + - a zero-dimensional ndarray specifying whether `A` is an upper or lower triangular matrix. + - a zero-dimensional ndarray specifying whether `A` should be transposed, conjugate-transposed, or not transposed. + - a zero-dimensional ndarray specifying whether `A` has a unit or non-unit diagonal.
@@ -79,21 +97,29 @@ The function has the following parameters: ```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 discreteUniform = require( '@stdlib/random/discrete-uniform' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var resolveTriangle = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); +var resolveTranspose = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); +var resolveDiagonal = require( '@stdlib/blas/base/diagonal-type-resolve-enum' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dtrmv = require( '@stdlib/blas/base/ndarray/dtrmv' ); var opts = { 'dtype': 'float64' }; +var eopts = { + 'dtype': 'int32' +}; + +var A = discreteUniform( [ 3, 3 ], 0, 10, opts ); +var x = discreteUniform( [ 3 ], 0, 10, opts ); -var x = new Float64Vector( discreteUniform( 3, 0, 10, opts ) ); -var A = new ndarray( 'float64', new Float64Array( discreteUniform( 9, 0, 10, opts ) ), [ 3, 3 ], [ 3, 1 ], 0, 'row-major' ); +var uplo = scalar2ndarray( resolveTriangle( 'upper' ), eopts ); +var trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), eopts ); +var diag = scalar2ndarray( resolveDiagonal( 'non-unit' ), eopts ); -var out = dtrmv( [ x, A ] ); +var out = dtrmv( [ A, x, uplo, trans, diag ] ); console.log( ndarray2array( out ) ); ``` diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js index 30bdd2cada3b..46193d1579a2 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js @@ -24,6 +24,10 @@ var bench = require( '@stdlib/bench' ); var ones = require( '@stdlib/ndarray/ones' ); 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 resolveTriangle = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); +var resolveTranspose = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); +var resolveDiagonal = require( '@stdlib/blas/base/diagonal-type-resolve-enum' ); var format = require( '@stdlib/string/format' ); var pkg = require( './../package.json' ).name; var dtrmv = require( './../lib' ); @@ -34,6 +38,9 @@ var dtrmv = require( './../lib' ); var options = { 'dtype': 'float64' }; +var eopts = { + 'dtype': 'int32' +}; // FUNCTIONS // @@ -46,11 +53,18 @@ var options = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; + var trans; + var uplo; + var diag; var A; + var x; - x = ones( [ len ], options ); A = ones( [ len, len ], options ); + x = ones( [ len ], options ); + + uplo = scalar2ndarray( resolveTriangle( 'upper' ), eopts ); + trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), eopts ); + diag = scalar2ndarray( resolveDiagonal( 'non-unit' ), eopts ); return benchmark; @@ -66,7 +80,7 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - z = dtrmv( [ x, A ] ); + z = dtrmv( [ A, x, uplo, trans, diag ] ); if ( typeof z !== 'object' ) { b.fail( 'should return an ndarray' ); } diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/repl.txt index 1d08443b482e..642dc6d8fc7d 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( arrays ) - Perform one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where - `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, + Performs one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where + `x` is a one-dimensional ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. Parameters @@ -9,8 +9,14 @@ arrays: ArrayLikeObject Array-like object containing the following ndarrays: - - a one-dimensional input ndarray. - - a two-dimensional input ndarray. + - a two-dimensional input ndarray corresponding to `A`. + - a one-dimensional input/output ndarray corresponding to `x`. + - a zero-dimensional ndarray specifying whether `A` is an upper or lower + triangular matrix. + - a zero-dimensional ndarray specifying whether `A` should be + transposed, conjugate-transposed, or not transposed. + - a zero-dimensional ndarray specifying whether `A` has a unit or non- + unit diagonal. Returns ------- @@ -19,13 +25,17 @@ Examples -------- - > var x = new {{alias:@stdlib/ndarray/vector/float64}}( [ 1.0, 2.0 ] ); - > var buf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 0.0, 1.0 ] ); - > var sh = [ 2, 2 ]; - > var st = [ 2, 1 ]; - > var A = new {{alias:@stdlib/ndarray/base/ctor}}( 'float64', buf, sh, st, 0, 'row-major' ); + > var abuf = [ [ 1.0, 2.0 ], [ 0.0, 1.0 ] ]; + > var A = new {{alias:@stdlib/ndarray/matrix/float64}}( abuf ); - > {{alias}}( [ x, A ] ); + > var xbuf = [ 1.0, 2.0 ]; + > var x = new {{alias:@stdlib/ndarray/vector/float64}}( xbuf ); + + > var uplo = {{alias:@stdlib/ndarray/from-scalar}}( 'upper' ); + > var trans = {{alias:@stdlib/ndarray/from-scalar}}( 'no-transpose' ); + > var diag = {{alias:@stdlib/ndarray/from-scalar}}( 'non-unit' ); + + > {{alias}}( [ A, x, uplo, trans, diag ] ); > x [ 5.0, 2.0 ] diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/index.d.ts index 069d16ac8e35..6020e2f2ccfd 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/index.d.ts @@ -20,36 +20,52 @@ /// -import { float64ndarray } from '@stdlib/types/ndarray'; +import { float64ndarray, ndarray } from '@stdlib/types/ndarray'; /** -* Performs one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. +* Performs one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is a one-dimensional ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. * * ## Notes * * - The function expects the following ndarrays: * -* - a one-dimensional input ndarray. -* - a two-dimensional input ndarray. +* - a two-dimensional input ndarray corresponding to `A`. +* - a one-dimensional input/output ndarray corresponding to `x`. +* - a zero-dimensional ndarray specifying whether `A` is an upper or lower triangular matrix. +* - a zero-dimensional ndarray specifying whether `A` should be transposed, conjugate-transposed, or not transposed. +* - a zero-dimensional ndarray specifying whether `A` has a unit or non-unit diagonal. * * @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 ndarray = require( '@stdlib/ndarray/base/ctor' ); -* var Float64Array = require( '@stdlib/array/float64' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var resolveTriangle = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); +* var resolveTranspose = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); +* var resolveDiagonal = require( '@stdlib/blas/base/diagonal-type-resolve-enum' ); * +* var A = new Float64Matrix( [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ] ); * var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); -* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ), [ 3, 3 ], [ 3, 1 ], 0, 'row-major' ); * -* var out = dtrmv( [ x, A ] ); +* var uplo = scalar2ndarray( resolveTriangle( 'upper' ), { +* 'dtype': 'int32' +* }); +* var trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), { +* 'dtype': 'int32' +* }); +* var diag = scalar2ndarray( resolveDiagonal( 'unit' ), { +* 'dtype': 'int32' +* }); +* +* var z = dtrmv( [ A, x, uplo, trans, diag ] ); * // returns [ 14.0, 8.0, 3.0 ] * -* var bool = ( out === x ); +* var bool = ( z === x ); * // returns true */ -declare function dtrmv( arrays: [ float64ndarray, float64ndarray ] ): float64ndarray; +declare function dtrmv( arrays: [ float64ndarray, float64ndarray, ndarray, ndarray, ndarray ] ): float64ndarray; // EXPORTS // diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/test.ts index 220a9afc0fd0..8d059efea72d 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/docs/types/test.ts @@ -26,14 +26,23 @@ import dtrmv = require( '@stdlib/blas/base/ndarray/dtrmv' ); // The function returns an ndarray... { - const x = zeros( [ 3 ], { + const A = zeros( [ 3, 3 ], { 'dtype': 'float64' }); - const A = zeros( [ 3, 3 ], { + const x = zeros( [ 3 ], { 'dtype': 'float64' }); + const uplo = zeros( [], { + 'dtype': 'int32' + }); + const trans = zeros( [], { + 'dtype': 'int32' + }); + const diag = zeros( [], { + 'dtype': 'int32' + }); - dtrmv( [ x, A ] ); // $ExpectType float64ndarray + dtrmv( [ A, x, uplo, trans, diag ] ); // $ExpectType float64ndarray } // The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... @@ -51,13 +60,22 @@ import dtrmv = require( '@stdlib/blas/base/ndarray/dtrmv' ); // The compiler throws an error if the function is provided an unsupported number of arguments... { - const x = zeros( [ 3 ], { + const A = zeros( [ 3, 3 ], { 'dtype': 'float64' }); - const A = zeros( [ 3, 3 ], { + const x = zeros( [ 3 ], { 'dtype': 'float64' }); + const uplo = zeros( [], { + 'dtype': 'int32' + }); + const trans = zeros( [], { + 'dtype': 'int32' + }); + const diag = zeros( [], { + 'dtype': 'int32' + }); dtrmv(); // $ExpectError - dtrmv( [ x, A ], {} ); // $ExpectError + dtrmv( [ A, x, uplo, trans, diag ], {} ); // $ExpectError } diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/examples/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/examples/index.js index a197022c25b9..9bc4f6dbbf25 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/examples/index.js @@ -18,19 +18,27 @@ '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 discreteUniform = require( '@stdlib/random/discrete-uniform' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var resolveTriangle = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); +var resolveTranspose = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); +var resolveDiagonal = require( '@stdlib/blas/base/diagonal-type-resolve-enum' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dtrmv = require( './../lib' ); var opts = { 'dtype': 'float64' }; +var eopts = { + 'dtype': 'int32' +}; + +var A = discreteUniform( [ 3, 3 ], 0, 10, opts ); +var x = discreteUniform( [ 3 ], 0, 10, opts ); -var x = new Float64Vector( discreteUniform( 3, 0, 10, opts ) ); -var A = new ndarray( 'float64', new Float64Array( discreteUniform( 9, 0, 10, opts ) ), [ 3, 3 ], [ 3, 1 ], 0, 'row-major' ); +var uplo = scalar2ndarray( resolveTriangle( 'upper' ), eopts ); +var trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), eopts ); +var diag = scalar2ndarray( resolveDiagonal( 'non-unit' ), eopts ); -var out = dtrmv( [ x, A ] ); +var out = dtrmv( [ A, x, uplo, trans, diag ] ); console.log( ndarray2array( out ) ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/index.js index 4329a4fc8545..1c323f61df01 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/index.js @@ -19,20 +19,33 @@ 'use strict'; /** -* BLAS level 2 routine to perform one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. +* BLAS level 2 routine to perform one of the matrix-vector operations `x = A*x` or `x = A^T*x` for a triangular matrix `A`. * * @module @stdlib/blas/base/ndarray/dtrmv * * @example +* var Float64Matrix = require( '@stdlib/ndarray/matrix/float64' ); * var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); -* var ndarray = require( '@stdlib/ndarray/base/ctor' ); -* var Float64Array = require( '@stdlib/array/float64' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var resolveTriangle = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); +* var resolveTranspose = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); +* var resolveDiagonal = require( '@stdlib/blas/base/diagonal-type-resolve-enum' ); * var dtrmv = require( '@stdlib/blas/base/ndarray/dtrmv' ); * +* var A = new Float64Matrix( [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ] ); * var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); -* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ), [ 3, 3 ], [ 3, 1 ], 0, 'row-major' ); * -* var out = dtrmv( [ x, A ] ); +* var uplo = scalar2ndarray( resolveTriangle( 'upper' ), { +* 'dtype': 'int32' +* }); +* var trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), { +* 'dtype': 'int32' +* }); +* var diag = scalar2ndarray( resolveDiagonal( 'unit' ), { +* 'dtype': 'int32' +* }); +* +* var out = dtrmv( [ A, x, uplo, trans, diag ] ); * // returns [ 14.0, 8.0, 3.0 ] * * var bool = ( out === x ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/main.js index b74d7e152b52..22ccdc5ddedf 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/main.js @@ -20,46 +20,81 @@ // 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' ); +var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' ); var strided = require( '@stdlib/blas/base/dtrmv' ).ndarray; // MAIN // /** -* Performs one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. +* Performs one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is a one-dimensional ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix. * * ## Notes * * - The function expects the following ndarrays: * -* - a one-dimensional input ndarray. -* - a two-dimensional input ndarray. +* - a two-dimensional input ndarray corresponding to `A`. +* - a one-dimensional input/output ndarray corresponding to `x`. +* - a zero-dimensional ndarray specifying whether `A` is an upper or lower triangular matrix. +* - a zero-dimensional ndarray specifying whether `A` should be transposed, conjugate-transposed, or not transposed. +* - a zero-dimensional ndarray specifying whether `A` has a unit or non-unit diagonal. * * @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 ndarray = require( '@stdlib/ndarray/base/ctor' ); -* var Float64Array = require( '@stdlib/array/float64' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var resolveTriangle = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); +* var resolveTranspose = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); +* var resolveDiagonal = require( '@stdlib/blas/base/diagonal-type-resolve-enum' ); * +* var A = new Float64Matrix( [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ] ); * var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); -* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 1.0, 2.0, 3.0, 2.0, 1.0 ] ), [ 3, 3 ], [ 3, 1 ], 0, 'row-major' ); * -* var out = dtrmv( [ x, A ] ); +* var uplo = scalar2ndarray( resolveTriangle( 'upper' ), { +* 'dtype': 'int32' +* }); +* var trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), { +* 'dtype': 'int32' +* }); +* var diag = scalar2ndarray( resolveDiagonal( 'unit' ), { +* 'dtype': 'int32' +* }); +* +* var z = dtrmv( [ A, x, uplo, trans, diag ] ); * // returns [ 14.0, 8.0, 3.0 ] * -* var bool = ( out === x ); +* var bool = ( z === x ); * // returns true */ function dtrmv( arrays ) { - var x = arrays[ 0 ]; - var A = arrays[ 1 ]; - strided( 'upper', 'no-transpose', 'non-unit', numelDimension( A, 0 ), getData( A ), getStride( A, 0 ), getStride( A, 1 ), getOffset( A ), getData( x ), getStride( x, 0 ), getOffset( x ) ); + var trans; + var uplo; + var diag; + var sh; + var st; + var A; + var x; + + A = arrays[ 0 ]; + x = arrays[ 1 ]; + + uplo = ndarraylike2scalar( arrays[ 2 ] ); + trans = ndarraylike2scalar( arrays[ 3 ] ); + diag = ndarraylike2scalar( arrays[ 4 ] ); + + sh = getShape( A, false ); + st = getStrides( A, false ); + + strided( uplo, trans, diag, sh[ 0 ], getData( A ), st[ 0 ], st[ 1 ], getOffset( A ), getData( x ), getStride( x, 0 ), getOffset( x ) ); + return x; } diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/package.json b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/package.json index 63f91815d546..85872658afd1 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/package.json +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/base/ndarray/dtrmv", "version": "0.0.0", - "description": "Perform one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element ndarray and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix.", + "description": "Perform one of the matrix-vector operations `x = A*x` or `x = A^T*x` for a triangular matrix `A`.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js index d4e97c38d0a4..a4b75a3fd013 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js @@ -23,8 +23,12 @@ 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 resolveTriangle = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); +var resolveTranspose = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); +var resolveDiagonal = require( '@stdlib/blas/base/diagonal-type-resolve-enum' ); var dtrmv = require( './../lib' ); @@ -73,8 +77,11 @@ tape( 'the function has an arity of 1', function test( t ) { t.end(); }); -tape( 'the function performs the matrix-vector operation `x = A*x`', function test( t ) { +tape( 'the function performs the matrix-vector operation `x = A*x` (upper)', function test( t ) { var expected; + var trans; + var uplo; + var diag; var xbuf; var Abuf; var x; @@ -85,8 +92,17 @@ tape( 'the function performs the matrix-vector operation `x = A*x`', function te Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); x = vector( xbuf, 3, 1, 0 ); A = matrix( Abuf, 3, 3, 1, 0 ); + uplo = scalar2ndarray( resolveTriangle( 'upper' ), { + 'dtype': 'int32' + }); + trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), { + 'dtype': 'int32' + }); + diag = scalar2ndarray( resolveDiagonal( 'non-unit' ), { + 'dtype': 'int32' + }); - v = dtrmv( [ x, A ] ); + v = dtrmv( [ A, x, uplo, trans, diag ] ); expected = new Float64Array( [ 14.0, 28.0, 27.0 ] ); t.strictEqual( v, x, 'returns expected value' ); @@ -95,8 +111,113 @@ tape( 'the function performs the matrix-vector operation `x = A*x`', function te t.end(); }); -tape( 'the function supports ndarrays having non-unit strides', function test( t ) { +tape( 'the function performs the matrix-vector operation `x = A*x` (lower)', function test( t ) { var expected; + var trans; + var uplo; + var diag; + var xbuf; + var Abuf; + var x; + var A; + var v; + + xbuf = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); + x = vector( xbuf, 3, 1, 0 ); + A = matrix( Abuf, 3, 3, 1, 0 ); + uplo = scalar2ndarray( resolveTriangle( 'lower' ), { + 'dtype': 'int32' + }); + trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), { + 'dtype': 'int32' + }); + diag = scalar2ndarray( resolveDiagonal( 'non-unit' ), { + 'dtype': 'int32' + }); + + v = dtrmv( [ A, x, uplo, trans, diag ] ); + + expected = new Float64Array( [ 1.0, 14.0, 50.0 ] ); + t.strictEqual( v, x, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function performs the matrix-vector operation `x = A^T*x`', function test( t ) { + var expected; + var trans; + var uplo; + var diag; + var xbuf; + var Abuf; + var x; + var A; + var v; + + xbuf = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); + x = vector( xbuf, 3, 1, 0 ); + A = matrix( Abuf, 3, 3, 1, 0 ); + uplo = scalar2ndarray( resolveTriangle( 'upper' ), { + 'dtype': 'int32' + }); + trans = scalar2ndarray( resolveTranspose( 'transpose' ), { + 'dtype': 'int32' + }); + diag = scalar2ndarray( resolveDiagonal( 'non-unit' ), { + 'dtype': 'int32' + }); + + v = dtrmv( [ A, x, uplo, trans, diag ] ); + + expected = new Float64Array( [ 1.0, 12.0, 42.0 ] ); + t.strictEqual( v, x, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying that `A` has a unit diagonal', function test( t ) { + var expected; + var trans; + var uplo; + var diag; + var xbuf; + var Abuf; + var x; + var A; + var v; + + xbuf = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); + x = vector( xbuf, 3, 1, 0 ); + A = matrix( Abuf, 3, 3, 1, 0 ); + uplo = scalar2ndarray( resolveTriangle( 'upper' ), { + 'dtype': 'int32' + }); + trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), { + 'dtype': 'int32' + }); + diag = scalar2ndarray( resolveDiagonal( 'unit' ), { + 'dtype': 'int32' + }); + + v = dtrmv( [ A, x, uplo, trans, diag ] ); + + expected = new Float64Array( [ 14.0, 20.0, 3.0 ] ); + t.strictEqual( v, x, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports ndarrays having non-unit strides (upper)', function test( t ) { + var expected; + var trans; + var uplo; + var diag; var xbuf; var Abuf; var x; @@ -115,7 +236,17 @@ tape( 'the function supports ndarrays having non-unit strides', function test( t Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); A = matrix( Abuf, 3, 3, 1, 0 ); - v = dtrmv( [ x, A ] ); + uplo = scalar2ndarray( resolveTriangle( 'upper' ), { + 'dtype': 'int32' + }); + trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), { + 'dtype': 'int32' + }); + diag = scalar2ndarray( resolveDiagonal( 'non-unit' ), { + 'dtype': 'int32' + }); + + v = dtrmv( [ A, x, uplo, trans, diag ] ); expected = new Float64Array( [ 14.0, 0.0, 28.0, 0.0, 27.0 ] ); t.strictEqual( v, x, 'returns expected value' ); @@ -123,8 +254,11 @@ tape( 'the function supports ndarrays having non-unit strides', function test( t t.end(); }); -tape( 'the function supports ndarrays having negative strides', function test( t ) { +tape( 'the function supports ndarrays having negative strides (lower)', function test( t ) { var expected; + var trans; + var uplo; + var diag; var xbuf; var Abuf; var x; @@ -141,16 +275,29 @@ tape( 'the function supports ndarrays having negative strides', function test( t Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); A = matrix( Abuf, 3, 3, 1, 0 ); - v = dtrmv( [ x, A ] ); + uplo = scalar2ndarray( resolveTriangle( 'lower' ), { + 'dtype': 'int32' + }); + trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), { + 'dtype': 'int32' + }); + diag = scalar2ndarray( resolveDiagonal( 'non-unit' ), { + 'dtype': 'int32' + }); + + v = dtrmv( [ A, x, uplo, trans, diag ] ); - expected = new Float64Array( [ 27.0, 28.0, 14.0 ] ); + expected = new Float64Array( [ 50.0, 14.0, 1.0 ] ); t.strictEqual( v, x, '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 ) { +tape( 'the function supports ndarrays having non-zero offsets (upper)', function test( t ) { var expected; + var trans; + var uplo; + var diag; var xbuf; var Abuf; var x; @@ -182,7 +329,17 @@ tape( 'the function supports ndarrays having non-zero offsets', function test( t ]); A = matrix( Abuf, 3, 3, 1, 2 ); - v = dtrmv( [ x, A ] ); + uplo = scalar2ndarray( resolveTriangle( 'upper' ), { + 'dtype': 'int32' + }); + trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), { + 'dtype': 'int32' + }); + diag = scalar2ndarray( resolveDiagonal( 'non-unit' ), { + 'dtype': 'int32' + }); + + v = dtrmv( [ A, x, uplo, trans, diag ] ); expected = new Float64Array([ 0.0, From 4fb62d6eca7cf207a03fe88b664263e220a6b9ea Mon Sep 17 00:00:00 2001 From: kaustubh Date: Sun, 16 Aug 2026 12:50:09 +0530 Subject: [PATCH 3/4] fix: use correct signature --- 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: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - 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: na - task: lint_license_headers status: passed --- --- .../@stdlib/blas/base/ndarray/dtrmv/README.md | 10 ++++++- .../base/ndarray/dtrmv/benchmark/benchmark.js | 28 +++++++++++++------ .../blas/base/ndarray/dtrmv/examples/index.js | 10 ++++++- .../blas/base/ndarray/dtrmv/lib/main.js | 6 ++-- 4 files changed, 39 insertions(+), 15 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/README.md index f7d00807e906..29067c616d28 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/README.md @@ -98,10 +98,12 @@ The function has the following parameters: ```javascript var discreteUniform = require( '@stdlib/random/discrete-uniform' ); +var zeros = require( '@stdlib/ndarray/zeros' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var resolveTriangle = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); var resolveTranspose = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); var resolveDiagonal = require( '@stdlib/blas/base/diagonal-type-resolve-enum' ); +var dtriu = require( '@stdlib/blas/ext/base/ndarray/dtriu' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dtrmv = require( '@stdlib/blas/base/ndarray/dtrmv' ); @@ -112,13 +114,19 @@ var eopts = { 'dtype': 'int32' }; -var A = discreteUniform( [ 3, 3 ], 0, 10, opts ); +var M = discreteUniform( [ 3, 3 ], 0, 10, opts ); +var A = zeros( [ 3, 3 ], opts ); var x = discreteUniform( [ 3 ], 0, 10, opts ); var uplo = scalar2ndarray( resolveTriangle( 'upper' ), eopts ); var trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), eopts ); var diag = scalar2ndarray( resolveDiagonal( 'non-unit' ), eopts ); +var k = scalar2ndarray( 0, { + 'dtype': 'generic' +}); +dtriu( [ M, A, k ] ); + var out = dtrmv( [ A, x, uplo, trans, diag ] ); console.log( ndarray2array( out ) ); ``` diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js index 46193d1579a2..304bfa223953 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js @@ -22,12 +22,14 @@ var bench = require( '@stdlib/bench' ); var ones = require( '@stdlib/ndarray/ones' ); +var zeros = require( '@stdlib/ndarray/zeros' ); 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 resolveTriangle = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); var resolveTranspose = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); var resolveDiagonal = require( '@stdlib/blas/base/diagonal-type-resolve-enum' ); +var dtriu = require( '@stdlib/blas/ext/base/ndarray/dtriu' ); var format = require( '@stdlib/string/format' ); var pkg = require( './../package.json' ).name; var dtrmv = require( './../lib' ); @@ -49,18 +51,26 @@ var eopts = { * Creates a benchmark function. * * @private -* @param {PositiveInteger} len - array length +* @param {PositiveInteger} N - number of elements along each dimension * @returns {Function} benchmark function */ -function createBenchmark( len ) { +function createBenchmark( N ) { var trans; var uplo; var diag; + var M; var A; + var k; var x; - A = ones( [ len, len ], options ); - x = ones( [ len ], options ); + M = ones( [ N, N ], options ); + A = zeros( [ N, N ], options ); + k = scalar2ndarray( 0, { + 'dtype': 'generic' + }); + dtriu( [ M, A, k ] ); + + x = ones( [ N ], options ); uplo = scalar2ndarray( resolveTriangle( 'upper' ), eopts ); trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), eopts ); @@ -86,7 +96,7 @@ function createBenchmark( len ) { } } b.toc(); - if ( isnan( z.get( i%len ) ) ) { + if ( isnan( z.get( i%N ) ) ) { b.fail( 'should not return NaN' ); } b.pass( 'benchmark finished' ); @@ -103,9 +113,9 @@ function createBenchmark( len ) { * @private */ function main() { - var len; var min; var max; + var N; var f; var i; @@ -113,9 +123,9 @@ function main() { 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 ); + N = pow( 10, i ); + f = createBenchmark( N ); + bench( format( '%s:size=%d', pkg, N*N ), f ); } } diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/examples/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/examples/index.js index 9bc4f6dbbf25..ecb13b0a1bb9 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/examples/index.js @@ -19,10 +19,12 @@ 'use strict'; var discreteUniform = require( '@stdlib/random/discrete-uniform' ); +var zeros = require( '@stdlib/ndarray/zeros' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var resolveTriangle = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); var resolveTranspose = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); var resolveDiagonal = require( '@stdlib/blas/base/diagonal-type-resolve-enum' ); +var dtriu = require( '@stdlib/blas/ext/base/ndarray/dtriu' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dtrmv = require( './../lib' ); @@ -33,12 +35,18 @@ var eopts = { 'dtype': 'int32' }; -var A = discreteUniform( [ 3, 3 ], 0, 10, opts ); +var M = discreteUniform( [ 3, 3 ], 0, 10, opts ); +var A = zeros( [ 3, 3 ], opts ); var x = discreteUniform( [ 3 ], 0, 10, opts ); var uplo = scalar2ndarray( resolveTriangle( 'upper' ), eopts ); var trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), eopts ); var diag = scalar2ndarray( resolveDiagonal( 'non-unit' ), eopts ); +var k = scalar2ndarray( 0, { + 'dtype': 'generic' +}); +dtriu( [ M, A, k ] ); + var out = dtrmv( [ A, x, uplo, trans, diag ] ); console.log( ndarray2array( out ) ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/main.js index 22ccdc5ddedf..64a5fe2c86d8 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/lib/main.js @@ -20,7 +20,7 @@ // MODULES // -var getShape = require( '@stdlib/ndarray/base/shape' ); +var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); var getStrides = require( '@stdlib/ndarray/base/strides' ); var getStride = require( '@stdlib/ndarray/base/stride' ); var getOffset = require( '@stdlib/ndarray/base/offset' ); @@ -78,7 +78,6 @@ function dtrmv( arrays ) { var trans; var uplo; var diag; - var sh; var st; var A; var x; @@ -90,10 +89,9 @@ function dtrmv( arrays ) { trans = ndarraylike2scalar( arrays[ 3 ] ); diag = ndarraylike2scalar( arrays[ 4 ] ); - sh = getShape( A, false ); st = getStrides( A, false ); - strided( uplo, trans, diag, sh[ 0 ], getData( A ), st[ 0 ], st[ 1 ], getOffset( A ), getData( x ), getStride( x, 0 ), getOffset( x ) ); + strided( uplo, trans, diag, numelDimension( A, 0 ), getData( A ), st[ 0 ], st[ 1 ], getOffset( A ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len return x; } From fa15fd66b5d885fad69c13053f3fcedb5d4f5788 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Sun, 16 Aug 2026 20:53:58 +0530 Subject: [PATCH 4/4] fix: apply suggestions --- 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: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - 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: na - task: lint_license_headers status: passed --- --- .../@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js | 2 +- lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js index 304bfa223953..1b18d8850af4 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/benchmark/benchmark.js @@ -74,7 +74,7 @@ function createBenchmark( N ) { uplo = scalar2ndarray( resolveTriangle( 'upper' ), eopts ); trans = scalar2ndarray( resolveTranspose( 'no-transpose' ), eopts ); - diag = scalar2ndarray( resolveDiagonal( 'non-unit' ), eopts ); + diag = scalar2ndarray( resolveDiagonal( 'unit' ), eopts ); return benchmark; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js index a4b75a3fd013..cbdd21f63d9b 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dtrmv/test/test.js @@ -191,7 +191,7 @@ tape( 'the function supports specifying that `A` has a unit diagonal', function var v; xbuf = new Float64Array( [ 1.0, 2.0, 3.0 ] ); - Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); + Abuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 1.0, 6.0, 7.0, 8.0, 1.0 ] ); x = vector( xbuf, 3, 1, 0 ); A = matrix( Abuf, 3, 3, 1, 0 ); uplo = scalar2ndarray( resolveTriangle( 'upper' ), {