Skip to content

Commit 4cc9e61

Browse files
anandkaranubcanandkaranubc
committed
docs: update examples to avoid explicit for loops
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 736e165 commit 4cc9e61

File tree

24 files changed

+182
-246
lines changed

24 files changed

+182
-246
lines changed

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

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -109,20 +109,17 @@ y = mycdf( 2.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/bernoulli/cdf' );
114115

115-
var p;
116-
var x;
117-
var y;
118-
var i;
119-
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-
}
116+
var opts = {
117+
'dtype': 'float64'
118+
};
119+
var x = uniform( 25, 0.0, 5.0, opts );
120+
var p = uniform( x.length, 0.0, 1.0, opts );
121+
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/bernoulli/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 x = uniform( 25, 0.0, 5.0, opts );
29+
var p = uniform( x.length, 0.0, 1.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/bernoulli/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/bernoulli/entropy' );
109109

110-
var v;
111-
var i;
112-
var p;
110+
var opts = {
111+
'dtype': 'float64'
112+
};
113+
var p = uniform( 25, 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/bernoulli/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( 25, 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/bernoulli/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/bernoulli/kurtosis' );
109109

110-
var v;
111-
var i;
112-
var p;
110+
var opts = {
111+
'dtype': 'float64'
112+
};
113+
var p = uniform( 25, 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/bernoulli/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( 25, 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/bernoulli/mean/README.md‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -103,19 +103,16 @@ v = mean( -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 mean = require( '@stdlib/stats/base/dists/bernoulli/mean' );
109109

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

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

121118
</section>
@@ -177,7 +174,7 @@ double stdlib_base_dists_bernoulli_mean( const double p );
177174
178175
<!-- /.usage -->
179176
180-
<!-- C API usage notes. Make sure to keep an empty line after the `section`
177+
<!-- C API usage notes. Make sure to keep an empty line after the `section`
181178
element and another before the `/section` close. -->
182179
183180
<section class="notes">

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

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

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

‎lib/node_modules/@stdlib/stats/base/dists/bernoulli/median/README.md‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -103,19 +103,16 @@ v = median( -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 median = require( '@stdlib/stats/base/dists/bernoulli/median' );
109109

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

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

121118
</section>

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

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

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

0 commit comments

Comments
 (0)