@stdlib/math-base-special-digamma

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!

digamma

Digamma function.

The digamma function ψ is the logarithmic derivative of the gamma function, i.e.

Installation

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

Usage

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

digamma( x )

Evaluates the digamma function.

var v = digamma( -2.5 );
// returns ~1.103

v = digamma( 1.0 );
// returns ~-0.577

v = digamma( 10.0 );
// returns ~2.252

If x is 0 or a negative integer, the function returns NaN.

var v = digamma( 0.0 );
// returns NaN

v = digamma( -1.0 );
// returns NaN

v = digamma( -2.0 );
// returns NaN

If provided NaN, the function returns NaN.

var v = digamma( NaN );
// returns NaN

Examples

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

var x;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
    x = (randu()*10.0) - 5.0;
    v = digamma( x );
    console.log( 'x: %d, f(x): %d', x, v );
}

---

C APIs

Usage

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

stdlib_base_digamma( x )

Evaluates the digamma function.

double out = stdlib_base_digamma( -2.5 );
// returns ~1.103

out = stdlib_base_digamma( 1.0 );
// returns ~-0.577

The function accepts the following arguments:

• x: [in] double input value.

double stdlib_base_digamma( const double x );

Examples

#include "stdlib/math/base/special/digamma.h"
#include <stdlib.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_digamma( x[ i ] );
        printf( "digamma(%lf) = %lf\n", x[ i ], y );
    }
}

---

See Also

• @stdlib/math-base/special/gamma: gamma function.
• @stdlib/math-base/special/trigamma: trigamma 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

• 337adbf - add C implementation for math/base/special/digamma (#2533)

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

Commits

<details>

• 272ae7a - docs: remove comment (by Athan Reines)
• 55ec8ed - docs: remove comment (by Athan Reines)
• 2777e4b - bench: resolve lint errors in benchmarks (by Athan Reines)
• 26337e1 - docs: fix return annotation tag in C comments (by Philipp Burckhardt)
• e9d0de8 - chore: update package meta data (#2596) (by stdlib-bot, Athan Reines)
• ed638e3 - docs: update Boost version and fix C function name in README.md (#2577) (by Gunj Joshi)
• 337adbf - feat: add C implementation for math/base/special/digamma (#2533) (by Gunj Joshi)

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