From d2b39cc2b9c4ca953d3f670342bcc39566008153 Mon Sep 17 00:00:00 2001 From: kgryte Date: Sat, 23 Sep 2023 19:19:48 +0000 Subject: [PATCH] feat: update namespace TypeScript declarations --- .../math/base/special/docs/types/index.d.ts | 21 +++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts index 45f6e9ea27c2..e59c149cc0a6 100644 --- a/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts @@ -1584,16 +1584,25 @@ interface Namespace { cceilf: typeof cceilf; /** - * Rounds a complex number to the nearest multiple of `10^n` toward positive infinity. + * Rounds each component of a double-precision complex number to the nearest multiple of `10^n` toward positive infinity. * - * @param re - real component - * @param im - imaginary component + * @param z - input value * @param n - integer power of 10 - * @returns real and imaginary components + * @returns result * * @example - * var out = ns.cceiln( 5.555, -3.333, -2 ); - * // returns [ 5.56, -3.33 ] + * var Complex128 = require( `@stdlib/complex/float64` ); + * var real = require( `@stdlib/complex/real` ); + * var imag = require( `@stdlib/complex/imag` ); + * + * var v = ns.cceiln( new Complex128( 5.555, -3.333 ), -2 ); + * // returns + * + * var re = real( v ); + * // returns 5.56 + * + * var im = imag( v ); + * // returns -3.33 */ cceiln: typeof cceiln;