From 584bd29d3fbfc982cfb75769d5b4b1dd10435520 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Fri, 12 Dec 2025 19:23:24 +0000 Subject: [PATCH] docs: improve doctests for complex number instances in math/base/special/csignum --- 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: 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 --- --- .../math/base/special/csignum/README.md | 26 +++---------------- .../math/base/special/csignum/docs/repl.txt | 6 +---- .../special/csignum/docs/types/index.d.ts | 10 +------ .../math/base/special/csignum/lib/index.js | 26 +++---------------- .../math/base/special/csignum/lib/main.js | 26 +++---------------- .../math/base/special/csignum/lib/native.js | 26 +++---------------- 6 files changed, 14 insertions(+), 106 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/csignum/README.md b/lib/node_modules/@stdlib/math/base/special/csignum/README.md index a05a29f1372e..a3c8fdd72fff 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignum/README.md +++ b/lib/node_modules/@stdlib/math/base/special/csignum/README.md @@ -46,35 +46,15 @@ Evaluates the [signum][signum] function of a double-precision complex floating-p ```javascript var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var v = csignum( new Complex128( -4.2, 5.5 ) ); -// returns - -var re = real( v ); -// returns -0.6069136033622302 - -var im = imag( v ); -// returns 0.79476781392673 +// returns [ -0.6069136033622302, 0.79476781392673 ] v = csignum( 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 = csignum( 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/csignum/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/csignum/docs/repl.txt index cc72c0b366f9..b5ea32acd77b 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignum/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/csignum/docs/repl.txt @@ -16,11 +16,7 @@ Examples -------- > var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( -4.2, 5.5 ) ) - - > var re = {{alias:@stdlib/complex/float64/real}}( v ) - -0.6069136033622302 - > var im = {{alias:@stdlib/complex/float64/imag}}( v ) - 0.79476781392673 + [ -0.6069136033622302, 0.79476781392673 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/csignum/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/csignum/docs/types/index.d.ts index 72c35cb28911..e8ca6ee173fb 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignum/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/csignum/docs/types/index.d.ts @@ -30,17 +30,9 @@ import { Complex128 } from '@stdlib/types/complex'; * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var v = csignum( new Complex128( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -0.6069136033622302 -* -* var im = imag( v ); -* // returns 0.79476781392673 +* // returns [ -0.6069136033622302, 0.79476781392673 ] */ declare function csignum( z: Complex128 ): Complex128; diff --git a/lib/node_modules/@stdlib/math/base/special/csignum/lib/index.js b/lib/node_modules/@stdlib/math/base/special/csignum/lib/index.js index 32dfd754f2da..2faba32cb5c6 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignum/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/csignum/lib/index.js @@ -25,36 +25,16 @@ * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var csignum = require( '@stdlib/math/base/special/csignum' ); * * var v = csignum( new Complex128( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -0.6069136033622302 -* -* var im = imag( v ); -* // returns 0.79476781392673 +* // returns [ -0.6069136033622302, 0.79476781392673 ] * * v = csignum( 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 = csignum( 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/csignum/lib/main.js b/lib/node_modules/@stdlib/math/base/special/csignum/lib/main.js index 283e21b53762..8fb4f63b7b38 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignum/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/csignum/lib/main.js @@ -36,35 +36,15 @@ var cabs = require( '@stdlib/math/base/special/cabs' ); * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var v = csignum( new Complex128( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -0.6069136033622302 -* -* var im = imag( v ); -* // returns 0.79476781392673 +* // returns [ -0.6069136033622302, 0.79476781392673 ] * * v = csignum( 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 = csignum( new Complex128( NaN, NaN ) ); -* // returns -* -* re = real( v ); -* // returns NaN -* -* im = imag( v ); -* // returns NaN +* // returns [ NaN, NaN ] */ function csignum( z ) { var re; diff --git a/lib/node_modules/@stdlib/math/base/special/csignum/lib/native.js b/lib/node_modules/@stdlib/math/base/special/csignum/lib/native.js index 25811f224e8d..3023dcd68a74 100644 --- a/lib/node_modules/@stdlib/math/base/special/csignum/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/csignum/lib/native.js @@ -35,35 +35,15 @@ var addon = require( './../src/addon.node' ); * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var v = csignum( new Complex128( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -0.6069136033622302 -* -* var im = imag( v ); -* // returns 0.79476781392673 +* // returns [ -0.6069136033622302, 0.79476781392673 ] * * v = csignum( 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 = csignum( new Complex128( NaN, NaN ) ); -* // returns -* -* re = real( v ); -* // returns NaN -* -* im = imag( v ); -* // returns NaN +* // returns [ NaN, NaN ] */ function csignum( z ) { var v = addon( z );