From 5da2a84395541775a5ed6928577bc150c270e62f Mon Sep 17 00:00:00 2001 From: Gunj Joshi Date: Sat, 3 Aug 2024 06:43:49 +0530 Subject: [PATCH] feat: add C implementation for `math/base/special/factorialln` PR-URL: #2731 Ref: #649 Reviewed-by: Philipp Burckhardt --- .../math/base/special/factorialln/README.md | 88 ++++++++ .../factorialln/benchmark/benchmark.native.js | 82 +++++++ .../factorialln/benchmark/c/native/Makefile | 146 +++++++++++++ .../benchmark/c/native/benchmark.c | 133 ++++++++++++ .../math/base/special/factorialln/binding.gyp | 170 +++++++++++++++ .../special/factorialln/examples/c/Makefile | 146 +++++++++++++ .../special/factorialln/examples/c/example.c | 31 +++ .../base/special/factorialln/include.gypi | 53 +++++ .../stdlib/math/base/special/factorialln.h | 38 ++++ .../base/special/factorialln/lib/native.js | 62 ++++++ .../base/special/factorialln/manifest.json | 75 +++++++ .../base/special/factorialln/src/Makefile | 70 ++++++ .../math/base/special/factorialln/src/addon.c | 23 ++ .../math/base/special/factorialln/src/main.c | 38 ++++ .../base/special/factorialln/test/test.js | 2 +- .../special/factorialln/test/test.native.js | 202 ++++++++++++++++++ 16 files changed, 1358 insertions(+), 1 deletion(-) create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/include/stdlib/math/base/special/factorialln.h create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/factorialln/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/factorialln/README.md b/lib/node_modules/@stdlib/math/base/special/factorialln/README.md index 493761f9ca2..b3f12b55081 100644 --- a/lib/node_modules/@stdlib/math/base/special/factorialln/README.md +++ b/lib/node_modules/@stdlib/math/base/special/factorialln/README.md @@ -166,6 +166,94 @@ for ( i = 0; i < x.length; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/factorialln.h" +``` + +#### stdlib_base_factorialln( x ) + +Evaluates the natural logarithm of the [factorial function][factorial-function]. For input values other than negative integers, the function returns `ln( x! ) = ln( Γ(x+1) )`, where `Γ` is the [Gamma][gamma-function] function. For negative integers, the function returns `NaN`. + +```c +double out = stdlib_base_factorialln( 3.0 ); +// returns ~1.792 + +out = stdlib_base_factorialln( -1.5 ); +// returns ~1.266 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +double stdlib_base_factorialln( const double n ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/factorialln.h" +#include + +int main( void ) { + const double x[] = { 2.0, 3.0, 5.0, 8.0 }; + + double y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_factorialln( x[ i ] ); + printf( "factorialln(%lf) = %lf\n", x[ i ], y ); + } +} +``` + +
+ + + +
+ + +