Skip to content

Commit 54ed22a

Browse files
authored
docs: update namespace TypeScript declarations
PR-URL: #5330 Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 6daebce commit 54ed22a

File tree

2 files changed

+258
-258
lines changed

2 files changed

+258
-258
lines changed

Diff for: lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts

+90-90
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ import cneg = require( '@stdlib/math/base/ops/cneg' );
2929
import cnegf = require( '@stdlib/math/base/ops/cnegf' );
3030
import csub = require( '@stdlib/math/base/ops/csub' );
3131
import csubf = require( '@stdlib/math/base/ops/csubf' );
32-
import div = require( '@stdlib/number/float64/base/div' );
3332
import divf = require( '@stdlib/math/base/ops/divf' );
3433
import imul = require( '@stdlib/math/base/ops/imul' );
3534
import imuldw = require( '@stdlib/math/base/ops/imuldw' );
36-
import mul = require( '@stdlib/number/float64/base/mul' );
3735
import mulf = require( '@stdlib/math/base/ops/mulf' );
38-
import sub = require( '@stdlib/number/float64/base/sub' );
3936
import subf = require( '@stdlib/math/base/ops/subf' );
4037
import umul = require( '@stdlib/math/base/ops/umul' );
4138
import umuldw = require( '@stdlib/math/base/ops/umuldw' );
4239
import addf = require( '@stdlib/number/float32/base/add' );
40+
import div = require( '@stdlib/number/float64/base/div' );
41+
import mul = require( '@stdlib/number/float64/base/mul' );
42+
import sub = require( '@stdlib/number/float64/base/sub' );
4343

4444
/**
4545
* Interface describing the `ops` namespace.
@@ -417,35 +417,6 @@ interface Namespace {
417417
*/
418418
csubf: typeof csubf;
419419

420-
/**
421-
* Divides two double-precision floating-point numbers `x` and `y`.
422-
*
423-
* @param x - first input value (divided)
424-
* @param y - second input value (divisor)
425-
* @returns result
426-
*
427-
* @example
428-
* var v = ns.div( -1.0, 5.0 );
429-
* // returns -0.2
430-
*
431-
* @example
432-
* var v = ns.div( 2.0, 5.0 );
433-
* // returns 0.4
434-
*
435-
* @example
436-
* var v = ns.div( 0.0, 5.0 );
437-
* // returns 0.0
438-
*
439-
* @example
440-
* var v = ns.div( -0.0, 5.0 );
441-
* // returns -0.0
442-
*
443-
* @example
444-
* var v = ns.div( NaN, NaN );
445-
* // returns NaN
446-
*/
447-
div: typeof div;
448-
449420
/**
450421
* Divides two single-precision floating-point numbers `x` and `y`.
451422
*
@@ -505,35 +476,6 @@ interface Namespace {
505476
*/
506477
imuldw: typeof imuldw;
507478

508-
/**
509-
* Multiplies two double-precision floating-point numbers `x` and `y`.
510-
*
511-
* @param x - first input value
512-
* @param y - second input value
513-
* @returns result
514-
*
515-
* @example
516-
* var v = ns.mul( -1.0, 5.0 );
517-
* // returns -5.0
518-
*
519-
* @example
520-
* var v = ns.mul( 2.0, 5.0 );
521-
* // returns 10.0
522-
*
523-
* @example
524-
* var v = ns.mul( 0.0, 5.0 );
525-
* // returns 0.0
526-
*
527-
* @example
528-
* var v = ns.mul( -0.0, 0.0 );
529-
* // returns -0.0
530-
*
531-
* @example
532-
* var v = ns.mul( NaN, NaN );
533-
* // returns NaN
534-
*/
535-
mul: typeof mul;
536-
537479
/**
538480
* Multiplies two single-precision floating-point numbers `x` and `y`.
539481
*
@@ -563,35 +505,6 @@ interface Namespace {
563505
*/
564506
mulf: typeof mulf;
565507

566-
/**
567-
* Subtracts two double-precision floating-point numbers `x` and `y`.
568-
*
569-
* @param x - first input value
570-
* @param y - second input value
571-
* @returns result
572-
*
573-
* @example
574-
* var v = ns.sub( -1.0, 5.0 );
575-
* // returns -6.0
576-
*
577-
* @example
578-
* var v = ns.sub( 2.0, 5.0 );
579-
* // returns -3.0
580-
*
581-
* @example
582-
* var v = ns.sub( 0.0, 5.0 );
583-
* // returns -5.0
584-
*
585-
* @example
586-
* var v = ns.sub( -0.0, 0.0 );
587-
* // returns -0.0
588-
*
589-
* @example
590-
* var v = ns.sub( NaN, NaN );
591-
* // returns NaN
592-
*/
593-
sub: typeof sub;
594-
595508
/**
596509
* Subtracts two single-precision floating-point numbers `x` and `y`.
597510
*
@@ -679,6 +592,93 @@ interface Namespace {
679592
* // returns NaN
680593
*/
681594
addf: typeof addf;
595+
596+
/**
597+
* Divides two double-precision floating-point numbers `x` and `y`.
598+
*
599+
* @param x - first input value (divided)
600+
* @param y - second input value (divisor)
601+
* @returns result
602+
*
603+
* @example
604+
* var v = ns.div( -1.0, 5.0 );
605+
* // returns -0.2
606+
*
607+
* @example
608+
* var v = ns.div( 2.0, 5.0 );
609+
* // returns 0.4
610+
*
611+
* @example
612+
* var v = ns.div( 0.0, 5.0 );
613+
* // returns 0.0
614+
*
615+
* @example
616+
* var v = ns.div( -0.0, 5.0 );
617+
* // returns -0.0
618+
*
619+
* @example
620+
* var v = ns.div( NaN, NaN );
621+
* // returns NaN
622+
*/
623+
div: typeof div;
624+
625+
/**
626+
* Multiplies two double-precision floating-point numbers `x` and `y`.
627+
*
628+
* @param x - first input value
629+
* @param y - second input value
630+
* @returns result
631+
*
632+
* @example
633+
* var v = ns.mul( -1.0, 5.0 );
634+
* // returns -5.0
635+
*
636+
* @example
637+
* var v = ns.mul( 2.0, 5.0 );
638+
* // returns 10.0
639+
*
640+
* @example
641+
* var v = ns.mul( 0.0, 5.0 );
642+
* // returns 0.0
643+
*
644+
* @example
645+
* var v = ns.mul( -0.0, 0.0 );
646+
* // returns -0.0
647+
*
648+
* @example
649+
* var v = ns.mul( NaN, NaN );
650+
* // returns NaN
651+
*/
652+
mul: typeof mul;
653+
654+
/**
655+
* Subtracts two double-precision floating-point numbers `x` and `y`.
656+
*
657+
* @param x - first input value
658+
* @param y - second input value
659+
* @returns result
660+
*
661+
* @example
662+
* var v = ns.sub( -1.0, 5.0 );
663+
* // returns -6.0
664+
*
665+
* @example
666+
* var v = ns.sub( 2.0, 5.0 );
667+
* // returns -3.0
668+
*
669+
* @example
670+
* var v = ns.sub( 0.0, 5.0 );
671+
* // returns -5.0
672+
*
673+
* @example
674+
* var v = ns.sub( -0.0, 0.0 );
675+
* // returns -0.0
676+
*
677+
* @example
678+
* var v = ns.sub( NaN, NaN );
679+
* // returns NaN
680+
*/
681+
sub: typeof sub;
682682
}
683683

684684
/**

0 commit comments

Comments
 (0)