From 19504c4b0e87981e26bf6d04a73d098a98f06b7d Mon Sep 17 00:00:00 2001 From: kaustubh Date: Sun, 21 Jun 2026 22:31:14 +0530 Subject: [PATCH 01/16] feat: add blas/base/ndarray/dspr --- 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/dspr/README.md | 127 +++++++++ .../base/ndarray/dspr/benchmark/benchmark.js | 112 ++++++++ .../blas/base/ndarray/dspr/docs/repl.txt | 36 +++ .../base/ndarray/dspr/docs/types/index.d.ts | 63 +++++ .../blas/base/ndarray/dspr/docs/types/test.ts | 69 +++++ .../blas/base/ndarray/dspr/examples/index.js | 39 +++ .../blas/base/ndarray/dspr/lib/index.js | 54 ++++ .../blas/base/ndarray/dspr/lib/main.js | 77 ++++++ .../blas/base/ndarray/dspr/package.json | 73 ++++++ .../blas/base/ndarray/dspr/test/test.js | 241 ++++++++++++++++++ 10 files changed, 891 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dspr/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dspr/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dspr/package.json create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/dspr/test/test.js diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md new file mode 100644 index 000000000000..77cde0c31599 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md @@ -0,0 +1,127 @@ + + +# dspr + +> Perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`. + +
+ +
+ + + +
+ +## Usage + +```javascript +var dspr = require( '@stdlib/blas/base/ndarray/dspr' ); +``` + +#### dspr( arrays ) + +Performs the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`, where `alpha` is a scalar, `x` is an ndarray, and `A` is an `N` 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 x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); +var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ), [ 6 ], [ 1 ], 0, 'row-major' ); + +var alpha = scalar2ndarray( 1.0, { + 'dtype': 'float64' +}); + +var out = dspr( [ x, A, alpha ] ); +// returns [ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ] + +var bool = ( out === A ); +// returns true +``` + +The function has the following parameters: + +- **arrays**: array-like object containing the following ndarrays: + + - first one-dimensional input ndarray. + - second one-dimensional symmetric input ndarray. + - first 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 dspr = require( '@stdlib/blas/base/ndarray/dspr' ); + +var opts = { + 'dtype': 'float64' +}; + +var x = new Float64Vector( discreteUniform( 4, 0, 10, opts ) ); +var A = new ndarray( 'float64', new Float64Array( discreteUniform( 10, 0, 10, opts ) ), [ 10 ], [ 1 ], 0, 'row-major' ); + +var alpha = scalar2ndarray( 3.0, opts ); + +var out = dspr( [ x, A, alpha ] ); +console.log( ndarray2array( out ) ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/benchmark/benchmark.js new file mode 100644 index 000000000000..ca80411f14e3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/benchmark/benchmark.js @@ -0,0 +1,112 @@ +/** +* @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 dspr = 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 x; + var A; + + A = uniform( [ (len * (len + 1)) / 2 ], -100.0, 100.0, options ); + x = uniform( [ len ], -100.0, 100.0, options ); + + alpha = 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 = dspr( [ x, A, alpha ] ); + 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/dspr/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt new file mode 100644 index 000000000000..8f651ab512ed --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt @@ -0,0 +1,36 @@ + +{{alias}}( arrays ) + Performs the symmetric rank 1 operation `A = alpha*x*x^T + A` for a + symmetric matrix supplied in packed form `A`, where `alpha` is a + scalar, `x` is an ndarray, and `A` is an `N` by `N` matrix. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing the following ndarrays: + + - first one-dimensional input ndarray. + - second one-dimensional symmetric input ndarray. + - first zero-dimensional ndarray containing a scalar constant. + + Returns + ------- + out: ndarray + Output ndarray. + + Examples + -------- + > var x = new {{alias:@stdlib/ndarray/vector/float64}}( [ 1.0, 2.0, 3.0 ] ); + > var buf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ); + > var sh = [ 6 ]; + > var st = [ 1 ]; + > var A = new {{alias:@stdlib/ndarray/base/ctor}}( 'float64', buf, sh, st, 0, 'row-major' ); + > var alpha = {{alias:@stdlib/ndarray/from-scalar}}( 1.0, { 'dtype': 'float64' }); + + > {{alias}}( [ x, A, alpha ] ); + > A + [ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts new file mode 100644 index 000000000000..992365f3b74c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.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. +*/ + +// TypeScript Version: 4.1 + +/// + +import { float64ndarray } from '@stdlib/types/ndarray'; + +/** +* Performs the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`, where `alpha` is a scalar, `x` is an ndarray, and `A` is an `N` by `N` matrix. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - first one-dimensional input ndarray. +* - second one-dimensional symmetric input ndarray. +* - first 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 x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); +* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ), [ 6 ], [ 1 ], 0, 'row-major' ); +* +* var alpha = scalar2ndarray( 1.0, { +* 'dtype': 'float64' +* }); +* +* var out = dspr( [ x, A, alpha ] ); +* // returns [ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ] +* +* var bool = ( out === A ); +* // returns true +*/ +declare function dspr( arrays: [ float64ndarray, float64ndarray, float64ndarray ] ): float64ndarray; + + +// EXPORTS // + +export = dspr; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/test.ts new file mode 100644 index 000000000000..00528dc9a36c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/test.ts @@ -0,0 +1,69 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/* eslint-disable space-in-parens */ + +import zeros = require( '@stdlib/ndarray/zeros' ); +import dspr = require( '@stdlib/blas/base/ndarray/dspr' ); + + +// TESTS // + +// The function returns an ndarray... +{ + const A = zeros( [ 6 ], { + 'dtype': 'float64' + }); + const x = zeros( [ 3 ], { + 'dtype': 'float64' + }); + const alpha = zeros( [], { + 'dtype': 'float64' + }); + + dspr( [ x, A, alpha ] ); // $ExpectType float64ndarray +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + dspr( '10' ); // $ExpectError + dspr( 10 ); // $ExpectError + dspr( true ); // $ExpectError + dspr( false ); // $ExpectError + dspr( null ); // $ExpectError + dspr( undefined ); // $ExpectError + dspr( [] ); // $ExpectError + dspr( {} ); // $ExpectError + dspr( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const A = zeros( [ 6 ], { + 'dtype': 'float64' + }); + const x = zeros( [ 3 ], { + 'dtype': 'float64' + }); + const alpha = zeros( [], { + 'dtype': 'float64' + }); + + dspr(); // $ExpectError + dspr( [ x, A, alpha ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/examples/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/examples/index.js new file mode 100644 index 000000000000..89344c512b56 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/examples/index.js @@ -0,0 +1,39 @@ +/** +* @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 dspr = require( './../lib' ); + +var opts = { + 'dtype': 'float64' +}; + +var x = new Float64Vector( discreteUniform( 4, 0, 10, opts ) ); +var A = new ndarray( 'float64', new Float64Array( discreteUniform( 10, 0, 10, opts ) ), [ 10 ], [ 1 ], 0, 'row-major' ); + +var alpha = scalar2ndarray( 3.0, opts ); + +var out = dspr( [ x, A, alpha ] ); +console.log( ndarray2array( out ) ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js new file mode 100644 index 000000000000..cae8294b8d5a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js @@ -0,0 +1,54 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* BLAS level 2 routine to perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`. +* +* @module @stdlib/blas/base/ndarray/dspr +* +* @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 dspr = require( '@stdlib/blas/base/ndarray/dspr' ); +* +* var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); +* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ), [ 6 ], [ 1 ], 0, 'row-major' ); +* +* var alpha = scalar2ndarray( 1.0, { +* 'dtype': 'float64' +* }); +* +* var out = dspr( [ x, A, alpha ] ); +* // returns [ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ] +* +* var bool = ( out === A ); +* // returns true +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js new file mode 100644 index 000000000000..510745fec7c9 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js @@ -0,0 +1,77 @@ +/** +* @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/dspr' ).ndarray; + + +// MAIN // + +/** +* Performs the symmetric rank 1 operation `A = alpha*x*x^T + A`, where `alpha` is a scalar, `x` is an ndarray, and `A` is an `N` by `N` symmetric matrix supplied in packed form. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - first one-dimensional input ndarray. +* - second one-dimensional symmetric input ndarray. +* - first 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 x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); +* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ), [ 6 ], [ 1 ], 0, 'row-major' ); +* +* var alpha = scalar2ndarray( 1.0, { +* 'dtype': 'float64' +* }); +* +* var out = dspr( [ x, A, alpha ] ); +* // returns [ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ] +* +* var bool = ( out === A ); +* // returns true +*/ +function dspr( arrays ) { + var alpha = ndarraylike2scalar( arrays[ 2 ] ); + var x = arrays[ 0 ]; + var A = arrays[ 1 ]; + strided( 'row-major', 'upper', numelDimension( x, 0 ), alpha, getData( x ), getStride( x, 0 ), getOffset( x ), getData( A ), getStride( A, 0 ), getOffset( A ) ); + return A; +} + + +// EXPORTS // + +module.exports = dspr; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/package.json b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/package.json new file mode 100644 index 000000000000..13b06187dc71 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/package.json @@ -0,0 +1,73 @@ +{ + "name": "@stdlib/blas/base/ndarray/dspr", + "version": "0.0.0", + "description": "Perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`.", + "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", + "dspr", + "linear", + "algebra", + "subroutines", + "rank 1", + "symmetric", + "update", + "vector", + "matrix", + "array", + "ndarray", + "float64", + "double", + "float64array" + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/test/test.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/test/test.js new file mode 100644 index 000000000000..ba19f61380ed --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/test/test.js @@ -0,0 +1,241 @@ +/** +* @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 dspr = 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' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dspr, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( dspr.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function performs the symmetric rank 1 operation `A = alpha*x*x^T + A`', function test( t ) { + var expected; + var alpha; + 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, 1.0, 2.0, 1.0 ] ); + A = vector( Abuf, 6, 1, 0 ); + x = vector( xbuf, 3, 1, 0 ); + alpha = scalar2ndarray( 1.0, { + 'dtype': 'float64' + }); + + v = dspr( [ x, A, alpha ] ); + + expected = new Float64Array( [ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ] ); + t.strictEqual( v, A, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + + xbuf = new Float64Array( [ 1.0, 1.0, 1.0 ] ); + Abuf = new Float64Array( [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] ); + A = vector( Abuf, 6, 1, 0 ); + x = vector( xbuf, 3, 1, 0 ); + alpha = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + + v = dspr( [ x, A, alpha ] ); + + expected = new Float64Array( [ 3.0, 6.0, 4.0, 7.0, 5.0, 8.0 ] ); + t.strictEqual( v, A, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `alpha` is `0`, the function returns `A` unchanged', function test( t ) { + var expected; + var alpha; + 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, 1.0, 2.0, 1.0 ] ); + A = vector( Abuf, 6, 1, 0 ); + x = vector( xbuf, 3, 1, 0 ); + alpha = scalar2ndarray( 0.0, { + 'dtype': 'float64' + }); + + v = dspr( [ x, A, alpha ] ); + + expected = new Float64Array( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ); + t.strictEqual( v, A, '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 xbuf; + var Abuf; + var x; + var A; + var v; + + Abuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + A = vector( Abuf, 6, 1, 0 ); + + xbuf = new Float64Array([ + 1.0, // 0 + 0.0, + 2.0, // 1 + 0.0, + 3.0 // 2 + ]); + x = vector( xbuf, 3, 2, 0 ); + + alpha = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + + v = dspr( [ x, A, alpha ] ); + + expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.0, 12.0, 18.0 ] ); + t.strictEqual( v, A, '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 xbuf; + var Abuf; + var x; + var A; + var v; + + Abuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + A = vector( Abuf, 6, 1, 0 ); + + xbuf = new Float64Array([ + 3.0, // 2 + 2.0, // 1 + 1.0 // 0 + ]); + x = vector( xbuf, 3, -1, 2 ); + + alpha = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + + v = dspr( [ x, A, alpha ] ); + + expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.0, 12.0, 18.0 ] ); + t.strictEqual( v, A, '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 xbuf; + var Abuf; + var x; + var A; + var v; + + Abuf = new Float64Array([ + 999.0, + 999.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0 + ]); + A = vector( Abuf, 6, 1, 2 ); + + xbuf = new Float64Array([ + 0.0, + 0.0, + 1.0, // 0 + 2.0, // 1 + 3.0 // 2 + ]); + x = vector( xbuf, 3, 1, 2 ); + + alpha = scalar2ndarray( 2.0, { + 'dtype': 'float64' + }); + + v = dspr( [ x, A, alpha ] ); + + expected = new Float64Array([ + 999.0, + 999.0, + 2.0, + 4.0, + 6.0, + 8.0, + 12.0, + 18.0 + ]); + t.strictEqual( v, A, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); From dc939794745db253b04ee99e3995a087f04be1c7 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Wed, 15 Jul 2026 10:35:54 +0530 Subject: [PATCH 02/16] feat: refactor 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: na - 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/dspr/README.md | 40 ++++--- .../base/ndarray/dspr/benchmark/benchmark.js | 11 +- .../blas/base/ndarray/dspr/docs/repl.txt | 30 +++-- .../base/ndarray/dspr/docs/types/index.d.ts | 25 ++-- .../blas/base/ndarray/dspr/docs/types/test.ts | 14 ++- .../blas/base/ndarray/dspr/examples/index.js | 15 +-- .../blas/base/ndarray/dspr/lib/index.js | 12 +- .../blas/base/ndarray/dspr/lib/main.js | 47 +++++--- .../blas/base/ndarray/dspr/test/test.js | 113 ++++++++++++++---- 9 files changed, 209 insertions(+), 98 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md index 77cde0c31599..05b136d837cd 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md @@ -22,6 +22,8 @@ limitations under the License. > Perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`. + +
@@ -38,25 +40,27 @@ var dspr = require( '@stdlib/blas/base/ndarray/dspr' ); #### dspr( arrays ) -Performs the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`, where `alpha` is a scalar, `x` is an ndarray, and `A` is an `N` by `N` matrix. +Performs the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`, where `alpha` is a scalar, `x` is a one-dimensional ndarray, and `A` is an `N` 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 resolveEnum = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); -var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ), [ 6 ], [ 1 ], 0, 'row-major' ); +var AP = new Float64Vector( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ); +var uplo = scalar2ndarray( resolveEnum( 'upper' ), { + 'dtype': 'int8' +}); var alpha = scalar2ndarray( 1.0, { 'dtype': 'float64' }); -var out = dspr( [ x, A, alpha ] ); +var y = dspr( [ x, AP, uplo, alpha ] ); // returns [ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ] -var bool = ( out === A ); +var bool = ( y === AP ); // returns true ``` @@ -64,9 +68,10 @@ The function has the following parameters: - **arrays**: array-like object containing the following ndarrays: - - first one-dimensional input ndarray. - - second one-dimensional symmetric input ndarray. - - first zero-dimensional ndarray containing a scalar constant. + - a one-dimensional input ndarray corresponding to `x`. + - a one-dimensional input/output ndarray corresponding to the packed form of `A`. + - a zero-dimensional ndarray specifying whether the upper or lower triangular part of `A` is supplied. + - a zero-dimensional ndarray containing a scalar constant corresponding to `alpha`. @@ -82,14 +87,14 @@ The function has the following parameters: ## 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 discreteUniform = require( '@stdlib/random/discrete-uniform' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var resolveEnum = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dspr = require( '@stdlib/blas/base/ndarray/dspr' ); @@ -97,12 +102,15 @@ var opts = { 'dtype': 'float64' }; -var x = new Float64Vector( discreteUniform( 4, 0, 10, opts ) ); -var A = new ndarray( 'float64', new Float64Array( discreteUniform( 10, 0, 10, opts ) ), [ 10 ], [ 1 ], 0, 'row-major' ); +var x = discreteUniform( [ 4 ], 0, 10, opts ); +var AP = discreteUniform( [ 10 ], 0, 10, opts ); +var uplo = scalar2ndarray( resolveEnum( 'upper' ), { + 'dtype': 'int8' +}); var alpha = scalar2ndarray( 3.0, opts ); -var out = dspr( [ x, A, alpha ] ); +var out = dspr( [ x, AP, uplo, alpha ] ); console.log( ndarray2array( out ) ); ``` diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/benchmark/benchmark.js index ca80411f14e3..f4cd83999d28 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/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/matrix-triangle-resolve-enum' ); var format = require( '@stdlib/string/format' ); var pkg = require( './../package.json' ).name; var dspr = require( './../lib' ); @@ -48,12 +49,16 @@ var options = { */ function createBenchmark( len ) { var alpha; + var uplo; + var AP; var x; - var A; - A = uniform( [ (len * (len + 1)) / 2 ], -100.0, 100.0, options ); + AP = uniform( [ (len * (len + 1)) / 2 ], -100.0, 100.0, options ); x = uniform( [ len ], -100.0, 100.0, options ); + uplo = scalar2ndarray( resolveEnum( 'upper' ), { + 'dtype': 'int8' + }); alpha = scalar2ndarray( 1.0, options ); return benchmark; @@ -70,7 +75,7 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - z = dspr( [ x, A, alpha ] ); + z = dspr( [ x, AP, uplo, alpha ] ); if ( typeof z !== 'object' ) { b.fail( 'should return an ndarray' ); } diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt index 8f651ab512ed..a9311a897900 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt @@ -1,17 +1,21 @@ {{alias}}( arrays ) Performs the symmetric rank 1 operation `A = alpha*x*x^T + A` for a - symmetric matrix supplied in packed form `A`, where `alpha` is a - scalar, `x` is an ndarray, and `A` is an `N` by `N` matrix. + symmetric matrix supplied in packed form `A`, where `alpha` is a scalar, + `x` is a one-dimensional ndarray, and `A` is an `N` by `N` matrix. Parameters ---------- arrays: ArrayLikeObject Array-like object containing the following ndarrays: - - first one-dimensional input ndarray. - - second one-dimensional symmetric input ndarray. - - first zero-dimensional ndarray containing a scalar constant. + - a one-dimensional input ndarray corresponding to `x`. + - a one-dimensional input/output ndarray corresponding to the packed + form of `A`. + - a zero-dimensional ndarray specifying whether the upper or lower + triangular part of `A` is supplied. + - a zero-dimensional ndarray containing a scalar constant corresponding + to `alpha`. Returns ------- @@ -20,15 +24,17 @@ Examples -------- - > var x = new {{alias:@stdlib/ndarray/vector/float64}}( [ 1.0, 2.0, 3.0 ] ); - > var buf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ); - > var sh = [ 6 ]; - > var st = [ 1 ]; - > var A = new {{alias:@stdlib/ndarray/base/ctor}}( 'float64', buf, sh, st, 0, 'row-major' ); + > var xbuf = [ 1.0, 2.0, 3.0 ]; + > var x = new {{alias:@stdlib/ndarray/vector/float64}}( xbuf ); + + > var apbuf = [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ]; + > var AP = new {{alias:@stdlib/ndarray/vector/float64}}( apbuf ); + + > var uplo = {{alias:@stdlib/ndarray/from-scalar}}( 'upper' ); > var alpha = {{alias:@stdlib/ndarray/from-scalar}}( 1.0, { 'dtype': 'float64' }); - > {{alias}}( [ x, A, alpha ] ); - > A + > {{alias}}( [ x, AP, uplo, alpha ] ); + > AP [ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ] See Also diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts index 992365f3b74c..15ac07295aa6 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts @@ -20,18 +20,19 @@ /// -import { float64ndarray } from '@stdlib/types/ndarray'; +import { float64ndarray, ndarray } from '@stdlib/types/ndarray'; /** -* Performs the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`, where `alpha` is a scalar, `x` is an ndarray, and `A` is an `N` by `N` matrix. +* Performs the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`, where `alpha` is a scalar, `x` is a one-dimensional ndarray, and `A` is an `N` by `N` matrix. * * ## Notes * * - The function expects the following ndarrays: * -* - first one-dimensional input ndarray. -* - second one-dimensional symmetric input ndarray. -* - first zero-dimensional ndarray containing a scalar constant. +* - a one-dimensional input ndarray corresponding to `x`. +* - a one-dimensional input/output ndarray corresponding to the packed form of `A`. +* - a zero-dimensional ndarray specifying whether the upper or lower triangular part of `A` is supplied. +* - a zero-dimensional ndarray containing a scalar constant corresponding to `alpha`. * * @param arrays - array-like object containing ndarrays * @returns output ndarray @@ -39,23 +40,25 @@ import { float64ndarray } from '@stdlib/types/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 resolveEnum = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); * * var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); -* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ), [ 6 ], [ 1 ], 0, 'row-major' ); +* var AP = new Float64Vector( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ); * +* var uplo = scalar2ndarray( resolveEnum( 'upper' ), { +* 'dtype': 'int8' +* }); * var alpha = scalar2ndarray( 1.0, { * 'dtype': 'float64' * }); * -* var out = dspr( [ x, A, alpha ] ); +* var y = dspr( [ x, AP, uplo, alpha ] ); * // returns [ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ] * -* var bool = ( out === A ); +* var bool = ( y === AP ); * // returns true */ -declare function dspr( arrays: [ float64ndarray, float64ndarray, float64ndarray ] ): float64ndarray; +declare function dspr( arrays: [ float64ndarray, float64ndarray, ndarray, float64ndarray ] ): float64ndarray; // EXPORTS // diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/test.ts index 00528dc9a36c..11cd1cc60142 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/test.ts @@ -26,17 +26,20 @@ import dspr = require( '@stdlib/blas/base/ndarray/dspr' ); // The function returns an ndarray... { - const A = zeros( [ 6 ], { + const AP = zeros( [ 6 ], { 'dtype': 'float64' }); const x = zeros( [ 3 ], { 'dtype': 'float64' }); + const uplo = zeros( [], { + 'dtype': 'int8' + }); const alpha = zeros( [], { 'dtype': 'float64' }); - dspr( [ x, A, alpha ] ); // $ExpectType float64ndarray + dspr( [ x, AP, uplo, alpha ] ); // $ExpectType float64ndarray } // The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... @@ -54,16 +57,19 @@ import dspr = require( '@stdlib/blas/base/ndarray/dspr' ); // The compiler throws an error if the function is provided an unsupported number of arguments... { - const A = zeros( [ 6 ], { + const AP = zeros( [ 6 ], { 'dtype': 'float64' }); const x = zeros( [ 3 ], { 'dtype': 'float64' }); + const uplo = zeros( [], { + 'dtype': 'int8' + }); const alpha = zeros( [], { 'dtype': 'float64' }); dspr(); // $ExpectError - dspr( [ x, A, alpha ], {} ); // $ExpectError + dspr( [ x, AP, uplo, alpha ], {} ); // $ExpectError } diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/examples/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/examples/index.js index 89344c512b56..4d93060ff283 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/examples/index.js @@ -18,11 +18,9 @@ '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 resolveEnum = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dspr = require( './../lib' ); @@ -30,10 +28,13 @@ var opts = { 'dtype': 'float64' }; -var x = new Float64Vector( discreteUniform( 4, 0, 10, opts ) ); -var A = new ndarray( 'float64', new Float64Array( discreteUniform( 10, 0, 10, opts ) ), [ 10 ], [ 1 ], 0, 'row-major' ); +var x = discreteUniform( [ 4 ], 0, 10, opts ); +var AP = discreteUniform( [ 10 ], 0, 10, opts ); +var uplo = scalar2ndarray( resolveEnum( 'upper' ), { + 'dtype': 'int8' +}); var alpha = scalar2ndarray( 3.0, opts ); -var out = dspr( [ x, A, alpha ] ); +var out = dspr( [ x, AP, uplo, alpha ] ); console.log( ndarray2array( out ) ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js index cae8294b8d5a..d63ce1ac061f 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js @@ -26,21 +26,23 @@ * @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 resolveEnum = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); * var dspr = require( '@stdlib/blas/base/ndarray/dspr' ); * * var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); -* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ), [ 6 ], [ 1 ], 0, 'row-major' ); +* var AP = new Float64Vector( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ); * +* var uplo = scalar2ndarray( resolveEnum( 'upper' ), { +* 'dtype': 'int8' +* }); * var alpha = scalar2ndarray( 1.0, { * 'dtype': 'float64' * }); * -* var out = dspr( [ x, A, alpha ] ); +* var out = dspr( [ x, AP, uplo, alpha ] ); * // returns [ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ] * -* var bool = ( out === A ); +* var bool = ( out === AP ); * // returns true */ diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js index 510745fec7c9..f2c36d709abd 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js @@ -20,26 +20,29 @@ // MODULES // -var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var getShape = require( '@stdlib/ndarray/base/shape' ); +var getOrder = require( '@stdlib/ndarray/base/order' ); 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 resolveStr = require( '@stdlib/blas/base/matrix-triangle-resolve-str' ); var strided = require( '@stdlib/blas/base/dspr' ).ndarray; // MAIN // /** -* Performs the symmetric rank 1 operation `A = alpha*x*x^T + A`, where `alpha` is a scalar, `x` is an ndarray, and `A` is an `N` by `N` symmetric matrix supplied in packed form. +* Performs the symmetric rank 1 operation `A = alpha*x*x^T + A`, where `alpha` is a scalar, `x` is a one-dimensional ndarray, and `A` is an `N` by `N` symmetric matrix supplied in packed form. * * ## Notes * * - The function expects the following ndarrays: * -* - first one-dimensional input ndarray. -* - second one-dimensional symmetric input ndarray. -* - first zero-dimensional ndarray containing a scalar constant. +* - a one-dimensional input ndarray corresponding to `x`. +* - a one-dimensional input/output ndarray corresponding to the packed form of `A`. +* - a zero-dimensional ndarray specifying whether the upper or lower triangular part of `A` is supplied. +* - a zero-dimensional ndarray containing a scalar constant corresponding to `alpha`. * * @param {ArrayLikeObject} arrays - array-like object containing ndarrays * @returns {Object} output ndarray @@ -47,28 +50,42 @@ var strided = require( '@stdlib/blas/base/dspr' ).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 resolveEnum = require( '@stdlib/blas/base/matrix-triangle-resolve-enum' ); * * var x = new Float64Vector( [ 1.0, 2.0, 3.0 ] ); -* var A = new ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ), [ 6 ], [ 1 ], 0, 'row-major' ); +* var AP = new Float64Vector( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ); * +* var uplo = scalar2ndarray( resolveEnum( 'upper' ), { +* 'dtype': 'int8' +* }); * var alpha = scalar2ndarray( 1.0, { * 'dtype': 'float64' * }); * -* var out = dspr( [ x, A, alpha ] ); +* var y = dspr( [ x, AP, uplo, alpha ] ); * // returns [ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ] * -* var bool = ( out === A ); +* var bool = ( y === AP ); * // returns true */ function dspr( arrays ) { - var alpha = ndarraylike2scalar( arrays[ 2 ] ); - var x = arrays[ 0 ]; - var A = arrays[ 1 ]; - strided( 'row-major', 'upper', numelDimension( x, 0 ), alpha, getData( x ), getStride( x, 0 ), getOffset( x ), getData( A ), getStride( A, 0 ), getOffset( A ) ); - return A; + var alpha; + var uplo; + var sh; + var AP; + var x; + + x = arrays[ 0 ]; + AP = arrays[ 1 ]; + + uplo = resolveStr( ndarraylike2scalar( arrays[ 2 ] ) ); + alpha = ndarraylike2scalar( arrays[ 3 ] ); + + sh = getShape( x, false ); + + strided( getOrder( AP ), uplo, sh[ 0 ], alpha, getData( x ), getStride( x, 0 ), getOffset( x ), getData( AP ), getStride( AP, 0 ), getOffset( AP ) ); + + return AP; } diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/test/test.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/test/test.js index ba19f61380ed..e997ac910c4f 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/test/test.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/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/matrix-triangle-resolve-enum' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var getData = require( '@stdlib/ndarray/data-buffer' ); var dspr = require( './../lib' ); @@ -59,11 +60,12 @@ tape( 'the function has an arity of 1', function test( t ) { t.end(); }); -tape( 'the function performs the symmetric rank 1 operation `A = alpha*x*x^T + A`', function test( t ) { +tape( 'the function performs the symmetric rank 1 operation `A = alpha*x*x^T + A` (upper)', function test( t ) { var expected; var alpha; var xbuf; var Abuf; + var uplo; var x; var A; var v; @@ -76,7 +78,11 @@ tape( 'the function performs the symmetric rank 1 operation `A = alpha*x*x^T + A 'dtype': 'float64' }); - v = dspr( [ x, A, alpha ] ); + uplo = scalar2ndarray( resolveEnum( 'upper' ), { + 'dtype': 'int8' + }); + + v = dspr( [ x, A, uplo, alpha ] ); expected = new Float64Array( [ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ] ); t.strictEqual( v, A, 'returns expected value' ); @@ -90,7 +96,11 @@ tape( 'the function performs the symmetric rank 1 operation `A = alpha*x*x^T + A 'dtype': 'float64' }); - v = dspr( [ x, A, alpha ] ); + uplo = scalar2ndarray( resolveEnum( 'upper' ), { + 'dtype': 'int8' + }); + + v = dspr( [ x, A, uplo, alpha ] ); expected = new Float64Array( [ 3.0, 6.0, 4.0, 7.0, 5.0, 8.0 ] ); t.strictEqual( v, A, 'returns expected value' ); @@ -99,11 +109,43 @@ tape( 'the function performs the symmetric rank 1 operation `A = alpha*x*x^T + A t.end(); }); +tape( 'the function performs the symmetric rank 1 operation `A = alpha*x*x^T + A` (lower)', function test( t ) { + var expected; + var alpha; + var xbuf; + var Abuf; + var uplo; + var x; + var A; + var v; + + xbuf = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + Abuf = new Float64Array( [ 1.0, 2.0, 1.0, 3.0, 2.0, 1.0 ] ); + A = vector( Abuf, 6, 1, 0 ); + x = vector( xbuf, 3, 1, 0 ); + alpha = scalar2ndarray( 1.0, { + 'dtype': 'float64' + }); + + uplo = scalar2ndarray( resolveEnum( 'lower' ), { + 'dtype': 'int8' + }); + + v = dspr( [ x, A, uplo, alpha ] ); + + expected = new Float64Array( [ 2.0, 4.0, 5.0, 6.0, 8.0, 10.0 ] ); + t.strictEqual( v, A, 'returns expected value' ); + t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'if `alpha` is `0`, the function returns `A` unchanged', function test( t ) { var expected; var alpha; var xbuf; var Abuf; + var uplo; var x; var A; var v; @@ -116,7 +158,11 @@ tape( 'if `alpha` is `0`, the function returns `A` unchanged', function test( t 'dtype': 'float64' }); - v = dspr( [ x, A, alpha ] ); + uplo = scalar2ndarray( resolveEnum( 'upper' ), { + 'dtype': 'int8' + }); + + v = dspr( [ x, A, uplo, alpha ] ); expected = new Float64Array( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ); t.strictEqual( v, A, 'returns expected value' ); @@ -130,11 +176,12 @@ tape( 'the function supports ndarrays having non-unit strides', function test( t var alpha; var xbuf; var Abuf; + var uplo; var x; 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, 1.0, 2.0, 1.0 ] ); A = vector( Abuf, 6, 1, 0 ); xbuf = new Float64Array([ @@ -150,9 +197,13 @@ tape( 'the function supports ndarrays having non-unit strides', function test( t 'dtype': 'float64' }); - v = dspr( [ x, A, alpha ] ); + uplo = scalar2ndarray( resolveEnum( 'upper' ), { + 'dtype': 'int8' + }); + + v = dspr( [ x, A, uplo, alpha ] ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.0, 12.0, 18.0 ] ); + expected = new Float64Array( [ 3.0, 6.0, 9.0, 9.0, 14.0, 19.0 ] ); t.strictEqual( v, A, 'returns expected value' ); t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); t.end(); @@ -163,27 +214,34 @@ tape( 'the function supports ndarrays having negative strides', function test( t var alpha; var xbuf; var Abuf; + var uplo; var x; 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, 1.0, 2.0, 1.0 ] ); A = vector( Abuf, 6, 1, 0 ); xbuf = new Float64Array([ 3.0, // 2 + 0.0, 2.0, // 1 + 0.0, 1.0 // 0 ]); - x = vector( xbuf, 3, -1, 2 ); + x = vector( xbuf, 3, -2, 4 ); alpha = scalar2ndarray( 2.0, { 'dtype': 'float64' }); - v = dspr( [ x, A, alpha ] ); + uplo = scalar2ndarray( resolveEnum( 'upper' ), { + 'dtype': 'int8' + }); + + v = dspr( [ x, A, uplo, alpha ] ); - expected = new Float64Array( [ 2.0, 4.0, 6.0, 8.0, 12.0, 18.0 ] ); + expected = new Float64Array( [ 3.0, 6.0, 9.0, 9.0, 14.0, 19.0 ] ); t.strictEqual( v, A, 'returns expected value' ); t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); t.end(); @@ -194,19 +252,20 @@ tape( 'the function supports ndarrays having non-zero offsets', function test( t var alpha; var xbuf; var Abuf; + var uplo; var x; var A; 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, + 1.0, + 2.0, + 1.0 ]); A = vector( Abuf, 6, 1, 2 ); @@ -223,17 +282,21 @@ tape( 'the function supports ndarrays having non-zero offsets', function test( t 'dtype': 'float64' }); - v = dspr( [ x, A, alpha ] ); + uplo = scalar2ndarray( resolveEnum( 'upper' ), { + 'dtype': 'int8' + }); + + v = dspr( [ x, A, uplo, alpha ] ); expected = new Float64Array([ - 999.0, - 999.0, - 2.0, - 4.0, + 0.0, + 0.0, + 3.0, 6.0, - 8.0, - 12.0, - 18.0 + 9.0, + 9.0, + 14.0, + 19.0 ]); t.strictEqual( v, A, 'returns expected value' ); t.strictEqual( isSameFloat64Array( getData( v ), expected ), true, 'returns expected value' ); From 89b06ede3d955300fe1610b817e171b70bca9f31 Mon Sep 17 00:00:00 2001 From: Kaustubh Patange Date: Wed, 15 Jul 2026 11:40:16 +0530 Subject: [PATCH 03/16] Update lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js Signed-off-by: Kaustubh Patange --- lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js index f2c36d709abd..0aa04f0a63f3 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js @@ -26,7 +26,6 @@ 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 resolveStr = require( '@stdlib/blas/base/matrix-triangle-resolve-str' ); var strided = require( '@stdlib/blas/base/dspr' ).ndarray; From f6dab2c67fc6341b7baa6f5409dfbfb2f8230ded Mon Sep 17 00:00:00 2001 From: Kaustubh Patange Date: Wed, 15 Jul 2026 11:40:24 +0530 Subject: [PATCH 04/16] Update lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js Signed-off-by: Kaustubh Patange --- lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js index 0aa04f0a63f3..7743b6810f95 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js @@ -77,7 +77,7 @@ function dspr( arrays ) { x = arrays[ 0 ]; AP = arrays[ 1 ]; - uplo = resolveStr( ndarraylike2scalar( arrays[ 2 ] ) ); + uplo = ndarraylike2scalar( arrays[ 2 ] ); alpha = ndarraylike2scalar( arrays[ 3 ] ); sh = getShape( x, false ); From 93d40a1296521d71a2ebc3b331a276d1cd8bef68 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 15 Jul 2026 21:05:35 -0700 Subject: [PATCH 05/16] Apply suggestions from code review Co-authored-by: Athan Signed-off-by: Athan --- .../@stdlib/blas/base/ndarray/dspr/lib/main.js | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js index 7743b6810f95..7ef79ea5e370 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/main.js @@ -20,7 +20,7 @@ // MODULES // -var getShape = require( '@stdlib/ndarray/base/shape' ); +var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); var getOrder = require( '@stdlib/ndarray/base/order' ); var getStride = require( '@stdlib/ndarray/base/stride' ); var getOffset = require( '@stdlib/ndarray/base/offset' ); @@ -70,7 +70,6 @@ var strided = require( '@stdlib/blas/base/dspr' ).ndarray; function dspr( arrays ) { var alpha; var uplo; - var sh; var AP; var x; @@ -80,9 +79,7 @@ function dspr( arrays ) { uplo = ndarraylike2scalar( arrays[ 2 ] ); alpha = ndarraylike2scalar( arrays[ 3 ] ); - sh = getShape( x, false ); - - strided( getOrder( AP ), uplo, sh[ 0 ], alpha, getData( x ), getStride( x, 0 ), getOffset( x ), getData( AP ), getStride( AP, 0 ), getOffset( AP ) ); + strided( getOrder( AP ), uplo, numelDimension( x, 0 ), alpha, getData( x ), getStride( x, 0 ), getOffset( x ), getData( AP ), getStride( AP, 0 ), getOffset( AP ) ); // eslint-disable-line max-len return AP; } From 2e536e03772abcd918909af7af4f51935d75261f Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 15 Jul 2026 21:06:51 -0700 Subject: [PATCH 06/16] Apply suggestions from code review Co-authored-by: Athan Signed-off-by: Athan --- .../@stdlib/blas/base/ndarray/dspr/benchmark/benchmark.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/benchmark/benchmark.js index f4cd83999d28..cf11dc1c66d6 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/benchmark/benchmark.js @@ -53,7 +53,7 @@ function createBenchmark( len ) { var AP; var x; - AP = uniform( [ (len * (len + 1)) / 2 ], -100.0, 100.0, options ); + AP = uniform( [ ( len * ( len+1 ) ) / 2 ], -100.0, 100.0, options ); x = uniform( [ len ], -100.0, 100.0, options ); uplo = scalar2ndarray( resolveEnum( 'upper' ), { From bd6af5c0b1da656238702437c31944aa43ebc41d Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 15 Jul 2026 21:11:56 -0700 Subject: [PATCH 07/16] Apply suggestions from code review Co-authored-by: Athan Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js index d63ce1ac061f..f052098c57a0 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* BLAS level 2 routine to perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`. +* BLAS level 2 routine to perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix `A` supplied in packed form. * * @module @stdlib/blas/base/ndarray/dspr * From e2e960e59211f0200e5df65058e4771f508c8c78 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 15 Jul 2026 21:15:17 -0700 Subject: [PATCH 08/16] Apply suggestions from code review Co-authored-by: Athan Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/ndarray/dspr/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/package.json b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/package.json index 13b06187dc71..1e1813b73bde 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/package.json +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/base/ndarray/dspr", "version": "0.0.0", - "description": "Perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`.", + "description": "Perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix `A` supplied in packed form.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", From 553341436b5de90fbbd3ca4b95fc114dc5c911ab Mon Sep 17 00:00:00 2001 From: kaustubh Date: Thu, 16 Jul 2026 10:49:07 +0530 Subject: [PATCH 09/16] fix: update 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: na - 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/dspr/README.md | 2 +- .../@stdlib/blas/base/ndarray/dspr/docs/repl.txt | 6 +++--- .../@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts | 3 +-- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md index 05b136d837cd..984d74d0a44e 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md @@ -40,7 +40,7 @@ var dspr = require( '@stdlib/blas/base/ndarray/dspr' ); #### dspr( arrays ) -Performs the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`, where `alpha` is a scalar, `x` is a one-dimensional ndarray, and `A` is an `N` by `N` matrix. +Performs the symmetric rank 1 operation `A = alpha*x*x^T + A`, where `alpha` is a scalar, `x` is a one-dimensional ndarray, and `A` is a symmetric `N` by `N` matrix supplied in packed form. ```javascript var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt index a9311a897900..9e15bcf22bfd 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( arrays ) - Performs the symmetric rank 1 operation `A = alpha*x*x^T + A` for a - symmetric matrix supplied in packed form `A`, where `alpha` is a scalar, - `x` is a one-dimensional ndarray, and `A` is an `N` by `N` matrix. + Performs the symmetric rank 1 operation `A = alpha*x*x^T + A`, where `alpha` + is a scalar, `x` is a one-dimensional ndarray, and `A` is a symmetric `N` + by `N` matrix supplied in packed form. Parameters ---------- diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts index 15ac07295aa6..fb91fcc47ceb 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts @@ -23,8 +23,7 @@ import { float64ndarray, ndarray } from '@stdlib/types/ndarray'; /** -* Performs the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`, where `alpha` is a scalar, `x` is a one-dimensional ndarray, and `A` is an `N` by `N` matrix. -* +* Performs the symmetric rank 1 operation `A = alpha*x*x^T + A`, where `alpha` is a scalar, `x` is a one-dimensional ndarray, and `A` is a symmetric `N` by `N` matrix supplied in packed form. * ## Notes * * - The function expects the following ndarrays: From 265802262b54eac88e0a259a09d31156a03efc28 Mon Sep 17 00:00:00 2001 From: Kaustubh Patange Date: Thu, 16 Jul 2026 22:35:44 +0530 Subject: [PATCH 10/16] Update lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts Signed-off-by: Kaustubh Patange --- .../@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts index fb91fcc47ceb..b1ff8ade9adf 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts @@ -24,6 +24,7 @@ import { float64ndarray, ndarray } from '@stdlib/types/ndarray'; /** * Performs the symmetric rank 1 operation `A = alpha*x*x^T + A`, where `alpha` is a scalar, `x` is a one-dimensional ndarray, and `A` is a symmetric `N` by `N` matrix supplied in packed form. +* * ## Notes * * - The function expects the following ndarrays: From 44719a86b707f0dc04f554cb87e9d3845614cb4a Mon Sep 17 00:00:00 2001 From: Kaustubh Patange Date: Thu, 16 Jul 2026 22:39:38 +0530 Subject: [PATCH 11/16] Update lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts Signed-off-by: Kaustubh Patange --- .../@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts index b1ff8ade9adf..43dcc7e6e0b7 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/types/index.d.ts @@ -24,7 +24,7 @@ import { float64ndarray, ndarray } from '@stdlib/types/ndarray'; /** * Performs the symmetric rank 1 operation `A = alpha*x*x^T + A`, where `alpha` is a scalar, `x` is a one-dimensional ndarray, and `A` is a symmetric `N` by `N` matrix supplied in packed form. -* +* * ## Notes * * - The function expects the following ndarrays: From ed7b6f59c02f5ac5cc6680493c9856d8a84d9775 Mon Sep 17 00:00:00 2001 From: Kaustubh Patange Date: Thu, 16 Jul 2026 22:48:26 +0530 Subject: [PATCH 12/16] Update lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md Signed-off-by: Kaustubh Patange --- lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md index 984d74d0a44e..3ae1c1d83ae0 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md @@ -20,7 +20,7 @@ limitations under the License. # dspr -> Perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix supplied in packed form `A`. +> Perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix `A` supplied in packed form. From 76f71619f693cf92e8223fe6036f9a3db4c278eb Mon Sep 17 00:00:00 2001 From: Athan Date: Thu, 16 Jul 2026 10:55:14 -0700 Subject: [PATCH 13/16] Apply suggestions from code review Co-authored-by: Athan Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt index 9e15bcf22bfd..2d023923a19a 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( arrays ) Performs the symmetric rank 1 operation `A = alpha*x*x^T + A`, where `alpha` - is a scalar, `x` is a one-dimensional ndarray, and `A` is a symmetric `N` - by `N` matrix supplied in packed form. + is a scalar, `x` is a one-dimensional ndarray, and `A` is a symmetric `N` by + `N` matrix supplied in packed form. Parameters ---------- From e67b6f44bda9793f12c6464a63cfdd1e54b275c8 Mon Sep 17 00:00:00 2001 From: Athan Date: Thu, 16 Jul 2026 10:56:16 -0700 Subject: [PATCH 14/16] Apply suggestions from code review Co-authored-by: Athan Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt index 2d023923a19a..ff6c68d0c614 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/docs/repl.txt @@ -31,7 +31,8 @@ > var AP = new {{alias:@stdlib/ndarray/vector/float64}}( apbuf ); > var uplo = {{alias:@stdlib/ndarray/from-scalar}}( 'upper' ); - > var alpha = {{alias:@stdlib/ndarray/from-scalar}}( 1.0, { 'dtype': 'float64' }); + > var opts = { 'dtype': 'float64' }; + > var alpha = {{alias:@stdlib/ndarray/from-scalar}}( 1.0, opts ); > {{alias}}( [ x, AP, uplo, alpha ] ); > AP From ccf5e2beba8db29f75cacd569831db28fc7a3db4 Mon Sep 17 00:00:00 2001 From: Athan Date: Thu, 16 Jul 2026 10:58:04 -0700 Subject: [PATCH 15/16] Apply suggestions from code review Co-authored-by: Athan Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md index 3ae1c1d83ae0..0800459aa86e 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md @@ -22,8 +22,6 @@ limitations under the License. > Perform the symmetric rank 1 operation `A = alpha*x*x^T + A` for a symmetric matrix `A` supplied in packed form. - -
From 999e209c91506149bb93a76c002e1d007fdedc3a Mon Sep 17 00:00:00 2001 From: Athan Date: Thu, 16 Jul 2026 10:59:13 -0700 Subject: [PATCH 16/16] Apply suggestions from code review Co-authored-by: Athan Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md index 0800459aa86e..7bd1fd11f61e 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/dspr/README.md @@ -85,8 +85,6 @@ The function has the following parameters: ## Examples - - ```javascript