Skip to content

Commit dfddd73

Browse files
hrshyakgryte
andauthored
docs: replace manual for loop in examples
PR-URL: #6608 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Athan Reines <[email protected]>
1 parent dd5765d commit dfddd73

File tree

10 files changed

+78
-98
lines changed

10 files changed

+78
-98
lines changed

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

+7-9
Original file line numberDiff line numberDiff line change
@@ -98,18 +98,16 @@ v = ceil10( NaN );
9898
<!-- eslint no-undef: "error" -->
9999

100100
```javascript
101-
var randu = require( '@stdlib/random/base/randu' );
101+
var uniform = require( '@stdlib/random/array/uniform' );
102+
var logEachMap = require( '@stdlib/console/log-each-map' );
102103
var ceil10 = require( '@stdlib/math/base/special/ceil10' );
103104
104-
var x;
105-
var v;
106-
var i;
105+
var opts = {
106+
'dtype': 'float64'
107+
};
108+
var x = uniform( 100, -50.0, 50.0, opts );
107109
108-
for ( i = 0; i < 100; i++ ) {
109-
x = (randu()*100.0) - 50.0;
110-
v = ceil10( x );
111-
console.log( 'Value: %d. Rounded: %d.', x, v );
112-
}
110+
logEachMap( 'x: %0.4f. Rounded: %0.4f.', x, ceil10 );
113111
```
114112

115113
</section>

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

+7-9
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 ceil10 = require( './../lib' );
2324

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

28-
for ( i = 0; i < 100; i++ ) {
29-
x = (randu()*100.0) - 50.0;
30-
v = ceil10( x );
31-
console.log( 'x: %d. Rounded: %d.', x, v );
32-
}
30+
logEachMap( 'x: %0.4f. Rounded: %0.4f.', x, ceil10 );

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

+7-9
Original file line numberDiff line numberDiff line change
@@ -83,18 +83,16 @@ v = ceil2( NaN );
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 ceil2 = require( '@stdlib/math/base/special/ceil2' );
8889

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

93-
for ( i = 0; i < 100; i++ ) {
94-
x = (randu()*100.0) - 50.0;
95-
v = ceil2( x );
96-
console.log( 'Value: %d. Rounded: %d.', x, v );
97-
}
95+
logEachMap( 'x: %0.4f. Rounded: %0.4f.', x, ceil2 );
9896
```
9997

10098
</section>

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

+7-9
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 ceil2 = require( './../lib' );
2324

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

28-
for ( i = 0; i < 100; i++ ) {
29-
x = (randu()*100.0) - 50.0;
30-
v = ceil2( x );
31-
console.log( 'x: %d. Rounded: %d.', x, v );
32-
}
30+
logEachMap( 'x: %0.4f. Rounded: %0.4f.', x, ceil2 );

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

+7-9
Original file line numberDiff line numberDiff line change
@@ -65,18 +65,16 @@ v = ceilsd( 0.0313, 2, 2 );
6565
<!-- eslint no-undef: "error" -->
6666

6767
```javascript
68-
var randu = require( '@stdlib/random/base/randu' );
68+
var uniform = require( '@stdlib/random/array/uniform' );
69+
var logEachMap = require( '@stdlib/console/log-each-map' );
6970
var ceilsd = require( '@stdlib/math/base/special/ceilsd' );
7071

71-
var x;
72-
var y;
73-
var i;
72+
var opts = {
73+
'dtype': 'float64'
74+
};
75+
var x = uniform( 100, -5000.0, 5000.0, opts );
7476

75-
for ( i = 0; i < 100; i++ ) {
76-
x = (randu()*10000.0) - 5000.0;
77-
y = ceilsd( x, 5, 10 );
78-
console.log( 'x: %d. Rounded: %d.', x, y );
79-
}
77+
logEachMap( 'x: %0.4f. y: %d. z: %d. Rounded: %0.4f.', x, 5, 10, ceilsd );
8078
```
8179

8280
</section>

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

+7-9
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 ceilsd = require( './../lib' );
2324

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

28-
for ( i = 0; i < 100; i++ ) {
29-
x = (randu()*10000.0) - 5000.0;
30-
y = ceilsd( x, 5, 10 );
31-
console.log( 'x: %d. Rounded: %d.', x, y );
32-
}
30+
logEachMap( 'x: %0.4f. y: %d. z: %d. Rounded: %0.4f.', x, 5, 10, ceilsd );

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

+9-11
Original file line numberDiff line numberDiff line change
@@ -95,20 +95,18 @@ v = clamp( 3.14, 0.0, NaN );
9595
<!-- eslint no-undef: "error" -->
9696

9797
```javascript
98-
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
98+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
99+
var logEachMap = require( '@stdlib/console/log-each-map' );
99100
var clamp = require( '@stdlib/math/base/special/clamp' );
100101

101-
var min;
102-
var max;
103-
var v;
104-
var i;
102+
var opts = {
103+
'dtype': 'float64'
104+
};
105+
var min = discreteUniform( 100, 0, 10, opts );
106+
var max = discreteUniform( 100, 5, 15, opts );
107+
var v = discreteUniform( 100, -20, 20, opts );
105108

106-
for ( i = 0; i < 100; i++ ) {
107-
min = discreteUniform( 0.0, 10.0 );
108-
max = discreteUniform( 5.0, 15.0 );
109-
v = discreteUniform( -20.0, 20.0 );
110-
console.log( 'clamp(%d,%d,%d) => %d', v, min, max, clamp( v, min, max ) );
111-
}
109+
logEachMap( 'clamp(%d,%d,%d) => %d', v, min, max, clamp );
112110
```
113111

114112
</section>

Diff for: lib/node_modules/@stdlib/math/base/special/clamp/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 clamp = 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( 'clamp(%d,%d,%d) => %d', v, min, max, clamp( v, min, max ) );
34-
}
32+
logEachMap( 'clamp(%d,%d,%d) => %d', v, min, max, clamp );

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

+9-11
Original file line numberDiff line numberDiff line change
@@ -95,20 +95,18 @@ v = clampf( 3.14, 0.0, NaN );
9595
<!-- eslint no-undef: "error" -->
9696

9797
```javascript
98-
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
98+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
99+
var logEachMap = require( '@stdlib/console/log-each-map' );
99100
var clampf = require( '@stdlib/math/base/special/clampf' );
100101

101-
var min;
102-
var max;
103-
var v;
104-
var i;
102+
var opts = {
103+
'dtype': 'float32'
104+
};
105+
var min = discreteUniform( 100, 0, 10, opts );
106+
var max = discreteUniform( 100, 5, 15, opts );
107+
var v = discreteUniform( 100, -20, 20, opts );
105108

106-
for ( i = 0; i < 100; i++ ) {
107-
min = discreteUniform( 0.0, 10.0 );
108-
max = discreteUniform( 5.0, 15.0 );
109-
v = discreteUniform( -20.0, 20.0 );
110-
console.log( 'clampf(%d,%d,%d) => %d', v, min, max, clampf( v, min, max ) );
111-
}
109+
logEachMap( 'clampf(%d,%d,%d) => %d', v, min, max, clampf );
112110
```
113111

114112
</section>

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

24-
var min;
25-
var max;
26-
var v;
27-
var i;
25+
var opts = {
26+
'dtype': 'float32'
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( 'clampf(%d,%d,%d) => %d', v, min, max, clampf( v, min, max ) );
34-
}
32+
logEachMap( 'clampf(%d,%d,%d) => %d', v, min, max, clampf );

0 commit comments

Comments
 (0)