Skip to content

docs: replace manual for loop in examples #7123

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 1 commit into from
May 30, 2025
+106 −148
Merged

docs: replace manual for loop in examples #7123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/mgf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,21 +111,17 @@ var y = mymgf( 0.1 );
<!-- 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 mgf = require( '@stdlib/stats/base/dists/degenerate/mgf' );

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

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

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

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

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

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 = mode( mu );
console.log( 'µ: %d, mode(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, mode(X;µ): %0.4f', mu, mode );
```

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/mode/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 mode = 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 = mode( mu );
console.log( 'µ: %d, mode(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, mode(X;µ): %0.4f', mu, mode );
20 changes: 8 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/pdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,21 +106,17 @@ y = mypdf( 12.0 );
<!-- eslint no-undef: "error" -->

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

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 = pdf( 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, pdf );
```

</section>
Expand Down
20 changes: 8 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/pdf/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 pdf = 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 = pdf( 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, pdf );
20 changes: 8 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/pmf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,21 +76,17 @@ y = mypmf( 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 pmf = require( '@stdlib/stats/base/dists/degenerate/pmf' );

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 = pmf( x, mu );
console.log( 'x: %d, µ: %d, P(X=x;µ): %d', x, mu, y );
}
logEachMap( 'x: %0.4f, µ: %0.4f, P(X=x;µ): %0.4f', x, mu, pmf );
```

</section>
Expand Down
20 changes: 8 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/pmf/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 pmf = 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 = pmf( x, mu );
console.log( 'x: %d, µ: %d, P(X=x;µ): %d', x, mu, y );
}
logEachMap( 'x: %0.4f, µ: %0.4f, P(X=x;µ): %0.4f', x, mu, pmf );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,20 +90,17 @@ y = myquantile( 1.1 );
<!-- 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 quantile = require( '@stdlib/stats/base/dists/degenerate/quantile' );

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

for ( i = 0; i < 10; i++ ) {
p = randu();
mu = ( randu()*10.0 ) - 5.0;
y = quantile( p, mu );
console.log( 'p: %d, µ: %d, Q(p;µ): %d', p, mu, y );
}
logEachMap( 'p: %0.4f, µ: %0.4f, Q(p;µ): %0.4f', p, mu, quantile );
```

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

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

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

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 = stdev( mu );
console.log( 'µ: %d, SD(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, SD(X;µ): %0.4f', mu, stdev );
```

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/stdev/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 stdev = 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 = stdev( mu );
console.log( 'µ: %d, SD(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, SD(X;µ): %0.4f', mu, stdev );
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/variance/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,18 +93,16 @@ v = variance( 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 variance = require( '@stdlib/stats/base/dists/degenerate/variance' );

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 = variance( mu );
console.log( 'µ: %d, Var(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, Var(X;µ): %0.4f', mu, variance );
```

</section>
Expand Down
16 changes: 7 additions & 9 deletions lib/node_modules/@stdlib/stats/base/dists/degenerate/variance/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 variance = 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 = variance( mu );
console.log( 'µ: %d, Var(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'µ: %0.4f, Var(X;µ): %0.4f', mu, variance );