From 236898b64089c0e266f7407f55bd604949030dc7 Mon Sep 17 00:00:00 2001 From: kshitijgarg2811-oss Date: Tue, 6 Jan 2026 15:46:49 +0530 Subject: [PATCH 1/2] improved doctest for complex number --- .../@stdlib/math/base/special/cflipsign/README.md | 11 +---------- .../@stdlib/math/base/special/cflipsign/docs/repl.txt | 8 ++------ .../math/base/special/cflipsign/docs/types/index.d.ts | 10 +--------- .../@stdlib/math/base/special/cflipsign/lib/index.js | 10 +--------- .../@stdlib/math/base/special/cflipsign/lib/main.js | 10 +--------- .../@stdlib/math/base/special/cflipsign/lib/native.js | 10 +--------- 6 files changed, 7 insertions(+), 52 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsign/README.md b/lib/node_modules/@stdlib/math/base/special/cflipsign/README.md index ecd0516f9d2b..5916cbce8c8c 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsign/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cflipsign/README.md @@ -46,17 +46,8 @@ Returns a double-precision complex floating-point number with the same magnitude ```javascript var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); - var v = cflipsign( new Complex128( -4.2, 5.5 ), -1.0 ); -// returns - -var re = real( v ); -// returns 4.2 - -var im = imag( v ); -// returns -5.5 +// returns [ 4.2, -5.5 ] ``` diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsign/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cflipsign/docs/repl.txt index 067b1408dc36..15c184183526 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsign/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cflipsign/docs/repl.txt @@ -19,12 +19,8 @@ Examples -------- > var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( -4.2, 5.5 ), -9.0 ) - - > var re = {{alias:@stdlib/complex/float64/real}}( v ) - 4.2 - > var im = {{alias:@stdlib/complex/float64/imag}}( v ) - -5.5 - + + [ 4.2, -5.5 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsign/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cflipsign/docs/types/index.d.ts index 8352d2a23899..4f3e27f9f77e 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsign/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cflipsign/docs/types/index.d.ts @@ -31,17 +31,9 @@ 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 v = cflipsign( new Complex128( -4.2, 5.5 ), -55.0 ); -* // returns -* -* var re = real( v ); -* // returns 4.2 -* -* var im = imag( v ); -* // returns -5.5 +* // returns [ 4.2, -5.5 ] */ declare function cflipsign( z: Complex128, y: number ): Complex128; diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsign/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cflipsign/lib/index.js index 0e6964eea28d..5d33aa5197cb 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsign/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cflipsign/lib/index.js @@ -25,18 +25,10 @@ * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var cflipsign = require( '@stdlib/math/base/special/cflipsign' ); * * var v = cflipsign( new Complex128( -4.2, 5.5 ), -55.0 ); -* // returns -* -* var re = real( v ); -* // returns 4.2 -* -* var im = imag( v ); -* // returns -5.5 +* // returns [ 4.2, -5.5 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsign/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cflipsign/lib/main.js index e2b8619e43e7..de6664213096 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsign/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cflipsign/lib/main.js @@ -37,17 +37,9 @@ 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 v = cflipsign( new Complex128( -4.2, 5.5 ), -55.0 ); -* // returns -* -* var re = real( v ); -* // returns 4.2 -* -* var im = imag( v ); -* // returns -5.5 +* // returns [ 4.2, -5.5 ] */ function cflipsign( z, y ) { var re = real( z ); diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsign/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cflipsign/lib/native.js index 799f68d7c49c..25d06071fa6c 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsign/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cflipsign/lib/native.js @@ -36,17 +36,9 @@ 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 v = cflipsign( new Complex128( -4.2, 5.5 ), -55.0 ); -* // returns -* -* var re = real( v ); -* // returns 4.2 -* -* var im = imag( v ); -* // returns -5.5 +* // returns [ 4.2, -5.5 ] */ function cflipsign( z, y ) { var v = addon( z, y ); From ead53a5d783b2d801d362bda3f438cb5d4f2b6fb Mon Sep 17 00:00:00 2001 From: kshitijgarg2811-oss Date: Tue, 6 Jan 2026 16:06:56 +0530 Subject: [PATCH 2/2] removed whitespaces --- .../@stdlib/math/base/special/cflipsign/docs/repl.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsign/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cflipsign/docs/repl.txt index 15c184183526..d0932358f5a8 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsign/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cflipsign/docs/repl.txt @@ -19,7 +19,6 @@ Examples -------- > var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( -4.2, 5.5 ), -9.0 ) - [ 4.2, -5.5 ] See Also --------