Skip to content

Commit

Permalink
feat!: update namespace TypeScript declarations
Browse files Browse the repository at this point in the history
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: stdlib-js#4828
Reviewed-by: Athan Reines <kgryte@gmail.com>
stdlib-bot authored and Neerajpathak07 committed Jan 23, 2025
1 parent 8d8ffda commit 7cc0273
Showing 1 changed file with 0 additions and 31 deletions.
31 changes: 0 additions & 31 deletions lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
@@ -24,7 +24,6 @@ import cumax = require( '@stdlib/stats/base/cumax' );
import cumaxabs = require( '@stdlib/stats/base/cumaxabs' );
import cumin = require( '@stdlib/stats/base/cumin' );
import cuminabs = require( '@stdlib/stats/base/cuminabs' );
import dcumax = require( '@stdlib/stats/strided/dcumax' );
import dcumaxabs = require( '@stdlib/stats/base/dcumaxabs' );
import dcumin = require( '@stdlib/stats/base/dcumin' );
import dcuminabs = require( '@stdlib/stats/base/dcuminabs' );
@@ -346,36 +345,6 @@ interface Namespace {
*/
cuminabs: typeof cuminabs;

/**
* Computes the cumulative maximum of double-precision floating-point strided array elements.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - `x` stride length
* @param y - output array
* @param strideY - `y` stride length
* @returns output array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
* var y = new Float64Array( x.length );
*
* ns.dcumax( x.length, x, 1, y, 1 );
* // y => <Float64Array>[ 1.0, 1.0, 2.0 ]
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
* var y = new Float64Array( x.length );
*
* ns.dcumax.ndarray( x.length, x, 1, 0, y, 1, 0 );
* // y => <Float64Array>[ 1.0, 1.0, 2.0 ]
*/
dcumax: typeof dcumax;

/**
* Computes the cumulative maximum absolute value of double-precision floating-point strided array elements.
*

0 comments on commit 7cc0273

Please sign in to comment.