From 2d72c6d714eeda7851ffa214e30a4fe4ca64b521 Mon Sep 17 00:00:00 2001 From: prajjwalbajpai Date: Sat, 13 Dec 2025 23:18:11 +0530 Subject: [PATCH 1/2] docs: improve doctests for complex number instances in math/base/special/cround --- 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: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - 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 --- --- .../math/base/special/cround/README.md | 34 +++---------------- .../math/base/special/cround/docs/repl.txt | 6 +--- .../base/special/cround/docs/types/index.d.ts | 8 +---- .../math/base/special/cround/lib/index.js | 34 +++---------------- .../math/base/special/cround/lib/main.js | 34 +++---------------- .../math/base/special/cround/lib/native.js | 8 +---- .../math/base/special/cround/src/main.c | 7 +--- 7 files changed, 16 insertions(+), 115 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cround/README.md b/lib/node_modules/@stdlib/math/base/special/cround/README.md index 39537bfcad52..3669e00e181a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cround/README.md @@ -36,44 +36,18 @@ Rounds each component of a double-precision complex floating-point number to the ```javascript var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var v = cround( new Complex128( -4.2, 5.5 ) ); -// returns - -var re = real( v ); -// returns -4.0 - -var im = imag( v ); -// returns 6.0 +// returns [ -4.0, 6.0 ] v = cround( new Complex128( 9.99999, 0.1 ) ); -// returns - -re = real( v ); -// returns 10.0 - -im = imag( v ); -// returns 0.0 +// returns [ 10.0, 0.0 ] v = cround( new Complex128( 0.0, 0.0 ) ); -// returns - -re = real( v ); -// returns 0.0 - -im = imag( v ); -// returns 0.0 +// returns [ 0.0, 0.0 ] v = cround( new Complex128( NaN, NaN ) ); -// returns - -re = real( v ); -// returns NaN - -im = imag( v ); -// returns NaN +// returns [ NaN, NaN ] ``` diff --git a/lib/node_modules/@stdlib/math/base/special/cround/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cround/docs/repl.txt index be325525460a..ed31621f112a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cround/docs/repl.txt @@ -16,11 +16,7 @@ Examples -------- > var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 5.5, 3.3 ) ) - - > var re = {{alias:@stdlib/complex/float64/real}}( v ) - 6.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( v ) - 3.0 + [ 6.0, 3.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts index 8a164837fe82..5aa41d145a06 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cround/docs/types/index.d.ts @@ -34,13 +34,7 @@ import { Complex128 } from '@stdlib/types/complex'; * var imag = require( '@stdlib/complex/float64/imag' ); * * var v = cround( new Complex128( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -4.0 -* -* var im = imag( v ); -* // returns 6.0 +* // returns [ -4.0, 6.0 ] */ declare function cround( z: Complex128 ): Complex128; diff --git a/lib/node_modules/@stdlib/math/base/special/cround/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cround/lib/index.js index 37a7df1d1607..76009cce59ab 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cround/lib/index.js @@ -25,45 +25,19 @@ * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var cround = require( '@stdlib/math/base/special/cround' ); * * var v = cround( new Complex128( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -4.0 -* -* var im = imag( v ); -* // returns 6.0 +* // returns [ -4.0, 6.0 ] * * v = cround( new Complex128( 9.99999, 0.1 ) ); -* // returns -* -* re = real( v ); -* // returns 10.0 -* -* im = imag( v ); -* // returns 0.0 +* // returns [ 10.0, 0.0 ] * * v = cround( new Complex128( 0.0, 0.0 ) ); -* // returns -* -* re = real( v ); -* // returns 0.0 -* -* im = imag( v ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * v = cround( new Complex128( NaN, NaN ) ); -* // returns -* -* re = real( v ); -* // returns NaN -* -* im = imag( v ); -* // returns NaN +* // returns [ NaN, NaN ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/math/base/special/cround/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cround/lib/main.js index 917196aabbe5..bc76f77dca6c 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cround/lib/main.js @@ -36,44 +36,18 @@ var imag = require( '@stdlib/complex/float64/imag' ); * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var v = cround( new Complex128( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -4.0 -* -* var im = imag( v ); -* // returns 6.0 +* // returns [ -4.0, 6.0 ] * * v = cround( new Complex128( 9.99999, 0.1 ) ); -* // returns -* -* re = real( v ); -* // returns 10.0 -* -* im = imag( v ); -* // returns 0.0 +* // returns [ 10.0, 0.0 ] * * v = cround( new Complex128( 0.0, 0.0 ) ); -* // returns -* -* re = real( v ); -* // returns 0.0 -* -* im = imag( v ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * v = cround( new Complex128( NaN, NaN ) ); -* // returns -* -* re = real( v ); -* // returns NaN -* -* im = imag( v ); -* // returns NaN +* // returns [ NaN, NaN ] */ function cround( z ) { return new Complex128( round( real( z ) ), round( imag( z ) ) ); diff --git a/lib/node_modules/@stdlib/math/base/special/cround/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cround/lib/native.js index 8510309c60fe..74884cb53157 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cround/lib/native.js @@ -39,13 +39,7 @@ var addon = require( './../src/addon.node' ); * var imag = require( '@stdlib/complex/float64/imag' ); * * var v = cround( new Complex128( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -4 -* -* var im = imag( v ); -* // returns 6.0 +* // returns [ -4, 6.0 ] */ function cround( z ) { var v = addon( z ); diff --git a/lib/node_modules/@stdlib/math/base/special/cround/src/main.c b/lib/node_modules/@stdlib/math/base/special/cround/src/main.c index 3e8ffb2ee089..55974e527707 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/cround/src/main.c @@ -35,12 +35,7 @@ * stdlib_complex128_t z = stdlib_complex128( -4.2, 5.5 ); * * stdlib_complex128_t out = stdlib_base_cround( z ); -* -* double re = stdlib_complex128_real( out ); -* // returns -5.0 -* -* double im = stdlib_complex128_imag( out ); -* // returns 6.0 +* // returns [ -5.0, 6.0 ] */ stdlib_complex128_t stdlib_base_cround( const stdlib_complex128_t z ) { double re; From ecb8e13f4577d777e641a4623ae5925719cb08a9 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 13 Dec 2025 12:34:25 -0600 Subject: [PATCH 2/2] style: format as floating-point number Signed-off-by: Philipp Burckhardt --- lib/node_modules/@stdlib/math/base/special/cround/lib/native.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cround/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cround/lib/native.js index 74884cb53157..4fa5c5e6c84f 100644 --- a/lib/node_modules/@stdlib/math/base/special/cround/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cround/lib/native.js @@ -39,7 +39,7 @@ var addon = require( './../src/addon.node' ); * var imag = require( '@stdlib/complex/float64/imag' ); * * var v = cround( new Complex128( -4.2, 5.5 ) ); -* // returns [ -4, 6.0 ] +* // returns [ -4.0, 6.0 ] */ function cround( z ) { var v = addon( z );