From a6e1e469888e6301671b56868f767f6d35bec463 Mon Sep 17 00:00:00 2001 From: ShabiShett07 Date: Mon, 9 Jun 2025 23:54:55 +0530 Subject: [PATCH] docs: update examples for complex/float32/basemul --- 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/float32/base/mul/README.md | 10 +------ .../float32/base/mul/docs/types/index.d.ts | 26 ++----------------- .../complex/float32/base/mul/lib/index.js | 13 +--------- .../complex/float32/base/mul/lib/main.js | 13 +--------- .../complex/float32/base/mul/lib/native.js | 13 +--------- 5 files changed, 6 insertions(+), 69 deletions(-) diff --git a/lib/node_modules/@stdlib/complex/float32/base/mul/README.md b/lib/node_modules/@stdlib/complex/float32/base/mul/README.md index 9d885ef22ffc..0b42f6181423 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/mul/README.md +++ b/lib/node_modules/@stdlib/complex/float32/base/mul/README.md @@ -42,20 +42,12 @@ Multiples 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 z1 = new Complex64( 5.0, 3.0 ); var z2 = new Complex64( -2.0, 1.0 ); var v = mul( z1, z2 ); -// returns - -var re = realf( v ); -// returns -13.0 - -var im = imagf( v ); -// returns -1.0 +// returns [ -13.0, -1.0 ] ``` #### mul.assign( re1, im1, re2, im2, out, strideOut, offsetOut ) diff --git a/lib/node_modules/@stdlib/complex/float32/base/mul/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/float32/base/mul/docs/types/index.d.ts index 9168e4040fd2..c0d71056ad75 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/mul/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/complex/float32/base/mul/docs/types/index.d.ts @@ -36,23 +36,12 @@ interface Mul { * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); - * var realf = require( '@stdlib/complex/float32/real' ); - * var imagf = require( '@stdlib/complex/float32/imag' ); * * var z1 = new Complex64( 5.0, 3.0 ); - * // returns - * * var z2 = new Complex64( -2.0, 1.0 ); - * // returns * * var out = mul( z1, z2 ); - * // returns - * - * var re = realf( out ); - * // returns -13.0 - * - * var im = imagf( out ); - * // returns -1.0 + * // returns [ -13.0, -1.0 ] */ ( z1: Complex64, z2: Complex64 ): Complex64; @@ -115,23 +104,12 @@ interface Mul { * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * var z1 = new Complex64( 5.0, 3.0 ); -* // returns -* * var z2 = new Complex64( -2.0, 1.0 ); -* // returns * * var out = mul( z1, z2 ); -* // returns -* -* var re = realf( out ); -* // returns -13.0 -* -* var im = imagf( out ); -* // returns -1.0 +* // returns [ -13.0, -1.0 ] * * @example * var Float32Array = require( '@stdlib/array/float32' ); diff --git a/lib/node_modules/@stdlib/complex/float32/base/mul/lib/index.js b/lib/node_modules/@stdlib/complex/float32/base/mul/lib/index.js index f5413ce1e2f1..5df899e3e5a6 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/mul/lib/index.js +++ b/lib/node_modules/@stdlib/complex/float32/base/mul/lib/index.js @@ -25,24 +25,13 @@ * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * var mul = require( '@stdlib/complex/float32/base/mul' ); * * var z1 = new Complex64( 5.0, 3.0 ); -* // returns -* * var z2 = new Complex64( -2.0, 1.0 ); -* // returns * * var out = mul( z1, z2 ); -* // returns -* -* var re = realf( out ); -* // returns -13.0 -* -* var im = imagf( out ); -* // returns -1.0 +* // returns [ -13.0, -1.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/complex/float32/base/mul/lib/main.js b/lib/node_modules/@stdlib/complex/float32/base/mul/lib/main.js index e0b456db0f97..2195d7a101ca 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/mul/lib/main.js +++ b/lib/node_modules/@stdlib/complex/float32/base/mul/lib/main.js @@ -37,23 +37,12 @@ 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 z1 = new Complex64( 5.0, 3.0 ); -* // returns -* * var z2 = new Complex64( -2.0, 1.0 ); -* // returns * * var out = mul( z1, z2 ); -* // returns -* -* var re = realf( out ); -* // returns -13.0 -* -* var im = imagf( out ); -* // returns -1.0 +* // returns [ -13.0, -1.0 ] */ function mul( z1, z2 ) { var re1 = realf( z1 ); diff --git a/lib/node_modules/@stdlib/complex/float32/base/mul/lib/native.js b/lib/node_modules/@stdlib/complex/float32/base/mul/lib/native.js index aff2e19f70c6..69038b5ffeae 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/mul/lib/native.js +++ b/lib/node_modules/@stdlib/complex/float32/base/mul/lib/native.js @@ -36,23 +36,12 @@ 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 z1 = new Complex64( 5.0, 3.0 ); -* // returns -* * var z2 = new Complex64( -2.0, 1.0 ); -* // returns * * var out = mul( z1, z2 ); -* // returns -* -* var re = realf( out ); -* // returns -13.0 -* -* var im = imagf( out ); -* // returns -1.0 +* // returns [ -13.0, -1.0 ] */ function mul( z1, z2 ) { var v = addon( z1, z2 );