From 72c8accde43bbb0e28ee97568ebd1df4e43e35e6 Mon Sep 17 00:00:00 2001 From: prajjwalbajpai Date: Sun, 14 Dec 2025 18:31:45 +0530 Subject: [PATCH 1/2] docs: improve doctests for complex number instances in `math/base/special/csignumf` --- 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/csignumf/README.md | 27 +++---------------- .../math/base/special/csignumf/docs/repl.txt | 6 +---- .../special/csignumf/docs/types/index.d.ts | 10 +------ .../math/base/special/csignumf/lib/index.js | 26 +++--------------- .../math/base/special/csignumf/lib/main.js | 26 +++--------------- .../math/base/special/csignumf/lib/native.js | 26 +++--------------- .../math/base/special/csignumf/src/main.c | 7 +---- 7 files changed, 15 insertions(+), 113 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/csignumf/README.md b/lib/node_modules/@stdlib/math/base/special/csignumf/README.md index cb5d79226780..ac0c4d8f21f4 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignumf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/csignumf/README.md @@ -46,35 +46,14 @@ Evaluates the [signum][signum] function of a single-precision complex floating-p ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var real = require( '@stdlib/complex/float32/real' ); -var imag = require( '@stdlib/complex/float32/imag' ); - var v = csignumf( new Complex64( -4.2, 5.5 ) ); -// returns - -var re = real( v ); -// returns ~-0.607 - -var im = imag( v ); -// returns ~0.795 +// returns [ ~-0.607, ~0.795 ] v = csignumf( new Complex64( 0.0, 0.0 ) ); -// returns - -re = real( v ); -// returns 0.0 - -im = imag( v ); -// returns 0.0 +// returns [ 0.0, 0.0 ] v = csignumf( new Complex64( 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/csignumf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/csignumf/docs/repl.txt index 7e43ca521e76..14d03ebda893 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignumf/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/csignumf/docs/repl.txt @@ -16,11 +16,7 @@ Examples -------- > var v = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( -4.2, 5.5 ) ) - - > var re = {{alias:@stdlib/complex/float32/real}}( v ) - ~-0.607 - > var im = {{alias:@stdlib/complex/float32/imag}}( v ) - ~0.795 + [ ~-0.607, ~0.795 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/csignumf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/csignumf/docs/types/index.d.ts index 329284c21864..90bd61291698 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignumf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/csignumf/docs/types/index.d.ts @@ -30,17 +30,9 @@ import { Complex64 } from '@stdlib/types/complex'; * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * * var v = csignumf( new Complex64( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns ~-0.607 -* -* var im = imag( v ); -* // returns ~0.795 +* // returns [ ~-0.607, ~0.795 ] */ declare function csignumf( z: Complex64 ): Complex64; diff --git a/lib/node_modules/@stdlib/math/base/special/csignumf/lib/index.js b/lib/node_modules/@stdlib/math/base/special/csignumf/lib/index.js index 6c012fe58fee..fe7882c8607e 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignumf/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/csignumf/lib/index.js @@ -25,36 +25,16 @@ * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * var csignumf = require( '@stdlib/math/base/special/csignumf' ); * * var v = csignumf( new Complex64( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns ~-0.607 -* -* var im = imag( v ); -* // returns ~0.795 +* // returns [ ~-0.607, ~0.795 ] * * v = csignumf( new Complex64( 0.0, 0.0 ) ); -* // returns -* -* re = real( v ); -* // returns 0.0 -* -* im = imag( v ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * v = csignumf( new Complex64( 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/csignumf/lib/main.js b/lib/node_modules/@stdlib/math/base/special/csignumf/lib/main.js index 69bcb5693dcd..6621bc7e1f34 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignumf/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/csignumf/lib/main.js @@ -37,35 +37,15 @@ var cabsf = require( '@stdlib/math/base/special/cabsf' ); * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * * var v = csignumf( new Complex64( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns ~-0.607 -* -* var im = imag( v ); -* // returns ~0.795 +* // returns [ ~-0.607, ~0.795 ] * * v = csignumf( new Complex64( 0.0, 0.0 ) ); -* // returns -* -* re = real( v ); -* // returns 0.0 -* -* im = imag( v ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * v = csignumf( new Complex64( NaN, NaN ) ); -* // returns -* -* re = real( v ); -* // returns NaN -* -* im = imag( v ); -* // returns NaN +* // returns [ NaN, NaN ] */ function csignumf( z ) { var re; diff --git a/lib/node_modules/@stdlib/math/base/special/csignumf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/csignumf/lib/native.js index d7e8af5dbc2a..bab63d9c7e57 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignumf/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/csignumf/lib/native.js @@ -35,35 +35,15 @@ var addon = require( './../src/addon.node' ); * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * * var v = csignumf( new Complex64( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns ~-0.607 -* -* var im = imag( v ); -* // returns ~0.795 +* // returns [ ~-0.607, ~0.795 ] * * v = csignumf( new Complex64( 0.0, 0.0 ) ); -* // returns -* -* re = real( v ); -* // returns 0.0 -* -* im = imag( v ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * v = csignumf( new Complex64( NaN, NaN ) ); -* // returns -* -* re = real( v ); -* // returns NaN -* -* im = imag( v ); -* // returns NaN +* // returns [ NaN, NaN ] */ function csignumf( z ) { var v = addon( z ); diff --git a/lib/node_modules/@stdlib/math/base/special/csignumf/src/main.c b/lib/node_modules/@stdlib/math/base/special/csignumf/src/main.c index a60bef26518d..f517b15976f8 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignumf/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/csignumf/src/main.c @@ -35,12 +35,7 @@ * stdlib_complex64_t z = stdlib_complex64( -4.2f, 5.5f ); * * stdlib_complex64_t out = stdlib_base_csignumf( z ); -* -* float re = stdlib_complex64_real( out ); -* // returns ~-0.607f -* -* float im = stdlib_complex64_imag( out ); -* // returns ~0.795f +* // returns [ ~-0.607f, ~0.795f ] */ stdlib_complex64_t stdlib_base_csignumf( const stdlib_complex64_t z ) { float re; From bceb4b549b2bb90906b3041fb471d278e737f116 Mon Sep 17 00:00:00 2001 From: Athan Date: Mon, 15 Dec 2025 23:05:45 -0800 Subject: [PATCH 2/2] Discard changes to lib/node_modules/@stdlib/math/base/special/csignumf/src/main.c --- .../@stdlib/math/base/special/csignumf/src/main.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/csignumf/src/main.c b/lib/node_modules/@stdlib/math/base/special/csignumf/src/main.c index f517b15976f8..a60bef26518d 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignumf/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/csignumf/src/main.c @@ -35,7 +35,12 @@ * stdlib_complex64_t z = stdlib_complex64( -4.2f, 5.5f ); * * stdlib_complex64_t out = stdlib_base_csignumf( z ); -* // returns [ ~-0.607f, ~0.795f ] +* +* float re = stdlib_complex64_real( out ); +* // returns ~-0.607f +* +* float im = stdlib_complex64_imag( out ); +* // returns ~0.795f */ stdlib_complex64_t stdlib_base_csignumf( const stdlib_complex64_t z ) { float re;