Skip to content

Commit dac7fbc

Browse files
hrshyakgryte
andauthored
docs: replace manual for loop in examples
PR-URL: #6636 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 2698899 commit dac7fbc

File tree

10 files changed

+75
-73
lines changed

10 files changed

+75
-73
lines changed

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

+8-9
Original file line numberDiff line numberDiff line change
@@ -156,18 +156,17 @@ y = gammainc( 2.0, 0.0 );
156156
<!-- eslint no-undef: "error" -->
157157

158158
```javascript
159-
var randu = require( '@stdlib/random/base/randu' );
159+
var uniform = require( '@stdlib/random/array/uniform' );
160+
var logEachMap = require( '@stdlib/console/log-each-map' );
160161
var gammainc = require( '@stdlib/math/base/special/gammainc' );
161162

162-
var i;
163-
var x;
164-
var s;
163+
var opts = {
164+
'dtype': 'float64'
165+
};
166+
var x = uniform( 100, 0.0, 10.0, opts );
167+
var s = uniform( 100, 0.0, 10.0, opts );
165168

166-
for ( i = 0; i < 100; i++ ) {
167-
x = randu() * 10.0;
168-
s = randu() * 10.0;
169-
console.log( 'x: %d, \t s: %d, \t f(x,s): %d', x.toFixed( 4 ), s.toFixed( 4 ), gammainc( x, s ).toFixed( 4 ) );
170-
}
169+
logEachMap( 'x: %0.4f, \t s: %0.4f, \t f(x,s): %0.4f', x, s, gammainc );
171170
```
172171

173172
</section>

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

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

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

28-
for ( i = 0; i < 100; i++ ) {
29-
x = randu() * 10.0;
30-
s = randu() * 10.0;
31-
console.log( 'x: %d, \t s: %d, \t f(x,s): %d', x.toFixed( 4 ), s.toFixed( 4 ), gammainc( x, s ).toFixed( 4 ) );
32-
}
31+
logEachMap( 'x: %0.4f, \t s: %0.4f, \t f(x,s): %0.4f', x, s, gammainc );

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

+9-10
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ P( x, a ) = \frac{\gamma(a,x)}{\Gamma(a)} = \frac{1}{\Gamma(a)} \int_0^x t^{a-1}
4141

4242
Specifically, for given `p` and `a` it finds the `x` such that `p = P(x, a)`.
4343

44-
The function can also be used to invert the upper incomplete gamma function, which is defined as follows:
44+
The function can also be used to invert the upper incomplete gamma function, which is defined as follows:
4545

4646
<!-- <equation class="equation" label="eq:upper_incomplete_gamma" align="center" raw="Q( x, a ) = \frac{\Gamma(a,x)}{\Gamma(a)} = \frac{1}{\Gamma(a)} \int_x^\infty t^{a-1} e^{-t} \; dt" alt="Regularized upper incomplete gamma function."> -->
4747

@@ -119,18 +119,17 @@ y = gammaincinv( -0.5, 1.0 );
119119
<!-- eslint no-undef: "error" -->
120120

121121
```javascript
122-
var randu = require( '@stdlib/random/base/randu' );
122+
var uniform = require( '@stdlib/random/array/uniform' );
123+
var logEachMap = require( '@stdlib/console/log-each-map' );
123124
var gammaincinv = require( '@stdlib/math/base/special/gammaincinv' );
124125

125-
var a;
126-
var i;
127-
var p;
126+
var opts = {
127+
'dtype': 'float64'
128+
};
129+
var p = uniform( 100, 0.0, 1.0, opts );
130+
var a = uniform( 100, 0.0, 50.0, opts );
128131

129-
for ( i = 0; i < 100; i++ ) {
130-
p = randu();
131-
a = randu() * 50.0;
132-
console.log( 'p: %d, \t a: %d, \t P^(-1)(p, a): %d', p.toFixed( 4 ), a.toFixed( 4 ), gammaincinv( p, a ).toFixed( 4 ) );
133-
}
132+
logEachMap( 'p: %0.4f, \t a: %0.4f, \t P^(-1)(p, a): %0.4f', p, a, gammaincinv );
134133
```
135134

136135
</section>

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

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

24-
var a;
25-
var i;
26-
var p;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var p = uniform( 100, 0.0, 1.0, opts );
29+
var a = uniform( 100, 0.0, 50.0, opts );
2730

28-
for ( i = 0; i < 100; i++ ) {
29-
p = randu();
30-
a = randu() * 50.0;
31-
console.log( 'p: %d, \t a: %d, \t P^(-1)(p, a): %d', p.toFixed( 4 ), a.toFixed( 4 ), gammaincinv( p, a ).toFixed( 4 ) );
32-
}
31+
logEachMap( 'p: %0.4f, \t a: %0.4f, \t P^(-1)(p, a): %0.4f', p, a, gammaincinv );

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

+7-6
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,16 @@ v = gammaln( NaN );
6868
<!-- eslint no-undef: "error" -->
6969

7070
```javascript
71-
var linspace = require( '@stdlib/array/base/linspace' );
71+
var uniform = require( '@stdlib/random/array/uniform' );
72+
var logEachMap = require( '@stdlib/console/log-each-map' );
7273
var gammaln = require( '@stdlib/math/base/special/gammaln' );
7374

74-
var x = linspace( -10.0, 10.0, 100 );
75+
var opts = {
76+
'dtype': 'float64'
77+
};
78+
var x = uniform( 100, -10.0, 10.0, opts );
7579

76-
var i;
77-
for ( i = 0; i < x.length; i++ ) {
78-
console.log( 'x: %d, f(x): %d', x[ i ], gammaln( x[ i ] ) );
79-
}
80+
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaln );
8081
```
8182

8283
</section>

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

+7-6
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 gammaln = 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 ], gammaln( x[ i ] ) );
29-
}
30+
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaln );

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

+7-6
Original file line numberDiff line numberDiff line change
@@ -92,15 +92,16 @@ v = gammasgn( NaN );
9292
<!-- eslint no-undef: "error" -->
9393

9494
```javascript
95-
var linspace = require( '@stdlib/array/base/linspace' );
95+
var uniform = require( '@stdlib/random/array/uniform' );
96+
var logEachMap = require( '@stdlib/console/log-each-map' );
9697
var gammasgn = require( '@stdlib/math/base/special/gammasgn' );
9798

98-
var x = linspace( -10.0, 10.0, 100 );
99+
var opts = {
100+
'dtype': 'float64'
101+
};
102+
var x = uniform( 100, -10.0, 10.0, opts );
99103

100-
var i;
101-
for ( i = 0; i < x.length; i++ ) {
102-
console.log( 'x: %d, f(x): %d', x[ i ], gammasgn( x[ i ] ) );
103-
}
104+
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammasgn );
104105
```
105106

106107
</section>

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

+7-6
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 gammasgn = 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 ], gammasgn( x[ i ] ) );
29-
}
30+
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammasgn );

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

+7-6
Original file line numberDiff line numberDiff line change
@@ -96,15 +96,16 @@ v = gcd( 48, NaN );
9696

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

101-
var a = discreteUniform( 100, 0, 50 );
102-
var b = discreteUniform( a.length, 0, 50 );
102+
var opts = {
103+
'dtype': 'float64'
104+
};
105+
var a = discreteUniform( 100, 0, 50, opts );
106+
var b = discreteUniform( a.length, 0, 50, opts );
103107

104-
var i;
105-
for ( i = 0; i < a.length; i++ ) {
106-
console.log( 'gcd(%d,%d) = %d', a[ i ], b[ i ], gcd( a[ i ], b[ i ] ) );
107-
}
108+
logEachMap( 'gcd(%d,%d) = %d', a, b, gcd );
108109
```
109110

110111
</section>

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

+7-6
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,13 @@
1919
'use strict';
2020

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

24-
var a = discreteUniform( 100, 0, 50 );
25-
var b = discreteUniform( a.length, 0, 50 );
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var a = discreteUniform( 100, 0, 50, opts );
29+
var b = discreteUniform( a.length, 0, 50, opts );
2630

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

0 commit comments

Comments
 (0)