Skip to content

Commit

Permalink
feat: update namespace TypeScript declarations
Browse files Browse the repository at this point in the history
  • Loading branch information
kgryte authored and stdlib-bot committed Sep 23, 2023
1 parent e627b29 commit efd7d22
Showing 1 changed file with 31 additions and 13 deletions.
44 changes: 31 additions & 13 deletions lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 <Complex128>
*
* var re = real( v );
* // returns 5.56
*
* var im = imag( v );
* // returns -3.33
*/
cceiln: typeof cceiln;

Expand Down Expand Up @@ -1914,16 +1923,25 @@ interface Namespace {
cfloor: typeof cfloor;

/**
* Rounds a complex number to the nearest multiple of `10^n` toward negative infinity.
* Rounds each component of a double-precision complex floating-point number to the nearest multiple of `10^n` toward negative 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.cfloorn( 5.555, -3.333, -2 );
* // returns [ 5.55, -3.34 ]
* var Complex128 = require( `@stdlib/complex/float64` );
* var real = require( `@stdlib/complex/real` );
* var imag = require( `@stdlib/complex/imag` );
*
* var v = cfloor( new Complex128( 5.555, -3.333 ), -2 );
* // returns <Complex128>
*
* var re = real( v );
* // returns 5.55
*
* var im = imag( v );
* // returns -3.34
*/
cfloorn: typeof cfloorn;

Expand Down Expand Up @@ -3363,7 +3381,7 @@ interface Namespace {
floorf: typeof floorf;

/**
* Rounds a numeric value to the nearest multiple of `10^n` toward negative infinity.
* Rounds a double-precision floating-point number to the nearest multiple of `10^n` toward negative infinity.
*
* ## Notes
*
Expand Down

0 comments on commit efd7d22

Please sign in to comment.