From fd2b6488c1d3b0f0324f1abc4a67918e16953b63 Mon Sep 17 00:00:00 2001 From: DivyanshuVorrtex Date: Thu, 4 Dec 2025 19:52:10 +0000 Subject: [PATCH] docs : complex example update --- .../math/base/special/cfloorf/README.md | 34 ++-------------- .../math/base/special/cfloorf/docs/repl.txt | 6 +-- .../special/cfloorf/docs/types/index.d.ts | 10 +---- .../math/base/special/cfloorf/lib/index.js | 40 ++----------------- .../math/base/special/cfloorf/lib/main.js | 40 ++----------------- .../math/base/special/cfloorf/lib/native.js | 10 +---- 6 files changed, 15 insertions(+), 125 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cfloorf/README.md b/lib/node_modules/@stdlib/math/base/special/cfloorf/README.md index a173af1afdef..8c4c4ce3dd55 100644 --- a/lib/node_modules/@stdlib/math/base/special/cfloorf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cfloorf/README.md @@ -36,44 +36,18 @@ Rounds each component of a single-precision complex floating-point number toward ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var real = require( '@stdlib/complex/float32/real' ); -var imag = require( '@stdlib/complex/float32/imag' ); var v = cfloorf( new Complex64( -4.2, 5.5 ) ); -// returns - -var re = real( v ); -// returns -5.0 - -var im = imag( v ); -// returns 5.0 +// returns [ -5.0, 5.0 ] v = cfloorf( new Complex64( 9.99999, 0.1 ) ); -// returns - -re = real( v ); -// returns 9.0 - -im = imag( v ); -// returns 0.0 +// returns [ 9.0, 0.0 ] v = cfloorf( 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 = cfloorf( 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/cfloorf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cfloorf/docs/repl.txt index bbf581ba882c..cb991ede6717 100644 --- a/lib/node_modules/@stdlib/math/base/special/cfloorf/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cfloorf/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 ) - 5.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( v ) - 3.0 + [ 5.0, 3.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cfloorf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cfloorf/docs/types/index.d.ts index 44153d662142..b67b0041578a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cfloorf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cfloorf/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 = cfloorf( new Complex64( 5.5, 3.3 ) ); -* // returns -* -* var re = real( v ); -* // returns 5.0 -* -* var im = imag( v ); -* // returns 3.0 +* // returns [ 5.0, 3.0 ] */ declare function cfloorf( z: Complex64 ): Complex64; diff --git a/lib/node_modules/@stdlib/math/base/special/cfloorf/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cfloorf/lib/index.js index 69eaa7a646ab..6b7835cd09df 100644 --- a/lib/node_modules/@stdlib/math/base/special/cfloorf/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cfloorf/lib/index.js @@ -25,63 +25,31 @@ * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * var cfloorf = require( '@stdlib/math/base/special/cfloorf' ); * * var v = cfloorf( new Complex64( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -5.0 -* -* var im = imag( v ); -* // returns 5.0 +* // returns [ -5.0, 5.0 ] * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * var cfloorf = require( '@stdlib/math/base/special/cfloorf' ); * * var v = cfloorf( new Complex64( 9.99999, 0.1 ) ); -* // returns -* -* var re = real( v ); -* // returns 9.0 -* -* var im = imag( v ); -* // returns 0.0 +* // returns [ 9.0, 0.0 ] * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * var cfloorf = require( '@stdlib/math/base/special/cfloorf' ); * * var v = cfloorf( new Complex64( 0.0, 0.0 ) ); -* // returns -* -* var re = real( v ); -* // returns 0.0 -* -* var im = imag( v ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * var cfloorf = require( '@stdlib/math/base/special/cfloorf' ); * * var v = cfloorf( new Complex64( NaN, NaN ) ); -* // returns -* -* var re = real( v ); -* // returns NaN -* -* var im = imag( v ); -* // returns NaN +* // returns [ NaN, NaN ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/math/base/special/cfloorf/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cfloorf/lib/main.js index 2207eeee4afb..c9f0061aa962 100644 --- a/lib/node_modules/@stdlib/math/base/special/cfloorf/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cfloorf/lib/main.js @@ -36,59 +36,27 @@ 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 = cfloorf( new Complex64( -4.2, 5.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -5.0 -* -* var im = imag( v ); -* // returns 5.0 +* // returns [ -5.0, 5.0 ] * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * * var v = cfloorf( new Complex64( 9.99999, 0.1 ) ); -* // returns -* -* var re = real( v ); -* // returns 9.0 -* -* var im = imag( v ); -* // returns 0.0 +* // returns [ 9.0, 0.0 ] * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * * var v = cfloorf( new Complex64( 0.0, 0.0 ) ); -* // returns -* -* var re = real( v ); -* // returns 0.0 -* -* var im = imag( v ); -* // returns 0.0 +* // returns [ 0.0, 0.0 ] * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * * var v = cfloorf( new Complex64( NaN, NaN ) ); -* // returns -* -* var re = real( v ); -* // returns NaN -* -* var im = imag( v ); -* // returns NaN +* // returns [ NaN, NaN ] */ function cfloorf( z ) { return new Complex64( floorf( real( z ) ), floorf( imag( z ) ) ); diff --git a/lib/node_modules/@stdlib/math/base/special/cfloorf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cfloorf/lib/native.js index d177653bce1a..f72427143876 100644 --- a/lib/node_modules/@stdlib/math/base/special/cfloorf/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cfloorf/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 = cfloorf( new Complex64( -1.5, 2.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -2.0 -* -* var im = imag( v ); -* // returns 2.0 +* // returns [ -2.0, 2.0 ] */ function cfloorf( z ) { var v = addon( z );