Skip to content

Commit 31d673e

Browse files
authored
feat!: update namespace TypeScript declarations
This commit removes the `dnanmean` symbol from the `stats/base` namespace. BREAKING CHANGE: remove `dnanmean` from `stats/base` To migrate, users should access the same symbol via the `@stdlib/stats/strided` namespace. PR-URL: #5385 Reviewed-by: Athan Reines <[email protected]>
1 parent 61f4a86 commit 31d673e

File tree

3 files changed

+36
-83
lines changed

3 files changed

+36
-83
lines changed

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

+2-22
Original file line numberDiff line numberDiff line change
@@ -2400,39 +2400,19 @@ interface Namespace {
24002400
*
24012401
* @example
24022402
* var Complex128Array = require( '@stdlib/array/complex128' );
2403-
* var real = require( '@stdlib/complex/float64/real' );
2404-
* var imag = require( '@stdlib/complex/float64/imag' );
24052403
*
24062404
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
24072405
*
24082406
* ns.zdscal( 3, 2.0, zx, 1 );
2409-
*
2410-
* var z = zx.get( 1 );
2411-
* // returns <Complex128>
2412-
*
2413-
* var re = real( z );
2414-
* // returns 6.0
2415-
*
2416-
* var im = imag( z );
2417-
* // returns 8.0
2407+
* // zx => <Complex128Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
24182408
*
24192409
* @example
24202410
* var Complex128Array = require( '@stdlib/array/complex128' );
2421-
* var real = require( '@stdlib/complex/float64/real' );
2422-
* var imag = require( '@stdlib/complex/float64/imag' );
24232411
*
24242412
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
24252413
*
24262414
* ns.zdscal.ndarray( 2, 2.0, zx, 1, 1 );
2427-
*
2428-
* var z = zx.get( 1 );
2429-
* // returns <Complex128>
2430-
*
2431-
* var re = real( z );
2432-
* // returns 10.0
2433-
*
2434-
* var im = imag( z );
2435-
* // returns 12.0
2415+
* // zx => <Complex128Array>[ 1.0, 2.0, 6.0, 8.0, 10.0, 12.0 ]
24362416
*/
24372417
zdscal: typeof zdscal;
24382418

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

+30-30
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ 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 divf = require( '@stdlib/number/float32/base/div' );
3332
import imul = require( '@stdlib/math/base/ops/imul' );
3433
import imuldw = require( '@stdlib/math/base/ops/imuldw' );
3534
import mulf = require( '@stdlib/number/float32/base/mul' );
3635
import subf = require( '@stdlib/math/base/ops/subf' );
3736
import umul = require( '@stdlib/math/base/ops/umul' );
3837
import umuldw = require( '@stdlib/math/base/ops/umuldw' );
3938
import addf = require( '@stdlib/number/float32/base/add' );
39+
import divf = require( '@stdlib/number/float32/base/div' );
4040
import div = require( '@stdlib/number/float64/base/div' );
4141
import mul = require( '@stdlib/number/float64/base/mul' );
4242
import sub = require( '@stdlib/number/float64/base/sub' );
@@ -417,35 +417,6 @@ interface Namespace {
417417
*/
418418
csubf: typeof csubf;
419419

420-
/**
421-
* Divides two single-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.divf( -1.0, 5.0 );
429-
* // returns ~-0.2
430-
*
431-
* @example
432-
* var v = ns.divf( 2.0, 5.0 );
433-
* // returns ~0.4
434-
*
435-
* @example
436-
* var v = ns.divf( 0.0, 5.0 );
437-
* // returns 0.0
438-
*
439-
* @example
440-
* var v = ns.divf( -0.0, 5.0 );
441-
* // returns -0.0
442-
*
443-
* @example
444-
* var v = ns.divf( NaN, NaN );
445-
* // returns NaN
446-
*/
447-
divf: typeof divf;
448-
449420
/**
450421
* Performs C-like multiplication of two signed 32-bit integers.
451422
*
@@ -593,6 +564,35 @@ interface Namespace {
593564
*/
594565
addf: typeof addf;
595566

567+
/**
568+
* Divides two single-precision floating-point numbers `x` and `y`.
569+
*
570+
* @param x - first input value (divided)
571+
* @param y - second input value (divisor)
572+
* @returns result
573+
*
574+
* @example
575+
* var v = ns.divf( -1.0, 5.0 );
576+
* // returns ~-0.2
577+
*
578+
* @example
579+
* var v = ns.divf( 2.0, 5.0 );
580+
* // returns ~0.4
581+
*
582+
* @example
583+
* var v = ns.divf( 0.0, 5.0 );
584+
* // returns 0.0
585+
*
586+
* @example
587+
* var v = ns.divf( -0.0, 5.0 );
588+
* // returns -0.0
589+
*
590+
* @example
591+
* var v = ns.divf( NaN, NaN );
592+
* // returns NaN
593+
*/
594+
divf: typeof divf;
595+
596596
/**
597597
* Divides two double-precision floating-point numbers `x` and `y`.
598598
*

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

+4-31
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ import dmeanvarpn = require( '@stdlib/stats/base/dmeanvarpn' );
3535
import dmskmax = require( '@stdlib/stats/base/dmskmax' );
3636
import dmskmin = require( '@stdlib/stats/base/dmskmin' );
3737
import dmskrange = require( '@stdlib/stats/base/dmskrange' );
38-
import dnanmean = require( '@stdlib/stats/strided/dnanmean' );
3938
import dnanmeanors = require( '@stdlib/stats/base/dnanmeanors' );
4039
import dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' );
4140
import dnanmeanpw = require( '@stdlib/stats/base/dnanmeanpw' );
@@ -646,32 +645,6 @@ interface Namespace {
646645
*/
647646
dmskrange: typeof dmskrange;
648647

649-
/**
650-
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values.
651-
*
652-
* @param N - number of indexed elements
653-
* @param x - input array
654-
* @param strideX - stride length
655-
* @returns arithmetic mean
656-
*
657-
* @example
658-
* var Float64Array = require( '@stdlib/array/float64' );
659-
*
660-
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
661-
*
662-
* var v = ns.dnanmean( x.length, x, 1 );
663-
* // returns ~0.3333
664-
*
665-
* @example
666-
* var Float64Array = require( '@stdlib/array/float64' );
667-
*
668-
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
669-
*
670-
* var v = ns.dnanmean.ndarray( x.length, x, 1, 0 );
671-
* // returns ~0.3333
672-
*/
673-
dnanmean: typeof dnanmean;
674-
675648
/**
676649
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation.
677650
*
@@ -1145,7 +1118,7 @@ interface Namespace {
11451118
* @param N - number of indexed elements
11461119
* @param correction - degrees of freedom adjustment
11471120
* @param x - input array
1148-
* @param stride - stride length
1121+
* @param strideX - stride length
11491122
* @returns variance
11501123
*
11511124
* @example
@@ -1172,7 +1145,7 @@ interface Namespace {
11721145
* @param N - number of indexed elements
11731146
* @param correction - degrees of freedom adjustment
11741147
* @param x - input array
1175-
* @param stride - stride length
1148+
* @param strideX - stride length
11761149
* @returns variance
11771150
*
11781151
* @example
@@ -1226,7 +1199,7 @@ interface Namespace {
12261199
* @param N - number of indexed elements
12271200
* @param correction - degrees of freedom adjustment
12281201
* @param x - input array
1229-
* @param stride - stride length
1202+
* @param strideX - stride length
12301203
* @returns variance
12311204
*
12321205
* @example
@@ -1253,7 +1226,7 @@ interface Namespace {
12531226
* @param N - number of indexed elements
12541227
* @param correction - degrees of freedom adjustment
12551228
* @param x - input array
1256-
* @param stride - stride length
1229+
* @param strideX - stride length
12571230
* @returns variance
12581231
*
12591232
* @example

0 commit comments

Comments
 (0)