Skip to content

Commit 2dcc230

Browse files
committed
docs: replace manual for loop in examples
1 parent 73ca98e commit 2dcc230

File tree

14 files changed

+118
-168
lines changed

14 files changed

+118
-168
lines changed

lib/node_modules/@stdlib/stats/base/dists/gamma/mgf/README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -144,22 +144,18 @@ y = mymgf( 0.5 );
144144
<!-- eslint no-undef: "error" -->
145145

146146
```javascript
147-
var randu = require( '@stdlib/random/base/randu' );
147+
var uniform = require( '@stdlib/random/array/uniform' );
148+
var logEachMap = require( '@stdlib/console/log-each-map' );
148149
var mgf = require( '@stdlib/stats/base/dists/gamma/mgf' );
149150

150-
var a;
151-
var b;
152-
var t;
153-
var v;
154-
var i;
155-
156-
for ( i = 0; i < 10; i++ ) {
157-
t = randu();
158-
a = randu() * 5.0;
159-
b = a + (randu() * 5.0);
160-
v = mgf( t, a, b );
161-
console.log( 't: %d, a: %d, b: %d, M_X(t;a,b): %d', t.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), v.toFixed( 4 ) );
162-
}
151+
var opts = {
152+
'dtype': 'float64'
153+
};
154+
var t = uniform( 10, 0.0, 3.0, opts );
155+
var alpha = uniform( 10, 0.0, 5.0, opts );
156+
var beta = uniform( 10, 0.0, 5.0, opts );
157+
158+
logEachMap( 't: %0.4f, α: %0.4f, β: %0.4f, M_X(t;α,β): %0.4f', t, alpha, beta, mgf );
163159
```
164160

165161
</section>

lib/node_modules/@stdlib/stats/base/dists/gamma/mgf/examples/index.js

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,15 @@
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 mgf = require( './../lib' );
2324

24-
var alpha;
25-
var beta;
26-
var t;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var t = uniform( 10, 0.0, 3.0, opts );
29+
var alpha = uniform( 10, 0.0, 5.0, opts );
30+
var beta = uniform( 10, 0.0, 5.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
t = randu() * 3.0;
32-
alpha = randu() * 5.0;
33-
beta = randu() * 5.0;
34-
y = mgf( t, alpha, beta );
35-
console.log( 't: %d, α: %d, β: %d, M_X(t;α,β): %d', t.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
36-
}
32+
logEachMap( 't: %0.4f, α: %0.4f, β: %0.4f, M_X(t;α,β): %0.4f', t, alpha, beta, mgf );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,18 @@ v = mode( 1.0, -1.0 );
123123
<!-- eslint no-undef: "error" -->
124124

125125
```javascript
126-
var randu = require( '@stdlib/random/base/randu' );
126+
var uniform = require( '@stdlib/random/array/uniform' );
127+
var logEachMap = require( '@stdlib/console/log-each-map' );
127128
var EPS = require( '@stdlib/constants/float64/eps' );
128129
var mode = require( '@stdlib/stats/base/dists/gamma/mode' );
129130

130-
var alpha;
131-
var beta;
132-
var v;
133-
var i;
131+
var opts = {
132+
'dtype': 'float64'
133+
};
134+
var alpha = uniform( 10, EPS, 10.0, opts );
135+
var beta = uniform( 10, EPS, 10.0, opts );
134136

135-
for ( i = 0; i < 10; i++ ) {
136-
alpha = ( randu()*10.0 ) + EPS;
137-
beta = ( randu()*10.0 ) + EPS;
138-
v = mode( alpha, beta );
139-
console.log( 'α: %d, β: %d, mode(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
140-
}
137+
logEachMap( 'α: %0.4f, β: %0.4f, mode(X;α,β): %0.4f', alpha, beta, mode );
141138
```
142139

143140
</section>

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

Lines changed: 8 additions & 11 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' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var EPS = require( '@stdlib/constants/float64/eps' );
2324
var mode = require( './../lib' );
2425

25-
var alpha;
26-
var beta;
27-
var v;
28-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var alpha = uniform( 10, EPS, 10.0, opts );
30+
var beta = uniform( 10, EPS, 10.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
alpha = ( randu()*10.0 ) + EPS;
32-
beta = ( randu()*10.0 ) + EPS;
33-
v = mode( alpha, beta );
34-
console.log( 'α: %d, β: %d, mode(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'α: %0.4f, β: %0.4f, mode(X;α,β): %0.4f', alpha, beta, mode );

lib/node_modules/@stdlib/stats/base/dists/gamma/pdf/README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -134,23 +134,18 @@ y = mypdf( 4.0 );
134134

135135
```javascript
136136
var uniform = require( '@stdlib/random/array/uniform' );
137+
var logEachMap = require( '@stdlib/console/log-each-map' );
137138
var EPS = require( '@stdlib/constants/float64/eps' );
138139
var pdf = require( '@stdlib/stats/base/dists/gamma/pdf' );
139140

140-
var alpha;
141-
var beta;
142-
var x;
143-
var y;
144-
var i;
141+
var opts = {
142+
'dtype': 'float64'
143+
};
144+
var x = uniform( 10, 0.0, 3.0, opts );
145+
var alpha = uniform( 10, EPS, 5.0, opts );
146+
var beta = uniform( 10, EPS, 5.0, opts );
145147

146-
x = uniform( 10, 0.0, 3.0 );
147-
alpha = uniform( 10, EPS, 5.0 );
148-
beta = uniform( 10, EPS, 5.0 );
149-
150-
for ( i = 0; i < x.length; i++ ) {
151-
y = pdf( x[ i ], alpha[ i ], beta[ i ] );
152-
console.log( 'x: %d, α: %d, β: %d, f(x;α,β): %d', x[ i ].toFixed( 4 ), alpha[ i ].toFixed( 4 ), beta[ i ].toFixed( 4 ), y.toFixed( 4 ) );
153-
}
148+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, f(x;α,β): %0.4f', x, alpha, beta, pdf );
154149
```
155150

156151
</section>

lib/node_modules/@stdlib/stats/base/dists/gamma/pdf/examples/index.js

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,15 @@
1919
'use strict';
2020

2121
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var EPS = require( '@stdlib/constants/float64/eps' );
2324
var pdf = require( './../lib' );
2425

25-
var alpha;
26-
var beta;
27-
var x;
28-
var y;
29-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = uniform( 10, 0.0, 3.0, opts );
30+
var alpha = uniform( 10, EPS, 5.0, opts );
31+
var beta = uniform( 10, EPS, 5.0, opts );
3032

31-
x = uniform( 10, 0.0, 3.0 );
32-
alpha = uniform( 10, EPS, 5.0 );
33-
beta = uniform( 10, EPS, 5.0 );
34-
35-
for ( i = 0; i < x.length; i++ ) {
36-
y = pdf( x[ i ], alpha[ i ], beta[ i ] );
37-
console.log( 'x: %d, α: %d, β: %d, f(x;α,β): %d', x[ i ].toFixed( 4 ), alpha[ i ].toFixed( 4 ), beta[ i ].toFixed( 4 ), y.toFixed( 4 ) );
38-
}
33+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, f(x;α,β): %0.4f', x, alpha, beta, pdf );

lib/node_modules/@stdlib/stats/base/dists/gamma/quantile/README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -132,22 +132,18 @@ y = myquantile( 0.4 );
132132
<!-- eslint no-undef: "error" -->
133133

134134
```javascript
135-
var randu = require( '@stdlib/random/base/randu' );
135+
var uniform = require( '@stdlib/random/array/uniform' );
136+
var logEachMap = require( '@stdlib/console/log-each-map' );
136137
var quantile = require( '@stdlib/stats/base/dists/gamma/quantile' );
137138

138-
var alpha;
139-
var beta;
140-
var p;
141-
var y;
142-
var i;
143-
144-
for ( i = 0; i < 20; i++ ) {
145-
p = randu();
146-
alpha = randu() * 5.0;
147-
beta = randu() * 5.0;
148-
y = quantile( p, alpha, beta );
149-
console.log( 'p: %d, α: %d, β: %d, Q(p;α,β): %d', p.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
150-
}
139+
var opts = {
140+
'dtype': 'float64'
141+
};
142+
var p = uniform( 20, 0.0, 1.0, opts );
143+
var alpha = uniform( 20, 0.0, 5.0, opts );
144+
var beta = uniform( 20, 0.0, 5.0, opts );
145+
146+
logEachMap( 'p: %0.4f, α: %0.4f, β: %0.4f, Q(p;α,β): %0.4f', p, alpha, beta, quantile );
151147
```
152148

153149
</section>

lib/node_modules/@stdlib/stats/base/dists/gamma/quantile/examples/index.js

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,15 @@
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 quantile = require( './../lib' );
2324

24-
var alpha;
25-
var beta;
26-
var p;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var p = uniform( 20, 0.0, 1.0, opts );
29+
var alpha = uniform( 20, 0.0, 5.0, opts );
30+
var beta = uniform( 20, 0.0, 5.0, opts );
2931

30-
for ( i = 0; i < 20; i++ ) {
31-
p = randu();
32-
alpha = randu() * 5.0;
33-
beta = randu() * 5.0;
34-
y = quantile( p, alpha, beta );
35-
console.log( 'p: %d, α: %d, β: %d, Q(p;α,β): %d', p.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
36-
}
32+
logEachMap( 'p: %0.4f, α: %0.4f, β: %0.4f, Q(p;α,β): %0.4f', p, alpha, beta, quantile );

lib/node_modules/@stdlib/stats/base/dists/gamma/skewness/README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -121,21 +121,18 @@ v = skewness( 1.0, -1.0 );
121121
<!-- eslint no-undef: "error" -->
122122

123123
```javascript
124-
var randu = require( '@stdlib/random/base/randu' );
124+
var uniform = require( '@stdlib/random/array/uniform' );
125+
var logEachMap = require( '@stdlib/console/log-each-map' );
125126
var EPS = require( '@stdlib/constants/float64/eps' );
126127
var skewness = require( '@stdlib/stats/base/dists/gamma/skewness' );
127128

128-
var alpha;
129-
var beta;
130-
var v;
131-
var i;
129+
var opts = {
130+
'dtype': 'float64'
131+
};
132+
var alpha = uniform( 10, EPS, 10.0, opts );
133+
var beta = uniform( 10, EPS, 10.0, opts );
132134

133-
for ( i = 0; i < 10; i++ ) {
134-
alpha = ( randu()*10.0 ) + EPS;
135-
beta = ( randu()*10.0 ) + EPS;
136-
v = skewness( alpha, beta );
137-
console.log( 'α: %d, β: %d, skew(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
138-
}
135+
logEachMap( 'α: %0.4f, β: %0.4f, skew(X;α,β): %0.4f', alpha, beta, skewness );
139136
```
140137

141138
</section>

lib/node_modules/@stdlib/stats/base/dists/gamma/skewness/examples/index.js

Lines changed: 8 additions & 11 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' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var EPS = require( '@stdlib/constants/float64/eps' );
2324
var skewness = require( './../lib' );
2425

25-
var alpha;
26-
var beta;
27-
var v;
28-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var alpha = uniform( 10, EPS, 10.0, opts );
30+
var beta = uniform( 10, EPS, 10.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
alpha = ( randu()*10.0 ) + EPS;
32-
beta = ( randu()*10.0 ) + EPS;
33-
v = skewness( alpha, beta );
34-
console.log( 'α: %d, β: %d, skew(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'α: %0.4f, β: %0.4f, skew(X;α,β): %0.4f', alpha, beta, skewness );

0 commit comments

Comments
 (0)