Skip to content

Commit cfada54

Browse files
authored
feat!: update namespace TypeScript declarations
This commit removes `dmaxsorted`, `dmaxabssorted`, and `dmeankbn` as part of the migration of those packages from `stats/base` to `stats/strided`. BREAKING CHANGE: remove `dmaxsorted`, `dmaxabssorted`, and `dmeankbn` To migrate, users should access the removed symbols via the `stats/strided` namespace. PR-URL: #5277 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent a4c70ed commit cfada54

File tree

1 file changed

+0
-81
lines changed
  • lib/node_modules/@stdlib/stats/base/docs/types

1 file changed

+0
-81
lines changed

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

Lines changed: 0 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,7 @@ import cumin = require( '@stdlib/stats/base/cumin' );
2626
import cuminabs = require( '@stdlib/stats/base/cuminabs' );
2727
import dcumin = require( '@stdlib/stats/base/dcumin' );
2828
import dists = require( '@stdlib/stats/base/dists' );
29-
import dmaxabssorted = require( '@stdlib/stats/strided/dmaxabssorted' );
30-
import dmaxsorted = require( '@stdlib/stats/strided/dmaxsorted' );
3129
import dmean = require( '@stdlib/stats/base/dmean' );
32-
import dmeankbn = require( '@stdlib/stats/strided/dmeankbn' );
3330
import dmeankbn2 = require( '@stdlib/stats/base/dmeankbn2' );
3431
import dmeanli = require( '@stdlib/stats/base/dmeanli' );
3532
import dmeanlipw = require( '@stdlib/stats/base/dmeanlipw' );
@@ -377,58 +374,6 @@ interface Namespace {
377374
*/
378375
dists: typeof dists;
379376

380-
/**
381-
* Computes the maximum absolute value of a sorted double-precision floating-point strided array.
382-
*
383-
* @param N - number of indexed elements
384-
* @param x - sorted input array
385-
* @param strideX - stride length
386-
* @returns maximum absolute value
387-
*
388-
* @example
389-
* var Float64Array = require( '@stdlib/array/float64' );
390-
*
391-
* var x = new Float64Array( [ -1.0, -2.0, -3.0 ] );
392-
*
393-
* var v = ns.dmaxabssorted( x.length, x, 1 );
394-
* // returns 3.0
395-
*
396-
* @example
397-
* var Float64Array = require( '@stdlib/array/float64' );
398-
*
399-
* var x = new Float64Array( [ -1.0, -2.0, -3.0 ] );
400-
*
401-
* var v = ns.dmaxabssorted.ndarray( x.length, x, 1, 0 );
402-
* // returns 3.0
403-
*/
404-
dmaxabssorted: typeof dmaxabssorted;
405-
406-
/**
407-
* Computes the maximum value of a sorted double-precision floating-point strided array.
408-
*
409-
* @param N - number of indexed elements
410-
* @param x - sorted input array
411-
* @param strideX - stride length
412-
* @returns maximum value
413-
*
414-
* @example
415-
* var Float64Array = require( '@stdlib/array/float64' );
416-
*
417-
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
418-
*
419-
* var v = ns.dmaxsorted( x.length, x, 1 );
420-
* // returns 3.0
421-
*
422-
* @example
423-
* var Float64Array = require( '@stdlib/array/float64' );
424-
*
425-
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
426-
*
427-
* var v = ns.dmaxsorted.ndarray( x.length, x, 1, 0 );
428-
* // returns 3.0
429-
*/
430-
dmaxsorted: typeof dmaxsorted;
431-
432377
/**
433378
* Computes the arithmetic mean of a double-precision floating-point strided array.
434379
*
@@ -455,32 +400,6 @@ interface Namespace {
455400
*/
456401
dmean: typeof dmean;
457402

458-
/**
459-
* Computes the arithmetic mean of a double-precision floating-point strided array using an improved Kahan–Babuška algorithm.
460-
*
461-
* @param N - number of indexed elements
462-
* @param x - input array
463-
* @param strideX - stride length
464-
* @returns arithmetic mean
465-
*
466-
* @example
467-
* var Float64Array = require( '@stdlib/array/float64' );
468-
*
469-
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
470-
*
471-
* var v = ns.dmeankbn( x.length, x, 1 );
472-
* // returns ~0.3333
473-
*
474-
* @example
475-
* var Float64Array = require( '@stdlib/array/float64' );
476-
*
477-
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
478-
*
479-
* var v = ns.dmeankbn.ndarray( x.length, x, 1, 0 );
480-
* // returns ~0.3333
481-
*/
482-
dmeankbn: typeof dmeankbn;
483-
484403
/**
485404
* Computes the arithmetic mean of a double-precision floating-point strided array using a second-order iterative Kahan–Babuška algorithm.
486405
*

0 commit comments

Comments
 (0)