From 1061e9ad6256ca35c563529d6181e6cbce16682c Mon Sep 17 00:00:00 2001 From: ShabiShett07 Date: Sun, 8 Jun 2025 14:23:33 +0530 Subject: [PATCH] docs: update examples for complex/float64/base/sub --- 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: na - 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/complex/float64/base/sub/README.md | 10 +--------- .../complex/float64/base/sub/docs/types/index.d.ts | 13 +------------ .../@stdlib/complex/float64/base/sub/lib/index.js | 13 +------------ .../@stdlib/complex/float64/base/sub/lib/main.js | 13 +------------ .../@stdlib/complex/float64/base/sub/lib/native.js | 13 +------------ 5 files changed, 5 insertions(+), 57 deletions(-) diff --git a/lib/node_modules/@stdlib/complex/float64/base/sub/README.md b/lib/node_modules/@stdlib/complex/float64/base/sub/README.md index 17e14f39814f..473e74e35c2b 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/sub/README.md +++ b/lib/node_modules/@stdlib/complex/float64/base/sub/README.md @@ -42,20 +42,12 @@ Subtracts two double-precision complex floating-point numbers. ```javascript var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var z1 = new Complex128( 5.0, 3.0 ); var z2 = new Complex128( -2.0, 1.0 ); var v = csub( z1, z2 ); -// returns - -var re = real( v ); -// returns 7.0 - -var im = imag( v ); -// returns 2.0 +// returns [ 7.0, 2.0 ] ``` diff --git a/lib/node_modules/@stdlib/complex/float64/base/sub/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/float64/base/sub/docs/types/index.d.ts index 8f2e6f3ea4c4..d07c5dbc41cd 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/sub/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/complex/float64/base/sub/docs/types/index.d.ts @@ -31,23 +31,12 @@ 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 z1 = new Complex128( 5.0, 3.0 ); -* // returns -* * var z2 = new Complex128( -2.0, 1.0 ); -* // returns * * var out = csub( z1, z2 ); -* // returns -* -* var re = real( out ); -* // returns 7.0 -* -* var im = imag( out ); -* // returns 2.0 +* // returns [ 7.0, 2.0 ] */ declare function csub( z1: Complex128, z2: Complex128 ): Complex128; diff --git a/lib/node_modules/@stdlib/complex/float64/base/sub/lib/index.js b/lib/node_modules/@stdlib/complex/float64/base/sub/lib/index.js index 863fefb067ff..26cd23a5ad43 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/sub/lib/index.js +++ b/lib/node_modules/@stdlib/complex/float64/base/sub/lib/index.js @@ -25,24 +25,13 @@ * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var csub = require( '@stdlib/complex/float64/base/sub' ); * * var z1 = new Complex128( 5.0, 3.0 ); -* // returns -* * var z2 = new Complex128( -2.0, 1.0 ); -* // returns * * var out = csub( z1, z2 ); -* // returns -* -* var re = real( out ); -* // returns 7.0 -* -* var im = imag( out ); -* // returns 2.0 +* // returns [ 7.0, 2.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/complex/float64/base/sub/lib/main.js b/lib/node_modules/@stdlib/complex/float64/base/sub/lib/main.js index eceddf57da3c..cd0b77cbdfdd 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/sub/lib/main.js +++ b/lib/node_modules/@stdlib/complex/float64/base/sub/lib/main.js @@ -36,23 +36,12 @@ var imag = require( '@stdlib/complex/float64/imag' ); * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var z1 = new Complex128( 5.0, 3.0 ); -* // returns -* * var z2 = new Complex128( -2.0, 1.0 ); -* // returns * * var out = csub( z1, z2 ); -* // returns -* -* var re = real( out ); -* // returns 7.0 -* -* var im = imag( out ); -* // returns 2.0 +* // returns [ 7.0, 2.0 ] */ function csub( z1, z2 ) { var re = real( z1 ) - real( z2 ); diff --git a/lib/node_modules/@stdlib/complex/float64/base/sub/lib/native.js b/lib/node_modules/@stdlib/complex/float64/base/sub/lib/native.js index fb430eea659f..fd99ae2202a8 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/sub/lib/native.js +++ b/lib/node_modules/@stdlib/complex/float64/base/sub/lib/native.js @@ -36,23 +36,12 @@ 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 z1 = new Complex128( 5.0, 3.0 ); -* // returns -* * var z2 = new Complex128( -2.0, 1.0 ); -* // returns * * var out = csub( z1, z2 ); -* // returns -* -* var re = real( out ); -* // returns 7.0 -* -* var im = imag( out ); -* // returns 2.0 +* // returns [ 7.0, 2.0 ] */ function csub( z1, z2 ) { var v = addon( z1, z2 );