Skip to content

Commit fb535ff

Browse files
stdlib-botShabiShett07
stdlib-bot
authored and
ShabiShett07
committed
feat!: update namespace TypeScript declarations
This PR removes `dmax` from the `stats/base` namespace. That package has moved to `stats/strided`. BREAKING CHANGE: remove `dmax` To migrate, users should access `dmax` via the `stats/strided` namespace. PR-URL: stdlib-js#4809 Reviewed-by: Athan Reines <[email protected]>
1 parent 2bf2cee commit fb535ff

File tree

2 files changed

+35
-62
lines changed

2 files changed

+35
-62
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1444,12 +1444,12 @@ interface Namespace {
14441444
dsumpw: typeof dsumpw;
14451445

14461446
/**
1447-
* Adds a constant to each element in a strided array.
1447+
* Adds a scalar constant to each element in a strided array.
14481448
*
14491449
* @param N - number of indexed elements
1450-
* @param alpha - constant
1450+
* @param alpha - scalar constant
14511451
* @param x - input array
1452-
* @param stride - stride length
1452+
* @param strideX - stride length
14531453
* @returns `x`
14541454
*
14551455
* @example
@@ -1467,12 +1467,12 @@ interface Namespace {
14671467
gapx: typeof gapx;
14681468

14691469
/**
1470-
* Adds a constant to each strided array element and computes the sum.
1470+
* Adds a scalar constant to each strided array element and computes the sum.
14711471
*
14721472
* @param N - number of indexed elements
14731473
* @param alpha - constant
14741474
* @param x - input array
1475-
* @param stride - stride length
1475+
* @param strideX - stride length
14761476
* @returns sum
14771477
*
14781478
* @example
@@ -1513,12 +1513,12 @@ interface Namespace {
15131513
gapxsumkbn: typeof gapxsumkbn;
15141514

15151515
/**
1516-
* Adds a constant to each strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.
1516+
* Adds a scalar constant to each strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.
15171517
*
15181518
* @param N - number of indexed elements
1519-
* @param alpha - constant
1519+
* @param alpha - scalar constant
15201520
* @param x - input array
1521-
* @param stride - stride length
1521+
* @param strideX - stride length
15221522
* @returns sum
15231523
*
15241524
* @example
@@ -1536,12 +1536,12 @@ interface Namespace {
15361536
gapxsumkbn2: typeof gapxsumkbn2;
15371537

15381538
/**
1539-
* Adds a constant to each strided array element and computes the sum using ordinary recursive summation.
1539+
* Adds a scalar constant to each strided array element and computes the sum using ordinary recursive summation.
15401540
*
15411541
* @param N - number of indexed elements
1542-
* @param alpha - constant
1542+
* @param alpha - scalar constant
15431543
* @param x - input array
1544-
* @param stride - stride length
1544+
* @param strideX - stride length
15451545
* @returns sum
15461546
*
15471547
* @example
@@ -1559,12 +1559,12 @@ interface Namespace {
15591559
gapxsumors: typeof gapxsumors;
15601560

15611561
/**
1562-
* Adds a constant to each strided array element and computes the sum using pairwise summation.
1562+
* Adds a scalar constant to each strided array element and computes the sum using pairwise summation.
15631563
*
15641564
* @param N - number of indexed elements
1565-
* @param alpha - constant
1565+
* @param alpha - scalar constant
15661566
* @param x - input array
1567-
* @param stride - stride length
1567+
* @param strideX - stride length
15681568
* @returns sum
15691569
*
15701570
* @example
@@ -1586,7 +1586,7 @@ interface Namespace {
15861586
*
15871587
* @param N - number of indexed elements
15881588
* @param x - input array
1589-
* @param stride - stride length
1589+
* @param strideX - stride length
15901590
* @returns sum
15911591
*
15921592
* @example
@@ -1609,9 +1609,9 @@ interface Namespace {
16091609
* @param N - number of indexed elements
16101610
* @param sum - initial sum
16111611
* @param x - input array
1612-
* @param strideX - `x` stride length
1612+
* @param strideX - stride length for `x`
16131613
* @param y - output array
1614-
* @param strideY - `y` stride length
1614+
* @param strideY - stride length for `y`
16151615
* @returns output array
16161616
*
16171617
* @example
@@ -1663,9 +1663,9 @@ interface Namespace {
16631663
* @param N - number of indexed elements
16641664
* @param sum - initial sum
16651665
* @param x - input array
1666-
* @param strideX - `x` stride length
1666+
* @param strideX - stride length for `x`
16671667
* @param y - output array
1668-
* @param strideY - `y` stride length
1668+
* @param strideY - stride length for `y`
16691669
* @returns output array
16701670
*
16711671
* @example
@@ -1717,9 +1717,9 @@ interface Namespace {
17171717
* @param N - number of indexed elements
17181718
* @param sum - initial sum
17191719
* @param x - input array
1720-
* @param strideX - `x` stride length
1720+
* @param strideX - stride length for `x`
17211721
* @param y - output array
1722-
* @param strideY - `y` stride length
1722+
* @param strideY - stride length for `y`
17231723
* @returns output array
17241724
*
17251725
* @example
@@ -1739,12 +1739,12 @@ interface Namespace {
17391739
gcusumpw: typeof gcusumpw;
17401740

17411741
/**
1742-
* Fills a strided array with a specified scalar value.
1742+
* Fills a strided array with a specified scalar constant.
17431743
*
17441744
* @param N - number of indexed elements
1745-
* @param alpha - constant
1745+
* @param alpha - scalar constant
17461746
* @param x - input array
1747-
* @param stride - stride length
1747+
* @param strideX - stride length
17481748
* @returns `x`
17491749
*
17501750
* @example
@@ -1777,8 +1777,8 @@ interface Namespace {
17771777
*
17781778
* @param N - number of indexed elements
17791779
* @param x - input array
1780-
* @param stride - stride length
1781-
* @param clbk - callback
1780+
* @param strideX - stride length
1781+
* @param clbk - callback function
17821782
* @param thisArg - execution context
17831783
* @returns `x`
17841784
*
@@ -2169,7 +2169,7 @@ interface Namespace {
21692169
*
21702170
* @param N - number of indexed elements
21712171
* @param x - input array
2172-
* @param stride - stride length
2172+
* @param strideX - stride length
21732173
* @returns sum
21742174
*
21752175
* @example
@@ -2307,12 +2307,12 @@ interface Namespace {
23072307
sapxsum: typeof sapxsum;
23082308

23092309
/**
2310-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.
2310+
* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.
23112311
*
23122312
* @param N - number of indexed elements
2313-
* @param alpha - constant
2313+
* @param alpha - scalar constant
23142314
* @param x - input array
2315-
* @param stride - stride length
2315+
* @param strideX - stride length
23162316
* @returns sum
23172317
*
23182318
* @example
@@ -2446,9 +2446,9 @@ interface Namespace {
24462446
* @param N - number of indexed elements
24472447
* @param sum - initial sum
24482448
* @param x - input array
2449-
* @param strideX - `x` stride length
2449+
* @param strideX - stride length for `x`
24502450
* @param y - output array
2451-
* @param strideY - `y` stride length
2451+
* @param strideY - stride length for `y`
24522452
* @returns output array
24532453
*
24542454
* @example

‎lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts‎

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ import dcumaxabs = require( '@stdlib/stats/base/dcumaxabs' );
2929
import dcumin = require( '@stdlib/stats/base/dcumin' );
3030
import dcuminabs = require( '@stdlib/stats/base/dcuminabs' );
3131
import dists = require( '@stdlib/stats/base/dists' );
32-
import dmax = require( '@stdlib/stats/strided/dmax' );
3332
import dmaxabs = require( '@stdlib/stats/base/dmaxabs' );
3433
import dmaxabssorted = require( '@stdlib/stats/base/dmaxabssorted' );
3534
import dmaxsorted = require( '@stdlib/stats/base/dmaxsorted' );
@@ -472,32 +471,6 @@ interface Namespace {
472471
*/
473472
dists: typeof dists;
474473

475-
/**
476-
* Computes the maximum value of a double-precision floating-point strided array.
477-
*
478-
* @param N - number of indexed elements
479-
* @param x - input array
480-
* @param strideX - stride length
481-
* @returns maximum value
482-
*
483-
* @example
484-
* var Float64Array = require( '@stdlib/array/float64' );
485-
*
486-
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
487-
*
488-
* var v = ns.dmax( x.length, x, 1 );
489-
* // returns 2.0
490-
*
491-
* @example
492-
* var Float64Array = require( '@stdlib/array/float64' );
493-
*
494-
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
495-
*
496-
* var v = ns.dmax.ndarray( x.length, x, 1, 0 );
497-
* // returns 2.0
498-
*/
499-
dmax: typeof dmax;
500-
501474
/**
502475
* Computes the maximum absolute value of a double-precision floating-point strided array.
503476
*
@@ -2059,7 +2032,7 @@ interface Namespace {
20592032
*
20602033
* @param N - number of indexed elements
20612034
* @param x - input array
2062-
* @param stride - stride length
2035+
* @param strideX - stride length
20632036
* @returns arithmetic mean
20642037
*
20652038
* @example
@@ -2085,7 +2058,7 @@ interface Namespace {
20852058
*
20862059
* @param N - number of indexed elements
20872060
* @param x - input array
2088-
* @param stride - stride length
2061+
* @param strideX - stride length
20892062
* @returns arithmetic mean
20902063
*
20912064
* @example
@@ -2137,7 +2110,7 @@ interface Namespace {
21372110
*
21382111
* @param N - number of indexed elements
21392112
* @param x - input array
2140-
* @param stride - stride length
2113+
* @param strideX - stride length
21412114
* @returns arithmetic mean
21422115
*
21432116
* @example

0 commit comments

Comments
 (0)