Skip to content

Commit ae963e1

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

File tree

6 files changed

+46
-46
lines changed

6 files changed

+46
-46
lines changed

Diff for: lib/node_modules/@stdlib/math/base/special/vercos/README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,17 @@ v = vercos( -3.141592653589793/6.0 );
7777
<!-- eslint no-undef: "error" -->
7878

7979
```javascript
80-
var linspace = require( '@stdlib/array/base/linspace' );
80+
var uniform = require( '@stdlib/random/array/uniform' );
81+
var logEachMap = require( '@stdlib/console/log-each-map' );
8182
var TWO_PI = require( '@stdlib/constants/float64/two-pi' );
8283
var vercos = require( '@stdlib/math/base/special/vercos' );
8384

84-
var x = linspace( 0.0, TWO_PI, 100 );
85+
var opts = {
86+
'dtype': 'float64'
87+
};
88+
var x = uniform( 100, 0.0, TWO_PI, opts );
8589

86-
var i;
87-
for ( i = 0; i < x.length; i++ ) {
88-
console.log( vercos( x[ i ] ) );
89-
}
90+
logEachMap( 'vercos(%0.4f) = %0.4f', x, vercos );
9091
```
9192

9293
</section>

Diff for: lib/node_modules/@stdlib/math/base/special/vercos/examples/index.js

+7-6
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@
1818

1919
'use strict';
2020

21-
var linspace = require( '@stdlib/array/base/linspace' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var TWO_PI = require( '@stdlib/constants/float64/two-pi' );
2324
var vercos = require( './../lib' );
2425

25-
var x = linspace( 0.0, TWO_PI, 100 );
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = uniform( 100, 0.0, TWO_PI, opts );
2630

27-
var i;
28-
for ( i = 0; i < x.length; i++ ) {
29-
console.log( 'vercos(%d) = %d', x[ i ], vercos( x[ i ] ) );
30-
}
31+
logEachMap( 'vercos(%0.4f) = %0.4f', x, vercos );

Diff for: lib/node_modules/@stdlib/math/base/special/versin/README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,17 @@ v = versin( -3.141592653589793/6.0 );
7777
<!-- eslint no-undef: "error" -->
7878

7979
```javascript
80-
var linspace = require( '@stdlib/array/base/linspace' );
80+
var uniform = require( '@stdlib/random/array/uniform' );
81+
var logEachMap = require( '@stdlib/console/log-each-map' );
8182
var TWO_PI = require( '@stdlib/constants/float64/two-pi' );
8283
var versin = require( '@stdlib/math/base/special/versin' );
8384

84-
var x = linspace( 0.0, TWO_PI, 100 );
85+
var opts = {
86+
'dtype': 'float64'
87+
};
88+
var x = uniform( 100, 0.0, TWO_PI, opts );
8589

86-
var i;
87-
for ( i = 0; i < x.length; i++ ) {
88-
console.log( versin( x[ i ] ) );
89-
}
90+
logEachMap( 'versin(%0.4f) = %0.4f', x, versin );
9091
```
9192

9293
</section>

Diff for: lib/node_modules/@stdlib/math/base/special/versin/examples/index.js

+7-6
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@
1818

1919
'use strict';
2020

21-
var linspace = require( '@stdlib/array/base/linspace' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var TWO_PI = require( '@stdlib/constants/float64/two-pi' );
2324
var versin = require( './../lib' );
2425

25-
var x = linspace( 0.0, TWO_PI, 100 );
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = uniform( 100, 0.0, TWO_PI, opts );
2630

27-
var i;
28-
for ( i = 0; i < x.length; i++ ) {
29-
console.log( 'versin(%d) = %d', x[ i ], versin( x[ i ] ) );
30-
}
31+
logEachMap( 'versin(%0.4f) = %0.4f', x, versin );

Diff for: lib/node_modules/@stdlib/math/base/special/wrap/README.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -106,20 +106,18 @@ var v = wrap( 3.14, 3.0, 3.0 );
106106
<!-- eslint no-undef: "error" -->
107107

108108
```javascript
109-
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
109+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
110+
var logEachMap = require( '@stdlib/console/log-each-map' );
110111
var wrap = require( '@stdlib/math/base/special/wrap' );
111112

112-
var min;
113-
var max;
114-
var v;
115-
var i;
113+
var opts = {
114+
'dtype': 'float64'
115+
};
116+
var min = discreteUniform( 100, 0, 10, opts );
117+
var max = discreteUniform( 100, 5, 15, opts );
118+
var v = discreteUniform( 100, -20, 20, opts );
116119

117-
for ( i = 0; i < 100; i++ ) {
118-
min = discreteUniform( 0.0, 10.0 );
119-
max = discreteUniform( 5.0, 15.0 );
120-
v = discreteUniform( -20.0, 20.0 );
121-
console.log( 'wrap(%d,%d,%d) => %d', v, min, max, wrap( v, min, max ) );
122-
}
120+
logEachMap( 'wrap(%d,%d,%d) => %0.4f', v, min, max, wrap );
123121
```
124122

125123
</section>

Diff for: lib/node_modules/@stdlib/math/base/special/wrap/examples/index.js

+9-11
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,15 @@
1818

1919
'use strict';
2020

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

24-
var min;
25-
var max;
26-
var v;
27-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var min = discreteUniform( 100, 0, 10, opts );
29+
var max = discreteUniform( 100, 5, 15, opts );
30+
var v = discreteUniform( 100, -20, 20, opts );
2831

29-
for ( i = 0; i < 100; i++ ) {
30-
min = discreteUniform( 0.0, 10.0 );
31-
max = discreteUniform( 5.0, 15.0 );
32-
v = discreteUniform( -20.0, 20.0 );
33-
console.log( 'wrap(%d,%d,%d) => %d', v, min, max, wrap( v, min, max ) );
34-
}
32+
logEachMap( 'wrap(%d,%d,%d) => %0.4f', v, min, max, wrap );

0 commit comments

Comments
 (0)