From 1348c5de0db0da161c8dd2f9f9f650d58b781e37 Mon Sep 17 00:00:00 2001 From: sujal sunil chaudhary Date: Fri, 12 Dec 2025 00:43:21 +0530 Subject: [PATCH] docs/improve-math-base-special-cceiln --- .../math/base/special/cceiln/README.md | 53 +++---------------- .../math/base/special/cceiln/docs/repl.txt | 6 +-- .../base/special/cceiln/docs/types/index.d.ts | 10 +--- .../math/base/special/cceiln/lib/index.js | 34 ++---------- .../math/base/special/cceiln/lib/main.js | 36 ++----------- .../math/base/special/cceiln/lib/native.js | 34 ++---------- 6 files changed, 20 insertions(+), 153 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cceiln/README.md b/lib/node_modules/@stdlib/math/base/special/cceiln/README.md index 72dfb5126eef..bb52cf7eff98 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceiln/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cceiln/README.md @@ -36,50 +36,24 @@ Rounds each component of a double-precision complex floating-point number to the ```javascript var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); // Round components to 2 decimal places: var z = new Complex128( -3.141592653589793, 3.141592653589793 ); var v = cceiln( z, -2 ); -// returns - -var re = real( v ); -// returns -3.14 - -var im = imag( v ); -// returns 3.15 +// returns [ -3.14, 3.15 ] // If n = 0, `cceiln` behaves like `cceil`: z = new Complex128( 9.99999, 0.1 ); v = cceiln( z, 0 ); -// returns - -re = real( v ); -// returns 10.0 - -im = imag( v ); -// returns 1.0 +// returns [ 10.0, 1.0 ] // Round components to the nearest thousand: z = new Complex128( 12368.0, -12368.0 ); v = cceiln( z, 3 ); -// returns - -re = real( v ); -// returns 13000.0 - -im = imag( v ); -// returns -12000.0 +// returns [ 13000.0, -12000.0 ] v = cceiln( new Complex128( NaN, NaN ), 2 ); -// returns - -re = real( v ); -// returns NaN - -im = imag( v ); -// returns NaN +// returns [ NaN, NaN ] ``` @@ -94,21 +68,13 @@ im = imag( v ); ```javascript var Complex128 = require( '@stdlib/complex/float64/ctor' ); - var real = require( '@stdlib/complex/float64/real' ); - var imag = require( '@stdlib/complex/float64/imag' ); var x = 0.2 + 0.1; // returns 0.30000000000000004 // Should round components to 0.3: var v = cceiln( new Complex128( x, x ), -16 ); - // returns - - var re = real( v ); - // returns 0.3000000000000001 - - var im = imag( v ); - // returns 0.3000000000000001 + // returns [ 0.3000000000000001, 0.3000000000000001 ] ``` @@ -177,18 +143,11 @@ Rounds each component of a double-precision complex floating-point number to the ```c #include "stdlib/complex/float64/ctor.h" -#include "stdlib/complex/float64/real.h" -#include "stdlib/complex/float64/imag.h" stdlib_complex128_t z = stdlib_complex128( -3.141592653589793, 3.141592653589793 ); stdlib_complex128_t out = stdlib_base_cceiln( z, -2 ); - -double re = stdlib_complex128_real( out ); -// returns -3.14 - -double im = stdlib_complex128_imag( out ); -// returns 3.15 +// returns [ -3.14, 3.15 ] ``` The function accepts the following arguments: diff --git a/lib/node_modules/@stdlib/math/base/special/cceiln/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cceiln/docs/repl.txt index b45365e512ec..5b018d05ef6d 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceiln/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cceiln/docs/repl.txt @@ -19,11 +19,7 @@ Examples -------- > var out = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 5.555, -3.333 ), -2 ) - - > var re = {{alias:@stdlib/complex/float64/real}}( out ) - 5.56 - > var im = {{alias:@stdlib/complex/float64/imag}}( out ) - -3.33 + [ 5.56, -3.33 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cceiln/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cceiln/docs/types/index.d.ts index 0df302a8f96d..83392b4bb1df 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceiln/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cceiln/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 = cceiln( new Complex128( 5.555, -3.333 ), -2 ); -* // returns -* -* var re = real( v ); -* // returns 5.56 -* -* var im = imag( v ); -* // returns -3.33 +* // returns [ 5.56, -3.33 ] */ declare function cceiln( z: Complex128, n: number ): Complex128; diff --git a/lib/node_modules/@stdlib/math/base/special/cceiln/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cceiln/lib/index.js index 681ecd911f25..474adb662040 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceiln/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cceiln/lib/index.js @@ -25,51 +25,25 @@ * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var cceiln = require( '@stdlib/math/base/special/cceiln' ); * * // Round components to 2 decimal places: * var z = new Complex128( -3.141592653589793, 3.141592653589793 ) * var v = cceiln( z, -2 ); -* // returns -* -* var re = real( v ); -* // returns -3.14 -* -* var im = imag( v ); -* // returns 3.15 +* // returns [ -3.14, 3.15 ] * * // If n = 0, `cceiln` behaves like `cceil`: * z = new Complex128( 9.99999, 0.1 ) * v = cceiln( z, 0 ); -* // returns -* -* re = real( v ); -* // returns 10.0 -* -* im = imag( v ); -* // returns 1.0 +* // returns [ 10.0, 1.0 ] * * // Round components to the nearest thousand: * z = new Complex128( 12368.0, -12368.0 ) * v = cceiln( z, 3 ); -* // returns -* -* re = real( v ); -* // returns 13000.0 -* -* im = imag( v ); -* // returns -12000.0 +* // returns [ 13000.0, -12000.0 ] * * v = cceiln( new Complex128( NaN, NaN ), 2 ); -* // 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/cceiln/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cceiln/lib/main.js index 4107ec43d2d9..6dd8ced81d13 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceiln/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cceiln/lib/main.js @@ -22,8 +22,6 @@ var ceiln = require( '@stdlib/math/base/special/ceiln' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); -var real = require( '@stdlib/complex/float64/real' ); -var imag = require( '@stdlib/complex/float64/imag' ); // MAIN // @@ -37,50 +35,24 @@ 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' ); * * // Round components to 2 decimal places: * var z = new Complex128( -3.141592653589793, 3.141592653589793 ) * var v = cceiln( z, -2 ); -* // returns -* -* var re = real( v ); -* // returns -3.14 -* -* var im = imag( v ); -* // returns 3.15 +* // returns [ -3.14, 3.15 ] * * // If n = 0, `cceiln` behaves like `cceil`: * z = new Complex128( 9.99999, 0.1 ) * v = cceiln( z, 0 ); -* // returns -* -* re = real( v ); -* // returns 10.0 -* -* im = imag( v ); -* // returns 1.0 +* // returns [ 10.0, 1.0 ] * * // Round components to the nearest thousand: * z = new Complex128( 12368.0, -12368.0 ) * v = cceiln( z, 3 ); -* // returns -* -* re = real( v ); -* // returns 13000.0 -* -* im = imag( v ); -* // returns -12000.0 +* // returns [ 13000.0, -12000.0 ] * * v = cceiln( new Complex128( NaN, NaN ), 2 ); -* // returns -* -* re = real( v ); -* // returns NaN -* -* im = imag( v ); -* // returns NaN +* // returns [ NaN, NaN ] */ function cceiln( z, n ) { return new Complex128( ceiln( real( z ), n ), ceiln( imag( z ), n ) ); diff --git a/lib/node_modules/@stdlib/math/base/special/cceiln/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cceiln/lib/native.js index 847b54eae9a4..84da7ef06d96 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceiln/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cceiln/lib/native.js @@ -36,50 +36,24 @@ 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' ); * * // Round components to 2 decimal places: * var z = new Complex128( -3.141592653589793, 3.141592653589793 ) * var v = cceiln( z, -2 ); -* // returns -* -* var re = real( v ); -* // returns -3.14 -* -* var im = imag( v ); -* // returns 3.15 +* // returns [ -3.14, 3.15 ] * * // If n = 0, `cceiln` behaves like `cceil`: * z = new Complex128( 9.99999, 0.1 ) * v = cceiln( z, 0 ); -* // returns -* -* re = real( v ); -* // returns 10.0 -* -* im = imag( v ); -* // returns 1.0 +* // returns [ 10.0, 1.0 ] * * // Round components to the nearest thousand: * z = new Complex128( 12368.0, -12368.0 ) * v = cceiln( z, 3 ); -* // returns -* -* re = real( v ); -* // returns 13000.0 -* -* im = imag( v ); -* // returns -12000.0 +* // returns [ 13000.0, -12000.0 ] * * v = cceiln( new Complex128( NaN, NaN ), 2 ); -* // returns -* -* re = real( v ); -* // returns NaN -* -* im = imag( v ); -* // returns NaN +* // returns [ NaN, NaN ] */ function cceiln( z, n ) { var v = addon( z, n );