diff --git a/lib/node_modules/@stdlib/math/base/special/gammaincinv/README.md b/lib/node_modules/@stdlib/math/base/special/gammaincinv/README.md index 7426de70ddd1..c7c676f38ac8 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaincinv/README.md +++ b/lib/node_modules/@stdlib/math/base/special/gammaincinv/README.md @@ -138,6 +138,64 @@ logEachMap( 'p: %0.4f, \t a: %0.4f, \t P^(-1)(p, a): %0.4f', p, a, gammaincinv ) +
+ +## C API + + +
+
+#include "stdlib/math/base/special/gammaincinv.h"
+#include 
+
+double stdlib_base_special_gammaincinv( const double p, const double a, const bool upper )
+
+
+ +

+Inverts the lower incomplete gamma function. +

+ +
+
+double y = stdlib_base_special_gammaincinv( 0.5, 1.0, false );
+// returns ~0.693
+
+y = stdlib_base_special_gammaincinv( 0.1, 1.0, true );
+// returns ~2.303
+
+
+ +The function accepts the following arguments: + +* p: `[in] double` probability value. +* a: `[in] double` scale parameter. +* upper: `[in] bool` boolean indicating if the function should invert the upper tail of the incomplete gamma function instead. + +
+
+double stdlib_base_special_gammaincinv( const double p, const double a, const bool upper );
+
+
+ +

+ +

+ + +
+
+$ stdlib repl
+> #include "stdlib/math/base/special/gammaincinv.h"
+> #include 
+>
+> double y = stdlib_base_special_gammaincinv( 0.8, 2.0, false );
+> printf( "y = %f\n", y );
+> // => y = 1.213038...
+
+
+ +