From e89de73407756e5ae0c8d3998d4944a937baf916 Mon Sep 17 00:00:00 2001 From: hrshya Date: Tue, 25 Mar 2025 00:15:47 +0530 Subject: [PATCH 1/2] docs: replace manual for loop in examples --- .../@stdlib/math/base/special/deg2rad/README.md | 16 +++++++--------- .../math/base/special/deg2rad/examples/index.js | 16 +++++++--------- .../@stdlib/math/base/special/deg2radf/README.md | 16 +++++++--------- .../math/base/special/deg2radf/examples/index.js | 16 +++++++--------- .../@stdlib/math/base/special/digamma/README.md | 16 +++++++--------- .../math/base/special/digamma/examples/index.js | 16 +++++++--------- .../math/base/special/dirac-delta/README.md | 13 +++++++------ .../base/special/dirac-delta/examples/index.js | 13 +++++++------ .../math/base/special/dirac-deltaf/README.md | 13 +++++++------ .../base/special/dirac-deltaf/examples/index.js | 13 +++++++------ .../math/base/special/dirichlet-eta/README.md | 13 +++++++------ .../base/special/dirichlet-eta/examples/index.js | 13 +++++++------ 12 files changed, 84 insertions(+), 90 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/deg2rad/README.md b/lib/node_modules/@stdlib/math/base/special/deg2rad/README.md index 30a4c4801a5f..e9577063e970 100644 --- a/lib/node_modules/@stdlib/math/base/special/deg2rad/README.md +++ b/lib/node_modules/@stdlib/math/base/special/deg2rad/README.md @@ -56,18 +56,16 @@ r = deg2rad( NaN ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var deg2rad = require( '@stdlib/math/base/special/deg2rad' ); -var d; -var r; -var i; +var opts = { + 'dtype': 'float64' +}; +var d = uniform( 100, -360.0, 360.0, opts ); -for ( i = 0; i < 100; i++ ) { - d = (randu()*720.0) - 360.0; - r = deg2rad( d ); - console.log( 'degrees: %d => radians: %d', d, r ); -} +logEachMap( 'degrees: %0.4f => radians: %0.4f', d, deg2rad ); ``` diff --git a/lib/node_modules/@stdlib/math/base/special/deg2rad/examples/index.js b/lib/node_modules/@stdlib/math/base/special/deg2rad/examples/index.js index 0415b275ab35..31c4a90505a6 100644 --- a/lib/node_modules/@stdlib/math/base/special/deg2rad/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/deg2rad/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 deg2rad = require( './../lib' ); -var d; -var r; -var i; +var opts = { + 'dtype': 'float64' +}; +var d = uniform( 100, -360.0, 360.0, opts ); -for ( i = 0; i < 100; i++ ) { - d = (randu()*720.0) - 360.0; - r = deg2rad( d ); - console.log( 'degrees: %d => radians: %d', d, r ); -} +logEachMap( 'degrees: %0.4f => radians: %0.4f', d, deg2rad ); diff --git a/lib/node_modules/@stdlib/math/base/special/deg2radf/README.md b/lib/node_modules/@stdlib/math/base/special/deg2radf/README.md index de78b118cd3e..180fe5eecc65 100644 --- a/lib/node_modules/@stdlib/math/base/special/deg2radf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/deg2radf/README.md @@ -56,18 +56,16 @@ r = deg2radf( NaN ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var deg2radf = require( '@stdlib/math/base/special/deg2radf' ); -var d; -var r; -var i; +var opts = { + 'dtype': 'float32' +}; +var d = uniform( 100, -360.0, 360.0, opts ); -for ( i = 0; i < 100; i++ ) { - d = (randu()*720.0) - 360.0; - r = deg2radf( d ); - console.log( 'degrees: %d => radians: %d', d, r ); -} +logEachMap( 'degrees: %0.4f => radians: %0.4f', d, deg2radf ); ``` diff --git a/lib/node_modules/@stdlib/math/base/special/deg2radf/examples/index.js b/lib/node_modules/@stdlib/math/base/special/deg2radf/examples/index.js index 5a82a9f58e9c..51242f1ded73 100644 --- a/lib/node_modules/@stdlib/math/base/special/deg2radf/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/deg2radf/examples/index.js @@ -18,15 +18,13 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +const logEachMap = require('@stdlib/console/log-each-map'); var deg2radf = require( './../lib' ); -var d; -var r; -var i; +var opts = { + 'dtype': 'float32' +}; +var d = uniform( 100, -360.0, 360.0, opts ); -for ( i = 0; i < 100; i++ ) { - d = (randu()*720.0) - 360.0; - r = deg2radf( d ); - console.log( 'degrees: %d => radians: %d', d, r ); -} +logEachMap( 'degrees: %0.4f => radians: %0.4f', d, deg2radf ); diff --git a/lib/node_modules/@stdlib/math/base/special/digamma/README.md b/lib/node_modules/@stdlib/math/base/special/digamma/README.md index 1d10be62bd99..e88af52c8bd0 100644 --- a/lib/node_modules/@stdlib/math/base/special/digamma/README.md +++ b/lib/node_modules/@stdlib/math/base/special/digamma/README.md @@ -97,18 +97,16 @@ var v = digamma( NaN ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var digamma = require( '@stdlib/math/base/special/digamma' ); -var x; -var v; -var i; +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -5.0, 5.0, opts ); -for ( i = 0; i < 10; i++ ) { - x = (randu()*10.0) - 5.0; - v = digamma( x ); - console.log( 'x: %d, f(x): %d', x, v ); -} +logEachMap( 'x: %0.4f, f(x): %0.4f', x, digamma ); ``` diff --git a/lib/node_modules/@stdlib/math/base/special/digamma/examples/index.js b/lib/node_modules/@stdlib/math/base/special/digamma/examples/index.js index f65aae769cf4..a8507cd490a9 100644 --- a/lib/node_modules/@stdlib/math/base/special/digamma/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/digamma/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 digamma = require( './../lib' ); -var x; -var v; -var i; +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -5.0, 5.0, opts ); -for ( i = 0; i < 10; i++ ) { - x = (randu()*10.0) - 5.0; - v = digamma( x ); - console.log( 'x: %d, f(x): %d', x, v ); -} +logEachMap( 'x: %0.4f, f(x): %0.4f', x, digamma ); diff --git a/lib/node_modules/@stdlib/math/base/special/dirac-delta/README.md b/lib/node_modules/@stdlib/math/base/special/dirac-delta/README.md index 0a242695b1d6..01142ca7c36c 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirac-delta/README.md +++ b/lib/node_modules/@stdlib/math/base/special/dirac-delta/README.md @@ -94,15 +94,16 @@ v = diracDelta( NaN ); ```javascript -var linspace = require( '@stdlib/array/base/linspace' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var diracDelta = require( '@stdlib/math/base/special/dirac-delta' ); -var x = linspace( -1.0, 1.0, 101 ); +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -1.0, 1.0, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( 'dirac(%d) = %d', x[ i ], diracDelta( x[ i ] ) ); -} +logEachMap( 'dirac(%0.4f) = %0.4f', x, diracDelta ); ``` diff --git a/lib/node_modules/@stdlib/math/base/special/dirac-delta/examples/index.js b/lib/node_modules/@stdlib/math/base/special/dirac-delta/examples/index.js index f3e2f951997e..375a4d79a278 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirac-delta/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/dirac-delta/examples/index.js @@ -18,12 +18,13 @@ 'use strict'; -var linspace = require( '@stdlib/array/base/linspace' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var diracDelta = require( './../lib' ); -var x = linspace( -1.0, 1.0, 101 ); +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -1.0, 1.0, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( 'dirac(%d) = %d', x[ i ], diracDelta( x[ i ] ) ); -} +logEachMap( 'dirac(%0.4f) = %0.4f', x, diracDelta ); diff --git a/lib/node_modules/@stdlib/math/base/special/dirac-deltaf/README.md b/lib/node_modules/@stdlib/math/base/special/dirac-deltaf/README.md index 84e96cae0cc4..3ea809d73920 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirac-deltaf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/dirac-deltaf/README.md @@ -94,15 +94,16 @@ v = diracDeltaf( NaN ); ```javascript -var linspace = require( '@stdlib/array/base/linspace' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var diracDeltaf = require( '@stdlib/math/base/special/dirac-deltaf' ); -var x = linspace( -1.0, 1.0, 101 ); +var opts = { + 'dtype': 'float32' +}; +var x = uniform( 100, -1.0, 1.0, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( 'dirac(%d) = %d', x[ i ], diracDeltaf( x[ i ] ) ); -} +logEachMap( 'dirac(%0.4f) = %0.4f', x, diracDeltaf ); ``` diff --git a/lib/node_modules/@stdlib/math/base/special/dirac-deltaf/examples/index.js b/lib/node_modules/@stdlib/math/base/special/dirac-deltaf/examples/index.js index c73fc1acf1a0..fee2217dccd4 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirac-deltaf/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/dirac-deltaf/examples/index.js @@ -18,12 +18,13 @@ 'use strict'; -var linspace = require( '@stdlib/array/base/linspace' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var diracDeltaf = require( './../lib' ); -var x = linspace( -1.0, 1.0, 101 ); +var opts = { + 'dtype': 'float32' +}; +var x = uniform( 100, -1.0, 1.0, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( 'dirac(%d) = %d', x[ i ], diracDeltaf( x[ i ] ) ); -} +logEachMap( 'dirac(%0.4f) = %0.4f', x, diracDeltaf ); diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/README.md b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/README.md index fa72b8c599ad..d4bfe3ab6779 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/README.md +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/README.md @@ -102,15 +102,16 @@ v = eta( NaN ); ```javascript -var linspace = require( '@stdlib/array/base/linspace' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var eta = require( '@stdlib/math/base/special/dirichlet-eta' ); -var s = linspace( -50.0, 50.0, 200 ); +var opts = { + 'dtype': 'float64' +}; +var s = uniform( 200, -50.0, 50.0, opts ); -var i; -for ( i = 0; i < s.length; i++ ) { - console.log( 's: %d, η(s): %d', s[ i ], eta( s[ i ] ) ); -} +logEachMap( 's: %0.4f, η(s): %0.4f', s, eta ); ``` diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/examples/index.js b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/examples/index.js index 42fd1e00b239..6f08249dcea2 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/examples/index.js @@ -18,12 +18,13 @@ 'use strict'; -var linspace = require( '@stdlib/array/base/linspace' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var eta = require( './../lib' ); -var s = linspace( -50.0, 50.0, 200 ); +var opts = { + 'dtype': 'float64' +}; +var s = uniform( 200, -50.0, 50.0, opts ); -var i; -for ( i = 0; i < s.length; i++ ) { - console.log( 's: %d, η(s): %d', s[ i ], eta( s[ i ] ) ); -} +logEachMap( 's: %0.4f, η(s): %0.4f', s, eta ); From 9024c8ceaa94519a8592019b5724ef0989a30cbc Mon Sep 17 00:00:00 2001 From: hrshya Date: Tue, 25 Mar 2025 00:31:37 +0530 Subject: [PATCH 2/2] fix: resolve lint issues --- lib/node_modules/@stdlib/math/base/special/deg2radf/README.md | 2 +- .../@stdlib/math/base/special/deg2radf/examples/index.js | 2 +- lib/node_modules/@stdlib/math/base/special/digamma/README.md | 2 +- .../@stdlib/math/base/special/dirac-delta/README.md | 2 +- .../@stdlib/math/base/special/dirac-deltaf/README.md | 2 +- .../@stdlib/math/base/special/dirichlet-eta/README.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/deg2radf/README.md b/lib/node_modules/@stdlib/math/base/special/deg2radf/README.md index 180fe5eecc65..e13a0f3107af 100644 --- a/lib/node_modules/@stdlib/math/base/special/deg2radf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/deg2radf/README.md @@ -61,7 +61,7 @@ var logEachMap = require( '@stdlib/console/log-each-map' ); var deg2radf = require( '@stdlib/math/base/special/deg2radf' ); var opts = { - 'dtype': 'float32' + 'dtype': 'float32' }; var d = uniform( 100, -360.0, 360.0, opts ); diff --git a/lib/node_modules/@stdlib/math/base/special/deg2radf/examples/index.js b/lib/node_modules/@stdlib/math/base/special/deg2radf/examples/index.js index 51242f1ded73..d2037ddad0ee 100644 --- a/lib/node_modules/@stdlib/math/base/special/deg2radf/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/deg2radf/examples/index.js @@ -19,7 +19,7 @@ 'use strict'; var uniform = require( '@stdlib/random/array/uniform' ); -const logEachMap = require('@stdlib/console/log-each-map'); +var logEachMap = require( '@stdlib/console/log-each-map' ); var deg2radf = require( './../lib' ); var opts = { diff --git a/lib/node_modules/@stdlib/math/base/special/digamma/README.md b/lib/node_modules/@stdlib/math/base/special/digamma/README.md index e88af52c8bd0..f648bc965f76 100644 --- a/lib/node_modules/@stdlib/math/base/special/digamma/README.md +++ b/lib/node_modules/@stdlib/math/base/special/digamma/README.md @@ -102,7 +102,7 @@ var logEachMap = require( '@stdlib/console/log-each-map' ); var digamma = require( '@stdlib/math/base/special/digamma' ); var opts = { - 'dtype': 'float64' + 'dtype': 'float64' }; var x = uniform( 100, -5.0, 5.0, opts ); diff --git a/lib/node_modules/@stdlib/math/base/special/dirac-delta/README.md b/lib/node_modules/@stdlib/math/base/special/dirac-delta/README.md index 01142ca7c36c..3e3fc9e24a45 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirac-delta/README.md +++ b/lib/node_modules/@stdlib/math/base/special/dirac-delta/README.md @@ -99,7 +99,7 @@ var logEachMap = require( '@stdlib/console/log-each-map' ); var diracDelta = require( '@stdlib/math/base/special/dirac-delta' ); var opts = { - 'dtype': 'float64' + 'dtype': 'float64' }; var x = uniform( 100, -1.0, 1.0, opts ); diff --git a/lib/node_modules/@stdlib/math/base/special/dirac-deltaf/README.md b/lib/node_modules/@stdlib/math/base/special/dirac-deltaf/README.md index 3ea809d73920..43285c03992f 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirac-deltaf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/dirac-deltaf/README.md @@ -99,7 +99,7 @@ var logEachMap = require( '@stdlib/console/log-each-map' ); var diracDeltaf = require( '@stdlib/math/base/special/dirac-deltaf' ); var opts = { - 'dtype': 'float32' + 'dtype': 'float32' }; var x = uniform( 100, -1.0, 1.0, opts ); diff --git a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/README.md b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/README.md index d4bfe3ab6779..ed297cf80e6b 100644 --- a/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/README.md +++ b/lib/node_modules/@stdlib/math/base/special/dirichlet-eta/README.md @@ -107,7 +107,7 @@ var logEachMap = require( '@stdlib/console/log-each-map' ); var eta = require( '@stdlib/math/base/special/dirichlet-eta' ); var opts = { - 'dtype': 'float64' + 'dtype': 'float64' }; var s = uniform( 200, -50.0, 50.0, opts );