Skip to content

docs: replace manual for loop in examples #6249

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
Mar 21, 2025
Merged

docs: replace manual for loop in examples #6249

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/arcsine/entropy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,21 +111,17 @@ y = entropy( 3.0, 3.0 );
<!-- eslint no-undef: "error" -->

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

var a;
var b;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var a = uniform( 25, 0.0, 10.0, opts );
var b = uniform( a.length, 15.0, 25.0, opts );

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

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

var a;
var b;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var a = uniform( 25, 0.0, 10.0, opts );
var b = uniform( a.length, 15.0, 25.0, opts );

for ( i = 0; i < 10; i++ ) {
a = ( randu()*10.0 );
b = ( randu()*10.0 ) + a + EPS;
v = entropy( a, b );
console.log( 'a: %d, b: %d, h(X;a,b): %d', a.toFixed( 4 ), b.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'a: %0.4f, b: %0.4f, h(X;a,b): %0.4f', a, b, entropy );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/arcsine/kurtosis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,20 +111,17 @@ y = kurtosis( 3.0, 3.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/arcsine/kurtosis' );

var a;
var b;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var a = uniform( 25, 0.0, 10.0, opts );
var b = uniform( a.length, 10.0, 20.0, opts );

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

</section>
Expand Down
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/arcsine/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 a;
var b;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var a = uniform( 25, 0.0, 10.0, opts );
var b = uniform( a.length, 10.0, 20.0, opts );

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

var a;
var b;
var x;
var y;
var i;

for ( i = 0; i < 25; i++ ) {
x = ( randu()*20.0 ) - 10.0;
a = ( randu()*20.0 ) - 20.0;
b = a + ( randu()*40.0 );
y = logcdf( x, a, b );
console.log( 'x: %d, a: %d, b: %d, ln(F(x;a,b)): %d', x.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), y.toFixed( 4 ) );
}
var opts = {
'dtype': 'float64'
};
var x = uniform( 25, -10.0, 10.0, opts );
var a = uniform( x.length, -20.0, 0.0, opts );
var b = uniform( x.length, 0.0, 40.0, opts );

logEachMap( 'x: %d, a: %d, b: %d, ln(F(x;a,b)): %d', x, a, b, logcdf );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anandkaranubc These should be %0.4f. This applies to other packages, as well.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @Planeshifter logEachMap supports string/format string interpolation.

```

</section>
Expand Down
22 changes: 9 additions & 13 deletions lib/node_modules/@stdlib/stats/base/dists/arcsine/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 a;
var b;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 25, -10.0, 10.0, opts );
var a = uniform( x.length, -20.0, 0.0, opts );
var b = uniform( x.length, 0.0, 40.0, opts );

for ( i = 0; i < 25; i++ ) {
x = ( randu()*20.0 ) - 10.0;
a = ( randu()*20.0 ) - 20.0;
b = a + ( randu()*40.0 );
y = logcdf( x, a, b );
console.log( 'x: %d, a: %d, b: %d, ln(F(x;a,b)): %d', x.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %d, a: %d, b: %d, ln(F(x;a,b)): %d', x, a, b, logcdf );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment.

24 changes: 10 additions & 14 deletions lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,22 +125,18 @@ y = mylogPDF( 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 logpdf = require( '@stdlib/stats/base/dists/arcsine/logpdf' );

var a;
var b;
var x;
var y;
var i;

for ( i = 0; i < 25; i++ ) {
x = ( randu()*20.0 ) - 10.0;
a = ( randu()*20.0 ) - 20.0;
b = a + ( randu()*40.0 );
y = logpdf( x, a, b );
console.log( 'x: %d, a: %d, b: %d, ln(f(x;a,b)): %d', x.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), y.toFixed( 4 ) );
}
var opts = {
'dtype': 'float64'
};
var x = uniform( 25, -10.0, 10.0, opts );
var a = uniform( x.length, -20.0, 0.0, opts );
var b = uniform( x.length, 0.0, 40.0, opts );

logEachMap( 'x: %d, a: %d, b: %d, ln(f(x;a,b)): %d', x, a, b, logpdf );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment.

```

</section>
Expand Down
22 changes: 9 additions & 13 deletions lib/node_modules/@stdlib/stats/base/dists/arcsine/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 a;
var b;
var x;
var y;
var i;
var opts = {
'dtype': 'float64'
};
var x = uniform( 25, -10.0, 10.0, opts );
var a = uniform( x.length, -20.0, 0.0, opts );
var b = uniform( x.length, 0.0, 40.0, opts );

for ( i = 0; i < 25; i++ ) {
x = ( randu()*20.0 ) - 10.0;
a = ( randu()*20.0 ) - 20.0;
b = a + ( randu()*40.0 );
y = logpdf( x, a, b );
console.log( 'x: %d, a: %d, b: %d, ln(f(x;a,b)): %d', x.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), y.toFixed( 4 ) );
}
logEachMap( 'x: %d, a: %d, b: %d, ln(f(x;a,b)): %d', x, a, b, logpdf );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment.

19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/arcsine/mean/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,20 +113,17 @@ y = mean( 3.0, 3.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/arcsine/mean' );

var a;
var b;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var a = uniform( 25, 0.0, 10.0, opts );
var b = uniform( a.length, 10.0, 20.0, opts );

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

</section>
Expand Down
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/arcsine/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 a;
var b;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var a = uniform( 25, 0.0, 10.0, opts );
var b = uniform( a.length, 10.0, 20.0, opts );

for ( i = 0; i < 10; i++ ) {
a = ( randu()*10.0 );
b = ( randu()*10.0 ) + a;
v = mean( a, b );
console.log( 'a: %d, b: %d, E(X;a,b): %d', a.toFixed( 4 ), b.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'a: %0.4f, b: %0.4f, E(X;a,b): %0.4f', a, b, mean );
21 changes: 9 additions & 12 deletions lib/node_modules/@stdlib/stats/base/dists/arcsine/median/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,20 +113,17 @@ y = median( 3.0, 3.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/arcsine/median' );

var a;
var b;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
a = ( randu()*10.0 );
b = ( randu()*10.0 ) + a;
v = median( a, b );
console.log( 'a: %d, b: %d, Median(X;a,b): %d', a.toFixed( 4 ), b.toFixed( 4 ), v.toFixed( 4 ) );
}
var opts = {
'dtype': 'float64'
};
var a = uniform( 25, 0.0, 10.0, opts );
var b = uniform( a.length, 10.0, 20.0, opts );

logEachMap( 'a: %0.4f, b: %0.4f, Median(X;a,b): %0.4f', a, b, median );
```

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

var a;
var b;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var a = uniform( 25, 0.0, 10.0, opts );
var b = uniform( a.length, 10.0, 20.0, opts );

for ( i = 0; i < 10; i++ ) {
a = ( randu()*10.0 );
b = ( randu()*10.0 ) + a;
v = median( a, b );
console.log( 'a: %d, b: %d, Median(X;a,b): %d', a.toFixed( 4 ), b.toFixed( 4 ), v.toFixed( 4 ) );
}
logEachMap( 'a: %0.4f, b: %0.4f, Median(X;a,b): %0.4f', a, b, median );
19 changes: 8 additions & 11 deletions lib/node_modules/@stdlib/stats/base/dists/arcsine/mode/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,20 +111,17 @@ y = mode( 3.0, 3.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 mode = require( '@stdlib/stats/base/dists/arcsine/mode' );

var a;
var b;
var v;
var i;
var opts = {
'dtype': 'float64'
};
var a = uniform( 25, 0.0, 10.0, opts );
var b = uniform( a.length, 10.0, 20.0, opts );

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

</section>
Expand Down
Loading