Skip to content

Commit 88af63a

Browse files
authored
docs: replace manual for loop in examples
PR-URL: #9444 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: Harsh <149176984+hrshya@users.noreply.github.com>
1 parent edccce1 commit 88af63a

File tree

28 files changed

+213
-285
lines changed

28 files changed

+213
-285
lines changed

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -122,20 +122,17 @@ y = myCDF( 0.5 );
122122
<!-- eslint no-undef: "error" -->
123123

124124
```javascript
125-
var randu = require( '@stdlib/random/base/randu' );
125+
var uniform = require( '@stdlib/random/array/uniform' );
126+
var logEachMap = require( '@stdlib/console/log-each-map' );
126127
var cdf = require( '@stdlib/stats/base/dists/rayleigh/cdf' );
127128

128-
var sigma;
129-
var x;
130-
var y;
131-
var i;
129+
var opts = {
130+
'dtype': 'float64'
131+
};
132+
var x = uniform( 10, 0.0, 10.0, opts );
133+
var sigma = uniform( 10, 0.0, 10.0, opts );
132134

133-
for ( i = 0; i < 10; i++ ) {
134-
x = randu() * 10.0;
135-
sigma = randu() * 10.0;
136-
y = cdf( x, sigma );
137-
console.log( 'x: %d, σ: %d, F(x;σ): %d', x.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
138-
}
135+
logEachMap( 'x: %0.4f, σ: %0.4f, F(x;σ): %0.4f', x, sigma, cdf );
139136
```
140137

141138
</section>

lib/node_modules/@stdlib/stats/base/dists/rayleigh/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 sigma;
25-
var x;
26-
var y;
27-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = uniform( 10, 0.0, 10.0, opts );
29+
var sigma = uniform( 10, 0.0, 10.0, opts );
2830

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

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

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,16 @@ var y = entropy( -1.0 );
9797
<!-- eslint no-undef: "error" -->
9898

9999
```javascript
100-
var randu = require( '@stdlib/random/base/randu' );
101-
var round = require( '@stdlib/math/base/special/round' );
100+
var uniform = require( '@stdlib/random/array/uniform' );
101+
var logEachMap = require( '@stdlib/console/log-each-map' );
102102
var entropy = require( '@stdlib/stats/base/dists/rayleigh/entropy' );
103103

104-
var sigma;
105-
var y;
106-
var i;
104+
var opts = {
105+
'dtype': 'float64'
106+
};
107+
var sigma = uniform( 10, 0.0, 20.0, opts );
107108

108-
for ( i = 0; i < 10; i++ ) {
109-
sigma = randu() * 20.0;
110-
y = entropy( sigma );
111-
console.log( 'σ: %d, h(X,v): %d', sigma.toFixed( 4 ), y.toFixed( 4 ) );
112-
}
109+
logEachMap( 'σ: %0.4f, h(X;σ): %0.4f', sigma, entropy );
113110
```
114111

115112
</section>

lib/node_modules/@stdlib/stats/base/dists/rayleigh/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 sigma;
25-
var i;
26-
var y;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var sigma = uniform( 10, 0.0, 20.0, opts );
2729

28-
for ( i = 0; i < 10; i++ ) {
29-
sigma = randu() * 20.0;
30-
y = entropy( sigma );
31-
console.log( 'σ: %d, h(X;σ): %d', sigma.toFixed( 4 ), y.toFixed( 4 ) );
32-
}
30+
logEachMap( 'σ: %0.4f, h(X;σ): %0.4f', sigma, entropy );

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

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,16 @@ var y = kurtosis( -1.0 );
9797
<!-- eslint no-undef: "error" -->
9898

9999
```javascript
100-
var randu = require( '@stdlib/random/base/randu' );
101-
var round = require( '@stdlib/math/base/special/round' );
100+
var uniform = require( '@stdlib/random/array/uniform' );
101+
var logEachMap = require( '@stdlib/console/log-each-map' );
102102
var kurtosis = require( '@stdlib/stats/base/dists/rayleigh/kurtosis' );
103103

104-
var sigma;
105-
var y;
106-
var i;
104+
var opts = {
105+
'dtype': 'float64'
106+
};
107+
var sigma = uniform( 10, 0.0, 20.0, opts );
107108

108-
for ( i = 0; i < 10; i++ ) {
109-
sigma = randu() * 20.0;
110-
y = kurtosis( sigma );
111-
console.log( 'σ: %d, Kurt(X,σ): %d', sigma.toFixed( 4 ), y.toFixed( 4 ) );
112-
}
109+
logEachMap( 'σ: %0.4f, Kurt(X;σ): %0.4f', sigma, kurtosis );
113110
```
114111

115112
</section>

lib/node_modules/@stdlib/stats/base/dists/rayleigh/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 sigma;
25-
var i;
26-
var y;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var sigma = uniform( 10, 0.0, 20.0, opts );
2729

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

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -132,20 +132,17 @@ y = mylogCDF( 0.5 );
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 logcdf = require( '@stdlib/stats/base/dists/rayleigh/logcdf' );
137138

138-
var sigma;
139-
var x;
140-
var y;
141-
var i;
139+
var opts = {
140+
'dtype': 'float64'
141+
};
142+
var x = uniform( 10, 0.0, 10.0, opts );
143+
var sigma = uniform( 10, 0.0, 10.0, opts );
142144

143-
for ( i = 0; i < 10; i++ ) {
144-
x = randu() * 10.0;
145-
sigma = randu() * 10.0;
146-
y = logcdf( x, sigma );
147-
console.log( 'x: %d, σ: %d, ln(F(x;σ)): %d', x.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
148-
}
145+
logEachMap( 'x: %0.4f, σ: %0.4f, ln(F(x;σ)): %0.4f', x, sigma, logcdf );
149146
```
150147

151148
</section>

lib/node_modules/@stdlib/stats/base/dists/rayleigh/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 sigma;
25-
var x;
26-
var y;
27-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = uniform( 10, 0.0, 10.0, opts );
29+
var sigma = uniform( 10, 0.0, 10.0, opts );
2830

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

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -133,20 +133,17 @@ 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/rayleigh/logpdf' );
138139

139-
var sigma;
140-
var x;
141-
var y;
142-
var i;
140+
var opts = {
141+
'dtype': 'float64'
142+
};
143+
var x = uniform( 10, 0.0, 10.0, opts );
144+
var sigma = uniform( 10, 0.0, 10.0, opts );
143145

144-
for ( i = 0; i < 10; i++ ) {
145-
x = randu() * 10.0;
146-
sigma = randu() * 10.0;
147-
y = logpdf( x, sigma );
148-
console.log( 'x: %d, σ: %d, ln(f(x;σ)): %d', x.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
149-
}
146+
logEachMap( 'x: %0.4f, σ: %0.4f, ln(f(x;σ)): %0.4f', x, sigma, logpdf );
150147
```
151148

152149
</section>

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

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

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

0 commit comments

Comments
 (0)