Skip to content

docs: replace manual for loop in examples #8047

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 2 commits into from
Sep 9, 2025
Merged

docs: replace manual for loop in examples #8047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e7f076
docs: replace manual for loop in examples
hrshya Sep 9, 2025
c061476
fixs lint issues
hrshya Sep 9, 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
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,20 +109,17 @@ y = mycdf( 1.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 cdf = require( '@stdlib/stats/base/dists/geometric/cdf' );

var p;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );
var x = uniform( 10, 0.0, 5.0, opts );

for ( i = 0; i < 10; i++ ) {
x = randu() * 5.0;
p = randu();
y = cdf( x, p );
console.log( 'x: %d, p: %d, F(x;p): %d', x.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, cdf );
```

</section>
Expand Down
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 cdf = require( './../lib' );

var p;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );
var x = uniform( 10, 0.0, 5.0, opts );

for ( i = 0; i < 10; i++ ) {
x = randu() * 5.0;
p = randu();
y = cdf( x, p );
console.log( 'x: %d, p: %d, F(x;p): %d', x.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, cdf );
17 changes: 7 additions & 10 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/entropy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,19 +103,16 @@ v = entropy( -1.0 );
<!-- eslint no-undef: "error" -->

```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/geometric/entropy' );

var v;
var i;
var p;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );

for ( i = 0; i < 10; i++ ) {
p = randu();
v = entropy( p );
console.log( 'p: %d, H(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'p: %0.4f, H(X;p): %0.4f', p, entropy );
```

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/entropy/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 v;
var i;
var p;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );

for ( i = 0; i < 10; i++ ) {
p = randu();
v = entropy( p );
console.log( 'p: %d, H(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'p: %0.4f, H(X;p): %0.4f', p, entropy );
17 changes: 7 additions & 10 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,19 +103,16 @@ v = kurtosis( -1.0 );
<!-- eslint no-undef: "error" -->

```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/geometric/kurtosis' );

var v;
var i;
var p;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );

for ( i = 0; i < 10; i++ ) {
p = randu();
v = kurtosis( p );
console.log( 'p: %d, Kurt(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'p: %0.4f, Kurt(X;p): %0.4f', p, kurtosis );
```

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 v;
var i;
var p;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );

for ( i = 0; i < 10; i++ ) {
p = randu();
v = kurtosis( p );
console.log( 'p: %d, Kurt(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'p: %0.4f, Kurt(X;p): %0.4f', p, kurtosis );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,20 +119,17 @@ y = mylogcdf( 1.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 logcdf = require( '@stdlib/stats/base/dists/geometric/logcdf' );

var p;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );
var x = uniform( 10, 0.0, 5.0, opts );

for ( i = 0; i < 10; i++ ) {
x = randu() * 5.0;
p = randu();
y = logcdf( x, p );
console.log( 'x: %d, p: %d, ln(F(x;p)): %d', x.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, logcdf );
```

</section>
Expand Down
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 logcdf = require( './../lib' );

var p;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );
var x = uniform( 10, 0.0, 5.0, opts );

for ( i = 0; i < 10; i++ ) {
x = randu() * 5.0;
p = randu();
y = logcdf( x, p );
console.log( 'x: %d, p: %d, F(x;p): %d', x.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, logcdf );
21 changes: 9 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,21 +122,18 @@ y = mylogpmf( 1.0 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var uniform = require( '@stdlib/random/array/uniform' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var logpmf = require( '@stdlib/stats/base/dists/geometric/logpmf' );

var p;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );
var x = discreteUniform( 10, 0, 5, opts );

for ( i = 0; i < 10; i++ ) {
x = round( randu() * 5.0 );
p = randu();
y = logpmf( x, p );
console.log( 'x: %d, p: %d, ln( P( X = x; p ) ): %d', x, p.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %d, p: %0.4f, ln( P( X = x; p ) ): %0.4f', x, p, logpmf );
```

</section>
Expand Down
21 changes: 9 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,15 @@

'use strict';

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var uniform = require( '@stdlib/random/array/uniform' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var logpmf = require( './../lib' );

var p;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );
var x = discreteUniform( 10, 0, 5, opts );

for ( i = 0; i < 10; i++ ) {
x = round( randu() * 5.0 );
p = randu();
y = logpmf( x, p );
console.log( 'x: %d, p: %d, ln( P( X = x; p ) ): %d', x, p.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %d, p: %0.4f, ln( P( X = x; p ) ): %0.4f', x, p, logpmf );
17 changes: 7 additions & 10 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/mean/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,19 +103,16 @@ v = mean( -1.0 );
<!-- eslint no-undef: "error" -->

```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/geometric/mean' );

var v;
var i;
var p;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );

for ( i = 0; i < 10; i++ ) {
p = randu();
v = mean( p );
console.log( 'p: %d, E(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'p: %0.4f, E(X;p): %0.4f', p, mean );
```

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/mean/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 v;
var i;
var p;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );

for ( i = 0; i < 10; i++ ) {
p = randu();
v = mean( p );
console.log( 'p: %d, E(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'p: %0.4f, E(X;p): %0.4f', p, mean );
17 changes: 7 additions & 10 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/median/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,19 +103,16 @@ v = median( -1.0 );
<!-- eslint no-undef: "error" -->

```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/geometric/median' );

var v;
var i;
var p;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );

for ( i = 0; i < 10; i++ ) {
p = randu();
v = median( p );
console.log( 'p: %d, Median(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'p: %0.4f, Median(X;p): %0.4f', p, median );
```

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/geometric/median/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 v;
var i;
var p;
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );

for ( i = 0; i < 10; i++ ) {
p = randu();
v = median( p );
console.log( 'p: %d, Median(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'p: %0.4f, Median(X;p): %0.4f', p, median );