From dc59b99c995d3635b1e627360e4bef65894c5e4e Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Sat, 13 Dec 2025 13:11:43 +0000 Subject: [PATCH] docs: improve doctests for complex number instances in math/base/special/cinv --- 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 --- --- .../@stdlib/math/base/special/cinv/README.md | 10 +--------- .../@stdlib/math/base/special/cinv/docs/repl.txt | 6 +----- .../math/base/special/cinv/docs/types/index.d.ts | 10 +--------- .../@stdlib/math/base/special/cinv/lib/index.js | 10 +--------- .../@stdlib/math/base/special/cinv/lib/main.js | 10 +--------- .../@stdlib/math/base/special/cinv/lib/native.js | 10 +--------- 6 files changed, 6 insertions(+), 50 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cinv/README.md b/lib/node_modules/@stdlib/math/base/special/cinv/README.md index 190733d72b86..7b03197f06c0 100644 --- a/lib/node_modules/@stdlib/math/base/special/cinv/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cinv/README.md @@ -53,17 +53,9 @@ Computes the inverse of a double-precision complex floating-point number. ```javascript var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var v = cinv( new Complex128( 2.0, 4.0 ) ); -// returns - -var re = real( v ); -// returns 0.1 - -var im = imag( v ); -// returns -0.2 +// returns [ 0.1, -0.2 ] ``` diff --git a/lib/node_modules/@stdlib/math/base/special/cinv/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cinv/docs/repl.txt index cdc0699c71c3..7e848a94c643 100644 --- a/lib/node_modules/@stdlib/math/base/special/cinv/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cinv/docs/repl.txt @@ -15,11 +15,7 @@ Examples -------- > var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 4.0 ) ) - - > var re = {{alias:@stdlib/complex/float64/real}}( v ) - 0.1 - > var im = {{alias:@stdlib/complex/float64/imag}}( v ) - -0.2 + [ 0.1, -0.2 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cinv/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cinv/docs/types/index.d.ts index 8331e987c322..826f31dc6b66 100644 --- a/lib/node_modules/@stdlib/math/base/special/cinv/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cinv/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 = cinv( new Complex128( 2.0, 4.0 ) ); -* // returns -* -* var re = real( v ); -* // returns 0.1 -* -* var im = imag( v ); -* // returns -0.2 +* // returns [ ~0.1, ~-0.2 ] */ declare function cinv( z: Complex128 ): Complex128; diff --git a/lib/node_modules/@stdlib/math/base/special/cinv/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cinv/lib/index.js index dba5a250e28d..28440e7d4f0f 100644 --- a/lib/node_modules/@stdlib/math/base/special/cinv/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cinv/lib/index.js @@ -25,18 +25,10 @@ * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var cinv = require( '@stdlib/math/base/special/cinv' ); * * var v = cinv( new Complex128( 2.0, 4.0 ) ); -* // returns -* -* var re = real( v ); -* // returns 0.1 -* -* var im = imag( v ); -* // returns -0.2 +* // returns [ 0.1, -0.2 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/math/base/special/cinv/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cinv/lib/main.js index 3e4bd5d2706a..71630700830a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cinv/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cinv/lib/main.js @@ -51,17 +51,9 @@ var RECIP_EPS_SQR = 2.0 / ( EPS * EPS ); * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var v = cinv( new Complex128( 2.0, 4.0 ) ); -* // returns -* -* var re = real( v ); -* // returns 0.1 -* -* var im = imag( v ); -* // returns -0.2 +* // returns [ 0.1, -0.2 ] */ function cinv( z ) { var ab; diff --git a/lib/node_modules/@stdlib/math/base/special/cinv/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cinv/lib/native.js index 03a2a1211279..012278d8c1e5 100644 --- a/lib/node_modules/@stdlib/math/base/special/cinv/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cinv/lib/native.js @@ -35,17 +35,9 @@ 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 = cinv( new Complex128( 2.0, 4.0 ) ); -* // returns -* -* var re = real( v ); -* // returns 0.1 -* -* var im = imag( v ); -* // returns -0.2 +* // returns [ 0.1, -0.2 ] */ function cinv( z ) { var v = addon( z );