From b9fb68f2c63f954a790a2764fb4d29705d58bdc4 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Fri, 12 Dec 2025 19:48:20 +0000 Subject: [PATCH] docs: improve doctests for complex number instances in math/base/special/ccis --- 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: na - task: lint_license_headers status: passed --- --- .../@stdlib/math/base/special/ccis/README.md | 18 ++--------------- .../math/base/special/ccis/docs/repl.txt | 12 ++--------- .../math/base/special/ccis/lib/index.js | 20 ++----------------- .../math/base/special/ccis/lib/main.js | 20 ++----------------- .../math/base/special/ccis/lib/native.js | 20 ++----------------- 5 files changed, 10 insertions(+), 80 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/ccis/README.md b/lib/node_modules/@stdlib/math/base/special/ccis/README.md index c9fe8cf31be2..8e664ac6adb9 100644 --- a/lib/node_modules/@stdlib/math/base/special/ccis/README.md +++ b/lib/node_modules/@stdlib/math/base/special/ccis/README.md @@ -57,30 +57,16 @@ Evaluates the [cis][cis] function for a double-precision complex floating-point ```javascript var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var z = new Complex128( 0.0, 0.0 ); var v = ccis( z ); -// returns - -var re = real( v ); -// returns 1.0 - -var im = imag( v ); -// returns 0.0 +// returns [ 1.0, 0.0 ] z = new Complex128( 1.0, 0.0 ); v = ccis( z ); -// returns - -re = real( v ); -// returns ~0.540 - -im = imag( v ); -// returns ~0.841 +// returns [ ~0.540, ~0.841 ] ``` diff --git a/lib/node_modules/@stdlib/math/base/special/ccis/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/ccis/docs/repl.txt index 9f3170bbe396..a1d607c7034c 100644 --- a/lib/node_modules/@stdlib/math/base/special/ccis/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/ccis/docs/repl.txt @@ -16,17 +16,9 @@ Examples -------- > var y = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 0.0, 0.0 ) ) - - > var re = {{alias:@stdlib/complex/float64/real}}( y ) - 1.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( y ) - 0.0 + [ 1.0, 0.0 ] > y = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 0.0 ) ) - - > re = {{alias:@stdlib/complex/float64/real}}( y ) - ~0.540 - > im = {{alias:@stdlib/complex/float64/imag}}( y ) - ~0.841 + [ ~0.540, ~0.841 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/ccis/lib/index.js b/lib/node_modules/@stdlib/math/base/special/ccis/lib/index.js index 93b565bbfe7f..cfff45a8c8d3 100644 --- a/lib/node_modules/@stdlib/math/base/special/ccis/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/ccis/lib/index.js @@ -25,39 +25,23 @@ * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var ccis = require( '@stdlib/math/base/special/ccis' ); * * var z = new Complex128( 0.0, 0.0 ); * // returns * * var out = ccis( z ); -* // returns -* -* var re = real( out ); -* // returns 1.0 -* -* var im = imag( out ); -* // returns 0.0 +* // returns [ 1.0, 0.0 ] * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var ccis = require( '@stdlib/math/base/special/ccis' ); * * var z = new Complex128( 1.0, 0.0 ); * // returns * * var out = ccis( z ); -* // returns -* -* var re = real( out ); -* // returns ~0.540 -* -* var im = imag( out ); -* // returns ~0.841 +* // returns [ ~0.540, ~0.841 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/math/base/special/ccis/lib/main.js b/lib/node_modules/@stdlib/math/base/special/ccis/lib/main.js index d55136d563c3..bc72cce7eb06 100644 --- a/lib/node_modules/@stdlib/math/base/special/ccis/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/ccis/lib/main.js @@ -43,37 +43,21 @@ var WORKSPACE = [ 0.0, 0.0 ]; * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var z = new Complex128( 0.0, 0.0 ); * // returns * * var out = ccis( z ); -* // returns -* -* var re = real( out ); -* // returns 1.0 -* -* var im = imag( out ); -* // returns 0.0 +* // returns [ 1.0, 0.0 ] * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var z = new Complex128( 1.0, 0.0 ); * // returns * * var out = ccis( z ); -* // returns -* -* var re = real( out ); -* // returns ~0.54 -* -* var im = imag( out ); -* // returns ~0.841 +* // returns [ ~0.540, ~0.841 ] */ function ccis( z ) { var re; diff --git a/lib/node_modules/@stdlib/math/base/special/ccis/lib/native.js b/lib/node_modules/@stdlib/math/base/special/ccis/lib/native.js index eb42e01cd28a..ca95bfdd71ba 100644 --- a/lib/node_modules/@stdlib/math/base/special/ccis/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/ccis/lib/native.js @@ -35,37 +35,21 @@ 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 z = new Complex128( 0.0, 0.0 ); * // returns * * var out = ccis( z ); -* // returns -* -* var re = real( out ); -* // returns 1.0 -* -* var im = imag( out ); -* // returns 0.0 +* // returns [ 1.0, 0.0 ] * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var z = new Complex128( 1.0, 0.0 ); * // returns * * var out = ccis( z ); -* // returns -* -* var re = real( out ); -* // returns ~0.540 -* -* var im = imag( out ); -* // returns ~0.841 +* // returns [ ~0.540, ~0.841 ] */ function ccis( z ) { var v = addon( z );