@stdlib/math-base-special-betainc

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

betainc

Incomplete beta function.

Installation

npm install @stdlib/math-base-special-betainc

Usage

var betainc = require( '@stdlib/math-base-special-betainc' );

betainc( x, a, b[, regularized[, upper]] )

By default, evaluates the regularized lower incomplete beta function for inputs x, a > 0 and b > 0. The fourth and fifth parameters of the function can be used to specify whether instead to evaluate the non-regularized and/or upper incomplete beta functions, respectively.

var y = betainc( 0.5, 2.0, 2.0 );
// returns 0.5

y = betainc( 0.5, 2.0, 2.0, false );
// returns ~0.083

y = betainc( 0.2, 1.0, 2.0 );
// returns 0.36

y = betainc( 0.2, 1.0, 2.0, true, true );
// returns 0.64

If provided NaN as any argument, the function returns NaN.

var y = betainc( NaN, 1.0, 1.0 );
// returns NaN

y = betainc( 0.8, NaN, 1.0 );
// returns NaN

y = betainc( 0.8, 1.0, NaN );
// returns NaN

If provided a x outside the interval [0,1], the function returns NaN.

var y = betainc( 1.5, 1.0, 1.0 );
// returns NaN

y = betainc( -0.5, 1.0, 1.0 );
// returns NaN

If provided a negative a, the function returns NaN.

var y = betainc( 0.5, -2.0, 2.0 );
// returns NaN

If provided a negative b, the function returns NaN.

var y = betainc( 0.5, 2.0, -2.0 );
// returns NaN

Examples

var randu = require( '@stdlib/random-base-randu' );
var betainc = require( '@stdlib/math-base-special-betainc' );

var i;
var x;
var a;
var b;

for ( i = 0; i < 100; i++ ) {
    x = randu();
    a = randu() * 10.0;
    b = randu() * 10.0;
    console.log( 'x: %d, \t a: %d, \t b: %d, \t f(x,a,b): %d', x.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), betainc( x, a, b ).toFixed( 4 ) );
}

---

See Also

• @stdlib/math-base/special/beta: beta function.
• @stdlib/math-base/special/betaincinv: inverse incomplete beta function.
• @stdlib/math-base/special/betaln: natural logarithm of the beta function.

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.2.2 (2024-07-28)

<section class="commits">

Commits

<details>

• 3e05048 - docs: remove comment (by Athan Reines)
• 55ec8ed - docs: remove comment (by Athan Reines)
• 2777e4b - bench: resolve lint errors in benchmarks (by Athan Reines)
• 9ed7d0e - chore: add missing trailing newlines (by Philipp Burckhardt)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 2 people contributed to this release. Thank you to the following contributors:

• Athan Reines
• Philipp Burckhardt

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.2.1">