From 5b0624add9eddec66cc676cdce8ce525b4171e8e Mon Sep 17 00:00:00 2001 From: ShabiShett07 Date: Sun, 8 Jun 2025 13:59:31 +0530 Subject: [PATCH] docs: update examples for complex/float64/base/mul-add --- 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 --- --- .../complex/float64/base/mul-add/README.md | 8 +---- .../base/mul-add/docs/types/index.d.ts | 30 ++----------------- .../complex/float64/base/mul-add/lib/index.js | 15 +--------- .../complex/float64/base/mul-add/lib/main.js | 15 +--------- .../float64/base/mul-add/lib/native.js | 15 +--------- 5 files changed, 6 insertions(+), 77 deletions(-) diff --git a/lib/node_modules/@stdlib/complex/float64/base/mul-add/README.md b/lib/node_modules/@stdlib/complex/float64/base/mul-add/README.md index 58c8750eab00..d9bbd3274a74 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/mul-add/README.md +++ b/lib/node_modules/@stdlib/complex/float64/base/mul-add/README.md @@ -51,13 +51,7 @@ var z3 = new Complex128( 7.0, -8.0 ); // Compute `alpha*x + y`: var v = muladd( z1, z2, z3 ); -// returns - -var re = real( v ); -// returns -6.0 - -var im = imag( v ); -// returns -9.0 +// returns [ -6.0, -9.0 ] ``` The function supports the following parameters: diff --git a/lib/node_modules/@stdlib/complex/float64/base/mul-add/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/float64/base/mul-add/docs/types/index.d.ts index 253384342b01..e3879e78d7fc 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/mul-add/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/complex/float64/base/mul-add/docs/types/index.d.ts @@ -47,26 +47,13 @@ interface MulAdd { * * @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 z3 = new Complex128( 7.0, -8.0 ); - * // returns * * var out = muladd( z1, z2, z3 ); - * // returns - * - * var re = real( out ); - * // returns -6.0 - * - * var im = imag( out ); - * // returns -9.0 + * // returns [ -6.0, -9.0 ] */ ( alpha: Complex128, x: Complex128, y: Complex128 ): Complex128; @@ -132,26 +119,13 @@ interface MulAdd { * * @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 z3 = new Complex128( 7.0, -8.0 ); -* // returns * * var out = muladd( z1, z2, z3 ); -* // returns -* -* var re = real( out ); -* // returns -6.0 -* -* var im = imag( out ); -* // returns -9.0 +* // returns [ -6.0, -9.0 ] * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/complex/float64/base/mul-add/lib/index.js b/lib/node_modules/@stdlib/complex/float64/base/mul-add/lib/index.js index e99d68fe80c1..31c2410bf7dd 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/mul-add/lib/index.js +++ b/lib/node_modules/@stdlib/complex/float64/base/mul-add/lib/index.js @@ -25,27 +25,14 @@ * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var muladd = require( '@stdlib/complex/float64/base/mul-add' ); * * var z1 = new Complex128( 5.0, 3.0 ); -* // returns -* * var z2 = new Complex128( -2.0, 1.0 ); -* // returns -* * var z3 = new Complex128( 7.0, -8.0 ); -* // returns * * var out = muladd( z1, z2, z3 ); -* // returns -* -* var re = real( out ); -* // returns -6.0 -* -* var im = imag( out ); -* // returns -9.0 +* // returns [ -6.0, -9.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/complex/float64/base/mul-add/lib/main.js b/lib/node_modules/@stdlib/complex/float64/base/mul-add/lib/main.js index 991f8c8e16ad..df0bde04f87a 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/mul-add/lib/main.js +++ b/lib/node_modules/@stdlib/complex/float64/base/mul-add/lib/main.js @@ -37,26 +37,13 @@ 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 z3 = new Complex128( 7.0, -8.0 ); -* // returns * * var out = muladd( z1, z2, z3 ); -* // returns -* -* var re = real( out ); -* // returns -6.0 -* -* var im = imag( out ); -* // returns -9.0 +* // returns [ -6.0, -9.0 ] */ function muladd( alpha, x, y ) { var re0 = real( alpha ); diff --git a/lib/node_modules/@stdlib/complex/float64/base/mul-add/lib/native.js b/lib/node_modules/@stdlib/complex/float64/base/mul-add/lib/native.js index b4ea2fa14c43..301213716b7e 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/mul-add/lib/native.js +++ b/lib/node_modules/@stdlib/complex/float64/base/mul-add/lib/native.js @@ -37,26 +37,13 @@ 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 z3 = new Complex128( 7.0, -8.0 ); -* // returns * * var out = muladd( z1, z2, z3 ); -* // returns -* -* var re = real( out ); -* // returns -6.0 -* -* var im = imag( out ); -* // returns -9.0 +* // returns [ -6.0, -9.0 ] */ function muladd( alpha, x, y ) { var v = addon( alpha, x, y );