Skip to content

docs: replace manual for loop in examples #7122

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
May 30, 2025
Merged

docs: replace manual for loop in examples #7122

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
15d39b6
docs: replace manual for loop in examples
hrshya May 30, 2025
76acc7f
chore: use %d when printing discrete numbers
Planeshifter May 30, 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
20 changes: 8 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/cdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,21 +93,17 @@ y = mycdf( 8.0 );
<!-- 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 cdf = require( '@stdlib/stats/base/dists/degenerate/cdf' );

var mu;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, 0.0, 10.0, opts );
var mu = discreteUniform( 10, 0.0, 10.0, opts );

for ( i = 0; i < 100; i++ ) {
x = round( randu()*10.0 );
mu = round( randu()*10.0 );
y = cdf( x, mu );
console.log( 'x: %d, µ: %d, F(x;µ): %d', x, mu, y );
}
logEachMap( 'x: %0.4f, µ: %0.4f, F(x;µ): %0.4f', x, mu, cdf );
```

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

var mu;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, 0, 10, opts );
var mu = discreteUniform( 10, 0, 10, opts );

for ( i = 0; i < 100; i++ ) {
x = round( randu()*10.0 );
mu = round( randu()*10.0 );
y = cdf( x, mu );
console.log( 'x: %d, µ: %d, F(x;µ): %d', x, mu, y );
}
logEachMap( 'x: %0.4f, µ: %0.4f, F(x;µ): %0.4f', x, mu, cdf );
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/entropy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,18 +93,16 @@ v = entropy( NaN );
<!-- 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 entropy = require( '@stdlib/stats/base/dists/degenerate/entropy' );

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

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

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/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 mu;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var mu = uniform( 10, 0.0, 1.0, opts );

for ( i = 0; i < 10; i++ ) {
mu = randu();
v = entropy( mu );
console.log( 'µ: %d, H(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, H(X;µ): %0.4f', mu, entropy );
20 changes: 8 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/logcdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,21 +93,17 @@ y = mylogcdf( 8.0 );
<!-- 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 logcdf = require( '@stdlib/stats/base/dists/degenerate/logcdf' );

var mu;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, 0, 10, opts );
var mu = discreteUniform( 10, 0, 10, opts );

for ( i = 0; i < 100; i++ ) {
x = round( randu()*10.0 );
mu = round( randu()*10.0 );
y = logcdf( x, mu );
console.log( 'x: %d, µ: %d, ln(F(x;µ)): %d', x, mu, y );
}
logEachMap( 'x: %d, µ: %d, ln(F(x;µ)): %0.4f', x, mu, logcdf );
```

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

var mu;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, 0, 10, opts );
var mu = discreteUniform( 10, 0, 10, opts );

for ( i = 0; i < 100; i++ ) {
x = round( randu()*10.0 );
mu = round( randu()*10.0 );
y = logcdf( x, mu );
console.log( 'x: %d, µ: %d, ln(F(x;µ)): %d', x, mu, y );
}
logEachMap( 'x: %d, µ: %d, ln(F(x;µ)): %0.4f', x, mu, logcdf );
20 changes: 8 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/logpdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,21 +106,17 @@ y = mylogpdf( 12.0 );
<!-- 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 logpdf = require( '@stdlib/stats/base/dists/degenerate/logpdf' );

var mu;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 100, 0, 5, opts );
var mu = discreteUniform( 100, 0, 5, opts );

for ( i = 0; i < 100; i++ ) {
x = round( randu()*5.0 );
mu = round( randu()*5.0 );
y = logpdf( x, mu );
console.log( 'x: %d, µ: %d, ln(f(x;µ)): %d', x, mu, y );
}
logEachMap( 'x: %d, µ: %d, ln(f(x;µ)): %0.4f', x, mu, logpdf );
```

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

var mu;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 100, 0, 5, opts );
var mu = discreteUniform( 100, 0, 5, opts );

for ( i = 0; i < 100; i++ ) {
x = round( randu()*5.0 );
mu = round( randu()*5.0 );
y = logpdf( x, mu );
console.log( 'x: %d, µ: %d, ln(f(x;µ)): %d', x, mu, y );
}
logEachMap( 'x: %d, µ: %d, ln(f(x;µ)): %0.4f', x, mu, logpdf );
20 changes: 8 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,21 +76,17 @@ y = mylogpmf( 12.0 );
<!-- 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 logpmf = require( '@stdlib/stats/base/dists/degenerate/logpmf' );

var mu;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 100, 0, 5, opts );
var mu = discreteUniform( 100, 0, 5, opts );

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

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

var mu;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 100, 0, 5, opts );
var mu = discreteUniform( 100, 0, 5, opts );

for ( i = 0; i < 100; i++ ) {
x = round( randu()*5.0 );
mu = round( randu()*5.0 );
y = logpmf( x, mu );
console.log( 'x: %d, µ: %d, ln(P(X=x;µ)): %d', x, mu, y );
}
logEachMap( 'x: %d, µ: %d, ln(P(X=x;µ)): %0.4f', x, mu, logpmf );
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/mean/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,18 +90,16 @@ v = mean( -0.5 );
<!-- 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 mean = require( '@stdlib/stats/base/dists/degenerate/mean' );

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

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

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/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 mu;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var mu = uniform( 10, 0.0, 1.0, opts );

for ( i = 0; i < 10; i++ ) {
mu = randu();
v = mean( mu );
console.log( 'µ: %d, E(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, E(X;µ): %0.4f', mu, mean );
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/median/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,18 +90,16 @@ v = median( -0.5 );
<!-- 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 median = require( '@stdlib/stats/base/dists/degenerate/median' );

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

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

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/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 mu;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var mu = uniform( 10, 0.0, 1.0, opts );

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