From b01975d64056ded2e69b61ab8b0f5efafa01a47f Mon Sep 17 00:00:00 2001 From: hrshya Date: Fri, 23 May 2025 14:04:24 +0530 Subject: [PATCH] docs: replace manual for loop in examples --- .../stats/base/dists/cosine/mgf/README.md | 24 ++++++++----------- .../base/dists/cosine/mgf/examples/index.js | 22 +++++++---------- .../stats/base/dists/cosine/mode/README.md | 19 +++++++-------- .../base/dists/cosine/mode/examples/index.js | 19 +++++++-------- .../stats/base/dists/cosine/pdf/README.md | 24 ++++++++----------- .../base/dists/cosine/pdf/examples/index.js | 22 +++++++---------- .../base/dists/cosine/quantile/README.md | 24 ++++++++----------- .../dists/cosine/quantile/examples/index.js | 22 +++++++---------- .../base/dists/cosine/skewness/README.md | 19 +++++++-------- .../dists/cosine/skewness/examples/index.js | 19 +++++++-------- .../stats/base/dists/cosine/stdev/README.md | 19 +++++++-------- .../base/dists/cosine/stdev/examples/index.js | 19 +++++++-------- .../base/dists/cosine/variance/README.md | 19 +++++++-------- .../dists/cosine/variance/examples/index.js | 19 +++++++-------- 14 files changed, 121 insertions(+), 169 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/README.md index eefbc41a9532..e7a58f520da4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/README.md @@ -113,22 +113,18 @@ var y = mymgf( 0.1 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var mgf = require( '@stdlib/stats/base/dists/cosine/mgf' ); -var mu; -var s; -var t; -var y; -var i; - -for ( i = 0; i < 10; i++ ) { - t = randu() * 10.0; - mu = randu() * 10.0; - s = randu() * 10.0; - y = mgf( t, mu, s ); - console.log( 't: %d, µ: %d, s: %d, M_X(t;µ,s): %d', t.toFixed( 4 ), mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) ); -} +var opts = { + 'dtype': 'float64' +}; +var t = uniform( 10, 0.0, 10.0, opts ); +var mu = uniform( 10, 0.0, 10.0, opts ); +var s = uniform( 10, 0.0, 10.0, opts ); + +logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, M_X(t;µ,s): %0.4f', t, mu, s, mgf ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/examples/index.js index d9b1897534b2..c14034432773 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/examples/index.js @@ -18,19 +18,15 @@ '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 mgf = require( './../lib' ); -var mu; -var s; -var t; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var t = uniform( 10, 0.0, 10.0, opts ); +var mu = uniform( 10, 0.0, 10.0, opts ); +var s = uniform( 10, 0.0, 10.0, opts ); -for ( i = 0; i < 10; i++ ) { - t = randu() * 10.0; - mu = randu() * 10.0; - s = randu() * 10.0; - y = mgf( t, mu, s ); - console.log( 'x: %d, µ: %d, s: %d, M_X(t;µ,s): %d', t.toFixed( 4 ), mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, M_X(t;µ,s): %0.4f', t, mu, s, mgf ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mode/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/mode/README.md index 1fb5d057a0f5..522ecfd38e8c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mode/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mode/README.md @@ -111,20 +111,17 @@ y = mode( 0.0, -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 mode = require( '@stdlib/stats/base/dists/cosine/mode' ); -var mu; -var s; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var mu = uniform( 10, -5.0, 5.0, opts ); +var s = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - mu = ( randu()*10.0 ) - 5.0; - s = randu() * 20.0; - y = mode( mu, s ); - console.log( 'µ: %d, s: %d, mode(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'µ: %0.4f, s: %0.4f, mode(X;µ,s): %0.4f', mu, s, mode ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mode/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/mode/examples/index.js index 7d2ddc7fa8c1..f34fd0adadd3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mode/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mode/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 mode = require( './../lib' ); -var mu; -var s; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var mu = uniform( 10, -5.0, 5.0, opts ); +var s = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - mu = ( randu()*10.0 ) - 5.0; - s = randu() * 20.0; - y = mode( mu, s ); - console.log( 'µ: %d, s: %d, mode(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'µ: %0.4f, s: %0.4f, mode(X;µ,s): %0.4f', mu, s, mode ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/pdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/pdf/README.md index df680738c973..37df3477e972 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/pdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/pdf/README.md @@ -120,22 +120,18 @@ y = mypdf( 5.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 pdf = require( '@stdlib/stats/base/dists/cosine/pdf' ); -var mu; -var s; -var x; -var y; -var i; - -for ( i = 0; i < 10; i++ ) { - x = randu() * 10.0; - mu = randu() * 10.0; - s = randu() * 10.0; - y = pdf( x, mu, s ); - console.log( 'x: %d, µ: %d, s: %d, f(x;µ,s): %d', x, mu, s, y ); -} +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 10, 0.0, 10.0, opts ); +var mu = uniform( 10, 0.0, 10.0, opts ); +var s = uniform( 10, 0.0, 10.0, opts ); + +logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, f(x;µ,s): %0.4f', x, mu, s, pdf ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/pdf/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/pdf/examples/index.js index 5736de8c7899..873ba1213aba 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/pdf/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/pdf/examples/index.js @@ -18,19 +18,15 @@ '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 pdf = require( './../lib' ); -var mu; -var s; -var x; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 10, 0.0, 10.0, opts ); +var mu = uniform( 10, 0.0, 10.0, opts ); +var s = uniform( 10, 0.0, 10.0, opts ); -for ( i = 0; i < 10; i++ ) { - x = randu() * 10; - mu = randu() * 10; - s = randu() * 10; - y = pdf( x, mu, s ); - console.log( 'x: %d, µ: %d, s: %d, f(x;µ,s): %d', x, mu, s, y ); -} +logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, f(x;µ,s): %0.4f', x, mu, s, pdf ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/quantile/README.md index 06f040b02def..ef186364a58b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/quantile/README.md @@ -111,22 +111,18 @@ y = myQuantile( 0.9 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var quantile = require( '@stdlib/stats/base/dists/cosine/quantile' ); -var mu; -var s; -var p; -var y; -var i; - -for ( i = 0; i < 10; i++ ) { - p = randu(); - mu = randu() * 10.0; - s = randu() * 10.0; - y = quantile( p, mu, s ); - console.log( 'p: %d, µ: %d, s: %d, Q(p;µ,s): %d', p, mu, s, y ); -} +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); +var mu = uniform( 10, 0.0, 10.0, opts ); +var s = uniform( 10, 0.0, 10.0, opts ); + +logEachMap( 'p: %0.4f, µ: %0.4f, s: %0.4f, Q(p;µ,s): %0.4f', p, mu, s, quantile ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/quantile/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/quantile/examples/index.js index 62063e5c85db..ffa84849bea2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/quantile/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/quantile/examples/index.js @@ -18,19 +18,15 @@ '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 quantile = require( './../lib' ); -var mu; -var s; -var p; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var p = uniform( 10, 0.0, 1.0, opts ); +var mu = uniform( 10, 0.0, 10.0, opts ); +var s = uniform( 10, 0.0, 10.0, opts ); -for ( i = 0; i < 10; i++ ) { - p = randu(); - mu = randu() * 10.0; - s = randu() * 10.0; - y = quantile( p, mu, s ); - console.log( 'p: %d, µ: %d, s: %d, Q(p;µ,s): %d', p, mu, s, y ); -} +logEachMap( 'p: %0.4f, µ: %0.4f, s: %0.4f, Q(p;µ,s): %0.4f', p, mu, s, quantile ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/skewness/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/skewness/README.md index 95b997a3f974..f041d52a1780 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/skewness/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/skewness/README.md @@ -111,20 +111,17 @@ y = skewness( 0.0, -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 skewness = require( '@stdlib/stats/base/dists/cosine/skewness' ); -var mu; -var s; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var mu = uniform( 10, -5.0, 5.0, opts ); +var s = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - mu = ( randu()*10.0 ) - 5.0; - s = randu() * 20.0; - y = skewness( mu, s ); - console.log( 'µ: %d, s: %d, skew(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'µ: %0.4f, s: %0.4f, skew(X;µ,s): %0.4f', mu, s, skewness ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/skewness/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/skewness/examples/index.js index c05622d493ea..5723eb9b4979 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/skewness/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/skewness/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 skewness = require( './../lib' ); -var mu; -var s; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var mu = uniform( 10, -5.0, 5.0, opts ); +var s = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - mu = ( randu()*10.0 ) - 5.0; - s = randu() * 20.0; - y = skewness( mu, s ); - console.log( 'µ: %d, s: %d, skew(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'µ: %0.4f, s: %0.4f, skew(X;µ,s): %0.4f', mu, s, skewness ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/stdev/README.md index b45773a1f340..0b767e85b014 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/stdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/stdev/README.md @@ -111,20 +111,17 @@ y = stdev( 0.0, -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 stdev = require( '@stdlib/stats/base/dists/cosine/stdev' ); -var mu; -var s; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var mu = uniform( 10, -5.0, 5.0, opts ); +var s = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - mu = ( randu()*10.0 ) - 5.0; - s = randu() * 20.0; - y = stdev( mu, s ); - console.log( 'µ: %d, s: %d, SD(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'µ: %0.4f, s: %0.4f, SD(X;µ,s): %0.4f', mu, s, stdev ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/stdev/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/stdev/examples/index.js index 0481c410fcdc..bf0cf93f4eac 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/stdev/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/stdev/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 stdev = require( './../lib' ); -var mu; -var s; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var mu = uniform( 10, -5.0, 5.0, opts ); +var s = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - mu = ( randu()*10.0 ) - 5.0; - s = randu() * 20.0; - y = stdev( mu, s ); - console.log( 'µ: %d, s: %d, SD(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'µ: %0.4f, s: %0.4f, SD(X;µ,s): %0.4f', mu, s, stdev ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/variance/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/variance/README.md index 262f567fd092..5fcc7e64e4b6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/variance/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/variance/README.md @@ -111,20 +111,17 @@ y = variance( 0.0, -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 variance = require( '@stdlib/stats/base/dists/cosine/variance' ); -var mu; -var s; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var mu = uniform( 10, -5.0, 5.0, opts ); +var s = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - mu = ( randu()*10.0 ) - 5.0; - s = randu() * 20.0; - y = variance( mu, s ); - console.log( 'µ: %d, s: %d, Var(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'µ: %0.4f, s: %0.4f, Var(X;µ,s): %0.4f', mu, s, variance ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/variance/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/variance/examples/index.js index 8f2823e00e27..5d082f050301 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/variance/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/variance/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 variance = require( './../lib' ); -var mu; -var s; -var y; -var i; +var opts = { + 'dtype': 'float64' +}; +var mu = uniform( 10, -5.0, 5.0, opts ); +var s = uniform( 10, 0.0, 20.0, opts ); -for ( i = 0; i < 10; i++ ) { - mu = ( randu()*10.0 ) - 5.0; - s = randu() * 20.0; - y = variance( mu, s ); - console.log( 'µ: %d, s: %d, Var(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) ); -} +logEachMap( 'µ: %0.4f, s: %0.4f, Var(X;µ,s): %0.4f', mu, s, variance );