Skip to content

Commit 76457d4

Browse files
hrshyahrshya
committed
docs: replace manual for loop in examples
1 parent f0df313 commit 76457d4

File tree

12 files changed

+84
-104
lines changed

12 files changed

+84
-104
lines changed

‎lib/node_modules/@stdlib/math/base/special/roundsd/README.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,18 +69,16 @@ var v = roundsd( 0.0313, 2, 2 );
6969
<!-- eslint no-undef: "error" -->
7070

7171
```javascript
72-
var randu = require( '@stdlib/random/base/randu' );
72+
var uniform = require( '@stdlib/random/array/uniform' );
73+
var logEachMap = require( '@stdlib/console/log-each-map' );
7374
var roundsd = require( '@stdlib/math/base/special/roundsd' );
7475

75-
var x;
76-
var y;
77-
var i;
76+
var opts = {
77+
'dtype': 'float64'
78+
};
79+
var x = uniform( 100, -5000.0, 5000.0, opts );
7880

79-
for ( i = 0; i < 100; i++ ) {
80-
x = (randu()*10000.0) - 5000.0;
81-
y = roundsd( x, 5 );
82-
console.log( 'x: %d. Rounded: %d.', x, y );
83-
}
81+
logEachMap( 'x: %0.4f. y: %d. Rounded: %0.4f.', x, 5, roundsd );
8482
```
8583

8684
</section>

‎lib/node_modules/@stdlib/math/base/special/roundsd/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 roundsd = 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 = roundsd( x, 5 );
31-
console.log( 'x: %d. Rounded: %d.', x, y );
32-
}
30+
logEachMap( 'x: %0.4f. y: %d. Rounded: %0.4f.', x, 5, roundsd );

‎lib/node_modules/@stdlib/math/base/special/rsqrt/README.md‎

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

9595
```javascript
96-
var randu = require( '@stdlib/random/base/randu' );
97-
var round = require( '@stdlib/math/base/special/round' );
96+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
97+
var logEachMap = require( '@stdlib/console/log-each-map' );
9898
var rsqrt = require( '@stdlib/math/base/special/rsqrt' );
9999

100-
var x;
101-
var i;
100+
var opts = {
101+
'dtype': 'float64'
102+
};
103+
var x = discreteUniform( 100, 0, 100, opts );
102104

103-
for ( i = 0; i < 100; i++ ) {
104-
x = round( randu() * 100.0 );
105-
console.log( 'rsqrt(%d) = %d', x, rsqrt( x ) );
106-
}
105+
logEachMap( 'rsqrt(%d) = %0.4f', x, rsqrt );
107106
```
108107

109108
</section>

‎lib/node_modules/@stdlib/math/base/special/rsqrt/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 rsqrt = 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( 'rsqrt(%d) = %d', x, rsqrt( x ) );
31-
}
30+
logEachMap( 'rsqrt(%d) = %0.4f', x, rsqrt );

‎lib/node_modules/@stdlib/math/base/special/rsqrtf/README.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -90,17 +90,16 @@ var v = rsqrtf( -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 rsqrtf = require( '@stdlib/math/base/special/rsqrtf' );
9696

97-
var x;
98-
var i;
97+
var opts = {
98+
'dtype': 'float32'
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( 'rsqrt(%d) = %d', x, rsqrtf( x ) );
103-
}
102+
logEachMap( 'rsqrt(%d) = %0.4f', x, rsqrtf );
104103
```
105104

106105
</section>

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

25-
var x;
26-
var i;
25+
var opts = {
26+
'dtype': 'float32'
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( 'rsqrt(%d) = %d', x, rsqrtf( x ) );
31-
}
30+
logEachMap( 'rsqrt(%d) = %0.4f', x, rsqrtf );

‎lib/node_modules/@stdlib/math/base/special/signum/README.md‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -103,19 +103,16 @@ Table of results:
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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
107+
var logEachMap = require( '@stdlib/console/log-each-map' );
108108
var signum = require( '@stdlib/math/base/special/signum' );
109109

110-
var sign;
111-
var x;
112-
var i;
110+
var opts = {
111+
'dtype': 'float64'
112+
};
113+
var x = discreteUniform( 100, -50, 50, opts );
113114

114-
for ( i = 0; i < 100; i++ ) {
115-
x = round( randu()*100.0 ) - 50.0;
116-
sign = signum( x );
117-
console.log( 'signum(%d) = %d', x, sign );
118-
}
115+
logEachMap( 'signum(%d) = %0.4f', x, signum );
119116
```
120117

121118
</section>

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

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

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

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

‎lib/node_modules/@stdlib/math/base/special/signumf/README.md‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -103,19 +103,16 @@ Table of results:
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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
107+
var logEachMap = require( '@stdlib/console/log-each-map' );
108108
var signumf = require( '@stdlib/math/base/special/signumf' );
109109

110-
var sign;
111-
var x;
112-
var i;
110+
var opts = {
111+
'dtype': 'float32'
112+
};
113+
var x = discreteUniform( 100, -50, 50, opts );
113114

114-
for ( i = 0; i < 100; i++ ) {
115-
x = round( randu()*100.0 ) - 50.0;
116-
sign = signumf( x );
117-
console.log( 'signum(%d) = %d', x, sign );
118-
}
115+
logEachMap( 'signum(%d) = %0.4f', x, signumf );
119116
```
120117

121118
</section>

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

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

25-
var sign;
26-
var x;
27-
var i;
25+
var opts = {
26+
'dtype': 'float32'
27+
};
28+
var x = discreteUniform( 100, -50, 50, opts );
2829

29-
for ( i = 0; i < 100; i++ ) {
30-
x = round( randu()*100.0 ) - 50.0;
31-
sign = signumf( x );
32-
console.log( 'signum(%d) = %d', x, sign );
33-
}
30+
logEachMap( 'signum(%d) = %0.4f', x, signumf );

0 commit comments

Comments
 (0)