Skip to content

Commit

Permalink
feat!: update namespace TypeScript declarations
Browse files Browse the repository at this point in the history 
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]>
  • Loading branch information
@stdlib-bot
stdlib-bot authored Feb 24, 2025
1 parent 61f4a86 commit 31d673e
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 83 deletions.
24 changes: 2 additions & 22 deletions lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2400,39 +2400,19 @@ interface Namespace {
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
*
* ns.zdscal( 3, 2.0, zx, 1 );
*
* var z = zx.get( 1 );
* // returns <Complex128>
*
* var re = real( z );
* // returns 6.0
*
* var im = imag( z );
* // returns 8.0
* // zx => <Complex128Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
*
* ns.zdscal.ndarray( 2, 2.0, zx, 1, 1 );
*
* var z = zx.get( 1 );
* // returns <Complex128>
*
* var re = real( z );
* // returns 10.0
*
* var im = imag( z );
* // returns 12.0
* // zx => <Complex128Array>[ 1.0, 2.0, 6.0, 8.0, 10.0, 12.0 ]
*/
zdscal: typeof zdscal;

Expand Down
60 changes: 30 additions & 30 deletions lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ import cneg = require( '@stdlib/math/base/ops/cneg' );
import cnegf = require( '@stdlib/math/base/ops/cnegf' );
import csub = require( '@stdlib/math/base/ops/csub' );
import csubf = require( '@stdlib/math/base/ops/csubf' );
import divf = require( '@stdlib/number/float32/base/div' );
import imul = require( '@stdlib/math/base/ops/imul' );
import imuldw = require( '@stdlib/math/base/ops/imuldw' );
import mulf = require( '@stdlib/number/float32/base/mul' );
import subf = require( '@stdlib/math/base/ops/subf' );
import umul = require( '@stdlib/math/base/ops/umul' );
import umuldw = require( '@stdlib/math/base/ops/umuldw' );
import addf = require( '@stdlib/number/float32/base/add' );
import divf = require( '@stdlib/number/float32/base/div' );
import div = require( '@stdlib/number/float64/base/div' );
import mul = require( '@stdlib/number/float64/base/mul' );
import sub = require( '@stdlib/number/float64/base/sub' );
Expand Down Expand Up @@ -417,35 +417,6 @@ interface Namespace {
*/
csubf: typeof csubf;

/**
* Divides two single-precision floating-point numbers `x` and `y`.
*
* @param x - first input value (divided)
* @param y - second input value (divisor)
* @returns result
*
* @example
* var v = ns.divf( -1.0, 5.0 );
* // returns ~-0.2
*
* @example
* var v = ns.divf( 2.0, 5.0 );
* // returns ~0.4
*
* @example
* var v = ns.divf( 0.0, 5.0 );
* // returns 0.0
*
* @example
* var v = ns.divf( -0.0, 5.0 );
* // returns -0.0
*
* @example
* var v = ns.divf( NaN, NaN );
* // returns NaN
*/
divf: typeof divf;

/**
* Performs C-like multiplication of two signed 32-bit integers.
*
Expand Down Expand Up @@ -593,6 +564,35 @@ interface Namespace {
*/
addf: typeof addf;

/**
* Divides two single-precision floating-point numbers `x` and `y`.
*
* @param x - first input value (divided)
* @param y - second input value (divisor)
* @returns result
*
* @example
* var v = ns.divf( -1.0, 5.0 );
* // returns ~-0.2
*
* @example
* var v = ns.divf( 2.0, 5.0 );
* // returns ~0.4
*
* @example
* var v = ns.divf( 0.0, 5.0 );
* // returns 0.0
*
* @example
* var v = ns.divf( -0.0, 5.0 );
* // returns -0.0
*
* @example
* var v = ns.divf( NaN, NaN );
* // returns NaN
*/
divf: typeof divf;

/**
* Divides two double-precision floating-point numbers `x` and `y`.
*
Expand Down
35 changes: 4 additions & 31 deletions lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ import dmeanvarpn = require( '@stdlib/stats/base/dmeanvarpn' );
import dmskmax = require( '@stdlib/stats/base/dmskmax' );
import dmskmin = require( '@stdlib/stats/base/dmskmin' );
import dmskrange = require( '@stdlib/stats/base/dmskrange' );
import dnanmean = require( '@stdlib/stats/strided/dnanmean' );
import dnanmeanors = require( '@stdlib/stats/base/dnanmeanors' );
import dnanmeanpn = require( '@stdlib/stats/base/dnanmeanpn' );
import dnanmeanpw = require( '@stdlib/stats/base/dnanmeanpw' );
Expand Down Expand Up @@ -646,32 +645,6 @@ interface Namespace {
*/
dmskrange: typeof dmskrange;

/**
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - stride length
* @returns arithmetic mean
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
*
* var v = ns.dnanmean( x.length, x, 1 );
* // returns ~0.3333
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
*
* var v = ns.dnanmean.ndarray( x.length, x, 1, 0 );
* // returns ~0.3333
*/
dnanmean: typeof dnanmean;

/**
* Computes the arithmetic mean of a double-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation.
*
Expand Down Expand Up @@ -1145,7 +1118,7 @@ interface Namespace {
* @param N - number of indexed elements
* @param correction - degrees of freedom adjustment
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns variance
*
* @example
Expand All @@ -1172,7 +1145,7 @@ interface Namespace {
* @param N - number of indexed elements
* @param correction - degrees of freedom adjustment
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns variance
*
* @example
Expand Down Expand Up @@ -1226,7 +1199,7 @@ interface Namespace {
* @param N - number of indexed elements
* @param correction - degrees of freedom adjustment
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns variance
*
* @example
Expand All @@ -1253,7 +1226,7 @@ interface Namespace {
* @param N - number of indexed elements
* @param correction - degrees of freedom adjustment
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns variance
*
* @example
Expand Down

1 comment on commit 31d673e

@stdlib-bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
blas/base $\color{green}870/870$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}870/870$
$\color{green}+100.00\%$
math/base/ops $\color{green}213/213$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}213/213$
$\color{green}+100.00\%$
stats/base $\color{green}1923/1923$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}1923/1923$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.