Skip to content

Commit 17ae854

Browse files
hrshyaanandkaranubc
hrshya
authored and
anandkaranubc
committed
docs: replace manual for loop in examples
PR-URL: stdlib-js#7170 Reviewed-by: Athan Reines <[email protected]>
1 parent 7ce5f1e commit 17ae854

File tree

22 files changed

+210
-284
lines changed

22 files changed

+210
-284
lines changed

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

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -145,23 +145,19 @@ y = mycdf( 2.0 );
145145
<!-- eslint no-undef: "error" -->
146146

147147
```javascript
148-
var randu = require( '@stdlib/random/base/randu' );
149-
var round = require( '@stdlib/math/base/special/round' );
148+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
149+
var uniform = require( '@stdlib/random/array/uniform' );
150+
var logEachMap = require( '@stdlib/console/log-each-map' );
150151
var cdf = require( '@stdlib/stats/base/dists/erlang/cdf' );
151152

152-
var lambda;
153-
var k;
154-
var x;
155-
var y;
156-
var i;
157-
158-
for ( i = 0; i < 20; i++ ) {
159-
x = randu() * 10.0;
160-
k = round( randu() * 10.0 );
161-
lambda = randu() * 5.0;
162-
y = cdf( x, k, lambda );
163-
console.log( 'x: %d, k: %d, λ: %d, F(x;k,λ): %d', x.toFixed( 4 ), k, lambda.toFixed( 4 ), y.toFixed( 4 ) );
164-
}
153+
var opts = {
154+
'dtype': 'float64'
155+
};
156+
var x = uniform( 20, 0.0, 10.0, opts );
157+
var k = discreteUniform( 20, 0, 10, opts );
158+
var lambda = uniform( 20, 0.0, 5.0, opts );
159+
160+
logEachMap( 'x: %0.4f, k: %d, λ: %0.4f, F(x;k,λ): %0.4f', x, k, lambda, cdf );
165161
```
166162

167163
</section>

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,16 @@
1818

1919
'use strict';
2020

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

25-
var lambda;
26-
var k;
27-
var x;
28-
var y;
29-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = uniform( 20, 0.0, 10.0, opts );
30+
var k = discreteUniform( 20, 0, 10, opts );
31+
var lambda = uniform( 20, 0.0, 5.0, opts );
3032

31-
for ( i = 0; i < 20; i++ ) {
32-
x = randu() * 10.0;
33-
k = round( randu() * 10.0 );
34-
lambda = randu() * 5.0;
35-
y = cdf( x, k, lambda );
36-
console.log( 'x: %d, k: %d, λ: %d, F(x;k,λ): %d', x.toFixed( 4 ), k, lambda.toFixed( 4 ), y.toFixed( 4 ) );
37-
}
33+
logEachMap( 'x: %0.4f, k: %d, λ: %0.4f, F(x;k,λ): %0.4f', x, k, lambda, cdf );

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

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -123,22 +123,19 @@ v = entropy( 2, -1.0 );
123123
<!-- eslint no-undef: "error" -->
124124

125125
```javascript
126-
var randu = require( '@stdlib/random/base/randu' );
127-
var round = require( '@stdlib/math/base/special/round' );
126+
var uniform = require( '@stdlib/random/array/uniform' );
127+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
128+
var logEachMap = require( '@stdlib/console/log-each-map' );
128129
var EPS = require( '@stdlib/constants/float64/eps' );
129130
var entropy = require( '@stdlib/stats/base/dists/erlang/entropy' );
130131

131-
var lambda;
132-
var k;
133-
var v;
134-
var i;
132+
var opts = {
133+
'dtype': 'float64'
134+
};
135+
var k = discreteUniform( 10, 0, 10, opts );
136+
var lambda = uniform( 10, EPS, 10.0, opts );
135137

136-
for ( i = 0; i < 10; i++ ) {
137-
k = round( randu()*10.0 );
138-
lambda = ( randu()*10.0 ) + EPS;
139-
v = entropy( k, lambda );
140-
console.log( 'k: %d, λ: %d, h(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
141-
}
138+
logEachMap( 'k: %d, λ: %0.4f, h(X;k,λ): %0.4f', k, lambda, entropy );
142139
```
143140

144141
</section>

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

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,16 @@
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 EPS = require( '@stdlib/constants/float64/eps' );
2425
var entropy = require( './../lib' );
2526

26-
var lambda;
27-
var k;
28-
var v;
29-
var i;
27+
var opts = {
28+
'dtype': 'float64'
29+
};
30+
var k = discreteUniform( 10, 0, 10, opts );
31+
var lambda = uniform( 10, EPS, 10.0, opts );
3032

31-
for ( i = 0; i < 10; i++ ) {
32-
k = round( randu()*10.0 );
33-
lambda = ( randu()*10.0 ) + EPS;
34-
v = entropy( k, lambda );
35-
console.log( 'k: %d, λ: %d, h(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
36-
}
33+
logEachMap( 'k: %d, λ: %0.4f, h(X;k,λ): %0.4f', k, lambda, entropy );

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

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -121,22 +121,19 @@ v = kurtosis( 2, -1.0 );
121121
<!-- eslint no-undef: "error" -->
122122

123123
```javascript
124-
var randu = require( '@stdlib/random/base/randu' );
125-
var round = require( '@stdlib/math/base/special/round' );
124+
var uniform = require( '@stdlib/random/array/uniform' );
125+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
126+
var logEachMap = require( '@stdlib/console/log-each-map' );
126127
var EPS = require( '@stdlib/constants/float64/eps' );
127128
var kurtosis = require( '@stdlib/stats/base/dists/erlang/kurtosis' );
128129

129-
var lambda;
130-
var k;
131-
var v;
132-
var i;
130+
var opts = {
131+
'dtype': 'float64'
132+
};
133+
var k = discreteUniform( 10, 0, 10, opts );
134+
var lambda = uniform( 10, EPS, 10.0, opts );
133135

134-
for ( i = 0; i < 10; i++ ) {
135-
k = round( randu()*10.0 );
136-
lambda = ( randu()*10.0 ) + EPS;
137-
v = kurtosis( k, lambda );
138-
console.log( 'k: %d, λ: %d, Kurt(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
139-
}
136+
logEachMap( 'k: %0.4f, λ: %d, Kurt(X;k,λ): %0.4f', k, lambda, kurtosis );
140137
```
141138

142139
</section>

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

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,16 @@
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 EPS = require( '@stdlib/constants/float64/eps' );
2425
var kurtosis = require( './../lib' );
2526

26-
var lambda;
27-
var k;
28-
var v;
29-
var i;
27+
var opts = {
28+
'dtype': 'float64'
29+
};
30+
var k = discreteUniform( 10, 0, 10, opts );
31+
var lambda = uniform( 10, EPS, 10.0, opts );
3032

31-
for ( i = 0; i < 10; i++ ) {
32-
k = round( randu()*10.0 );
33-
lambda = ( randu()*10.0 ) + EPS;
34-
v = kurtosis( k, lambda );
35-
console.log( 'k: %d, λ: %d, Kurt(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
36-
}
33+
logEachMap( 'k: %0.4f, λ: %d, Kurt(X;k,λ): %0.4f', k, lambda, kurtosis );

‎lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -136,23 +136,19 @@ y = mylogpdf( 4.0 );
136136
<!-- eslint no-undef: "error" -->
137137

138138
```javascript
139-
var randu = require( '@stdlib/random/base/randu' );
140-
var round = require( '@stdlib/math/base/special/round' );
139+
var uniform = require( '@stdlib/random/array/uniform' );
140+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
141+
var logEachMap = require( '@stdlib/console/log-each-map' );
141142
var logpdf = require( '@stdlib/stats/base/dists/erlang/logpdf' );
142143

143-
var lambda;
144-
var k;
145-
var x;
146-
var y;
147-
var i;
148-
149-
for ( i = 0; i < 20; i++ ) {
150-
x = randu() * 10.0;
151-
k = round( randu() * 10.0 );
152-
lambda = randu() * 5.0;
153-
y = logpdf( x, k, lambda );
154-
console.log( 'x: %d, k: %d, λ: %d, ln(f(x;k,λ)): %d', x.toFixed( 4 ), k, lambda.toFixed( 4 ), y.toFixed( 4 ) );
155-
}
144+
var opts = {
145+
'dtype': 'float64'
146+
};
147+
var x = uniform( 20, 0.0, 10.0, opts );
148+
var k = discreteUniform( 20, 0, 10, opts );
149+
var lambda = uniform( 20, 0.0, 5.0, opts );
150+
151+
logEachMap( 'x: %0.4f, k: %d, λ: %0.4f, ln(f(x;k,λ)): %0.4f', x, k, lambda, logpdf );
156152
```
157153

158154
</section>

‎lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/examples/index.js

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,16 @@
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 logpdf = require( './../lib' );
2425

25-
var lambda;
26-
var k;
27-
var x;
28-
var y;
29-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = uniform( 20, 0.0, 10.0, opts );
30+
var k = discreteUniform( 20, 0, 10, opts );
31+
var lambda = uniform( 20, 0.0, 5.0, opts );
3032

31-
for ( i = 0; i < 20; i++ ) {
32-
x = randu() * 10.0;
33-
k = round( randu() * 10.0 );
34-
lambda = randu() * 5.0;
35-
y = logpdf( x, k, lambda );
36-
console.log( 'x: %d, k: %d, λ: %d, ln(f(x;k,λ)): %d', x.toFixed( 4 ), k, lambda.toFixed( 4 ), y.toFixed( 4 ) );
37-
}
33+
logEachMap( 'x: %0.4f, k: %d, λ: %0.4f, ln(f(x;k,λ)): %0.4f', x, k, lambda, logpdf );

‎lib/node_modules/@stdlib/stats/base/dists/erlang/mean/README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -123,22 +123,19 @@ v = mean( 2, -1.0 );
123123
<!-- eslint no-undef: "error" -->
124124

125125
```javascript
126-
var randu = require( '@stdlib/random/base/randu' );
127-
var round = require( '@stdlib/math/base/special/round' );
126+
var uniform = require( '@stdlib/random/array/uniform' );
127+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
128+
var logEachMap = require( '@stdlib/console/log-each-map' );
128129
var EPS = require( '@stdlib/constants/float64/eps' );
129130
var mean = require( '@stdlib/stats/base/dists/erlang/mean' );
130131

131-
var lambda;
132-
var k;
133-
var v;
134-
var i;
132+
var opts = {
133+
'dtype': 'float64'
134+
};
135+
var k = discreteUniform( 10, 0, 10, opts );
136+
var lambda = uniform( 10, EPS, 10.0, opts );
135137

136-
for ( i = 0; i < 10; i++ ) {
137-
k = round( randu()*10.0 );
138-
lambda = ( randu()*10.0 ) + EPS;
139-
v = mean( k, lambda );
140-
console.log( 'k: %d, λ: %d, E(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
141-
}
138+
logEachMap( 'k: %d, λ: %0.4f, E(X;k,λ): %0.4f', k, lambda, mean );
142139
```
143140

144141
</section>

‎lib/node_modules/@stdlib/stats/base/dists/erlang/mean/examples/index.js

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,16 @@
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 EPS = require( '@stdlib/constants/float64/eps' );
2425
var mean = require( './../lib' );
2526

26-
var lambda;
27-
var k;
28-
var v;
29-
var i;
27+
var opts = {
28+
'dtype': 'float64'
29+
};
30+
var k = discreteUniform( 10, 0, 10, opts );
31+
var lambda = uniform( 10, EPS, 10.0, opts );
3032

31-
for ( i = 0; i < 10; i++ ) {
32-
k = round( randu()*10.0 );
33-
lambda = ( randu()*10.0 ) + EPS;
34-
v = mean( k, lambda );
35-
console.log( 'k: %d, λ: %d, E(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
36-
}
33+
logEachMap( 'k: %d, λ: %0.4f, E(X;k,λ): %0.4f', k, lambda, mean );

‎lib/node_modules/@stdlib/stats/base/dists/erlang/mode/README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -123,22 +123,19 @@ v = mode( 2, -1.0 );
123123
<!-- eslint no-undef: "error" -->
124124

125125
```javascript
126-
var randu = require( '@stdlib/random/base/randu' );
127-
var round = require( '@stdlib/math/base/special/round' );
126+
var uniform = require( '@stdlib/random/array/uniform' );
127+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
128+
var logEachMap = require( '@stdlib/console/log-each-map' );
128129
var EPS = require( '@stdlib/constants/float64/eps' );
129130
var mode = require( '@stdlib/stats/base/dists/erlang/mode' );
130131

131-
var lambda;
132-
var k;
133-
var v;
134-
var i;
132+
var opts = {
133+
'dtype': 'float64'
134+
};
135+
var k = discreteUniform( 10, 0, 10, opts );
136+
var lambda = uniform( 10, EPS, 10.0, opts );
135137

136-
for ( i = 0; i < 10; i++ ) {
137-
k = round( randu()*10.0 );
138-
lambda = ( randu()*10.0 ) + EPS;
139-
v = mode( k, lambda );
140-
console.log( 'k: %d, λ: %d, mode(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
141-
}
138+
logEachMap( 'k: %d, λ: %0.4f, mode(X;k,λ): %0.4f', k, lambda, mode );
142139
```
143140

144141
</section>

‎lib/node_modules/@stdlib/stats/base/dists/erlang/mode/examples/index.js

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,16 @@
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 EPS = require( '@stdlib/constants/float64/eps' );
2425
var mode = require( './../lib' );
2526

26-
var lambda;
27-
var k;
28-
var v;
29-
var i;
27+
var opts = {
28+
'dtype': 'float64'
29+
};
30+
var k = discreteUniform( 10, 0, 10, opts );
31+
var lambda = uniform( 10, EPS, 10.0, opts );
3032

31-
for ( i = 0; i < 10; i++ ) {
32-
k = round( randu()*10.0 );
33-
lambda = ( randu()*10.0 ) + EPS;
34-
v = mode( k, lambda );
35-
console.log( 'k: %d, λ: %d, mode(X;k,λ): %d', k.toFixed( 4 ), lambda.toFixed( 4 ), v.toFixed( 4 ) );
36-
}
33+
logEachMap( 'k: %d, λ: %0.4f, mode(X;k,λ): %0.4f', k, lambda, mode );

0 commit comments

Comments
 (0)