Skip to content

Commit a99f9fd

Browse files
committed
feat: update math/base/special TypeScript declarations
Signed-off-by: stdlib-bot <[email protected]>
1 parent f3a591e commit a99f9fd

File tree

1 file changed

+4
-36
lines changed
  • lib/node_modules/@stdlib/math/base/special/docs/types

1 file changed

+4
-36
lines changed

lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2559,17 +2559,9 @@ interface Namespace {
25592559
*
25602560
* @example
25612561
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
2562-
* var real = require( '@stdlib/complex/float64/real' );
2563-
* var imag = require( '@stdlib/complex/float64/imag' );
25642562
*
25652563
* var v = ns.cceil( new Complex128( -1.5, 2.5 ) );
2566-
* // returns <Complex128>
2567-
*
2568-
* var re = real( v );
2569-
* // returns -1.0
2570-
*
2571-
* var im = imag( v );
2572-
* // returns 3.0
2564+
* // returns <Complex128>[ -1.0, 3.0 ]
25732565
*/
25742566
cceil: typeof cceil;
25752567

@@ -2899,17 +2891,9 @@ interface Namespace {
28992891
*
29002892
* @example
29012893
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
2902-
* var real = require( '@stdlib/complex/float32/real' );
2903-
* var imag = require( '@stdlib/complex/float32/imag' );
29042894
*
29052895
* var v = ns.cflipsignf( new Complex64( -4.0, 5.0 ), -55.0 );
2906-
* // returns <Complex64>
2907-
*
2908-
* var re = real( v );
2909-
* // returns 4.0
2910-
*
2911-
* var im = imag( v );
2912-
* // returns -5.0
2896+
* // returns <Complex64>[ 4.0, -5.0 ]
29132897
*/
29142898
cflipsignf: typeof cflipsignf;
29152899

@@ -3709,17 +3693,9 @@ interface Namespace {
37093693
*
37103694
* @example
37113695
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
3712-
* var real = require( '@stdlib/complex/float64/real' );
3713-
* var imag = require( '@stdlib/complex/float64/imag' );
37143696
*
37153697
* var v = ns.croundn( new Complex128( 5.555, -3.333 ), -2 );
3716-
* // returns <Complex128>
3717-
*
3718-
* var re = real( v );
3719-
* // returns 5.56
3720-
*
3721-
* var im = imag( v );
3722-
* // returns -3.33
3698+
* // returns <Complex128>[ 5.56, -3.33 ]
37233699
*/
37243700
croundn: typeof croundn;
37253701

@@ -3867,17 +3843,9 @@ interface Namespace {
38673843
*
38683844
* @example
38693845
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
3870-
* var real = require( '@stdlib/complex/float64/real' );
3871-
* var imag = require( '@stdlib/complex/float64/imag' );
38723846
*
38733847
* var v = ns.csignum( new Complex128( -4.2, 5.5 ) );
3874-
* // returns <Complex128>
3875-
*
3876-
* var re = real( v );
3877-
* // returns -0.6069136033622302
3878-
*
3879-
* var im = imag( v );
3880-
* // returns 0.79476781392673
3848+
* // returns <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
38813849
*/
38823850
csignum: typeof csignum;
38833851

0 commit comments

Comments
 (0)