From a75803493d516b9115986223aa313a5df415eed2 Mon Sep 17 00:00:00 2001 From: ShabiShett07 Date: Mon, 9 Jun 2025 23:43:24 +0530 Subject: [PATCH] docs: update examples for complex/float32/base/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 --- --- .../@stdlib/complex/float32/base/add/README.md | 10 +--------- .../complex/float32/base/add/docs/types/index.d.ts | 11 +---------- .../@stdlib/complex/float32/base/add/lib/index.js | 11 +---------- .../@stdlib/complex/float32/base/add/lib/main.js | 11 +---------- .../@stdlib/complex/float32/base/add/lib/native.js | 11 +---------- 5 files changed, 5 insertions(+), 49 deletions(-) diff --git a/lib/node_modules/@stdlib/complex/float32/base/add/README.md b/lib/node_modules/@stdlib/complex/float32/base/add/README.md index 6322f1f86007..cde819f79665 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/add/README.md +++ b/lib/node_modules/@stdlib/complex/float32/base/add/README.md @@ -42,19 +42,11 @@ Adds two single-precision complex floating-point numbers. ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var realf = require( '@stdlib/complex/float32/real' ); -var imagf = require( '@stdlib/complex/float32/imag' ); var z = new Complex64( -1.5, 2.5 ); var v = add( z, z ); -// returns - -var re = realf( v ); -// returns -3.0 - -var im = imagf( v ); -// returns 5.0 +// returns [ -3.0, 5.0 ] ``` diff --git a/lib/node_modules/@stdlib/complex/float32/base/add/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/float32/base/add/docs/types/index.d.ts index c92f43197db2..518060a99e0a 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/add/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/complex/float32/base/add/docs/types/index.d.ts @@ -31,20 +31,11 @@ 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 z = new Complex64( 5.0, 3.0 ); -* // returns * * var out = add( z, z ); -* // returns -* -* var re = realf( out ); -* // returns 10.0 -* -* var im = imagf( out ); -* // returns 6.0 +* // returns [ 10.0, 6.0 ] */ declare function add( z1: Complex64, z2: Complex64 ): Complex64; diff --git a/lib/node_modules/@stdlib/complex/float32/base/add/lib/index.js b/lib/node_modules/@stdlib/complex/float32/base/add/lib/index.js index d9c476391adc..089413d73d89 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/add/lib/index.js +++ b/lib/node_modules/@stdlib/complex/float32/base/add/lib/index.js @@ -25,21 +25,12 @@ * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * var add = require( '@stdlib/complex/float32/base/add' ); * * var z = new Complex64( 5.0, 3.0 ); -* // returns * * var out = add( z, z ); -* // returns -* -* var re = realf( out ); -* // returns 10.0 -* -* var im = imagf( out ); -* // returns 6.0 +* // returns [ 10.0, 6.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/complex/float32/base/add/lib/main.js b/lib/node_modules/@stdlib/complex/float32/base/add/lib/main.js index 95a06a790f72..9d4f75048225 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/add/lib/main.js +++ b/lib/node_modules/@stdlib/complex/float32/base/add/lib/main.js @@ -37,20 +37,11 @@ var imagf = require( '@stdlib/complex/float32/imag' ); * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * var z = new Complex64( 5.0, 3.0 ); -* // returns * * var out = add( z, z ); -* // returns -* -* var re = realf( out ); -* // returns 10.0 -* -* var im = imagf( out ); -* // returns 6.0 +* // returns [ 10.0, 6.0 ] */ function add( z1, z2 ) { var re = f32( realf( z1 ) + realf( z2 ) ); diff --git a/lib/node_modules/@stdlib/complex/float32/base/add/lib/native.js b/lib/node_modules/@stdlib/complex/float32/base/add/lib/native.js index b86b03e9bba2..5c01cc42b327 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/add/lib/native.js +++ b/lib/node_modules/@stdlib/complex/float32/base/add/lib/native.js @@ -36,20 +36,11 @@ 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 z = new Complex64( 5.0, 3.0 ); -* // returns * * var out = add( z, z ); -* // returns -* -* var re = realf( out ); -* // returns 10.0 -* -* var im = imagf( out ); -* // returns 6.0 +* // returns [ 10.0, 6.0 ] */ function add( z1, z2 ) { var v = addon( z1, z2 );