@stdlib/math-base-special-gamma

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!

Gamma Function

Gamma function.

The gamma function extends the factorial function to real and complex numbers. If n is a positive integer,

-->

Generalized to all complex numbers z, except for nonpositive integers, the gamma function can be expressed as an infinite product

where γ ≈ 0.577216 is the Euler–Mascheroni constant.

Installation

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

Usage

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

gamma( x )

Evaluates the gamma function.

var v = gamma( 4.0 );
// returns 6.0

v = gamma( -1.5 );
// returns ~2.363

v = gamma( -0.5 );
// returns ~-3.545

v = gamma( 0.5 );
// returns ~1.772

v = gamma( 0.0 );
// returns Infinity

v = gamma( -0.0 );
// returns -Infinity

v = gamma( NaN );
// returns NaN

Examples

var linspace = require( '@stdlib/array-base-linspace' );
var gamma = require( '@stdlib/math-base-special-gamma' );

var x = linspace( -10.0, 10.0, 100 );

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

C APIs

Usage

#include "stdlib/math/base/special/gamma.h"

stdlib_base_gamma( x )

Evaluates the gamma function.

double out = stdlib_base_gamma( 4.0 );
// returns 6.0

out = stdlib_base_gamma( -1.5 );
// returns ~2.363

The function accepts the following arguments:

• x: [in] double input value.

double stdlib_base_gamma( const double x );

Examples

#include "stdlib/math/base/special/gamma.h"
#include <stdio.h>

int main( void ) {
    const double x[] = { 4.0, -1.5, -0.5, 0.5 };

    double y;
    int i;
    for ( i = 0; i < 4; i++ ) {
        y = stdlib_base_gamma( x[ i ] );
        printf( "gamma(%lf) = %lf\n", x[ i ], y );
    }
}

See Also

• @stdlib/math-base/special/gamma1pm1: compute gamma(x+1) - 1.
• @stdlib/math-base/special/gammainc: incomplete gamma function.
• @stdlib/math-base/special/gammaincinv: inverse incomplete gamma function.
• @stdlib/math-base/special/gammaln: natural logarithm of the gamma 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

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.3.0 (2024-07-28)

<section class="features">

Features

• 35af244 - add C implementation for math/base/special/gamma

</section> <!-- /.features --> <section class="commits">

Commits

<details>

• 39a6773 - docs: remove unused include from example in math/base/special/gamma/README.md (#2677) (by Gunj Joshi)
• 272ae7a - docs: remove comment (by Athan Reines)
• 3e05048 - docs: remove comment (by Athan Reines)
• 55ec8ed - docs: remove comment (by Athan Reines)
• 2777e4b - bench: resolve lint errors in benchmarks (by Athan Reines)
• ead1c3b - chore: update package meta data (#2640) (by stdlib-bot, Athan Reines)
• 35af244 - feat: add C implementation for math/base/special/gamma (by Gunj Joshi, Philipp Burckhardt)
• 9ed7d0e - chore: add missing trailing newlines (by Philipp Burckhardt)

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

Contributors

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

• Athan Reines
• Gunj Joshi
• Philipp Burckhardt

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