Skip to content

Commit a0220fb

Browse files
authored
feat!: update namespace TypeScript declarations
This commit removes `dcumax` from the `stats/base` namespace. That package has moved to `stats/strided`. BREAKING CHANGE: remove `dcumax` To migrate, users should update their code paths to access `dcumax` via `stats/strided`. PR-URL: #4828 Reviewed-by: Athan Reines <[email protected]>
1 parent 58801b6 commit a0220fb

File tree

1 file changed

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

1 file changed

+0
-31
lines changed

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

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ import cumax = require( '@stdlib/stats/base/cumax' );
2424
import cumaxabs = require( '@stdlib/stats/base/cumaxabs' );
2525
import cumin = require( '@stdlib/stats/base/cumin' );
2626
import cuminabs = require( '@stdlib/stats/base/cuminabs' );
27-
import dcumax = require( '@stdlib/stats/strided/dcumax' );
2827
import dcumaxabs = require( '@stdlib/stats/base/dcumaxabs' );
2928
import dcumin = require( '@stdlib/stats/base/dcumin' );
3029
import dcuminabs = require( '@stdlib/stats/base/dcuminabs' );
@@ -346,36 +345,6 @@ interface Namespace {
346345
*/
347346
cuminabs: typeof cuminabs;
348347

349-
/**
350-
* Computes the cumulative maximum of double-precision floating-point strided array elements.
351-
*
352-
* @param N - number of indexed elements
353-
* @param x - input array
354-
* @param strideX - `x` stride length
355-
* @param y - output array
356-
* @param strideY - `y` stride length
357-
* @returns output array
358-
*
359-
* @example
360-
* var Float64Array = require( '@stdlib/array/float64' );
361-
*
362-
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
363-
* var y = new Float64Array( x.length );
364-
*
365-
* ns.dcumax( x.length, x, 1, y, 1 );
366-
* // y => <Float64Array>[ 1.0, 1.0, 2.0 ]
367-
*
368-
* @example
369-
* var Float64Array = require( '@stdlib/array/float64' );
370-
*
371-
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
372-
* var y = new Float64Array( x.length );
373-
*
374-
* ns.dcumax.ndarray( x.length, x, 1, 0, y, 1, 0 );
375-
* // y => <Float64Array>[ 1.0, 1.0, 2.0 ]
376-
*/
377-
dcumax: typeof dcumax;
378-
379348
/**
380349
* Computes the cumulative maximum absolute value of double-precision floating-point strided array elements.
381350
*

0 commit comments

Comments
 (0)