From 934d0344baf6d0f94a02a71a89c602c2f9f8442f Mon Sep 17 00:00:00 2001 From: Ayushi Jain Date: Wed, 14 Jan 2026 05:54:27 +0000 Subject: [PATCH] docs:improve doctests for complex no instances in cfloor --- .../math/base/special/cfloor/README.md | 34 +++---------------- .../base/special/cfloor/docs/types/index.d.ts | 10 +----- 2 files changed, 5 insertions(+), 39 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cfloor/README.md b/lib/node_modules/@stdlib/math/base/special/cfloor/README.md index 712238bd4bb5..00c2385932f1 100644 --- a/lib/node_modules/@stdlib/math/base/special/cfloor/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cfloor/README.md @@ -36,44 +36,18 @@ Rounds a double-precision complex floating-point number toward negative infinity ```javascript var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); var v = cfloor( new Complex128( -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 = cfloor( new Complex128( 9.99999, 0.1 ) ); -// returns - -re = real( v ); -// returns 9.0 - -im = imag( v ); -// returns 0.0 +// returns [ 9.0, 0.0 ] v = cfloor( new Complex128( 0.0, 0.0 ) ); -// returns - -re = real( v ); -// returns 0.0 - -im = imag( v ); -// returns 0.0 +// returns [ 0.0, 0.0 ] v = cfloor( new Complex128( 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/cfloor/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cfloor/docs/types/index.d.ts index 3335863bfad0..f1ba06b80bac 100644 --- a/lib/node_modules/@stdlib/math/base/special/cfloor/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cfloor/docs/types/index.d.ts @@ -30,17 +30,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 = cfloor( new Complex128( 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 cfloor( z: Complex128 ): Complex128;