Skip to content

Commit fd5919c

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

File tree

12 files changed

+105
-147
lines changed

12 files changed

+105
-147
lines changed

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -226,22 +226,18 @@ int main( void ) {
226226
<!-- eslint no-undef: "error" -->
227227

228228
```javascript
229-
var randu = require( '@stdlib/random/base/randu' );
229+
var uniform = require( '@stdlib/random/array/uniform' );
230+
var logEachMap = require( '@stdlib/console/log-each-map' );
230231
var cdf = require( '@stdlib/stats/base/dists/gamma/cdf' );
231232

232-
var alpha;
233-
var beta;
234-
var x;
235-
var y;
236-
var i;
237-
238-
for ( i = 0; i < 10; i++ ) {
239-
x = randu() * 3.0;
240-
alpha = randu() * 5.0;
241-
beta = randu() * 5.0;
242-
y = cdf( x, alpha, beta );
243-
console.log( 'x: %d, α: %d, β: %d, F(x;α,β): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
244-
}
233+
var opts = {
234+
'dtype': 'float64'
235+
};
236+
var x = uniform( 10, 0.0, 3.0, opts );
237+
var alpha = uniform( 10, 0.0, 5.0, opts );
238+
var beta = uniform( 10, 0.0, 5.0, opts );
239+
240+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, F(x;α,β): %0.4f', x, alpha, beta, cdf );
245241
```
246242

247243
</section>

lib/node_modules/@stdlib/stats/base/dists/gamma/cdf/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 cdf = require( './../lib' );
2324

24-
var alpha;
25-
var beta;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = 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-
x = randu() * 3.0;
32-
alpha = randu() * 5.0;
33-
beta = randu() * 5.0;
34-
y = cdf( x, alpha, beta );
35-
console.log( 'x: %d, α: %d, β: %d, F(x;α,β): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
36-
}
32+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, F(x;α,β): %0.4f', x, alpha, beta, cdf );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,18 @@ v = entropy( 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 entropy = require( '@stdlib/stats/base/dists/gamma/entropy' );
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 = entropy( alpha, beta );
139-
console.log( 'α: %d, β: %d, h(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
140-
}
137+
logEachMap( 'α: %0.4f, β: %0.4f, h(X;α,β): %0.4f', alpha, beta, entropy );
141138
```
142139

143140
</section>

lib/node_modules/@stdlib/stats/base/dists/gamma/entropy/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 entropy = 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 = entropy( alpha, beta );
34-
console.log( 'α: %d, β: %d, h(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'α: %0.4f, β: %0.4f, h(X;α,β): %0.4f', alpha, beta, entropy );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -121,21 +121,18 @@ v = kurtosis( 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 kurtosis = require( '@stdlib/stats/base/dists/gamma/kurtosis' );
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 = kurtosis( alpha, beta );
137-
console.log( 'α: %d, β: %d, Kurt(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
138-
}
135+
logEachMap( 'α: %0.4f, β: %0.4f, Kurt(X;α,β): %0.4f', alpha, beta, kurtosis );
139136
```
140137

141138
</section>

lib/node_modules/@stdlib/stats/base/dists/gamma/kurtosis/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 kurtosis = 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 = kurtosis( alpha, beta );
34-
console.log( 'α: %d, β: %d, Kurt(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'α: %0.4f, β: %0.4f, Kurt(X;α,β): %0.4f', alpha, beta, kurtosis );

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -229,22 +229,18 @@ int main( void ) {
229229
<!-- eslint no-undef: "error" -->
230230

231231
```javascript
232-
var randu = require( '@stdlib/random/base/randu' );
232+
var uniform = require( '@stdlib/random/array/uniform' );
233+
var logEachMap = require( '@stdlib/console/log-each-map' );
233234
var logcdf = require( '@stdlib/stats/base/dists/gamma/logcdf' );
234235

235-
var alpha;
236-
var beta;
237-
var x;
238-
var y;
239-
var i;
240-
241-
for ( i = 0; i < 10; i++ ) {
242-
x = randu() * 3.0;
243-
alpha = randu() * 5.0;
244-
beta = randu() * 5.0;
245-
y = logcdf( x, alpha, beta );
246-
console.log( 'x: %d, α: %d, β: %d, ln(F(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
247-
}
236+
var opts = {
237+
'dtype': 'float64'
238+
};
239+
var x = uniform( 10, 0.0, 3.0, opts );
240+
var alpha = uniform( 10, 0.0, 5.0, opts );
241+
var beta = uniform( 10, 0.0, 5.0, opts );
242+
243+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(f(x;α,β)): %0.4f', x, alpha, beta, logcdf );
248244
```
249245

250246
</section>

lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/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 logcdf = require( './../lib' );
2324

24-
var alpha;
25-
var beta;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = 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-
x = randu() * 3.0;
32-
alpha = randu() * 5.0;
33-
beta = randu() * 5.0;
34-
y = logcdf( x, alpha, beta );
35-
console.log( 'x: %d, α: %d, β: %d, ln(f(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
36-
}
32+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(f(x;α,β)): %0.4f', x, alpha, beta, logcdf );

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

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

135135
```javascript
136-
var randu = require( '@stdlib/random/base/randu' );
136+
var uniform = require( '@stdlib/random/array/uniform' );
137+
var logEachMap = require( '@stdlib/console/log-each-map' );
137138
var logpdf = require( '@stdlib/stats/base/dists/gamma/logpdf' );
138139

139-
var alpha;
140-
var beta;
141-
var x;
142-
var y;
143-
var i;
144-
145-
for ( i = 0; i < 10; i++ ) {
146-
x = randu() * 3.0;
147-
alpha = randu() * 5.0;
148-
beta = randu() * 5.0;
149-
y = logpdf( x, alpha, beta );
150-
console.log( 'x: %d, α: %d, β: %d, ln(f(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
151-
}
140+
var opts = {
141+
'dtype': 'float64'
142+
};
143+
var x = uniform( 10, 0.0, 3.0, opts );
144+
var alpha = uniform( 10, 0.0, 5.0, opts );
145+
var beta = uniform( 10, 0.0, 5.0, opts );
146+
147+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(f(x;α,β)): %0.4f', x, alpha, beta, logpdf );
152148
```
153149

154150
</section>

lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/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 logpdf = require( './../lib' );
2324

24-
var alpha;
25-
var beta;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = 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-
x = randu() * 3.0;
32-
alpha = randu() * 5.0;
33-
beta = randu() * 5.0;
34-
y = logpdf( x, alpha, beta );
35-
console.log( 'x: %d, α: %d, β: %d, ln(f(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
36-
}
32+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(f(x;α,β)): %0.4f', x, alpha, beta, logpdf );

0 commit comments

Comments
 (0)