diff --git a/lib/node_modules/@stdlib/math/base/special/digamma/README.md b/lib/node_modules/@stdlib/math/base/special/digamma/README.md index d43cc085409c..ab46b4a40f75 100644 --- a/lib/node_modules/@stdlib/math/base/special/digamma/README.md +++ b/lib/node_modules/@stdlib/math/base/special/digamma/README.md @@ -115,6 +115,95 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/digamma.h" +``` + +#### digamma( x ) + +Evaluates the [digamma function][digamma-function]. + +```c +double out = digamma( -2.5 ); +// returns ~1.103 + +out = digamma( 1.0 ); +// returns ~-0.577 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +double digamma( const double x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/digamma.h" +#include +#include + +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 ); + } +} +``` + +
+ + + +
+ + +