From 5092f0125e8a4a628dd81aec52eb1adb253609d7 Mon Sep 17 00:00:00 2001 From: hrshya Date: Thu, 10 Apr 2025 20:36:27 +0530 Subject: [PATCH 1/2] docs: replace manual for loop in examples --- .../@stdlib/math/base/special/sin/README.md | 13 +++++++------ .../@stdlib/math/base/special/sin/examples/index.js | 13 +++++++------ .../@stdlib/math/base/special/sinc/README.md | 13 +++++++------ .../math/base/special/sinc/examples/index.js | 13 +++++++------ .../@stdlib/math/base/special/sind/README.md | 13 +++++++------ .../math/base/special/sind/examples/index.js | 13 +++++++------ .../@stdlib/math/base/special/sinh/README.md | 13 +++++++------ .../math/base/special/sinh/examples/index.js | 13 +++++++------ .../@stdlib/math/base/special/sinpi/README.md | 13 +++++++------ .../math/base/special/sinpi/examples/index.js | 13 +++++++------ 10 files changed, 70 insertions(+), 60 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/sin/README.md b/lib/node_modules/@stdlib/math/base/special/sin/README.md index 73bde3e8b64e..e11e183e38f5 100644 --- a/lib/node_modules/@stdlib/math/base/special/sin/README.md +++ b/lib/node_modules/@stdlib/math/base/special/sin/README.md @@ -56,16 +56,17 @@ v = sin( -3.141592653589793/6.0 ); ```javascript -var linspace = require( '@stdlib/array/base/linspace' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var TWO_PI = require( '@stdlib/constants/float64/two-pi' ); var sin = require( '@stdlib/math/base/special/sin' ); -var x = linspace( 0.0, TWO_PI, 100 ); +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, 0.0, TWO_PI, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( sin( x[ i ] ) ); -} +logEachMap( 'sin(%0.4f) = %0.4f', x, sin ); ``` diff --git a/lib/node_modules/@stdlib/math/base/special/sin/examples/index.js b/lib/node_modules/@stdlib/math/base/special/sin/examples/index.js index ce0f94b9cc00..2083ff86782e 100644 --- a/lib/node_modules/@stdlib/math/base/special/sin/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/sin/examples/index.js @@ -18,13 +18,14 @@ '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 TWO_PI = require( '@stdlib/constants/float64/two-pi' ); var sin = require( './../lib' ); -var x = linspace( 0.0, TWO_PI, 100 ); +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, 0.0, TWO_PI, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( 'sin(%d) = %d', x[ i ], sin( x[ i ] ) ); -} +logEachMap( 'sin(%0.4f) = %0.4f', x, sin ); diff --git a/lib/node_modules/@stdlib/math/base/special/sinc/README.md b/lib/node_modules/@stdlib/math/base/special/sinc/README.md index f9aa00ada6b9..22909860ee0f 100644 --- a/lib/node_modules/@stdlib/math/base/special/sinc/README.md +++ b/lib/node_modules/@stdlib/math/base/special/sinc/README.md @@ -82,15 +82,16 @@ v = sinc( 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 sinc = require( '@stdlib/math/base/special/sinc' ); -var x = linspace( -5.0, 5.0, 100 ); +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -5.0, 5.0, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( sinc( x[ i ] ) ); -} +logEachMap( 'sinc( %0.4f ) = %0.4f', x, sinc ); ``` diff --git a/lib/node_modules/@stdlib/math/base/special/sinc/examples/index.js b/lib/node_modules/@stdlib/math/base/special/sinc/examples/index.js index 3d26c66f3056..a08cc2cef337 100644 --- a/lib/node_modules/@stdlib/math/base/special/sinc/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/sinc/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 sinc = require( './../lib' ); -var x = linspace( -5.0, 5.0, 100 ); +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -5.0, 5.0, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( 'sinc( %d ) = %d', x[ i ], sinc( x[ i ] ) ); -} +logEachMap( 'sinc( %0.4f ) = %0.4f', x, sinc ); diff --git a/lib/node_modules/@stdlib/math/base/special/sind/README.md b/lib/node_modules/@stdlib/math/base/special/sind/README.md index b9ed22d673f0..494db5694375 100644 --- a/lib/node_modules/@stdlib/math/base/special/sind/README.md +++ b/lib/node_modules/@stdlib/math/base/special/sind/README.md @@ -63,15 +63,16 @@ v = sind( 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 sind = require( '@stdlib/math/base/special/sind' ); -var x = linspace( -180, 180, 100 ); +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -180.0, 180.0, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( sind( x[ i ] ) ); -} +logEachMap( 'sind(%0.4f) = %0.4f', x, sind ); ``` diff --git a/lib/node_modules/@stdlib/math/base/special/sind/examples/index.js b/lib/node_modules/@stdlib/math/base/special/sind/examples/index.js index 3308ef5498b1..ef236e973e09 100644 --- a/lib/node_modules/@stdlib/math/base/special/sind/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/sind/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 sind = require( './../lib' ); -var x = linspace( -180, 180, 100 ); +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -180.0, 180.0, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( 'sind(%d) = %d', x[ i ], sind( x[ i ] ) ); -} +logEachMap( 'sind(%0.4f) = %0.4f', x, sind ); diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/README.md b/lib/node_modules/@stdlib/math/base/special/sinh/README.md index 81e3abbac604..e1cec5e31df1 100644 --- a/lib/node_modules/@stdlib/math/base/special/sinh/README.md +++ b/lib/node_modules/@stdlib/math/base/special/sinh/README.md @@ -62,15 +62,16 @@ v = sinh( 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 sinh = require( '@stdlib/math/base/special/sinh' ); -var x = linspace( -5.0, 5.0, 100 ); +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -5.0, 5.0, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( sinh( x[ i ] ) ); -} +logEachMap( 'sinh( %0.4f ) = %0.4f', x, sinh ); ``` diff --git a/lib/node_modules/@stdlib/math/base/special/sinh/examples/index.js b/lib/node_modules/@stdlib/math/base/special/sinh/examples/index.js index 9a5de5a6d0c5..fed11ceaca39 100644 --- a/lib/node_modules/@stdlib/math/base/special/sinh/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/sinh/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 sinh = require( './../lib' ); -var x = linspace( -5.0, 5.0, 100 ); +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -5.0, 5.0, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( 'sinh( %d ) = %d', x[ i ], sinh( x[ i ] ) ); -} +logEachMap( 'sinh( %0.4f ) = %0.4f', x, sinh ); diff --git a/lib/node_modules/@stdlib/math/base/special/sinpi/README.md b/lib/node_modules/@stdlib/math/base/special/sinpi/README.md index c39719b251da..b94fa78f78ce 100644 --- a/lib/node_modules/@stdlib/math/base/special/sinpi/README.md +++ b/lib/node_modules/@stdlib/math/base/special/sinpi/README.md @@ -59,15 +59,16 @@ y = sinpi( 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 sinpi = require( '@stdlib/math/base/special/sinpi' ); -var x = linspace( -100.0, 100.0, 100 ); +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -100.0, 100.0, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( sinpi( x[ i ] ) ); -} +logEachMap( 'sin( π * %0.4f ) = %0.4f', x, sinpi ); ``` diff --git a/lib/node_modules/@stdlib/math/base/special/sinpi/examples/index.js b/lib/node_modules/@stdlib/math/base/special/sinpi/examples/index.js index 151e000289be..8a17e395b917 100644 --- a/lib/node_modules/@stdlib/math/base/special/sinpi/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/sinpi/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 sinpi = require( './../lib' ); -var x = linspace( -100.0, 100.0, 100 ); +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 100, -100.0, 100.0, opts ); -var i; -for ( i = 0; i < x.length; i++ ) { - console.log( 'sin( π * %d ) = %d', x[ i ], sinpi( x[ i ] ) ); -} +logEachMap( 'sin( π * %0.4f ) = %0.4f', x, sinpi ); From 5ae2846e8da46c74f8db47adb8fe6b58ce4a6e70 Mon Sep 17 00:00:00 2001 From: Harsh <149176984+hrshya@users.noreply.github.com> Date: Thu, 10 Apr 2025 20:44:01 +0530 Subject: [PATCH 2/2] resolve lint issue Signed-off-by: Harsh <149176984+hrshya@users.noreply.github.com> --- .../@stdlib/math/base/special/sin/examples/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/sin/examples/index.js b/lib/node_modules/@stdlib/math/base/special/sin/examples/index.js index 2083ff86782e..ddc3ef1897bc 100644 --- a/lib/node_modules/@stdlib/math/base/special/sin/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/sin/examples/index.js @@ -24,7 +24,7 @@ var TWO_PI = require( '@stdlib/constants/float64/two-pi' ); var sin = require( './../lib' ); var opts = { - 'dtype': 'float64' + 'dtype': 'float64' }; var x = uniform( 100, 0.0, TWO_PI, opts );