diff --git a/lib/node_modules/@stdlib/math/base/special/gamma-delta-ratio/README.md b/lib/node_modules/@stdlib/math/base/special/gamma-delta-ratio/README.md index c3008750cae0..09067c724e75 100644 --- a/lib/node_modules/@stdlib/math/base/special/gamma-delta-ratio/README.md +++ b/lib/node_modules/@stdlib/math/base/special/gamma-delta-ratio/README.md @@ -74,6 +74,99 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/gamma_delta_ratio.h" +``` + +#### stdlib_base_gamma_delta_ratio( z, delta ) + +Computes the ratio of two [gamma functions][@stdlib/math/base/special/gamma]. Specifically, the function evaluates `Γ( z ) / Γ( z + delta )`. + +```c +double out = stdlib_base_gamma_delta_ratio( 2.0, 3.0 ); +// returns ~0.042 + +out = stdlib_base_gamma_delta_ratio( 4.0, 0.5 ); +// returns ~0.516 +``` + +The function accepts the following arguments: + +- **z**: `[in] double` first gamma parameter. +- **delta**: `[in] double` difference. + +```c +double stdlib_base_gamma_delta_ratio( const double z, const double delta ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/gamma_delta_ratio.h" +#include +#include + +int main( void ) { + double delta; + double out; + double z; + int i; + + for ( i = 0; i < 100; i++ ) { + z = (double)rand() * 10.0; + delta = (double)rand() * 10.0; + out = stdlib_base_gamma_delta_ratio( z, delta ); + printf( "gamma_delta_ratio(%lf, %lf) = %lf\n", z, delta, out ); + } +} +``` + +
+ + + +
+ + +