From 58c89a7133461fe998a39d698c6ccc350d062c1b Mon Sep 17 00:00:00 2001 From: hrshya Date: Wed, 21 May 2025 10:11:32 +0530 Subject: [PATCH] docs: replace manual for loop in examples --- .../stats/base/dists/chisquare/cdf/README.md | 23 ++++++++----------- .../dists/chisquare/cdf/examples/index.js | 21 ++++++++--------- .../base/dists/chisquare/entropy/README.md | 17 ++++++-------- .../dists/chisquare/entropy/examples/index.js | 16 ++++++------- .../base/dists/chisquare/kurtosis/README.md | 17 ++++++-------- .../chisquare/kurtosis/examples/index.js | 16 ++++++------- .../base/dists/chisquare/logpdf/README.md | 21 ++++++++--------- .../dists/chisquare/logpdf/examples/index.js | 19 +++++++-------- .../stats/base/dists/chisquare/mean/README.md | 17 ++++++-------- .../dists/chisquare/mean/examples/index.js | 16 ++++++------- .../base/dists/chisquare/median/README.md | 17 ++++++-------- .../dists/chisquare/median/examples/index.js | 16 ++++++------- 12 files changed, 92 insertions(+), 124 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/cdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/chisquare/cdf/README.md index 1421631e38e6..6f1daac4a607 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/cdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/cdf/README.md @@ -132,21 +132,18 @@ y = mycdf( 1.5 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var cdf = require( '@stdlib/stats/base/dists/chisquare/cdf' ); -var k; -var x; -var y; -var i; - -for ( i = 0; i < 20; i++ ) { - x = randu() * 10.0; - k = round( randu()*5.0 ); - y = cdf( x, k ); - console.log( 'x: %d, k: %d, F(x;k): %d', x.toFixed( 4 ), k.toFixed( 4 ), y.toFixed( 4 ) ); -} +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 20, 0.0, 10.0, opts ); +var k = discreteUniform( 20, 0, 10, opts ); + +logEachMap( 'x: %0.4f, k: %0.4f, F(x;k): %0.4f', x, k, cdf ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/cdf/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/chisquare/cdf/examples/index.js index dea7e0587d0d..1919b2cbe110 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/cdf/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/cdf/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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var cdf = require( './../lib' ); -var k; -var x; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 20, 0.0, 10.0, opts ); +var k = discreteUniform( 20, 0, 10, opts ); -for ( i = 0; i < 20; i++ ) { - x = randu() * 10.0; - k = round( randu() * 10.0 ); - y = cdf( x, k ); - console.log( 'x: %d, k: %d, F(x;k): %d', x.toFixed( 4 ), k.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'x: %0.4f, k: %0.4f, F(x;k): %0.4f', x, k, cdf ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/entropy/README.md b/lib/node_modules/@stdlib/stats/base/dists/chisquare/entropy/README.md index d02dda5ba2e7..2f4b101154d1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/entropy/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/entropy/README.md @@ -97,19 +97,16 @@ var 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/chisquare/entropy' ); -var k; -var v; -var i; +var opts = { + 'dtype': 'float64' +}; +var k = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - k = randu() * 20.0; - v = entropy( k ); - console.log( 'k: %d, entropy(X,k): %d', k.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'k: %0.4f, h(X;k): %0.4f', k, entropy ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/entropy/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/chisquare/entropy/examples/index.js index 6bca694cbb8f..28d947774b8c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/entropy/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/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 i; -var k; -var v; +var opts = { + 'dtype': 'float64' +}; +var k = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - k = randu() * 20.0; - v = entropy( k ); - console.log( 'k: %d, h(X;k): %d', k.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'k: %0.4f, h(X;k): %0.4f', k, entropy ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/kurtosis/README.md b/lib/node_modules/@stdlib/stats/base/dists/chisquare/kurtosis/README.md index 7127e7e314b6..8a7d2f1a70e4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/kurtosis/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/kurtosis/README.md @@ -97,19 +97,16 @@ var 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/chisquare/kurtosis' ); -var k; -var v; -var i; +var opts = { + 'dtype': 'float64' +}; +var k = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - k = randu() * 20.0; - v = kurtosis( k ); - console.log( 'k: %d, Kurt(X,k): %d', k.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'k: %0.4f, Kurt(X;k): %0.4f', k, kurtosis ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/kurtosis/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/chisquare/kurtosis/examples/index.js index dec9cc39b230..50673274b667 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/kurtosis/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/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 i; -var k; -var v; +var opts = { + 'dtype': 'float64' +}; +var k = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - k = randu() * 20.0; - v = kurtosis( k ); - console.log( 'k: %d, Kurt(X;k): %d', k.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'k: %0.4f, Kurt(X;k): %0.4f', k, kurtosis ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/chisquare/logpdf/README.md index 4f7b156dd857..b192545a19e0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/logpdf/README.md @@ -120,20 +120,17 @@ y = myLogPDF( 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 logpdf = require( '@stdlib/stats/base/dists/chisquare/logpdf' ); -var k; -var x; -var y; -var i; - -for ( i = 0; i < 20; i++ ) { - x = randu() * 10.0; - k = randu() * 10.0; - y = logpdf( x, k ); - console.log( 'x: %d, k: %d, ln(f(x;k)): %d', x.toFixed( 4 ), k.toFixed( 4 ), y.toFixed( 4 ) ); -} +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 20, 0.0, 10.0, opts ); +var k = uniform( 20, 0.0, 10.0, opts ); + +logEachMap( 'x: %0.4f, k: %0.4f, ln(f(x;k)): %0.4f', x, k, logpdf ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/logpdf/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/chisquare/logpdf/examples/index.js index 678331d5c623..74965eb52583 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/logpdf/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/logpdf/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 logpdf = require( './../lib' ); -var k; -var x; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 20, 0.0, 10.0, opts ); +var k = uniform( 20, 0.0, 10.0, opts ); -for ( i = 0; i < 20; i++ ) { - x = randu() * 10.0; - k = randu() * 10.0; - y = logpdf( x, k ); - console.log( 'x: %d, k: %d, ln(f(x;k)): %d', x.toFixed( 4 ), k.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'x: %0.4f, k: %0.4f, ln(f(x;k)): %0.4f', x, k, logpdf ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/chisquare/mean/README.md index 51e181782e30..611f3667ec0c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/mean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/mean/README.md @@ -97,19 +97,16 @@ var 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/chisquare/mean' ); -var k; -var v; -var i; +var opts = { + 'dtype': 'float64' +}; +var k = uniform( 20, 0.0, 10.0, opts ); -for ( i = 0; i < 10; i++ ) { - k = randu() * 20.0; - v = mean( k ); - console.log( 'k: %d, E(X,k): %d', k.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'k: %0.4f, E(X;k): %0.4f', k, mean ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/mean/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/chisquare/mean/examples/index.js index ad213c1155be..99d630976b49 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/mean/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/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 i; -var k; -var v; +var opts = { + 'dtype': 'float64' +}; +var k = uniform( 20, 0.0, 10.0, opts ); -for ( i = 0; i < 10; i++ ) { - k = randu() * 20.0; - v = mean( k ); - console.log( 'k: %d, E(X;k): %d', k.toFixed( 4 ), v.toFixed( 4 ) ); -} +logEachMap( 'k: %0.4f, E(X;k): %0.4f', k, mean ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/README.md b/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/README.md index 40f5d6cf08f5..90e771a2dae7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/README.md @@ -80,19 +80,16 @@ var y = 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/chisquare/median' ); -var k; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var k = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - k = randu() * 20.0; - y = median( k ); - console.log( 'k: %d, Median(X,k): %d', k.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'k: %0.4f, Median(X;k): %0.4f', k, median ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/examples/index.js index fcbd812a5e31..dea1e23c16ee 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/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 i; -var k; -var y; +var opts = { + 'dtype': 'float64' +}; +var k = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - k = randu() * 20.0; - y = median( k ); - console.log( 'k: %d, Median(X;k): %d', k.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'k: %0.4f, Median(X;k): %0.4f', k, median );