Skip to content

docs: replace manual for loop in examples #6636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 11, 2025
Merged

docs: replace manual for loop in examples #6636

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4fda29
docs: replace manual for loop in examples
hrshya Apr 10, 2025
c5a2925
resolve lint issue
hrshya Apr 10, 2025
ed0f01c
Apply suggestions from code review
kgryte Apr 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/gammainc/README.md
View file
Original file line number Diff line number Diff line change
@@ -156,18 +156,17 @@ y = gammainc( 2.0, 0.0 );
<!-- eslint no-undef: "error" -->

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

var i;
var x;
var s;
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, 0.0, 10.0, opts );
var s = uniform( 100, 0.0, 10.0, opts );

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

</section>
17 changes: 8 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/gammainc/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -18,15 +18,14 @@

'use strict';

var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var gammainc = require( './../lib' );

var i;
var x;
var s;
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, 0.0, 10.0, opts );
var s = uniform( 100, 0.0, 10.0, opts );

for ( i = 0; i < 100; i++ ) {
x = randu() * 10.0;
s = randu() * 10.0;
console.log( 'x: %d, \t s: %d, \t f(x,s): %d', x.toFixed( 4 ), s.toFixed( 4 ), gammainc( x, s ).toFixed( 4 ) );
}
logEachMap( 'x: %0.4f, \t s: %0.4f, \t f(x,s): %0.4f', x, s, gammainc );
19 changes: 9 additions & 10 deletions lib/node_modules/@stdlib/math/base/special/gammaincinv/README.md
View file
Original file line number Diff line number Diff 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}

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

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

<!-- <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."> -->

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

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

var a;
var i;
var p;
var opts = {
'dtype': 'float64'
};
var p = uniform( 100, 0.0, 1.0, opts );
var a = uniform( 100, 0.0, 50.0, opts );

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

</section>
17 changes: 8 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/gammaincinv/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -18,15 +18,14 @@

'use strict';

var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var gammaincinv = require( './../lib' );

var a;
var i;
var p;
var opts = {
'dtype': 'float64'
};
var p = uniform( 100, 0.0, 1.0, opts );
var a = uniform( 100, 0.0, 50.0, opts );

for ( i = 0; i < 100; i++ ) {
p = randu();
a = randu() * 50.0;
console.log( 'p: %d, \t a: %d, \t P^(-1)(p, a): %d', p.toFixed( 4 ), a.toFixed( 4 ), gammaincinv( p, a ).toFixed( 4 ) );
}
logEachMap( 'p: %0.4f, \t a: %0.4f, \t P^(-1)(p, a): %0.4f', p, a, gammaincinv );
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/gammaln/README.md
View file
Original file line number Diff line number Diff line change
@@ -68,15 +68,16 @@ v = gammaln( NaN );
<!-- eslint no-undef: "error" -->

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

var x = linspace( -10.0, 10.0, 100 );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -10.0, 10.0, opts );

var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'x: %d, f(x): %d', x[ i ], gammaln( x[ i ] ) );
}
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaln );
```

</section>
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/gammaln/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -18,12 +18,13 @@

'use strict';

var linspace = require( '@stdlib/array/base/linspace' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var gammaln = require( './../lib' );

var x = linspace( -10.0, 10.0, 100 );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -10.0, 10.0, opts );

var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'x: %d, f(x): %d', x[ i ], gammaln( x[ i ] ) );
}
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaln );
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/gammasgn/README.md
View file
Original file line number Diff line number Diff line change
@@ -92,15 +92,16 @@ v = gammasgn( NaN );
<!-- eslint no-undef: "error" -->

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

var x = linspace( -10.0, 10.0, 100 );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -10.0, 10.0, opts );

var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'x: %d, f(x): %d', x[ i ], gammasgn( x[ i ] ) );
}
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammasgn );
```

</section>
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/gammasgn/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -18,12 +18,13 @@

'use strict';

var linspace = require( '@stdlib/array/base/linspace' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var gammasgn = require( './../lib' );

var x = linspace( -10.0, 10.0, 100 );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -10.0, 10.0, opts );

var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'x: %d, f(x): %d', x[ i ], gammasgn( x[ i ] ) );
}
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammasgn );
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/gcd/README.md
View file
Original file line number Diff line number Diff line change
@@ -96,15 +96,16 @@ v = gcd( 48, NaN );

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

var a = discreteUniform( 100, 0, 50 );
var b = discreteUniform( a.length, 0, 50 );
var opts = {
'dtype': 'float64'
};
var a = discreteUniform( 100, 0, 50, opts );
var b = discreteUniform( a.length, 0, 50, opts );

var i;
for ( i = 0; i < a.length; i++ ) {
console.log( 'gcd(%d,%d) = %d', a[ i ], b[ i ], gcd( a[ i ], b[ i ] ) );
}
logEachMap( 'gcd(%d,%d) = %d', a, b, gcd );
```

</section>
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/gcd/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -19,12 +19,13 @@
'use strict';

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

var a = discreteUniform( 100, 0, 50 );
var b = discreteUniform( a.length, 0, 50 );
var opts = {
'dtype': 'float64'
};
var a = discreteUniform( 100, 0, 50, opts );
var b = discreteUniform( a.length, 0, 50, opts );

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