From 653eb0c237374efd9bbb614a091d4b737fac38f0 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 10 May 2026 11:43:08 -0700 Subject: [PATCH] docs: improve doctests for complex number typed arrays in `utils/map-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 --- --- .../@stdlib/utils/map-reduce-right/README.md | 12 +++--------- .../@stdlib/utils/map-reduce-right/lib/ndarray.js | 15 ++++----------- .../@stdlib/utils/map-reduce-right/test/test.js | 6 +++--- 3 files changed, 10 insertions(+), 23 deletions(-) diff --git a/lib/node_modules/@stdlib/utils/map-reduce-right/README.md b/lib/node_modules/@stdlib/utils/map-reduce-right/README.md index 85d7e0e3ecbe..e3f0c2d36ee4 100644 --- a/lib/node_modules/@stdlib/utils/map-reduce-right/README.md +++ b/lib/node_modules/@stdlib/utils/map-reduce-right/README.md @@ -136,7 +136,7 @@ var mean = out / ctx.count; ```javascript var Complex64Array = require( '@stdlib/array/complex64' ); var Complex64 = require( '@stdlib/complex/float32/ctor' ); - var cceil = require( '@stdlib/math/base/special/cceil' ); + var cceilf = require( '@stdlib/math/base/special/cceilf' ); var realf = require( '@stdlib/complex/float32/real' ); var imagf = require( '@stdlib/complex/float32/imag' ); @@ -150,14 +150,8 @@ var mean = out / ctx.count; var x = new Complex64Array( [ 1.5, 2.5, 3.5, 4.5, 5.5, 6.5, 7.5, 8.5 ] ); - var v = mapReduceRight( x, new Complex64( 0.0, 0.0 ), cceil, sum ); - // returns - - var re = realf( v ); - // returns 20.0 - - var im = imagf( v ); - // returns 24.0 + var v = mapReduceRight( x, new Complex64( 0.0, 0.0 ), cceilf, sum ); + // returns [ 20.0, 24.0 ] ``` - For [`ndarray`][@stdlib/ndarray/ctor]-like objects, the function performs a single-pass map-reduce operation 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/map-reduce-right/lib/ndarray.js b/lib/node_modules/@stdlib/utils/map-reduce-right/lib/ndarray.js index 645207cc3211..efa39bf133f1 100644 --- a/lib/node_modules/@stdlib/utils/map-reduce-right/lib/ndarray.js +++ b/lib/node_modules/@stdlib/utils/map-reduce-right/lib/ndarray.js @@ -53,10 +53,8 @@ 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 cceil = require( '@stdlib/math/base/special/cceil' ); -* var cadd = require( '@stdlib/complex/float64/base/add' ); +* var cceilf = require( '@stdlib/math/base/special/cceilf' ); +* var cadd = require( '@stdlib/complex/float32/base/add' ); * var naryFunction = require( '@stdlib/utils/nary-function' ); * * // Create a data buffer: @@ -91,13 +89,8 @@ var MODE = 'throw'; * x.ref = x; * * // Compute the sum: -* var v = mapReduceRight( x, new Complex64( 0.0, 0.0 ), naryFunction( cceil, 1 ), naryFunction( cadd, 2 ) ); -* -* var re = realf( v ); -* // returns 20.0 -* -* var im = imagf( v ); -* // returns 24.0 +* var v = mapReduceRight( x, new Complex64( 0.0, 0.0 ), naryFunction( cceilf, 1 ), naryFunction( cadd, 2 ) ); +* // returns [ 20.0, 24.0 ] */ function mapReduceRight( x, initial, mapper, reducer, thisArg ) { var xbuf; diff --git a/lib/node_modules/@stdlib/utils/map-reduce-right/test/test.js b/lib/node_modules/@stdlib/utils/map-reduce-right/test/test.js index 18df8d65fc35..0744bde9d128 100644 --- a/lib/node_modules/@stdlib/utils/map-reduce-right/test/test.js +++ b/lib/node_modules/@stdlib/utils/map-reduce-right/test/test.js @@ -24,9 +24,9 @@ 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 abs = require( '@stdlib/math/base/special/abs' ); -var cceil = require( '@stdlib/math/base/special/cceil' ); +var cceilf = require( '@stdlib/math/base/special/cceilf' ); var Float64Array = require( '@stdlib/array/float64' ); var Complex64Array = require( '@stdlib/array/complex64' ); var array = require( '@stdlib/ndarray/array' ); @@ -239,7 +239,7 @@ tape( 'the function performs a map-reduce operation for each element in an array var f1; var f2; - f1 = naryFunction( cceil, 1 ); + f1 = naryFunction( cceilf, 1 ); f2 = naryFunction( cadd, 2 ); arr = new Complex64Array( [ 1.5, 2.5, 3.5, 4.5, 5.5, 6.5 ] );