Skip to content

Commit 544385d

Browse files
hrshyahrshya
authored
docs: replace manual for loop in examples
PR-URL: #6490 Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: Harsh <[email protected]>
1 parent b480ff0 commit 544385d

File tree

12 files changed

+96
-120
lines changed

12 files changed

+96
-120
lines changed

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

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ v = polygamma( 2, -1.0 );
7474
If `x` on the other hand is a negative even `integer`, the function returns `NaN`.
7575

7676
```javascript
77-
v = polygamma( 2, -4.0 );
77+
var v = polygamma( 2, -4.0 );
7878
// returns NaN
7979

8080
v = polygamma( 2, -2.0 );
@@ -105,21 +105,18 @@ v = polygamma( NaN, NaN );
105105
<!-- eslint no-undef: "error" -->
106106

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

112-
var n;
113-
var x;
114-
var v;
115-
var i;
116-
117-
for ( i = 0; i < 100; i++ ) {
118-
x = (randu()*100.0) - 50.0;
119-
n = round( randu()*50.0 );
120-
v = polygamma( x, n );
121-
console.log( 'x: %d, ψ^(%d)(x): %d', x, n, v );
122-
}
113+
var opts = {
114+
'dtype': 'float64'
115+
};
116+
var x = uniform( 100, -50.0, 50.0, opts );
117+
var n = discreteUniform( 100, 0, 50, opts );
118+
119+
logEachMap( 'x: %0.4f, ψ^(%d)(x): %0.4f', x, n, polygamma );
123120
```
124121

125122
</section>

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

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,15 @@
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 uniform = require( '@stdlib/random/array/uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var polygamma = require( './../lib' );
2425

25-
var n;
26-
var x;
27-
var v;
28-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = uniform( 100, -50.0, 50.0, opts );
30+
var n = discreteUniform( 100, 0, 50, opts );
2931

30-
for ( i = 0; i < 100; i++ ) {
31-
x = (randu()*100.0) - 50.0;
32-
n = round( randu()*50.0 );
33-
v = polygamma( n, x );
34-
console.log( 'x: %d, ψ^(%d)(x): %d', x, n, v );
35-
}
32+
logEachMap( 'x: %0.4f, ψ^(%d)(x): %0.4f', x, n, polygamma );

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

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -94,19 +94,17 @@ v = pow( NaN, NaN );
9494
<!-- eslint no-undef: "error" -->
9595

9696
```javascript
97-
var randu = require( '@stdlib/random/base/randu' );
98-
var round = require( '@stdlib/math/base/special/round' );
97+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
98+
var logEachMap = require( '@stdlib/console/log-each-map' );
9999
var pow = require( '@stdlib/math/base/special/pow' );
100100

101-
var b;
102-
var x;
103-
var i;
101+
var opts = {
102+
'dtype': 'float64'
103+
};
104+
var b = discreteUniform( 100, 0, 10, opts );
105+
var x = discreteUniform( 100, -5, 5, opts );
104106

105-
for ( i = 0; i < 100; i++ ) {
106-
b = round( randu()*10.0 );
107-
x = round( randu()*10.0 ) - 5.0;
108-
console.log( '%d^%d = %d', b, x, pow( b, x ) );
109-
}
107+
logEachMap( '%d^%d = %0.4f', b, x, pow );
110108
```
111109

112110
</section>

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

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

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

29-
for ( i = 0; i < 100; i++ ) {
30-
b = round( randu()*10.0 );
31-
x = round( randu()*10.0 ) - 5.0;
32-
console.log( '%d^%d = %d', b, x, pow( b, x ) );
33-
}
31+
logEachMap( '%d^%d = %0.4f', b, x, pow );

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -92,21 +92,17 @@ y = powm1( 5.0, NaN );
9292
<!-- eslint no-undef: "error" -->
9393

9494
```javascript
95-
var randu = require( '@stdlib/random/base/randu' );
96-
var round = require( '@stdlib/math/base/special/round' );
95+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
96+
var logEachMap = require( '@stdlib/console/log-each-map' );
9797
var powm1 = require( '@stdlib/math/base/special/powm1' );
9898

99-
var b;
100-
var x;
101-
var y;
102-
var i;
99+
var opts = {
100+
'dtype': 'float64'
101+
};
102+
var b = discreteUniform( 100, 0, 10, opts );
103+
var x = discreteUniform( 100, -5, 5, opts );
103104

104-
for ( i = 0; i < 100; i++ ) {
105-
b = round( randu()*10.0 );
106-
x = round( randu()*10.0 ) - 5.0;
107-
y = powm1( b, x );
108-
console.log( '%d^%d - 1 = %d', b, x, y );
109-
}
105+
logEachMap( '%d^%d - 1 = %0.4f', b, x, powm1 );
110106
```
111107

112108
</section>

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

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

25-
var b;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var b = discreteUniform( 100, 0, 10, opts );
29+
var x = discreteUniform( 100, -5, 5, opts );
2930

30-
for ( i = 0; i < 100; i++ ) {
31-
b = round( randu()*10.0 );
32-
x = round( randu()*10.0 ) - 5.0;
33-
y = powm1( b, x );
34-
console.log( '%d^%d - 1 = %d', b, x, y );
35-
}
31+
logEachMap( '%d^%d - 1 = %0.4f', b, x, powm1 );

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -71,19 +71,17 @@ d = rad2deg( NaN );
7171
<!-- eslint no-undef: "error" -->
7272

7373
```javascript
74-
var randu = require( '@stdlib/random/base/randu' );
74+
var uniform = require( '@stdlib/random/array/uniform' );
75+
var logEachMap = require( '@stdlib/console/log-each-map' );
7576
var TWO_PI = require( '@stdlib/constants/float64/two-pi' );
7677
var rad2deg = require( '@stdlib/math/base/special/rad2deg' );
7778
78-
var r;
79-
var d;
80-
var i;
79+
var opts = {
80+
'dtype': 'float64'
81+
};
82+
var r = uniform( 100, 0.0, TWO_PI, opts );
8183
82-
for ( i = 0; i < 100; i++ ) {
83-
r = randu() * TWO_PI;
84-
d = rad2deg( r );
85-
console.log( 'radians: %d => degrees: %d', r, d );
86-
}
84+
logEachMap( 'radians: %0.4f => degrees: %0.4f', r, rad2deg );
8785
```
8886

8987
</section>

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +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 TWO_PI = require( '@stdlib/constants/float64/two-pi' );
2324
var rad2deg = require( './../lib' );
2425

25-
var r;
26-
var d;
27-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var r = uniform( 100, 0.0, TWO_PI, opts );
2830

29-
for ( i = 0; i < 100; i++ ) {
30-
r = randu() * TWO_PI;
31-
d = rad2deg( r );
32-
console.log( 'radians: %d => degrees: %d', r, d );
33-
}
31+
logEachMap( 'radians: %0.4f => degrees: %0.4f', r, rad2deg );

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -71,19 +71,17 @@ d = rad2degf( NaN );
7171
<!-- eslint no-undef: "error" -->
7272

7373
```javascript
74-
var randu = require( '@stdlib/random/base/randu' );
74+
var uniform = require( '@stdlib/random/array/uniform' );
75+
var logEachMap = require( '@stdlib/console/log-each-map' );
7576
var TWO_PI = require( '@stdlib/constants/float32/two-pi' );
7677
var rad2degf = require( '@stdlib/math/base/special/rad2degf' );
7778
78-
var r;
79-
var d;
80-
var i;
79+
var opts = {
80+
'dtype': 'float32'
81+
};
82+
var r = uniform( 100, 0.0, TWO_PI, opts );
8183
82-
for ( i = 0; i < 100; i++ ) {
83-
r = randu() * TWO_PI;
84-
d = rad2degf( r );
85-
console.log( 'radians: %d => degrees: %d', r, d );
86-
}
84+
logEachMap( 'radians: %0.4f => degrees: %0.4f', r, rad2degf );
8785
```
8886

8987
</section>

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +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 TWO_PI = require( '@stdlib/constants/float32/two-pi' );
2324
var rad2degf = require( './../lib' );
2425

25-
var r;
26-
var d;
27-
var i;
26+
var opts = {
27+
'dtype': 'float32'
28+
};
29+
var r = uniform( 100, 0.0, TWO_PI, opts );
2830

29-
for ( i = 0; i < 100; i++ ) {
30-
r = randu() * TWO_PI;
31-
d = rad2degf( r );
32-
console.log( 'radians: %d => degrees: %d', r, d );
33-
}
31+
logEachMap( 'radians: %0.4f => degrees: %0.4f', r, rad2degf );

0 commit comments

Comments
 (0)