Skip to content

Commit 6e7f076

Browse files
committed
docs: replace manual for loop in examples
1 parent 187b71d commit 6e7f076

File tree

14 files changed

+106
-144
lines changed

14 files changed

+106
-144
lines changed

lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -109,20 +109,17 @@ y = mycdf( 1.0 );
109109
<!-- eslint no-undef: "error" -->
110110

111111
```javascript
112-
var randu = require( '@stdlib/random/base/randu' );
112+
var uniform = require( '@stdlib/random/array/uniform' );
113+
var logEachMap = require( '@stdlib/console/log-each-map' );
113114
var cdf = require( '@stdlib/stats/base/dists/geometric/cdf' );
114115

115-
var p;
116-
var x;
117-
var y;
118-
var i;
116+
var opts = {
117+
'dtype': 'float64'
118+
};
119+
var p = uniform( 10, 0.0, 1.0, opts );
120+
var x = uniform( 10, 0.0, 5.0, opts );
119121

120-
for ( i = 0; i < 10; i++ ) {
121-
x = randu() * 5.0;
122-
p = randu();
123-
y = cdf( x, p );
124-
console.log( 'x: %d, p: %d, F(x;p): %d', x.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) );
125-
}
122+
logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, cdf );
126123
```
127124

128125
</section>

lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/examples/index.js

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,14 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var cdf = require( './../lib' );
2324

24-
var p;
25-
var x;
26-
var y;
27-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var p = uniform( 10, 0.0, 1.0, opts );
29+
var x = uniform( 10, 0.0, 5.0, opts );
2830

29-
for ( i = 0; i < 10; i++ ) {
30-
x = randu() * 5.0;
31-
p = randu();
32-
y = cdf( x, p );
33-
console.log( 'x: %d, p: %d, F(x;p): %d', x.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) );
34-
}
31+
logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, cdf );

lib/node_modules/@stdlib/stats/base/dists/geometric/entropy/README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -103,19 +103,16 @@ v = entropy( -1.0 );
103103
<!-- eslint no-undef: "error" -->
104104

105105
```javascript
106-
var randu = require( '@stdlib/random/base/randu' );
107-
var round = require( '@stdlib/math/base/special/round' );
106+
var uniform = require( '@stdlib/random/array/uniform' );
107+
var logEachMap = require( '@stdlib/console/log-each-map' );
108108
var entropy = require( '@stdlib/stats/base/dists/geometric/entropy' );
109109

110-
var v;
111-
var i;
112-
var p;
110+
var opts = {
111+
'dtype': 'float64'
112+
};
113+
var p = uniform( 10, 0.0, 1.0, opts );
113114

114-
for ( i = 0; i < 10; i++ ) {
115-
p = randu();
116-
v = entropy( p );
117-
console.log( 'p: %d, H(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
118-
}
115+
logEachMap( 'p: %0.4f, H(X;p): %0.4f', p, entropy );
119116
```
120117

121118
</section>

lib/node_modules/@stdlib/stats/base/dists/geometric/entropy/examples/index.js

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,13 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var entropy = require( './../lib' );
2324

24-
var v;
25-
var i;
26-
var p;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var p = uniform( 10, 0.0, 1.0, opts );
2729

28-
for ( i = 0; i < 10; i++ ) {
29-
p = randu();
30-
v = entropy( p );
31-
console.log( 'p: %d, H(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'p: %0.4f, H(X;p): %0.4f', p, entropy );

lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -103,19 +103,16 @@ v = kurtosis( -1.0 );
103103
<!-- eslint no-undef: "error" -->
104104

105105
```javascript
106-
var randu = require( '@stdlib/random/base/randu' );
107-
var round = require( '@stdlib/math/base/special/round' );
106+
var uniform = require( '@stdlib/random/array/uniform' );
107+
var logEachMap = require( '@stdlib/console/log-each-map' );
108108
var kurtosis = require( '@stdlib/stats/base/dists/geometric/kurtosis' );
109109

110-
var v;
111-
var i;
112-
var p;
110+
var opts = {
111+
'dtype': 'float64'
112+
};
113+
var p = uniform( 10, 0.0, 1.0, opts );
113114

114-
for ( i = 0; i < 10; i++ ) {
115-
p = randu();
116-
v = kurtosis( p );
117-
console.log( 'p: %d, Kurt(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
118-
}
115+
logEachMap( 'p: %0.4f, Kurt(X;p): %0.4f', p, kurtosis );
119116
```
120117

121118
</section>

lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/index.js

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,13 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var kurtosis = require( './../lib' );
2324

24-
var v;
25-
var i;
26-
var p;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var p = uniform( 10, 0.0, 1.0, opts );
2729

28-
for ( i = 0; i < 10; i++ ) {
29-
p = randu();
30-
v = kurtosis( p );
31-
console.log( 'p: %d, Kurt(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'p: %0.4f, Kurt(X;p): %0.4f', p, kurtosis );

lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -119,20 +119,17 @@ y = mylogcdf( 1.0 );
119119
<!-- eslint no-undef: "error" -->
120120

121121
```javascript
122-
var randu = require( '@stdlib/random/base/randu' );
122+
var uniform = require( '@stdlib/random/array/uniform' );
123+
var logEachMap = require( '@stdlib/console/log-each-map' );
123124
var logcdf = require( '@stdlib/stats/base/dists/geometric/logcdf' );
124125

125-
var p;
126-
var x;
127-
var y;
128-
var i;
126+
var opts = {
127+
'dtype': 'float64'
128+
};
129+
var p = uniform( 10, 0.0, 1.0, opts );
130+
var x = uniform( 10, 0.0, 5.0, opts );
129131

130-
for ( i = 0; i < 10; i++ ) {
131-
x = randu() * 5.0;
132-
p = randu();
133-
y = logcdf( x, p );
134-
console.log( 'x: %d, p: %d, ln(F(x;p)): %d', x.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) );
135-
}
132+
logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, logcdf );}
136133
```
137134

138135
</section>

lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/examples/index.js

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,14 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var logcdf = require( './../lib' );
2324

24-
var p;
25-
var x;
26-
var y;
27-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var p = uniform( 10, 0.0, 1.0, opts );
29+
var x = uniform( 10, 0.0, 5.0, opts );
2830

29-
for ( i = 0; i < 10; i++ ) {
30-
x = randu() * 5.0;
31-
p = randu();
32-
y = logcdf( x, p );
33-
console.log( 'x: %d, p: %d, F(x;p): %d', x.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) );
34-
}
31+
logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, logcdf );

lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -122,21 +122,18 @@ y = mylogpmf( 1.0 );
122122
<!-- eslint no-undef: "error" -->
123123

124124
```javascript
125-
var randu = require( '@stdlib/random/base/randu' );
126-
var round = require( '@stdlib/math/base/special/round' );
125+
var uniform = require( '@stdlib/random/array/uniform' );
126+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
127+
var logEachMap = require( '@stdlib/console/log-each-map' );
127128
var logpmf = require( '@stdlib/stats/base/dists/geometric/logpmf' );
128129

129-
var p;
130-
var x;
131-
var y;
132-
var i;
130+
var opts = {
131+
'dtype': 'float64'
132+
};
133+
var p = uniform( 10, 0.0, 1.0, opts );
134+
var x = discreteUniform( 10, 0, 5, opts );
133135

134-
for ( i = 0; i < 10; i++ ) {
135-
x = round( randu() * 5.0 );
136-
p = randu();
137-
y = logpmf( x, p );
138-
console.log( 'x: %d, p: %d, ln( P( X = x; p ) ): %d', x, p.toFixed( 4 ), y.toFixed( 4 ) );
139-
}
136+
logEachMap( 'x: %d, p: %0.4f, ln( P( X = x; p ) ): %0.4f', x, p, logpmf );
140137
```
141138

142139
</section>

lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/examples/index.js

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,15 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
22-
var round = require( '@stdlib/math/base/special/round' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var logpmf = require( './../lib' );
2425

25-
var p;
26-
var x;
27-
var y;
28-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var p = uniform( 10, 0.0, 1.0, opts );
30+
var x = discreteUniform( 10, 0, 5, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
x = round( randu() * 5.0 );
32-
p = randu();
33-
y = logpmf( x, p );
34-
console.log( 'x: %d, p: %d, ln( P( X = x; p ) ): %d', x, p.toFixed( 4 ), y.toFixed( 4 ) );
35-
}
32+
logEachMap( 'x: %d, p: %0.4f, ln( P( X = x; p ) ): %0.4f', x, p, logpmf );

0 commit comments

Comments
 (0)