From d31fc5d448b36e7250a17310992d21d118d1a81a Mon Sep 17 00:00:00 2001 From: Ayushi Jain Date: Thu, 26 Feb 2026 15:27:40 +0000 Subject: [PATCH] docs: improve doctests for complex number instances in --- .../math/base/special/croundf/README.md | 34 +++---------------- .../math/base/special/croundf/docs/repl.txt | 6 +--- .../special/croundf/docs/types/index.d.ts | 10 +----- .../math/base/special/croundf/lib/index.js | 34 +++---------------- .../math/base/special/croundf/lib/main.js | 34 +++---------------- .../math/base/special/croundf/lib/native.js | 10 +----- 6 files changed, 15 insertions(+), 113 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/croundf/README.md b/lib/node_modules/@stdlib/math/base/special/croundf/README.md index 8bcb9e261bc4..c0348b3f3bcf 100644 --- a/lib/node_modules/@stdlib/math/base/special/croundf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/croundf/README.md @@ -36,44 +36,18 @@ Rounds each component of a single-precision complex floating-point number to the ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var real = require( '@stdlib/complex/float32/real' ); -var imag = require( '@stdlib/complex/float32/imag' ); var v = croundf( new Complex64( -4.2, 5.5 ) ); -// returns - -var re = real( v ); -// returns -4.0 - -var im = imag( v ); -// returns 6.0 +// returns [ -4.0, 6.0 ] v = croundf( new Complex64( 9.99999, 0.1 ) ); -// returns - -re = real( v ); -// returns 10.0 - -im = imag( v ); -// returns 0.0 +// returns [ 10.0, 0.0 ] v = croundf( new Complex64( 0.0, 0.0 ) ); -// returns - -re = real( v ); -// returns 0.0 - -im = imag( v ); -// returns 0.0 +// returns [ 0.0, 0.0 ] v = croundf( new Complex64( NaN, NaN ) ); -// returns - -re = real( v ); -// returns NaN - -im = imag( v ); -// returns NaN +// returns [ NaN, NaN ] ``` diff --git a/lib/node_modules/@stdlib/math/base/special/croundf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/croundf/docs/repl.txt index d54314cd1ace..faad67c41597 100644 --- a/lib/node_modules/@stdlib/math/base/special/croundf/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/croundf/docs/repl.txt @@ -16,11 +16,7 @@ Examples -------- > var v = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( 5.5, 3.3 ) ) - - > var re = {{alias:@stdlib/complex/float32/real}}( v ) - 6.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( v ) - 3.0 + [ 6.0, 3.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/croundf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/croundf/docs/types/index.d.ts index 9b199cfa2e79..48bc61462435 100644 --- a/lib/node_modules/@stdlib/math/base/special/croundf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/croundf/docs/types/index.d.ts @@ -30,17 +30,9 @@ import { Complex64 } from '@stdlib/types/complex'; * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * * var v = croundf( new Complex64( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -4.0 -* -* var im = imag( v ); -* // returns 6.0 +* // returns [ -4.0, 6.0 ] */ declare function croundf( z: Complex64 ): Complex64; diff --git a/lib/node_modules/@stdlib/math/base/special/croundf/lib/index.js b/lib/node_modules/@stdlib/math/base/special/croundf/lib/index.js index 370daebd3241..41e2d0d54245 100644 --- a/lib/node_modules/@stdlib/math/base/special/croundf/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/croundf/lib/index.js @@ -25,45 +25,19 @@ * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * var croundf = require( '@stdlib/math/base/special/croundf' ); * * var v = croundf( new Complex64( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -4.0 -* -* var im = imag( v ); -* // returns 6.0 +* // returns [ -4.0, 6.0 ] * * v = croundf( new Complex64( 9.99999, 0.1 ) ); -* // returns -* -* re = real( v ); -* // returns 10.0 -* -* im = imag( v ); -* // returns 0.0 +* // returns [ 10.0, 0.0 ] * * v = croundf( new Complex64( 0.0, 0.0 ) ); -* // returns -* -* re = real( v ); -* // returns 0.0 -* -* im = imag( v ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * v = croundf( new Complex64( NaN, NaN ) ); -* // returns -* -* re = real( v ); -* // returns NaN -* -* im = imag( v ); -* // returns NaN +* // returns [ NaN, NaN ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/math/base/special/croundf/lib/main.js b/lib/node_modules/@stdlib/math/base/special/croundf/lib/main.js index 2d00ae8a6168..6d9c282c57a9 100644 --- a/lib/node_modules/@stdlib/math/base/special/croundf/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/croundf/lib/main.js @@ -36,44 +36,18 @@ var imag = require( '@stdlib/complex/float32/imag' ); * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * * var v = croundf( new Complex64( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -4.0 -* -* var im = imag( v ); -* // returns 6.0 +* // returns [ -4.0, 6.0 ] * * v = croundf( new Complex64( 9.99999, 0.1 ) ); -* // returns -* -* re = real( v ); -* // returns 10.0 -* -* im = imag( v ); -* // returns 0.0 +* // returns [ 10.0, 0.0 ] * * v = croundf( new Complex64( 0.0, 0.0 ) ); -* // returns -* -* re = real( v ); -* // returns 0.0 -* -* im = imag( v ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * v = croundf( new Complex64( NaN, NaN ) ); -* // returns -* -* re = real( v ); -* // returns NaN -* -* im = imag( v ); -* // returns NaN +* // returns [ NaN, NaN ] */ function croundf( z ) { return new Complex64( roundf( real( z ) ), roundf( imag( z ) ) ); diff --git a/lib/node_modules/@stdlib/math/base/special/croundf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/croundf/lib/native.js index 969d0bafa90d..b454965b02b8 100644 --- a/lib/node_modules/@stdlib/math/base/special/croundf/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/croundf/lib/native.js @@ -35,17 +35,9 @@ var addon = require( './../src/addon.node' ); * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * * var v = croundf( new Complex64( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -4 -* -* var im = imag( v ); -* // returns 6.0 +* // returns [ -4, 6.0 ] */ function croundf( z ) { var v = addon( z );