Skip to content

Commit cae9a13

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

File tree

10 files changed

+73
-69
lines changed

10 files changed

+73
-69
lines changed

lib/node_modules/@stdlib/math/base/special/gamma-delta-ratio/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,18 +56,17 @@ y = gammaDeltaRatio( 100.0, 0.0 );
5656
<!-- eslint no-undef: "error" -->
5757

5858
```javascript
59-
var randu = require( '@stdlib/random/base/randu' );
59+
var uniform = require( '@stdlib/random/array/uniform' );
60+
var logEachMap = require( '@stdlib/console/log-each-map' );
6061
var gammaDeltaRatio = require( '@stdlib/math/base/special/gamma-delta-ratio' );
6162

62-
var delta;
63-
var z;
64-
var i;
63+
var opts = {
64+
'dtype': 'float64'
65+
};
66+
var z = uniform( 100, 0.0, 10.0, opts );
67+
var delta = uniform( 100, 0.0, 10.0, opts );
6568

66-
for ( i = 0; i < 100; i++ ) {
67-
z = randu()*10.0;
68-
delta = randu()*10.0;
69-
console.log( 'gamma( %d ) / gamma( %d + %d ) = %d', z, z, delta, gammaDeltaRatio( z, delta ) );
70-
}
69+
logEachMap( 'gamma( %0.4f ) / gamma( %0.4f + %0.4f ) = %0.4f', z, z, delta, gammaDeltaRatio );
7170
```
7271

7372
</section>

lib/node_modules/@stdlib/math/base/special/gamma-delta-ratio/examples/index.js

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

24-
var delta;
25-
var z;
26-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var z = uniform( 100, 0.0, 10.0, opts );
29+
var delta = uniform( 100, 0.0, 10.0, opts );
2730

28-
for ( i = 0; i < 100; i++ ) {
29-
z = randu()*10.0;
30-
delta = randu()*10.0;
31-
console.log( 'gamma( %d ) / gamma( %d + %d ) = %d', z, z, delta, gammaDeltaRatio( z, delta ) );
32-
}
31+
logEachMap( 'gamma( %0.4f ) / gamma( %0.4f + %0.4f ) = %0.4f', z, z, delta, gammaDeltaRatio );

lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum-expg-scaled/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The [Lanczos approximation][lanczos-approximation] for the [gamma function][gamm
3939

4040
<!-- </equation> -->
4141

42-
where `g` is an [arbitrary constant][@stdlib/constants/float64/gamma-lanczos-g] and `L_g(n)` is the Lanczos sum. The scaled Lanczos sum is given by
42+
where `g` is an [arbitrary constant][@stdlib/constants/float64/gamma-lanczos-g] and `L_g(n)` is the Lanczos sum. The scaled Lanczos sum is given by
4343

4444
<!-- <equation class="equation" label="eq:scaled_lanczos_sum" align="center" raw="L_g(n) \cdot \exp(-g)" alt="Scaled Lanczos sum."> -->
4545

@@ -101,15 +101,16 @@ v = gammaLanczosSumExpGScaled( NaN );
101101
<!-- eslint no-undef: "error" -->
102102

103103
```javascript
104-
var linspace = require( '@stdlib/array/base/linspace' );
104+
var uniform = require( '@stdlib/random/array/uniform' );
105+
var logEachMap = require( '@stdlib/console/log-each-map' );
105106
var gammaLanczosSumExpGScaled = require( '@stdlib/math/base/special/gamma-lanczos-sum-expg-scaled' );
106107

107-
var x = linspace( -10.0, 10.0, 100 );
108+
var opts = {
109+
'dtype': 'float64'
110+
};
111+
var x = uniform( 100, -10.0, 10.0, opts );
108112

109-
var i;
110-
for ( i = 0; i < x.length; i++ ) {
111-
console.log( 'x: %d, f(x): %d', x[ i ], gammaLanczosSumExpGScaled( x[ i ] ) );
112-
}
113+
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaLanczosSumExpGScaled );
113114
```
114115

115116
</section>

lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum-expg-scaled/examples/index.js

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

24-
var x = linspace( -10.0, 10.0, 100 );
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = uniform( 100, -10.0, 10.0, opts );
2529

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

lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,15 +88,16 @@ v = gammaLanczosSum( NaN );
8888
<!-- eslint no-undef: "error" -->
8989

9090
```javascript
91-
var linspace = require( '@stdlib/array/base/linspace' );
91+
var uniform = require( '@stdlib/random/array/uniform' );
92+
var logEachMap = require( '@stdlib/console/log-each-map' );
9293
var gammaLanczosSum = require( '@stdlib/math/base/special/gamma-lanczos-sum' );
9394

94-
var x = linspace( -10.0, 10.0, 100 );
95+
var opts = {
96+
'dtype': 'float64'
97+
};
98+
var x = uniform( 100, -10.0, 10.0, opts );
9599

96-
var i;
97-
for ( i = 0; i < x.length; i++ ) {
98-
console.log( 'x: %d, f(x): %d', x[ i ], gammaLanczosSum( x[ i ] ) );
99-
}
100+
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaLanczosSum );
100101
```
101102

102103
</section>

lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum/examples/index.js

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

24-
var x = linspace( -10.0, 10.0, 100 );
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = uniform( 100, -10.0, 10.0, opts );
2529

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

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

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,15 +106,16 @@ v = gamma( NaN );
106106
<!-- eslint no-undef: "error" -->
107107

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

112-
var x = linspace( -10.0, 10.0, 100 );
113+
var opts = {
114+
'dtype': 'float64'
115+
};
116+
var x = uniform( 100, -10.0, 10.0, opts );
113117

114-
var i;
115-
for ( i = 0; i < x.length; i++ ) {
116-
console.log( 'x: %d, f(x): %d', x[ i ], gamma( x[ i ] ) );
117-
}
118+
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gamma );
118119
```
119120

120121
</section>

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

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

24-
var x = linspace( -10.0, 10.0, 100 );
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = uniform( 100, -10.0, 10.0, opts );
2529

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

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,16 +59,16 @@ v = gamma1pm1( NaN );
5959
<!-- eslint no-undef: "error" -->
6060

6161
```javascript
62-
var randu = require( '@stdlib/random/base/randu' );
62+
var uniform = require( '@stdlib/random/array/uniform' );
63+
var logEachMap = require( '@stdlib/console/log-each-map' );
6364
var gamma1pm1 = require( '@stdlib/math/base/special/gamma1pm1' );
6465

65-
var x;
66-
var i;
66+
var opts = {
67+
'dtype': 'float64'
68+
};
69+
var x = uniform( 100, -5.0, 5.0, opts );
6770

68-
for ( i = 0; i < 100; i++ ) {
69-
x = (randu()*10.0) - 5.0;
70-
console.log( 'gamma(%d+1) - 1 = %d', x, gamma1pm1( x ) );
71-
}
71+
logEachMap( 'gamma(%0.4f+1) - 1 = %0.4f', x, gamma1pm1 );
7272
```
7373

7474
</section>

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

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

27-
for ( i = 0; i < 100; i++ ) {
28-
x = (randu()*10.0) - 5.0;
29-
console.log( 'gamma(%d+1) - 1 = %d', x, gamma1pm1( x ) );
30-
}
30+
logEachMap( 'gamma(%0.4f+1) - 1 = %0.4f', x, gamma1pm1 );

0 commit comments

Comments
 (0)