Skip to content

docs: replace manual for loop in examples #7170

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
Jun 2, 2025
Merged

docs: replace manual for loop in examples #7170

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
c16c79f
docs: replace manual for loop in examples
hrshya Jun 2, 2025
d43a971
resolves lint issues
hrshya Jun 2, 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
26 changes: 11 additions & 15 deletions lib/node_modules/@stdlib/stats/base/dists/erlang/cdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,23 +145,19 @@ y = mycdf( 2.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 uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var cdf = require( '@stdlib/stats/base/dists/erlang/cdf' );

var lambda;
var k;
var x;
var y;
var i;

for ( i = 0; i < 20; i++ ) {
x = randu() * 10.0;
k = round( randu() * 10.0 );
lambda = randu() * 5.0;
y = cdf( x, k, lambda );
console.log( 'x: %d, k: %d, λ: %d, F(x;k,λ): %d', x.toFixed( 4 ), k, lambda.toFixed( 4 ), y.toFixed( 4 ) );
}
var opts = {
'dtype': 'float64'
};
var x = uniform( 20, 0.0, 10.0, opts );
var k = discreteUniform( 20, 0, 10, opts );
var lambda = uniform( 20, 0.0, 5.0, opts );

logEachMap( 'x: %0.4f, k: %d, λ: %0.4f, F(x;k,λ): %0.4f', x, k, lambda, cdf );
```

</section>
Expand Down
24 changes: 10 additions & 14 deletions lib/node_modules/@stdlib/stats/base/dists/erlang/cdf/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,16 @@

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

var lambda;
var k;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 20, 0.0, 10.0, opts );
var k = discreteUniform( 20, 0, 10, opts );
var lambda = uniform( 20, 0.0, 5.0, opts );

for ( i = 0; i < 20; i++ ) {
x = randu() * 10.0;
k = round( randu() * 10.0 );
lambda = randu() * 5.0;
y = cdf( x, k, lambda );
console.log( 'x: %d, k: %d, λ: %d, F(x;k,λ): %d', x.toFixed( 4 ), k, lambda.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, k: %d, λ: %0.4f, F(x;k,λ): %0.4f', x, k, lambda, cdf );
21 changes: 9 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/erlang/entropy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,22 +123,19 @@ v = entropy( 2, -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 EPS = require( '@stdlib/constants/float64/eps' );
var entropy = require( '@stdlib/stats/base/dists/erlang/entropy' );

var lambda;
var k;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var k = discreteUniform( 10, 0, 10, opts );
var lambda = uniform( 10, EPS, 10.0, opts );

for ( i = 0; i < 10; i++ ) {
k = round( randu()*10.0 );
lambda = ( randu()*10.0 ) + EPS;
v = entropy( k, lambda );
console.log( 'k: %d, λ: %d, h(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'k: %d, λ: %0.4f, h(X;k,λ): %0.4f', k, lambda, entropy );
```

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

'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 EPS = require( '@stdlib/constants/float64/eps' );
var entropy = require( './../lib' );

var lambda;
var k;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var k = discreteUniform( 10, 0, 10, opts );
var lambda = uniform( 10, EPS, 10.0, opts );

for ( i = 0; i < 10; i++ ) {
k = round( randu()*10.0 );
lambda = ( randu()*10.0 ) + EPS;
v = entropy( k, lambda );
console.log( 'k: %d, λ: %d, h(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'k: %d, λ: %0.4f, h(X;k,λ): %0.4f', k, lambda, entropy );
21 changes: 9 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/erlang/kurtosis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,22 +121,19 @@ v = kurtosis( 2, -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 EPS = require( '@stdlib/constants/float64/eps' );
var kurtosis = require( '@stdlib/stats/base/dists/erlang/kurtosis' );

var lambda;
var k;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var k = discreteUniform( 10, 0, 10, opts );
var lambda = uniform( 10, EPS, 10.0, opts );

for ( i = 0; i < 10; i++ ) {
k = round( randu()*10.0 );
lambda = ( randu()*10.0 ) + EPS;
v = kurtosis( k, lambda );
console.log( 'k: %d, λ: %d, Kurt(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'k: %0.4f, λ: %d, Kurt(X;k,λ): %0.4f', k, lambda, kurtosis );
```

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

'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 EPS = require( '@stdlib/constants/float64/eps' );
var kurtosis = require( './../lib' );

var lambda;
var k;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var k = discreteUniform( 10, 0, 10, opts );
var lambda = uniform( 10, EPS, 10.0, opts );

for ( i = 0; i < 10; i++ ) {
k = round( randu()*10.0 );
lambda = ( randu()*10.0 ) + EPS;
v = kurtosis( k, lambda );
console.log( 'k: %d, λ: %d, Kurt(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'k: %0.4f, λ: %d, Kurt(X;k,λ): %0.4f', k, lambda, kurtosis );
26 changes: 11 additions & 15 deletions lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,23 +136,19 @@ y = mylogpdf( 4.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 logpdf = require( '@stdlib/stats/base/dists/erlang/logpdf' );

var lambda;
var k;
var x;
var y;
var i;

for ( i = 0; i < 20; i++ ) {
x = randu() * 10.0;
k = round( randu() * 10.0 );
lambda = randu() * 5.0;
y = logpdf( x, k, lambda );
console.log( 'x: %d, k: %d, λ: %d, ln(f(x;k,λ)): %d', x.toFixed( 4 ), k, lambda.toFixed( 4 ), y.toFixed( 4 ) );
}
var opts = {
'dtype': 'float64'
};
var x = uniform( 20, 0.0, 10.0, opts );
var k = discreteUniform( 20, 0, 10, opts );
var lambda = uniform( 20, 0.0, 5.0, opts );

logEachMap( 'x: %0.4f, k: %d, λ: %0.4f, ln(f(x;k,λ)): %0.4f', x, k, lambda, logpdf );
```

</section>
Expand Down
24 changes: 10 additions & 14 deletions lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,16 @@

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

var lambda;
var k;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 20, 0.0, 10.0, opts );
var k = discreteUniform( 20, 0, 10, opts );
var lambda = uniform( 20, 0.0, 5.0, opts );

for ( i = 0; i < 20; i++ ) {
x = randu() * 10.0;
k = round( randu() * 10.0 );
lambda = randu() * 5.0;
y = logpdf( x, k, lambda );
console.log( 'x: %d, k: %d, λ: %d, ln(f(x;k,λ)): %d', x.toFixed( 4 ), k, lambda.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, k: %d, λ: %0.4f, ln(f(x;k,λ)): %0.4f', x, k, lambda, logpdf );
21 changes: 9 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/erlang/mean/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,22 +123,19 @@ v = mean( 2, -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 EPS = require( '@stdlib/constants/float64/eps' );
var mean = require( '@stdlib/stats/base/dists/erlang/mean' );

var lambda;
var k;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var k = discreteUniform( 10, 0, 10, opts );
var lambda = uniform( 10, EPS, 10.0, opts );

for ( i = 0; i < 10; i++ ) {
k = round( randu()*10.0 );
lambda = ( randu()*10.0 ) + EPS;
v = mean( k, lambda );
console.log( 'k: %d, λ: %d, E(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'k: %d, λ: %0.4f, E(X;k,λ): %0.4f', k, lambda, mean );
```

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

'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 EPS = require( '@stdlib/constants/float64/eps' );
var mean = require( './../lib' );

var lambda;
var k;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var k = discreteUniform( 10, 0, 10, opts );
var lambda = uniform( 10, EPS, 10.0, opts );

for ( i = 0; i < 10; i++ ) {
k = round( randu()*10.0 );
lambda = ( randu()*10.0 ) + EPS;
v = mean( k, lambda );
console.log( 'k: %d, λ: %d, E(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'k: %d, λ: %0.4f, E(X;k,λ): %0.4f', k, lambda, mean );
21 changes: 9 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/erlang/mode/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,22 +123,19 @@ v = mode( 2, -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 EPS = require( '@stdlib/constants/float64/eps' );
var mode = require( '@stdlib/stats/base/dists/erlang/mode' );

var lambda;
var k;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var k = discreteUniform( 10, 0, 10, opts );
var lambda = uniform( 10, EPS, 10.0, opts );

for ( i = 0; i < 10; i++ ) {
k = round( randu()*10.0 );
lambda = ( randu()*10.0 ) + EPS;
v = mode( k, lambda );
console.log( 'k: %d, λ: %d, mode(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'k: %d, λ: %0.4f, mode(X;k,λ): %0.4f', k, lambda, mode );
```

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

'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 EPS = require( '@stdlib/constants/float64/eps' );
var mode = require( './../lib' );

var lambda;
var k;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var k = discreteUniform( 10, 0, 10, opts );
var lambda = uniform( 10, EPS, 10.0, opts );

for ( i = 0; i < 10; i++ ) {
k = round( randu()*10.0 );
lambda = ( randu()*10.0 ) + EPS;
v = mode( k, lambda );
console.log( 'k: %d, λ: %d, mode(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'k: %d, λ: %0.4f, mode(X;k,λ): %0.4f', k, lambda, mode );
Loading