Skip to content

docs: replace manual for loop in examples #6308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 24, 2025
Merged

docs: replace manual for loop in examples #6308

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5e613ad
docs: replace manual for loop in examples
hrshya Mar 22, 2025
9949a47
fix: resolve lint errors
stdlib-bot Mar 22, 2025
837a341
fix: resolves lint issues
hrshya Mar 22, 2025
a40d021
fix suggested changes
hrshya Mar 23, 2025
b9eb633
fixes suggested changes
hrshya Mar 24, 2025
6047f42
resolves indentation issues
hrshya Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/besselj0/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,15 @@ v = j0( NaN );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var j0 = require( '@stdlib/math/base/special/besselj0' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var besselj0 = require( '@stdlib/math/base/special/besselj0' );

var x;
var i;
var x = uniform( 100, 0.0, 100.0, {
'dtype': 'float64'
});

for ( i = 0; i < 100; i++ ) {
x = randu() * 10.0;
console.log( 'j0(%d) = %d', x, j0( x ) );
}
logEachMap( 'besselj0(%0.4f) = %0.4f', x, besselj0 );
```

</section>
Expand Down
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/besselj0/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +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 besselj0 = require( './../lib' );

var x;
var i;

for ( i = 0; i < 100; i++ ) {
x = randu() * 100.0;
console.log( 'besselj0(%d) = %d', x, besselj0( x ) );
}
x = uniform( 100, 0.0, 100.0, {
'dtype': 'float64'
});

logEachMap( 'besselj0(%0.4f) = %0.4f', x, besselj0 );
15 changes: 7 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/besselj1/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,15 @@ v = j1( NaN );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var j1 = require( '@stdlib/math/base/special/besselj1' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var besselj1 = require( '@stdlib/math/base/special/besselj1' );

var x;
var i;
var x = uniform( 100, 0.0, 100.0, {
'dtype': 'float64'
});

for ( i = 0; i < 100; i++ ) {
x = randu() * 10.0;
console.log( 'j1(%d) = %d', x, j1( x ) );
}
logEachMap( 'besselj1(%0.4f) = %0.4f', x, besselj1 );
```

</section>
Expand Down
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/besselj1/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +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 besselj1 = require( './../lib' );

var x;
var i;

for ( i = 0; i < 100; i++ ) {
x = randu() * 100.0;
console.log( 'besselj1(%d) = %d', x, besselj1( x ) );
}
x = uniform( 100, 0.0, 100.0, {
'dtype': 'float64'
});

logEachMap( 'besselj1(%0.4f) = %0.4f', x, besselj1 );
15 changes: 7 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/bessely0/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,15 @@ v = y0( NaN );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var y0 = require( '@stdlib/math/base/special/bessely0' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var bessely0 = require( '@stdlib/math/base/special/bessely0' );

var x;
var i;
var x = uniform( 100, 0.0, 100.0, {
'dtype': 'float64'
});

for ( i = 0; i < 100; i++ ) {
x = randu() * 10.0;
console.log( 'y0(%d) = %d', x, y0( x ) );
}
logEachMap( 'bessely0(%0.4f) = %0.4f', x, bessely0 );
```

</section>
Expand Down
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/bessely0/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +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 bessely0 = require( './../lib' );

var x;
var i;

for ( i = 0; i < 100; i++ ) {
x = randu() * 100.0;
console.log( 'bessely0(%d) = %d', x, bessely0( x ) );
}
x = uniform( 100, 0.0, 100.0, {
'dtype': 'float64'
});

logEachMap( 'bessely0(%0.4f) = %0.4f', x, bessely0 );
15 changes: 8 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/bessely1/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,16 +91,17 @@ v = y1( NaN );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var y1 = require( '@stdlib/math/base/special/bessely1' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var bessely1 = require( '@stdlib/math/base/special/bessely1' );

var x;
var i;

for ( i = 0; i < 100; i++ ) {
x = randu() * 10.0;
console.log( 'y1(%d) = %d', x, y1( x ) );
}
x = uniform( 100, 0.0, 100.0, {
'dtype': 'float64'
});

logEachMap( 'bessely1(%0.4f) = %0.4f', x, bessely1 );
```

</section>
Expand Down
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/bessely1/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +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 bessely1 = require( './../lib' );

var x;
var i;

for ( i = 0; i < 100; i++ ) {
x = randu() * 100.0;
console.log( 'bessely1(%d) = %d', x, bessely1( x ) );
}
x = uniform( 100, 0.0, 100.0, {
'dtype': 'float64'
});

logEachMap( 'bessely1(%0.4f) = %0.4f', x, bessely1 );
21 changes: 13 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/betainc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,20 +102,25 @@ var y = betainc( 0.5, 2.0, -2.0 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var betainc = require( '@stdlib/math/base/special/betainc' );

var i;
var x;
var a;
var b;

for ( i = 0; i < 100; i++ ) {
x = randu();
a = randu() * 10.0;
b = randu() * 10.0;
console.log( 'x: %d, \t a: %d, \t b: %d, \t f(x,a,b): %d', x.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), betainc( x, a, b ).toFixed( 4 ) );
}
x = uniform( 100, 0.0, 1.0, {
'dtype': 'float64'
});
a = uniform( 100, 0.0, 10.0, {
'dtype': 'float64'
});
b = uniform( 100, 0.0, 10.0, {
'dtype': 'float64'
});

logEachMap( 'x: %0.4f, \t a: %0.4f, \t b: %0.4f, \t f(x,a,b): %0.4f', x, a, b, betainc );
```

</section>
Expand Down
21 changes: 13 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/betainc/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,22 @@

'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 betainc = require( './../lib' );

var i;
var x;
var a;
var b;

for ( i = 0; i < 100; i++ ) {
x = randu();
a = randu() * 10.0;
b = randu() * 10.0;
console.log( 'x: %d, \t a: %d, \t b: %d, \t f(x,a,b): %d', x.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), betainc( x, a, b ).toFixed( 4 ) );
}
x = uniform( 100, 0.0, 1.0, {
'dtype': 'float64'
});
a = uniform( 100, 0.0, 10.0, {
'dtype': 'float64'
});
b = uniform( 100, 0.0, 10.0, {
'dtype': 'float64'
});

logEachMap( 'x: %0.4f, \t a: %0.4f, \t b: %0.4f, \t f(x,a,b): %0.4f', x, a, b, betainc );
21 changes: 13 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/betaincinv/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,20 +111,25 @@ y = betaincinv( 0.5, 2.0, 0.0 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var betaincinv = require( '@stdlib/math/base/special/betaincinv' );

var i;
var p;
var a;
var b;

for ( i = 0; i < 100; i++ ) {
p = randu();
a = randu() * 10.0;
b = randu() * 10.0;
console.log( 'p: %d, \t a: %d, \t b: %d, \t f(p,a,b): %d', p.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), betaincinv( p, a, b ) );
}
p = uniform( 100, 0.0, 1.0, {
'dtype': 'float64'
});
a = uniform( 100, 0.0, 10.0, {
'dtype': 'float64'
});
b = uniform( 100, 0.0, 10.0, {
'dtype': 'float64'
});

logEachMap( 'p: %0.4f, \t a: %0.4f, \t b: %0.4f, \t f(p,a,b): %0.4f', p, a, b, betaincinv );
```

</section>
Expand Down
21 changes: 13 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/betaincinv/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,22 @@

'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 betaincinv = require( './../lib' );

var i;
var p;
var a;
var b;

for ( i = 0; i < 100; i++ ) {
p = randu();
a = randu() * 10.0;
b = randu() * 10.0;
console.log( 'p: %d, \t a: %d, \t b: %d, \t f(p,a,b): %d', p.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), betaincinv( p, a, b ) );
}
p = uniform( 100, 0.0, 1.0, {
'dtype': 'float64'
});
a = uniform( 100, 0.0, 10.0, {
'dtype': 'float64'
});
b = uniform( 100, 0.0, 10.0, {
'dtype': 'float64'
});

logEachMap( 'p: %0.4f, \t a: %0.4f, \t b: %0.4f, \t f(p,a,b): %0.4f', p, a, b, betaincinv );
14 changes: 6 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/binomcoef/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,19 +124,17 @@ v = binomcoef( 5.5, 2 );
<!-- eslint no-undef: "error" -->

```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 logEachMap = require( '@stdlib/console/log-each-map' );
var binomcoef = require( '@stdlib/math/base/special/binomcoef' );

var n;
var k;
var i;

for ( i = 0; i < 100; i++ ) {
n = round( (randu()*30.0) - 10.0 );
k = round( randu()*20.0 );
console.log( '%d choose %d = %d', n, k, binomcoef( n, k ) );
}
n = discreteUniform( 100, -10, 30 );
k = discreteUniform( 100, 0, 20 );

logEachMap( '%d choose %d = %d', n, k, binomcoef );
```

</section>
Expand Down
14 changes: 6 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/binomcoef/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,14 @@

'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 logEachMap = require( '@stdlib/console/log-each-map' );
var binomcoef = require( './../lib' );

var n;
var k;
var i;

for ( i = 0; i < 100; i++ ) {
n = round( (randu()*40.0) - 10.0 );
k = round( randu()*20.0 );
console.log( '%d choose %d = %d', n, k, binomcoef( n, k ) );
}
n = discreteUniform( 100, -10, 30 );
k = discreteUniform( 100, 0, 20 );

logEachMap( '%d choose %d = %d', n, k, binomcoef );
14 changes: 6 additions & 8 deletions lib/node_modules/@stdlib/math/base/special/binomcoefln/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,19 +139,17 @@ v = binomcoefln( 5.5, 2 );
<!-- eslint no-undef: "error" -->

```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 logEachMap = require( '@stdlib/console/log-each-map' );
var binomcoefln = require( '@stdlib/math/base/special/binomcoefln' );

var n;
var k;
var i;

for ( i = 0; i < 100; i++ ) {
n = round( (randu()*40.0) - 10.0 );
k = round( randu()*20.0 );
console.log( 'ln( %d choose %d ) = %d', n, k, binomcoefln( n, k ) );
}
n = discreteUniform( 100, -10, 30 );
k = discreteUniform( 100, 0, 20 );

logEachMap( 'ln( %d choose %d ) = %d', n, k, binomcoefln );
```

</section>
Expand Down
Loading