diff --git a/lib/node_modules/@stdlib/math/base/assert/is-negative-integerf/README.md b/lib/node_modules/@stdlib/math/base/assert/is-negative-integerf/README.md index 2ea1c42662fc..c602221f22ca 100644 --- a/lib/node_modules/@stdlib/math/base/assert/is-negative-integerf/README.md +++ b/lib/node_modules/@stdlib/math/base/assert/is-negative-integerf/README.md @@ -167,6 +167,7 @@ bool stdlib_base_is_negative_integerf( const float x ); ```c #include "stdlib/math/base/assert/is_negative_integerf.h" #include +#include int main( void ) { const float x[] = { 5.0f, -5.0f, 3.14f, -3.14f, 0.0f, 0.0f/0.0f }; diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/ctor/README.md b/lib/node_modules/@stdlib/stats/base/dists/weibull/ctor/README.md index f67227fe3711..838c8af14dd4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/weibull/ctor/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/weibull/ctor/README.md @@ -137,6 +137,17 @@ var mu = weibull.mean; // returns ~10.877 ``` +#### Weibull.prototype.median + +Returns the [median][median]. + +```javascript +var weibull = new Weibull( 4.0, 12.0 ); + +var median = weibull.median; +// returns ~10.949 +``` + #### Weibull.prototype.mode Returns the [mode][mode]. @@ -334,6 +345,8 @@ var y = weibull.cdf( 0.8 ); [kurtosis]: https://en.wikipedia.org/wiki/Kurtosis +[median]: https://en.wikipedia.org/wiki/Median + [mode]: https://en.wikipedia.org/wiki/Mode_%28statistics%29 [skewness]: https://en.wikipedia.org/wiki/Skewness diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/nanmin-by/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/nanmin-by/docs/repl.txt index e21004662353..231a51d5030d 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/nanmin-by/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/ndarray/nanmin-by/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( arrays, clbk[, thisArg] ) Computes the minimum value of a one-dimensional ndarray via a callback - function, ignoring NaN values. + function, ignoring `NaN` values. If provided an empty ndarray, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/nanmin-by/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/nanmin-by/lib/main.js index 86d9e38f8f69..6f6201f3e4ec 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/nanmin-by/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/nanmin-by/lib/main.js @@ -30,7 +30,7 @@ var strided = require( '@stdlib/stats/strided/nanmin-by' ).ndarray; // MAIN // /** -* Computes the minimum value of a one-dimensional ndarray via a callback function, ignoring NaN values. +* Computes the minimum value of a one-dimensional ndarray via a callback function, ignoring `NaN` values. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/nanrange-by/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/nanrange-by/lib/main.js index 6452546207c9..31e7691ca587 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/nanrange-by/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/nanrange-by/lib/main.js @@ -30,7 +30,7 @@ var strided = require( '@stdlib/stats/strided/nanrange-by' ).ndarray; // MAIN // /** -* Computes the range of a one-dimensional ndarray via a callback function, ignoring NaN values. +* Computes the range of a one-dimensional ndarray via a callback function, ignoring `NaN` values. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanrange/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/snanrange/docs/repl.txt index 8a7b74dea5a6..a73816e26310 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanrange/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanrange/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( arrays ) Computes the range of a one-dimensional single-precision floating-point - ndarray, ignoring NaN values. + ndarray, ignoring `NaN` values. If provided an empty ndarray, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanrange/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/snanrange/docs/types/index.d.ts index 2a53ebf11cdf..fb6af95057c0 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanrange/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanrange/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { float32ndarray } from '@stdlib/types/ndarray'; /** -* Computes the range of a one-dimensional single-precision floating-point ndarray, ignoring NaN values. +* Computes the range of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanrange/lib/native.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanrange/lib/native.js index 75244f105eae..46037efb2e5e 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanrange/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanrange/lib/native.js @@ -28,7 +28,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Computes the range of a one-dimensional single-precision floating-point ndarray, ignoring NaN values. +* Computes the range of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/docs/repl.txt index fee81205525c..4948afd2464c 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( W ) Returns an accumulator function which incrementally computes a moving - maximum absolute value while ignoring `NaN` values. + maximum absolute value, ignoring `NaN` values. The `W` parameter defines the number of values over which to compute the moving maximum absolute value. diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/docs/types/index.d.ts index eb6696d1d283..b836adc7259e 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/docs/types/index.d.ts @@ -30,7 +30,7 @@ type accumulator = ( x?: number ) => number | null; /** -* Returns an accumulator function which incrementally computes a moving maximum absolute value while ignoring `NaN` values. +* Returns an accumulator function which incrementally computes a moving maximum absolute value, ignoring `NaN` values. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/lib/index.js b/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/lib/index.js index 6d7b94391561..57081a1154e3 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/lib/index.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Compute a moving maximum absolute value incrementally while ignoring `NaN` values. +* Compute a moving maximum absolute value incrementally, ignoring `NaN` values. * * @module @stdlib/stats/incr/nanmmaxabs * diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/lib/main.js b/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/lib/main.js index 2d108987a532..31cfff281977 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmmaxabs/lib/main.js @@ -29,7 +29,7 @@ var format = require( '@stdlib/string/format' ); // MAIN // /** -* Returns an accumulator function which incrementally computes a moving maximum absolute value while ignoring NaN values. +* Returns an accumulator function which incrementally computes a moving maximum absolute value, ignoring `NaN` values. * * @param {PositiveInteger} W - window size * @throws {TypeError} must provide a positive integer diff --git a/lib/node_modules/@stdlib/stats/incr/nanmstdev/README.md b/lib/node_modules/@stdlib/stats/incr/nanmstdev/README.md index e902ef52fc1d..c6b93c301ee3 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmstdev/README.md +++ b/lib/node_modules/@stdlib/stats/incr/nanmstdev/README.md @@ -20,7 +20,7 @@ limitations under the License. # incrnanmstdev -> Compute a moving [corrected sample standard deviation][standard-deviation] incrementally, ignoring NaN values. +> Compute a moving [corrected sample standard deviation][standard-deviation] incrementally, ignoring `NaN` values.
diff --git a/lib/node_modules/@stdlib/stats/incr/nanmstdev/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/nanmstdev/docs/repl.txt index 4589f9e9d77b..8f59fe097b4e 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmstdev/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/incr/nanmstdev/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( W[, mean] ) Returns an accumulator function which incrementally computes a moving - corrected sample standard deviation, ignoring NaN values. + corrected sample standard deviation, ignoring `NaN` values. The `W` parameter defines the number of values over which to compute the moving corrected sample standard deviation. @@ -53,4 +53,4 @@ See Also -------- - + diff --git a/lib/node_modules/@stdlib/stats/incr/nanmstdev/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/nanmstdev/docs/types/index.d.ts index 7661335a91e1..55297158cb74 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmstdev/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/incr/nanmstdev/docs/types/index.d.ts @@ -33,7 +33,7 @@ type accumulator = ( x?: number ) => number | null; /** -* Returns an accumulator function which incrementally computes a moving corrected sample standard deviation, ignoring NaN values. +* Returns an accumulator function which incrementally computes a moving corrected sample standard deviation, ignoring `NaN` values. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/incr/nanmstdev/lib/index.js b/lib/node_modules/@stdlib/stats/incr/nanmstdev/lib/index.js index 77da373559f8..1e33aa18972e 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmstdev/lib/index.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmstdev/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Compute a moving corrected sample standard deviation incrementally, ignoring NaN values. +* Compute a moving corrected sample standard deviation incrementally, ignoring `NaN` values. * * @module @stdlib/stats/incr/nanmstdev * diff --git a/lib/node_modules/@stdlib/stats/incr/nanmstdev/lib/main.js b/lib/node_modules/@stdlib/stats/incr/nanmstdev/lib/main.js index c6019c85afb5..c86ef602a678 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmstdev/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmstdev/lib/main.js @@ -27,7 +27,7 @@ var incrmstdev = require( '@stdlib/stats/incr/mstdev' ); // MAIN // /** -* Returns an accumulator function which incrementally computes a moving corrected sample standard deviation, ignoring NaN values. +* Returns an accumulator function which incrementally computes a moving corrected sample standard deviation, ignoring `NaN` values. * * ## Method * diff --git a/lib/node_modules/@stdlib/stats/incr/nanmvmr/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/nanmvmr/docs/repl.txt index 0da71893da2b..d8674700b884 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmvmr/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/incr/nanmvmr/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( W[, mean] ) Returns an accumulator function which incrementally computes a moving - variance-to-mean ratio (VMR) while ignoring NaN values. + variance-to-mean ratio (VMR), ignoring `NaN` values. The `W` parameter defines the number of values over which to compute the moving variance-to-mean ratio. diff --git a/lib/node_modules/@stdlib/stats/incr/nanmvmr/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/nanmvmr/docs/types/index.d.ts index 61f92e74a6a2..b266ec31326d 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmvmr/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/incr/nanmvmr/docs/types/index.d.ts @@ -33,7 +33,7 @@ type accumulator = ( x?: number ) => number | null; /** -* Returns an accumulator function which incrementally computes a moving variance-to-mean ratio (VMR) while ignoring `NaN` values. +* Returns an accumulator function which incrementally computes a moving variance-to-mean ratio (VMR), ignoring `NaN` values. * * @param W - window size * @param mean - mean value diff --git a/lib/node_modules/@stdlib/stats/incr/nanmvmr/lib/main.js b/lib/node_modules/@stdlib/stats/incr/nanmvmr/lib/main.js index 8050faf815f4..bdb794470bea 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmvmr/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmvmr/lib/main.js @@ -27,7 +27,7 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' ); // MAIN // /** -* Returns an accumulator function which incrementally computes a moving variance-to-mean ratio (VMR) while ignoring `NaN` values. +* Returns an accumulator function which incrementally computes a moving variance-to-mean ratio (VMR), ignoring `NaN` values. * * ## Method * diff --git a/lib/node_modules/@stdlib/stats/incr/nanprod/lib/index.js b/lib/node_modules/@stdlib/stats/incr/nanprod/lib/index.js index c405aeba148b..94358d512fd7 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanprod/lib/index.js +++ b/lib/node_modules/@stdlib/stats/incr/nanprod/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Compute a product incrementally, while ignoring `NaN` values. +* Compute a product incrementally, ignoring `NaN` values. * * @module @stdlib/stats/incr/nanprod *