From 264b0f41a8c82c6498fc6ec539dc8b0a7ba970e3 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Sat, 13 Dec 2025 09:31:31 +0000 Subject: [PATCH] docs: improve doctests for complex number instances in math/base/special/cinvf --- 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/cinvf/README.md | 10 +--------- .../@stdlib/math/base/special/cinvf/docs/repl.txt | 6 +----- .../math/base/special/cinvf/docs/types/index.d.ts | 10 +--------- .../@stdlib/math/base/special/cinvf/lib/index.js | 10 +--------- .../@stdlib/math/base/special/cinvf/lib/main.js | 10 +--------- .../@stdlib/math/base/special/cinvf/lib/native.js | 10 +--------- 6 files changed, 6 insertions(+), 50 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/README.md b/lib/node_modules/@stdlib/math/base/special/cinvf/README.md index 07dfbb204e7b..1dd768314ca4 100644 --- a/lib/node_modules/@stdlib/math/base/special/cinvf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cinvf/README.md @@ -52,17 +52,9 @@ Computes the inverse of a single-precision complex floating-point number. ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var v = cinvf( new Complex64( 2.0, 4.0 ) ); -// returns - -var re = realf( v ); -// returns ~0.1 - -var im = imagf( v ); -// returns ~-0.2 +// returns [ ~0.1, ~-0.2 ] ``` diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cinvf/docs/repl.txt index 37c597852bc1..b49f8f232520 100644 --- a/lib/node_modules/@stdlib/math/base/special/cinvf/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cinvf/docs/repl.txt @@ -15,11 +15,7 @@ Examples -------- > var v = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 4.0 ) ) - - > var re = {{alias:@stdlib/complex/float32/real}}( v ) - ~0.1 - > var im = {{alias:@stdlib/complex/float32/imag}}( v ) - ~-0.2 + [ ~0.1, ~-0.2 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cinvf/docs/types/index.d.ts index 7f15446eeaba..6618b36444b2 100644 --- a/lib/node_modules/@stdlib/math/base/special/cinvf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cinvf/docs/types/index.d.ts @@ -30,17 +30,9 @@ import { Complex64 } from '@stdlib/types/complex'; * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * var v = cinvf( new Complex64( 2.0, 4.0 ) ); -* // returns -* -* var re = realf( v ); -* // returns ~0.1 -* -* var im = imagf( v ); -* // returns ~-0.2 +* // returns [ ~0.1, ~-0.2 ] */ declare function cinvf( z: Complex64 ): Complex64; diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cinvf/lib/index.js index b4a19232d16b..50b4970e6f0e 100644 --- a/lib/node_modules/@stdlib/math/base/special/cinvf/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cinvf/lib/index.js @@ -25,18 +25,10 @@ * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * var cinvf = require( '@stdlib/math/base/special/cinvf' ); * * var v = cinvf( new Complex64( 2.0, 4.0 ) ); -* // returns -* -* var re = realf( v ); -* // returns ~0.1 -* -* var im = imagf( v ); -* // returns ~-0.2 +* // returns [ ~0.1, ~-0.2 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cinvf/lib/main.js index 8d77bae1bfe2..1c62fe0ae259 100644 --- a/lib/node_modules/@stdlib/math/base/special/cinvf/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cinvf/lib/main.js @@ -55,17 +55,9 @@ var RECIP_EPS_SQR = f32( TWO / f32(EPS*EPS) ); * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * var v = cinvf( new Complex64( 2.0, 4.0 ) ); -* // returns -* -* var re = realf( v ); -* // returns ~0.1 -* -* var im = imagf( v ); -* // returns ~-0.2 +* // returns [ ~0.1, ~-0.2 ] */ function cinvf( z ) { var ab; diff --git a/lib/node_modules/@stdlib/math/base/special/cinvf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cinvf/lib/native.js index 7ec05a39d143..08adb68bc0a6 100644 --- a/lib/node_modules/@stdlib/math/base/special/cinvf/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cinvf/lib/native.js @@ -35,17 +35,9 @@ var addon = require( './../src/addon.node' ); * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * var v = cinvf( new Complex64( 2.0, 4.0 ) ); -* // returns -* -* var re = realf( v ); -* // returns ~0.1 -* -* var im = imagf( v ); -* // returns ~-0.2 +* // returns [ ~0.1, ~-0.2 ] */ function cinvf( z ) { var v = addon( z );