Skip to content

Commit bb378ff

Browse files
authored
docs: replace manual for loop in examples
PR-URL: #6472 Reviewed-by: Athan Reines <[email protected]>
1 parent eb0c8c9 commit bb378ff

File tree

12 files changed

+78
-104
lines changed

12 files changed

+78
-104
lines changed

lib/node_modules/@stdlib/math/base/special/log10/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -90,17 +90,16 @@ var v = log10( -4.0 );
9090
<!-- eslint no-undef: "error" -->
9191

9292
```javascript
93-
var randu = require( '@stdlib/random/base/randu' );
94-
var round = require( '@stdlib/math/base/special/round' );
93+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
94+
var logEachMap = require( '@stdlib/console/log-each-map' );
9595
var log10 = require( '@stdlib/math/base/special/log10' );
9696

97-
var x;
98-
var i;
97+
var opts = {
98+
'dtype': 'float64'
99+
};
100+
var x = discreteUniform( 100, 0, 100, opts );
99101

100-
for ( i = 0; i < 100; i++ ) {
101-
x = round( randu() * 100.0 );
102-
console.log( 'log10(%d) = %d', x, log10( x ) );
103-
}
102+
logEachMap( 'log10(%0.4f) = %0.4f', x, log10 );
104103
```
105104

106105
</section>

lib/node_modules/@stdlib/math/base/special/log10/examples/index.js

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,13 @@
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 logEachMap = require( '@stdlib/console/log-each-map' );
2323
var log10 = require( './../lib' );
2424

25-
var x;
26-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = discreteUniform( 100, 0, 100, opts );
2729

28-
for ( i = 0; i < 100; i++ ) {
29-
x = round( randu() * 100.0 );
30-
console.log( 'log10(%d) = %d', x, log10( x ) );
31-
}
30+
logEachMap( 'log10(%0.4f) = %0.4f', x, log10 );

lib/node_modules/@stdlib/math/base/special/log2/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -87,17 +87,16 @@ var v = log2( -4.0 );
8787
<!-- eslint no-undef: "error" -->
8888

8989
```javascript
90-
var randu = require( '@stdlib/random/base/randu' );
91-
var round = require( '@stdlib/math/base/special/round' );
90+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
91+
var logEachMap = require( '@stdlib/console/log-each-map' );
9292
var log2 = require( '@stdlib/math/base/special/log2' );
9393

94-
var x;
95-
var i;
94+
var opts = {
95+
'dtype': 'float64'
96+
};
97+
var x = discreteUniform( 100, 0, 100, opts );
9698

97-
for ( i = 0; i < 100; i++ ) {
98-
x = round( randu() * 100.0 );
99-
console.log( 'log2(%d) = %d', x, log2( x ) );
100-
}
99+
logEachMap( 'log2(%0.4f) = %0.4f', x, log2 );
101100
```
102101

103102
</section>

lib/node_modules/@stdlib/math/base/special/log2/examples/index.js

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,13 @@
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 logEachMap = require( '@stdlib/console/log-each-map' );
2323
var log2 = require( './../lib' );
2424

25-
var x;
26-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = discreteUniform( 100, 0, 100, opts );
2729

28-
for ( i = 0; i < 100; i++ ) {
29-
x = round( randu() * 100.0 );
30-
console.log( 'log2(%d) = %d', x, log2( x ) );
31-
}
30+
logEachMap( 'log2(%0.4f) = %0.4f', x, log2 );

lib/node_modules/@stdlib/math/base/special/logf/README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,20 +66,17 @@ v = logf( 2.0, -4.0 );
6666
<!-- eslint no-undef: "error" -->
6767

6868
```javascript
69-
var randu = require( '@stdlib/random/array/discrete-uniform' );
69+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
70+
var logEachMap = require( '@stdlib/console/log-each-map' );
7071
var logf = require( '@stdlib/math/base/special/logf' );
7172

7273
var opts = {
7374
'dtype': 'float32'
7475
};
76+
var x = discreteUniform( 100, 0, 100, opts );
77+
var b = discreteUniform( 100, 0, 5, opts );
7578

76-
var x = randu( 100, 0, 100, opts );
77-
var b = randu( 100, 0, 5, opts );
78-
79-
var i;
80-
for ( i = 0; i < 100; i++ ) {
81-
console.log( 'logf( %d, %d ) = %d', x[ i ], b[ i ], logf( x[ i ], b[ i ] ) );
82-
}
79+
logEachMap( 'logf( %0.4f, %0.4f ) = %0.4f', x, b, logf );
8380
```
8481

8582
</section>

lib/node_modules/@stdlib/math/base/special/logf/examples/index.js

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,14 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/array/discrete-uniform' );
21+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var logf = require( './../lib' );
2324

2425
var opts = {
2526
'dtype': 'float32'
2627
};
28+
var x = discreteUniform( 100, 0, 100, opts );
29+
var b = discreteUniform( 100, 0, 5, opts );
2730

28-
var x = randu( 100, 0, 100, opts );
29-
var b = randu( 100, 0, 5, opts );
30-
31-
var i;
32-
for ( i = 0; i < 100; i++ ) {
33-
console.log( 'logf( %d, %d ) = %d', x[ i ], b[ i ], logf( x[ i ], b[ i ] ) );
34-
}
31+
logEachMap( 'logf( %0.4f, %0.4f ) = %0.4f', x, b, logf );

lib/node_modules/@stdlib/math/base/special/logit/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,16 @@ v = logit( -0.2 );
8686
<!-- eslint no-undef: "error" -->
8787

8888
```javascript
89-
var randu = require( '@stdlib/random/base/randu' );
89+
var uniform = require( '@stdlib/random/array/uniform' );
90+
var logEachMap = require( '@stdlib/console/log-each-map' );
9091
var logit = require( '@stdlib/math/base/special/logit' );
9192

92-
var p;
93-
var i;
93+
var opts = {
94+
'dtype': 'float64'
95+
};
96+
var p = uniform( 100, 0.0, 1.0, opts );
9497

95-
for ( i = 0; i < 100; i++ ) {
96-
p = randu();
97-
console.log( 'logit(%d) = %d', p, logit( p ) );
98-
}
98+
logEachMap( 'logit(%0.4f) = %0.4f', p, logit );
9999
```
100100

101101
</section>

lib/node_modules/@stdlib/math/base/special/logit/examples/index.js

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

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

27-
for ( i = 0; i < 100; i++ ) {
28-
p = randu();
29-
console.log( 'logit(%d) = %d', p, logit( p ) );
30-
}
30+
logEachMap( 'logit(%0.4f) = %0.4f', p, logit );

lib/node_modules/@stdlib/math/base/special/maxabs/README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -83,20 +83,17 @@ v = maxabs( NaN, 3.14 );
8383
<!-- eslint no-undef: "error" -->
8484

8585
```javascript
86-
var randu = require( '@stdlib/random/base/randu' );
86+
var uniform = require( '@stdlib/random/array/uniform' );
87+
var logEachMap = require( '@stdlib/console/log-each-map' );
8788
var maxabs = require( '@stdlib/math/base/special/maxabs' );
8889

89-
var x;
90-
var y;
91-
var v;
92-
var i;
90+
var opts = {
91+
'dtype': 'float64'
92+
};
93+
var x = uniform( 100, -500.0, 500.0, opts );
94+
var y = uniform( 100, -500.0, 500.0, opts );
9395

94-
for ( i = 0; i < 100; i++ ) {
95-
x = ( randu()*1000.0 ) - 500.0;
96-
y = ( randu()*1000.0 ) - 500.0;
97-
v = maxabs( x, y );
98-
console.log( 'maxabs(%d,%d) = %d', x, y, v );
99-
}
96+
logEachMap( 'maxabs(%0.4f,%0.4f) = %0.4f', x, y, maxabs );
10097
```
10198

10299
</section>

lib/node_modules/@stdlib/math/base/special/maxabs/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 maxabs = require( './../lib' );
2324

24-
var x;
25-
var y;
26-
var v;
27-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = uniform( 100, -500.0, 500.0, opts );
29+
var y = uniform( 100, -500.0, 500.0, opts );
2830

29-
for ( i = 0; i < 100; i++ ) {
30-
x = ( randu()*1000.0 ) - 500.0;
31-
y = ( randu()*1000.0 ) - 500.0;
32-
v = maxabs( x, y );
33-
console.log( 'maxabs(%d,%d) = %d', x, y, v );
34-
}
31+
logEachMap( 'maxabs(%0.4f,%0.4f) = %0.4f', x, y, maxabs );

0 commit comments

Comments
 (0)