From aab8fbbc0ce6ba700eaf965eecfd08a12b5f091c Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 10 May 2026 11:52:13 -0700 Subject: [PATCH] docs: improve doctests for complex number typed arrays in `utils/reduce-right` --- 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 status: passed - 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: na - task: lint_javascript_tests status: passed - 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: na - task: lint_license_headers status: passed --- --- lib/node_modules/@stdlib/utils/reduce-right/README.md | 8 +------- .../@stdlib/utils/reduce-right/lib/ndarray.js | 11 ++--------- .../@stdlib/utils/reduce-right/test/test.js | 2 +- 3 files changed, 4 insertions(+), 17 deletions(-) diff --git a/lib/node_modules/@stdlib/utils/reduce-right/README.md b/lib/node_modules/@stdlib/utils/reduce-right/README.md index 3d55594b91d3..6fe51472d025 100644 --- a/lib/node_modules/@stdlib/utils/reduce-right/README.md +++ b/lib/node_modules/@stdlib/utils/reduce-right/README.md @@ -139,13 +139,7 @@ var mean = out / ctx.count; var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); var v = reduceRight( x, new Complex64( 0.0, 0.0 ), sum ); - // returns - - var re = realf( v ); - // returns 16.0 - - var im = imagf( v ); - // returns 20.0 + // returns [ 16.0, 20.0 ] ``` - For [`ndarray`][@stdlib/ndarray/ctor]-like objects, the function performs a reduction over the entire input [`ndarray`][@stdlib/ndarray/ctor] (i.e., higher-order [`ndarray`][@stdlib/ndarray/ctor] dimensions are flattened to a single-dimension). diff --git a/lib/node_modules/@stdlib/utils/reduce-right/lib/ndarray.js b/lib/node_modules/@stdlib/utils/reduce-right/lib/ndarray.js index 64492c9e0c9e..947a13cbd921 100644 --- a/lib/node_modules/@stdlib/utils/reduce-right/lib/ndarray.js +++ b/lib/node_modules/@stdlib/utils/reduce-right/lib/ndarray.js @@ -52,9 +52,7 @@ var MODE = 'throw'; * @example * var Complex64Array = require( '@stdlib/array/complex64' ); * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); -* var cadd = require( '@stdlib/complex/float64/base/add' ); +* var cadd = require( '@stdlib/complex/float32/base/add' ); * var naryFunction = require( '@stdlib/utils/nary-function' ); * * // Create a data buffer: @@ -90,12 +88,7 @@ var MODE = 'throw'; * * // Compute the sum: * var v = reduceRight( x, new Complex64( 0.0, 0.0 ), naryFunction( cadd, 2 ) ); -* -* var re = realf( v ); -* // returns 16.0 -* -* var im = imagf( v ); -* // returns 20.0 +* // returns [ 16.0, 20.0 ] */ function reduceRight( x, initial, fcn, thisArg ) { var xbuf; diff --git a/lib/node_modules/@stdlib/utils/reduce-right/test/test.js b/lib/node_modules/@stdlib/utils/reduce-right/test/test.js index da627bf0af97..8d2a4d71d0e3 100644 --- a/lib/node_modules/@stdlib/utils/reduce-right/test/test.js +++ b/lib/node_modules/@stdlib/utils/reduce-right/test/test.js @@ -24,7 +24,7 @@ var tape = require( 'tape' ); var noop = require( '@stdlib/utils/noop' ); var naryFunction = require( '@stdlib/utils/nary-function' ); var add = require( '@stdlib/number/float64/base/add' ); -var cadd = require( '@stdlib/complex/float64/base/add' ); +var cadd = require( '@stdlib/complex/float32/base/add' ); var Float64Array = require( '@stdlib/array/float64' ); var Complex64Array = require( '@stdlib/array/complex64' ); var array = require( '@stdlib/ndarray/array' );