Skip to content

docs: replace manual for loop in examples #8263

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
wants to merge 2 commits into
base: develop
Choose a base branch
from
+225 −313
Open

docs: replace manual for loop in examples #8263

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
e1f54c9
docs: replace manual for loop in examples
hrshya Oct 21, 2025
3be1d36
fix: fixes lint issues
hrshya Oct 21, 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/lognormal/cdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,22 +114,18 @@ y = mycdf( 4.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/lognormal/cdf' );

var sigma;
var mu;
var x;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
x = randu() * 10.0;
mu = (randu() * 10.0) - 5.0;
sigma = randu() * 20.0;
y = cdf( x, mu, sigma );
console.log( 'x: %d, µ: %d, σ: %d, F(x;µ,σ): %d', x.toFixed( 4 ), mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
var opts = {
'dtype': 'float64'
};
var x = uniform( 10, 0.0, 10.0, opts );
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, F(x;µ,σ): %0.4f', x, mu, sigma, cdf );
```

</section>
Expand Down
22 changes: 9 additions & 13 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/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 sigma;
var mu;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 10, 0.0, 10.0, opts );
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

for ( i = 0; i < 10; i++ ) {
x = randu() * 10.0;
mu = (randu() * 10.0) - 5.0;
sigma = randu() * 20.0;
y = cdf( x, mu, sigma );
console.log( 'x: %d, µ: %d, σ: %d, F(x;µ,σ): %d', x.toFixed( 4 ), mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, F(x;µ,σ): %0.4f', x, mu, sigma, cdf );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/entropy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,20 +114,17 @@ y = entropy( 0.0, -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 entropy = require( '@stdlib/stats/base/dists/lognormal/entropy' );

var sigma;
var mu;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

for ( i = 0; i < 10; i++ ) {
mu = ( randu()*10.0 ) - 5.0;
sigma = randu() * 20.0;
y = entropy( mu, sigma );
console.log( 'µ: %d, σ: %d, h(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, σ: %0.4f, h(X;µ,σ): %0.4f', mu, sigma, entropy );
```

</section>
Expand Down
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/entropy/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 entropy = require( './../lib' );

var sigma;
var mu;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

for ( i = 0; i < 10; i++ ) {
mu = ( randu()*10.0 ) - 5.0;
sigma = randu() * 20.0;
y = entropy( mu, sigma );
console.log( 'µ: %d, σ: %d, h(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, σ: %0.4f, h(X;µ,σ): %0.4f', mu, sigma, entropy );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/kurtosis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,20 +114,17 @@ y = kurtosis( 0.0, -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 kurtosis = require( '@stdlib/stats/base/dists/lognormal/kurtosis' );

var sigma;
var mu;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

for ( i = 0; i < 10; i++ ) {
mu = ( randu()*10.0 ) - 5.0;
sigma = ( randu()*4.9 ) + 0.1;
y = kurtosis( mu, sigma );
console.log( 'µ: %d, σ: %d, Kurt(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, σ: %0.4f, Kurt(X;µ,σ): %0.4f', mu, sigma, kurtosis );
```

</section>
Expand Down
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/kurtosis/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 kurtosis = require( './../lib' );

var sigma;
var mu;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

for ( i = 0; i < 10; i++ ) {
mu = ( randu()*10.0 ) - 5.0;
sigma = randu() * 20.0;
y = kurtosis( mu, sigma );
console.log( 'µ: %d, σ: %d, Kurt(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, σ: %0.4f, Kurt(X;µ,σ): %0.4f', mu, sigma, kurtosis );
28 changes: 12 additions & 16 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,10 @@ var y = logcdf( 2.0, 8.0, 0.0 );
// returns -Infinity

y = logcdf( 8.0, 8.0, 0.0 );
// returns 0.0
// returns -Infinity

y = logcdf( 10.0, 8.0, 0.0 );
// returns 0.0
// returns -Infinity
```

#### logcdf.factory( mu, sigma )
Expand Down Expand Up @@ -106,22 +106,18 @@ y = mylogcdf( 5.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/lognormal/logcdf' );

var sigma;
var mu;
var x;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
x = randu() * 10.0;
mu = (randu() * 10.0) - 5.0;
sigma = randu() * 20.0;
y = logcdf( x, mu, sigma );
console.log( 'x: %d, µ: %d, σ: %d, ln(F(x;µ,σ)): %d', x, mu, sigma, y );
}
var opts = {
'dtype': 'float64'
};
var x = uniform( 10, 0.0, 10.0, opts );
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, ln(F(x;µ,σ)): %0.4f', x, mu, sigma, logcdf );
```

</section>
Expand Down
22 changes: 9 additions & 13 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/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 sigma;
var mu;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 10, 0.0, 10.0, opts );
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

for ( i = 0; i < 10; i++ ) {
x = randu() * 10.0;
mu = (randu() * 10.0) - 5.0;
sigma = randu() * 20.0;
y = logcdf( x, mu, sigma );
console.log( 'x: %d, µ: %d, σ: %d, ln(F(x;µ,σ)): %d', x.toFixed( 4 ), mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, ln(F(x;µ,σ)): %0.4f', x, mu, sigma, logcdf );
24 changes: 10 additions & 14 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/logpdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,22 +116,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/lognormal/logpdf' );

var sigma;
var mu;
var x;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
x = randu() * 10.0;
mu = (randu() * 10.0) - 5.0;
sigma = randu() * 20.0;
y = logpdf( x, mu, sigma );
console.log( 'x: %d, µ: %d, σ: %d, ln(f(x;µ,σ)): %d', x.toFixed( 4 ), mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
var opts = {
'dtype': 'float64'
};
var x = uniform( 10, 0.0, 10.0, opts );
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, ln(f(x;µ,σ)): %0.4f', x, mu, sigma, logpdf );
```

</section>
Expand Down
22 changes: 9 additions & 13 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/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 sigma;
var mu;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 10, 0.0, 10.0, opts );
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

for ( i = 0; i < 10; i++ ) {
x = randu() * 10.0;
mu = (randu() * 10.0) - 5.0;
sigma = randu() * 20.0;
y = logpdf( x, mu, sigma );
console.log( 'x: %d, µ: %d, σ: %d, ln(f(x;µ,σ)): %d', x.toFixed( 4 ), mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, ln(f(x;µ,σ)): %0.4f', x, mu, sigma, logpdf );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/mean/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,20 +114,17 @@ y = mean( 0.0, -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 mean = require( '@stdlib/stats/base/dists/lognormal/mean' );

var sigma;
var mu;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

for ( i = 0; i < 10; i++ ) {
mu = ( randu()*10.0 ) - 5.0;
sigma = randu() * 20.0;
y = mean( mu, sigma );
console.log( 'µ: %d, σ: %d, E(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, σ: %0.4f, E(X;µ,σ): %0.4f', mu, sigma, mean );
```

</section>
Expand Down
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/mean/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 mean = require( './../lib' );

var sigma;
var mu;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

for ( i = 0; i < 10; i++ ) {
mu = ( randu()*10.0 ) - 5.0;
sigma = randu() * 10.0;
y = mean( mu, sigma );
console.log( 'µ: %d, σ: %d, E(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, σ: %0.4f, E(X;µ,σ): %0.4f', mu, sigma, mean );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/median/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,20 +114,17 @@ y = median( 0.0, -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 median = require( '@stdlib/stats/base/dists/lognormal/median' );

var sigma;
var mu;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var mu = uniform( 10, -5.0, 5.0, opts );
var sigma = uniform( 10, 0.0, 20.0, opts );

for ( i = 0; i < 10; i++ ) {
mu = ( randu()*10.0 ) - 5.0;
sigma = randu() * 20.0;
y = median( mu, sigma );
console.log( 'µ: %d, σ: %d, Median(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, σ: %0.4f, Median(X;µ,σ): %0.4f', mu, sigma, median );
```

</section>
Expand Down
Loading