Skip to content

docs: replace manual for loop in examples #9057

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

Open
hrshya wants to merge 2 commits into
base: develop
Choose a base branch
from
+224 −312
Open

docs: replace manual for loop in examples #9057

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
266f5d8
docs: replace manual for loop in examples
hrshya Dec 15, 2025
cd9d63a
fix: clean up
hrshya Dec 15, 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
24 changes: 10 additions & 14 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/cdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,22 +131,18 @@ y = mycdf( 2.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 cdf = require( '@stdlib/stats/base/dists/pareto-type1/cdf' );

var alpha;
var beta;
var x;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
x = randu() * 8.0;
alpha = randu() * 5.0;
beta = randu() * 5.0;
y = cdf( x, alpha, beta );
console.log( 'x: %d, α: %d, β: %d, F(x;α,β): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
}
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, 0.0, 5.0, opts );
var beta = uniform( 10, 0.0, 5.0, opts );
var x = uniform( 10, 0.0, 8.0, opts );

logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, F(x;α,β): %0.4f', x, alpha, beta, cdf );
```

</section>
Expand Down
22 changes: 9 additions & 13 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/cdf/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,15 @@

'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 alpha;
var beta;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, 0.0, 5.0, opts );
var beta = uniform( 10, 0.0, 5.0, opts );
var x = uniform( 10, 0.0, 8.0, opts );

for ( i = 0; i < 10; i++ ) {
x = randu() * 8.0;
alpha = randu() * 5.0;
beta = randu() * 5.0;
y = cdf( x, alpha, beta );
console.log( 'x: %d, α: %d, β: %d, F(x;α,β): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, F(x;α,β): %0.4f', x, alpha, beta, cdf );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/entropy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,21 +123,18 @@ v = entropy( 1.0, -1.0 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var EPS = require( '@stdlib/constants/float64/eps' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var entropy = require( '@stdlib/stats/base/dists/pareto-type1/entropy' );

var alpha;
var beta;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, EPS, 10.0, opts );
var beta = uniform( 10, EPS, 10.0, opts );

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

</section>
Expand Down
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/entropy/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 uniform = require( '@stdlib/random/base/uniform' );
var uniform = require( '@stdlib/random/array/uniform' );
var EPS = require( '@stdlib/constants/float64/eps' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var entropy = require( './../lib' );

var alpha;
var beta;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, EPS, 10.0, opts );
var beta = uniform( 10, EPS, 10.0, opts );

for ( i = 0; i < 10; i++ ) {
alpha = uniform( EPS, 10.0 );
beta = uniform( EPS, 10.0 );
v = entropy( alpha, beta );
console.log( 'α: %d, β: %d, h(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'α: %0.4f, β: %0.4f, h(X;α,β): %0.4f', alpha, beta, entropy );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/kurtosis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,21 +129,18 @@ v = kurtosis( 1.0, -1.0 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var EPS = require( '@stdlib/constants/float64/eps' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var kurtosis = require( '@stdlib/stats/base/dists/pareto-type1/kurtosis' );

var alpha;
var beta;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, EPS + 4.0, 10.0, opts );
var beta = uniform( 10, EPS, 10.0, opts );

for ( i = 0; i < 10; i++ ) {
alpha = ( randu()*10.0 ) + 4.0 + EPS;
beta = ( randu()*10.0 ) + EPS;
v = kurtosis( alpha, beta );
console.log( 'α: %d, β: %d, Kurt(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'α: %0.4f, β: %0.4f, Kurt(X;α,β): %0.4f', alpha, beta, kurtosis );
```

</section>
Expand Down
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/kurtosis/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 uniform = require( '@stdlib/random/array/uniform' );
var EPS = require( '@stdlib/constants/float64/eps' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var kurtosis = require( './../lib' );

var alpha;
var beta;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, EPS + 4.0, 10.0, opts );
var beta = uniform( 10, EPS, 10.0, opts );

for ( i = 0; i < 10; i++ ) {
alpha = ( randu()*10.0 ) + 4.0 + EPS;
beta = ( randu()*10.0 ) + EPS;
v = kurtosis( alpha, beta );
console.log( 'α: %d, β: %d, Kurt(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'α: %0.4f, β: %0.4f, Kurt(X;α,β): %0.4f', alpha, beta, kurtosis );
24 changes: 10 additions & 14 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,22 +141,18 @@ y = mylogcdf( 2.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 logcdf = require( '@stdlib/stats/base/dists/pareto-type1/logcdf' );

var alpha;
var beta;
var x;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
x = randu() * 8.0;
alpha = randu() * 5.0;
beta = randu() * 5.0;
y = logcdf( x, alpha, beta );
console.log( 'x: %d, α: %d, β: %d, ln(F(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
}
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, 0.0, 5.0, opts );
var beta = uniform( 10, 0.0, 5.0, opts );
var x = uniform( 10, 0.0, 8.0, opts );

logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(F(x;α,β)): %0.4f', x, alpha, beta, logcdf );
```

</section>
Expand Down
22 changes: 9 additions & 13 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,15 @@

'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 alpha;
var beta;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, 0.0, 5.0, opts );
var beta = uniform( 10, 0.0, 5.0, opts );
var x = uniform( 10, 0.0, 8.0, opts );

for ( i = 0; i < 10; i++ ) {
x = randu() * 8.0;
alpha = randu() * 5.0;
beta = randu() * 5.0;
y = logcdf( x, alpha, beta );
console.log( 'x: %d, α: %d, β: %d, ln(F(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(F(x;α,β)): %0.4f', x, alpha, beta, logcdf );
24 changes: 10 additions & 14 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logpdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,22 +144,18 @@ y = mylogpdf( 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 logpdf = require( '@stdlib/stats/base/dists/pareto-type1/logpdf' );

var alpha;
var beta;
var x;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
x = randu() * 8.0;
alpha = randu() * 4.0;
beta = randu() * 4.0;
y = logpdf( x, alpha, beta );
console.log( 'x: %d, α: %d, β: %d, ln(f(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
}
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, 0.0, 4.0, opts );
var beta = uniform( 10, 0.0, 4.0, opts );
var x = uniform( 10, 0.0, 8.0, opts );

logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(f(x;α,β)): %0.4f', x, alpha, beta, logpdf );
```

</section>
Expand Down
22 changes: 9 additions & 13 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logpdf/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,15 @@

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

var alpha;
var beta;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, 0.0, 4.0, opts );
var beta = uniform( 10, 0.0, 4.0, opts );
var x = uniform( 10, 0.0, 8.0, opts );

for ( i = 0; i < 10; i++ ) {
x = randu() * 8.0;
alpha = randu() * 4.0;
beta = randu() * 4.0;
y = logpdf( x, alpha, beta );
console.log( 'x: %d, α: %d, β: %d, ln(f(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(f(x;α,β)): %0.4f', x, alpha, beta, logpdf );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/mean/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,21 +130,18 @@ v = mean( 1.0, -1.0 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var EPS = require( '@stdlib/constants/float64/eps' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var mean = require( '@stdlib/stats/base/dists/pareto-type1/mean' );

var alpha;
var beta;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, EPS, 10.0, opts );
var beta = uniform( 10, EPS, 10.0, opts );

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

</section>
Expand Down
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/mean/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 uniform = require( '@stdlib/random/array/uniform' );
var EPS = require( '@stdlib/constants/float64/eps' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var mean = require( './../lib' );

var alpha;
var beta;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, EPS, 10.0, opts );
var beta = uniform( 10, EPS, 10.0, opts );

for ( i = 0; i < 10; i++ ) {
alpha = ( randu()*10.0 ) + EPS;
beta = ( randu()*10.0 ) + EPS;
v = mean( alpha, beta );
console.log( 'α: %d, β: %d, E(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'α: %0.4f, β: %0.4f, E(X;α,β): %0.4f', alpha, beta, mean );
21 changes: 9 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/pareto-type1/median/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,21 +123,18 @@ v = median( 1.0, -1.0 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var EPS = require( '@stdlib/constants/float64/eps' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var median = require( '@stdlib/stats/base/dists/pareto-type1/median' );

var alpha;
var beta;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
alpha = ( randu()*10.0 ) + EPS;
beta = ( randu()*10.0 ) + EPS;
v = median( alpha, beta );
console.log( 'α: %d, β: %d, Median(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
}
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, EPS, 10.0, opts );
var beta = uniform( 10, EPS, 10.0, opts );

logEachMap( 'α: %0.4f, β: %0.4f, Median(X;α,β): %0.4f', alpha, beta, median );
```

</section>
Expand Down
Loading