From 6e7f07645a90705deedf48ea703caa183ee0a6a4 Mon Sep 17 00:00:00 2001 From: hrshya Date: Tue, 9 Sep 2025 13:54:57 +0530 Subject: [PATCH 1/2] docs: replace manual for loop in examples --- .../stats/base/dists/geometric/cdf/README.md | 19 +++++++---------- .../dists/geometric/cdf/examples/index.js | 19 +++++++---------- .../base/dists/geometric/entropy/README.md | 17 +++++++-------- .../dists/geometric/entropy/examples/index.js | 16 +++++++------- .../base/dists/geometric/kurtosis/README.md | 17 +++++++-------- .../geometric/kurtosis/examples/index.js | 16 +++++++------- .../base/dists/geometric/logcdf/README.md | 19 +++++++---------- .../dists/geometric/logcdf/examples/index.js | 19 +++++++---------- .../base/dists/geometric/logpmf/README.md | 21 ++++++++----------- .../dists/geometric/logpmf/examples/index.js | 21 ++++++++----------- .../stats/base/dists/geometric/mean/README.md | 17 +++++++-------- .../dists/geometric/mean/examples/index.js | 16 +++++++------- .../base/dists/geometric/median/README.md | 17 +++++++-------- .../dists/geometric/median/examples/index.js | 16 +++++++------- 14 files changed, 106 insertions(+), 144 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/README.md index 133161f1ae5a..41e6a1adde6e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/README.md @@ -109,20 +109,17 @@ y = mycdf( 1.0 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var cdf = require( '@stdlib/stats/base/dists/geometric/cdf' ); -var p; -var x; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); +var x = uniform( 10, 0.0, 5.0, opts ); -for ( i = 0; i < 10; i++ ) { - x = randu() * 5.0; - p = randu(); - y = cdf( x, p ); - console.log( 'x: %d, p: %d, F(x;p): %d', x.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, cdf ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/examples/index.js index 3a2cfc434488..88fa4d81cd16 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/examples/index.js @@ -18,17 +18,14 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var cdf = require( './../lib' ); -var p; -var x; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); +var x = uniform( 10, 0.0, 5.0, opts ); -for ( i = 0; i < 10; i++ ) { - x = randu() * 5.0; - p = randu(); - y = cdf( x, p ); - console.log( 'x: %d, p: %d, F(x;p): %d', x.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, cdf ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/entropy/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/entropy/README.md index 9c80855663cd..65617e5dfa4c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/entropy/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/entropy/README.md @@ -103,19 +103,16 @@ v = entropy( -1.0 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var entropy = require( '@stdlib/stats/base/dists/geometric/entropy' ); -var v; -var i; -var p; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); -for ( i = 0; i < 10; i++ ) { - p = randu(); - v = entropy( p ); - console.log( 'p: %d, H(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'p: %0.4f, H(X;p): %0.4f', p, entropy ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/entropy/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/entropy/examples/index.js index 1ea82b278b0a..d4a7b1a1c502 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/entropy/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/entropy/examples/index.js @@ -18,15 +18,13 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var entropy = require( './../lib' ); -var v; -var i; -var p; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); -for ( i = 0; i < 10; i++ ) { - p = randu(); - v = entropy( p ); - console.log( 'p: %d, H(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'p: %0.4f, H(X;p): %0.4f', p, entropy ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md index 8b4bdc2945fb..dabfa50cc2ad 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md @@ -103,19 +103,16 @@ v = kurtosis( -1.0 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var kurtosis = require( '@stdlib/stats/base/dists/geometric/kurtosis' ); -var v; -var i; -var p; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); -for ( i = 0; i < 10; i++ ) { - p = randu(); - v = kurtosis( p ); - console.log( 'p: %d, Kurt(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'p: %0.4f, Kurt(X;p): %0.4f', p, kurtosis ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/index.js index 4c630420a3b2..c223fe22c86e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/index.js @@ -18,15 +18,13 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var kurtosis = require( './../lib' ); -var v; -var i; -var p; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); -for ( i = 0; i < 10; i++ ) { - p = randu(); - v = kurtosis( p ); - console.log( 'p: %d, Kurt(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'p: %0.4f, Kurt(X;p): %0.4f', p, kurtosis ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md index 801c70cf17f6..9ef487bf7857 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md @@ -119,20 +119,17 @@ y = mylogcdf( 1.0 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var logcdf = require( '@stdlib/stats/base/dists/geometric/logcdf' ); -var p; -var x; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); +var x = uniform( 10, 0.0, 5.0, opts ); -for ( i = 0; i < 10; i++ ) { - x = randu() * 5.0; - p = randu(); - y = logcdf( x, p ); - console.log( 'x: %d, p: %d, ln(F(x;p)): %d', x.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, logcdf );} ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/examples/index.js index adc39a94a2ea..48be49f836aa 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/examples/index.js @@ -18,17 +18,14 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var logcdf = require( './../lib' ); -var p; -var x; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); +var x = uniform( 10, 0.0, 5.0, opts ); -for ( i = 0; i < 10; i++ ) { - x = randu() * 5.0; - p = randu(); - y = logcdf( x, p ); - console.log( 'x: %d, p: %d, F(x;p): %d', x.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, logcdf ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/README.md index ab1fc2027c7b..b5532c34bd69 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/README.md @@ -122,21 +122,18 @@ y = mylogpmf( 1.0 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var logpmf = require( '@stdlib/stats/base/dists/geometric/logpmf' ); -var p; -var x; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); +var x = discreteUniform( 10, 0, 5, opts ); -for ( i = 0; i < 10; i++ ) { - x = round( randu() * 5.0 ); - p = randu(); - y = logpmf( x, p ); - console.log( 'x: %d, p: %d, ln( P( X = x; p ) ): %d', x, p.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'x: %d, p: %0.4f, ln( P( X = x; p ) ): %0.4f', x, p, logpmf ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/examples/index.js index 277054059dcc..8cbf93abd9f4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/examples/index.js @@ -18,18 +18,15 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var logpmf = require( './../lib' ); -var p; -var x; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); +var x = discreteUniform( 10, 0, 5, opts ); -for ( i = 0; i < 10; i++ ) { - x = round( randu() * 5.0 ); - p = randu(); - y = logpmf( x, p ); - console.log( 'x: %d, p: %d, ln( P( X = x; p ) ): %d', x, p.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'x: %d, p: %0.4f, ln( P( X = x; p ) ): %0.4f', x, p, logpmf ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/mean/README.md index b36a01e96c7e..2c7b34457e12 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/mean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/mean/README.md @@ -103,19 +103,16 @@ v = mean( -1.0 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var mean = require( '@stdlib/stats/base/dists/geometric/mean' ); -var v; -var i; -var p; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); -for ( i = 0; i < 10; i++ ) { - p = randu(); - v = mean( p ); - console.log( 'p: %d, E(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'p: %0.4f, E(X;p): %0.4f', p, mean ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/mean/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/mean/examples/index.js index f0f55516d358..1c14985fcb86 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/mean/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/mean/examples/index.js @@ -18,15 +18,13 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var mean = require( './../lib' ); -var v; -var i; -var p; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); -for ( i = 0; i < 10; i++ ) { - p = randu(); - v = mean( p ); - console.log( 'p: %d, E(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'p: %0.4f, E(X;p): %0.4f', p, mean ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/median/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/median/README.md index ece2e8007c93..0b31e469211e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/median/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/median/README.md @@ -103,19 +103,16 @@ v = median( -1.0 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var median = require( '@stdlib/stats/base/dists/geometric/median' ); -var v; -var i; -var p; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); -for ( i = 0; i < 10; i++ ) { - p = randu(); - v = median( p ); - console.log( 'p: %d, Median(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'p: %0.4f, Median(X;p): %0.4f', p, median ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/median/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/median/examples/index.js index 2c3fe9dbb7cd..99c53ae508ce 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/median/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/median/examples/index.js @@ -18,15 +18,13 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var median = require( './../lib' ); -var v; -var i; -var p; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); -for ( i = 0; i < 10; i++ ) { - p = randu(); - v = median( p ); - console.log( 'p: %d, Median(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'p: %0.4f, Median(X;p): %0.4f', p, median ); From c061476a2995f7fb8abddbc9fe43311421b829cb Mon Sep 17 00:00:00 2001 From: Harsh <149176984+hrshya@users.noreply.github.com> Date: Tue, 9 Sep 2025 14:07:00 +0530 Subject: [PATCH 2/2] fixs lint issues Signed-off-by: Harsh <149176984+hrshya@users.noreply.github.com> --- .../@stdlib/stats/base/dists/geometric/logcdf/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md index 9ef487bf7857..9e94d3752414 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md @@ -129,7 +129,7 @@ var opts = { var p = uniform( 10, 0.0, 1.0, opts ); var x = uniform( 10, 0.0, 5.0, opts ); -logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, logcdf );} +logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, logcdf ); ```