Skip to content

docs: replace manual for loop in examples #6635

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 2 commits into from
Apr 11, 2025
Merged

docs: replace manual for loop in examples #6635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91c2b67
docs: replace manual for loop in examples
hrshya Apr 10, 2025
7ea4881
resolve lint issue
hrshya Apr 10, 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/gamma-delta-ratio/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,17 @@ y = gammaDeltaRatio( 100.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 gammaDeltaRatio = require( '@stdlib/math/base/special/gamma-delta-ratio' );

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

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

</section>
Expand Down
17 changes: 8 additions & 9 deletions lib/node_modules/@stdlib/math/base/special/gamma-delta-ratio/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 gammaDeltaRatio = require( './../lib' );

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

for ( i = 0; i < 100; i++ ) {
z = randu()*10.0;
delta = randu()*10.0;
console.log( 'gamma( %d ) / gamma( %d + %d ) = %d', z, z, delta, gammaDeltaRatio( z, delta ) );
}
logEachMap( 'gamma( %0.4f ) / gamma( %0.4f + %0.4f ) = %0.4f', z, z, delta, gammaDeltaRatio );
15 changes: 8 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum-expg-scaled/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The [Lanczos approximation][lanczos-approximation] for the [gamma function][gamm

<!-- </equation> -->

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
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

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

Expand Down Expand Up @@ -101,15 +101,16 @@ v = gammaLanczosSumExpGScaled( 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 gammaLanczosSumExpGScaled = require( '@stdlib/math/base/special/gamma-lanczos-sum-expg-scaled' );

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 ], gammaLanczosSumExpGScaled( x[ i ] ) );
}
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaLanczosSumExpGScaled );
```

</section>
Expand Down
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum-expg-scaled/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 gammaLanczosSumExpGScaled = 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 ], gammaLanczosSumExpGScaled( x[ i ] ) );
}
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaLanczosSumExpGScaled );
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,16 @@ v = gammaLanczosSum( 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 gammaLanczosSum = require( '@stdlib/math/base/special/gamma-lanczos-sum' );

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 ], gammaLanczosSum( x[ i ] ) );
}
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaLanczosSum );
```

</section>
Expand Down
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 gammaLanczosSum = 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 ], gammaLanczosSum( x[ i ] ) );
}
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaLanczosSum );
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/gamma/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,15 +106,16 @@ v = gamma( 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 gamma = require( '@stdlib/math/base/special/gamma' );

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 ], gamma( x[ i ] ) );
}
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gamma );
```

</section>
Expand Down
13 changes: 7 additions & 6 deletions lib/node_modules/@stdlib/math/base/special/gamma/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 gamma = 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 ], gamma( x[ i ] ) );
}
logEachMap( 'x: %0.4f, f(x): %0.4f', x, gamma );
14 changes: 7 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/gamma1pm1/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,16 @@ v = gamma1pm1( NaN );
<!-- 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 gamma1pm1 = require( '@stdlib/math/base/special/gamma1pm1' );

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

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

</section>
Expand Down
14 changes: 7 additions & 7 deletions lib/node_modules/@stdlib/math/base/special/gamma1pm1/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@

'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 gamma1pm1 = require( './../lib' );

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

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