diff --git a/docs/migration-guides/jstat/data/jstat_1_9_x.csv b/docs/migration-guides/jstat/data/jstat_1_9_x.csv index 51cb587c3587..3b02f2412332 100644 --- a/docs/migration-guides/jstat/data/jstat_1_9_x.csv +++ b/docs/migration-guides/jstat/data/jstat_1_9_x.csv @@ -224,7 +224,7 @@ betacf,(planned) ibetainv,@stdlib/math/base/special/betaincinv ibeta,@stdlib/math/base/special/betainc gammafn,@stdlib/math/base/special/gamma -gammaln,@stdlib/math/base/special/gammaln +absgammaln,@stdlib/math/base/special/absgammaln gammap,@stdlib/math/base/special/gammainc lowRegGamma,@stdlib/math/base/special/gammainc gammapinv,@stdlib/math/base/special/gammaincinv diff --git a/docs/migration-guides/simple-statistics/data/simple_statistics_7_0_2.csv b/docs/migration-guides/simple-statistics/data/simple_statistics_7_0_2.csv index cdcf6ff20451..b89aa1a68291 100644 --- a/docs/migration-guides/simple-statistics/data/simple_statistics_7_0_2.csv +++ b/docs/migration-guides/simple-statistics/data/simple_statistics_7_0_2.csv @@ -61,7 +61,7 @@ chiSquaredGoodnessOfFit,@stdlib/stats/chi2gof epsilon,@stdlib/constants/math/float64-eps factorial,@stdlib/math/base/special/factorial gamma,@stdlib/math/base/special/gamma -gammaln,@stdlib/math/base/special/gammaln +absgammaln,@stdlib/math/base/special/absgammaln uniqueCountSorted,N/A extent,@stdlib/stats/base/range extentSorted,(planned) diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/LICENSE b/lib/node_modules/@stdlib/math/base/special/absgammaln/LICENSE similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/LICENSE rename to lib/node_modules/@stdlib/math/base/special/absgammaln/LICENSE diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/README.md b/lib/node_modules/@stdlib/math/base/special/absgammaln/README.md similarity index 75% rename from lib/node_modules/@stdlib/math/base/special/gammaln/README.md rename to lib/node_modules/@stdlib/math/base/special/absgammaln/README.md index 72401ee74be9..e8498ed4ca59 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/README.md +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/README.md @@ -18,42 +18,42 @@ limitations under the License. --> -# gammaln +# absgammaln -> [Natural logarithm][@stdlib/math/base/special/ln] of the [gamma][@stdlib/math/base/special/gamma] function. +> [Natural logarithm][@stdlib/math/base/special/ln] of the [absolute][@stdlib/math/base/special/abs] value of the [gamma][@stdlib/math/base/special/gamma] function.
## Usage ```javascript -var gammaln = require( '@stdlib/math/base/special/gammaln' ); +var absgammaln = require( '@stdlib/math/base/special/absgammaln' ); ``` -#### gammaln( x ) +#### absgammaln( x ) -Evaluates the [natural logarithm][@stdlib/math/base/special/ln] of the [gamma function][@stdlib/math/base/special/gamma]. +Evaluates the [natural logarithm][@stdlib/math/base/special/ln] of the [absolute][@stdlib/math/base/special/abs] value of the [gamma][@stdlib/math/base/special/gamma] function. ```javascript -var v = gammaln( 2.0 ); +var v = absgammaln( 2.0 ); // returns 0.0 -v = gammaln( 1.0 ); +v = absgammaln( 1.0 ); // returns 0.0 -v = gammaln( 4.0 ); +v = absgammaln( 4.0 ); // returns ~1.792 -v = gammaln( -0.5 ); +v = absgammaln( -0.5 ); // returns ~1.266 -v = gammaln( 0.5 ); +v = absgammaln( 0.5 ); // returns ~0.572 -v = gammaln( 0.0 ); +v = absgammaln( 0.0 ); // returns Infinity -v = gammaln( NaN ); +v = absgammaln( NaN ); // returns NaN ``` @@ -70,14 +70,14 @@ v = gammaln( NaN ); ```javascript var uniform = require( '@stdlib/random/array/uniform' ); var logEachMap = require( '@stdlib/console/log-each-map' ); -var gammaln = require( '@stdlib/math/base/special/gammaln' ); +var absgammaln = require( '@stdlib/math/base/special/absgammaln' ); var opts = { 'dtype': 'float64' }; var x = uniform( 100, -10.0, 10.0, opts ); -logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaln ); +logEachMap( 'x: %0.4f, f(x): %0.4f', x, absgammaln ); ```
@@ -107,18 +107,18 @@ logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaln ); ### Usage ```c -#include "stdlib/math/base/special/gammaln.h" +#include "stdlib/math/base/special/absgammaln.h" ``` -#### stdlib_base_gammaln( x ) +#### stdlib_base_absgammaln( x ) -Evaluates the [natural logarithm][@stdlib/math/base/special/ln] of the [gamma function][@stdlib/math/base/special/gamma]. +Evaluates the [natural logarithm][@stdlib/math/base/special/ln] of the [absolute][@stdlib/math/base/special/abs] value of the [gamma][@stdlib/math/base/special/gamma] function. ```c -double out = stdlib_base_gammaln( 2.0 ); +double out = stdlib_base_absgammaln( 2.0 ); // returns 0.0 -out = stdlib_base_gammaln( 4.0 ); +out = stdlib_base_absgammaln( 4.0 ); // returns ~1.792 ``` @@ -127,7 +127,7 @@ The function accepts the following arguments: - **x**: `[in] double` input value. ```c -double stdlib_base_gammaln( const double x ); +double stdlib_base_absgammaln( const double x ); ``` @@ -149,7 +149,7 @@ double stdlib_base_gammaln( const double x ); ### Examples ```c -#include "stdlib/math/base/special/gammaln.h" +#include "stdlib/math/base/special/absgammaln.h" #include #include @@ -159,8 +159,8 @@ int main( void ) { double y; int i; for ( i = 0; i < 4; i++ ) { - y = stdlib_base_gammaln( x[ i ] ); - printf( "gammaln(%lf) = %lf\n", x[ i ], y ); + y = stdlib_base_absgammaln( x[ i ] ); + printf( "absgammaln(%lf) = %lf\n", x[ i ], y ); } } ``` @@ -195,6 +195,9 @@ int main( void ) { [@stdlib/math/base/special/ln]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ln +[@stdlib/math/base/special/abs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/abs + + [@stdlib/math/base/special/gamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/gamma diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/benchmark.js similarity index 93% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/benchmark.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/benchmark.js index c85cb24376d9..0161bff6546b 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/benchmark.js @@ -24,7 +24,7 @@ var bench = require( '@stdlib/bench' ); var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pkg = require( './../package.json' ).name; -var gammaln = require( './../lib' ); +var absgammaln = require( './../lib' ); // MAIN // @@ -38,7 +38,7 @@ bench( pkg, function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - y = gammaln( x[ i%x.length ] ); + y = absgammaln( x[ i%x.length ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/benchmark.native.js similarity index 89% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/benchmark.native.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/benchmark.native.js index beaecf7e12ec..e707aa7023c1 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/benchmark.native.js @@ -30,9 +30,9 @@ var pkg = require( './../package.json' ).name; // VARIABLES // -var gammaln = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var absgammaln = tryRequire( resolve( __dirname, './../lib/native.js' ) ); var opts = { - 'skip': ( gammaln instanceof Error ) + 'skip': ( absgammaln instanceof Error ) }; @@ -47,7 +47,7 @@ bench( pkg+'::native', opts, function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - y = gammaln( x[ i%x.length ] ); + y = absgammaln( x[ i%x.length ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/Makefile b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/Makefile similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/Makefile rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/Makefile diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/benchmark.c similarity index 99% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/benchmark.c rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/benchmark.c index f7c04b9c24df..96f1bd525242 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/benchmark.c @@ -22,7 +22,7 @@ #include #include -#define NAME "gammaln" +#define NAME "absgammaln" #define ITERATIONS 1000000 #define REPEATS 3 diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/cephes/Makefile b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/cephes/Makefile similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/cephes/Makefile rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/cephes/Makefile diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/cephes/benchmark.c b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/cephes/benchmark.c similarity index 99% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/cephes/benchmark.c rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/cephes/benchmark.c index 8b568a095a25..19242e5b5869 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/cephes/benchmark.c +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/cephes/benchmark.c @@ -22,7 +22,7 @@ #include #include -#define NAME "gammaln" +#define NAME "absgammaln" #define ITERATIONS 1000000 #define REPEATS 3 diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/native/Makefile similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/native/Makefile rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/native/Makefile diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/native/benchmark.c similarity index 95% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/native/benchmark.c rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/native/benchmark.c index fa823e29fbb3..13500d2c8e11 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/c/native/benchmark.c +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/c/native/benchmark.c @@ -16,14 +16,14 @@ * limitations under the License. */ -#include "stdlib/math/base/special/gammaln.h" +#include "stdlib/math/base/special/absgammaln.h" #include #include #include #include #include -#define NAME "gammaln" +#define NAME "absgammaln" #define ITERATIONS 1000000 #define REPEATS 3 @@ -102,7 +102,7 @@ static double benchmark( void ) { t = tic(); for ( i = 0; i < ITERATIONS; i++ ) { - y = stdlib_base_gammaln( x[ i%100 ] ); + y = stdlib_base_absgammaln( x[ i%100 ] ); if ( y != y ) { printf( "should not return NaN\n" ); break; diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/cpp/boost/Makefile b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/cpp/boost/Makefile similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/cpp/boost/Makefile rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/cpp/boost/Makefile diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/cpp/boost/benchmark.cpp b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/cpp/boost/benchmark.cpp similarity index 99% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/cpp/boost/benchmark.cpp rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/cpp/boost/benchmark.cpp index 93733a2019d9..7113eb6fa38d 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/cpp/boost/benchmark.cpp +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/cpp/boost/benchmark.cpp @@ -28,7 +28,7 @@ using boost::random::uniform_real_distribution; using boost::random::mt19937; -#define NAME "gammaln" +#define NAME "absgammaln" #define ITERATIONS 1000000 #define REPEATS 3 diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/julia/REQUIRE b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/julia/REQUIRE similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/julia/REQUIRE rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/julia/REQUIRE diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/julia/benchmark.jl b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/julia/benchmark.jl similarity index 99% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/julia/benchmark.jl rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/julia/benchmark.jl index 0afafa276289..7121880e1297 100755 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/julia/benchmark.jl +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/julia/benchmark.jl @@ -20,7 +20,7 @@ import BenchmarkTools using Printf # Benchmark variables: -name = "gammaln"; +name = "absgammaln"; repeats = 3; """ diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/python/benchmark.py b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/python/benchmark.py similarity index 99% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/python/benchmark.py rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/python/benchmark.py index 670d361d874a..6a482a32cce1 100755 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/python/benchmark.py +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/python/benchmark.py @@ -21,7 +21,7 @@ from __future__ import print_function import timeit -NAME = "gammaln" +NAME = "absgammaln" REPEATS = 3 ITERATIONS = 1000000 diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/python/scipy/benchmark.py b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/python/scipy/benchmark.py similarity index 97% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/python/scipy/benchmark.py rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/python/scipy/benchmark.py index 0ba1c19f8689..469a0ed4acd8 100755 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/python/scipy/benchmark.py +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/python/scipy/benchmark.py @@ -16,12 +16,12 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Benchmark scipy.special.gammaln.""" +"""Benchmark scipy.special.absgammaln.""" from __future__ import print_function import timeit -NAME = "gammaln" +NAME = "absgammaln" REPEATS = 3 ITERATIONS = 1000000 diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/r/DESCRIPTION b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/r/DESCRIPTION similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/r/DESCRIPTION rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/r/DESCRIPTION diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/r/benchmark.R b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/r/benchmark.R similarity index 77% rename from lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/r/benchmark.R rename to lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/r/benchmark.R index 4560caa7a296..af50f82e42ef 100755 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/benchmark/r/benchmark.R +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/benchmark/r/benchmark.R @@ -25,7 +25,7 @@ options( digits = 16L ); #' main(); main <- function() { # Define benchmark parameters: - name <- "gammaln"; + name <- 'absgammaln'; iterations <- 1000000L; repeats <- 3L; @@ -34,7 +34,7 @@ main <- function() { #' @examples #' print_version(); print_version <- function() { - cat( "TAP version 13\n" ); + cat( 'TAP version 13\n' ); } #' Print the TAP summary. @@ -45,12 +45,12 @@ main <- function() { #' @examples #' print_summary( 3, 3 ); print_summary <- function( total, passing ) { - cat( "#\n" ); - cat( paste0( "1..", total, "\n" ) ); # TAP plan - cat( paste0( "# total ", total, "\n" ) ); - cat( paste0( "# pass ", passing, "\n" ) ); - cat( "#\n" ); - cat( "# ok\n" ); + cat( '#\n' ); + cat( paste0( '1..', total, '\n' ) ); # TAP plan + cat( paste0( '# total ', total, '\n' ) ); + cat( paste0( '# pass ', passing, '\n' ) ); + cat( '#\n' ); + cat( '# ok\n' ); } #' Print benchmark results. @@ -62,11 +62,11 @@ main <- function() { #' print_results( 10000L, 0.131009101868 ); print_results <- function( iterations, elapsed ) { rate <- iterations / elapsed; - cat( " ---\n" ); - cat( paste0( " iterations: ", iterations, "\n" ) ); - cat( paste0( " elapsed: ", elapsed, "\n" ) ); - cat( paste0( " rate: ", rate, "\n" ) ); - cat( " ...\n" ); + cat( ' ---\n' ); + cat( paste0( ' iterations: ', iterations, '\n' ) ); + cat( paste0( ' elapsed: ', elapsed, '\n' ) ); + cat( paste0( ' rate: ', rate, '\n' ) ); + cat( ' ...\n' ); } #' Run a benchmark. @@ -85,10 +85,10 @@ main <- function() { #' elapsed <- benchmark( 10000L ); benchmark <- function( iterations ) { # Run the benchmarks: - results <- microbenchmark::microbenchmark( lgamma( (1000.0*runif(1)) - 500.0 ), times = iterations ); + results <- microbenchmark::microbenchmark( lgamma( (1000.0*runif(1.0)) - 500.0 ), times = iterations ); # Sum all the raw timing results to get a total "elapsed" time: - elapsed <- sum( results$time ); + elapsed <- sum( results[['time']] ); # Convert the elapsed time from nanoseconds to seconds: elapsed <- elapsed / 1.0e9; @@ -97,11 +97,11 @@ main <- function() { } print_version(); - for ( i in 1:repeats ) { - cat( paste0( "# r::", name, "\n" ) ); + for ( i in 1L:repeats ) { + cat( paste0( '# r::', name, '\n' ) ); elapsed <- benchmark( iterations ); print_results( iterations, elapsed ); - cat( paste0( "ok ", i, " benchmark finished", "\n" ) ); + cat( paste0( 'ok ', i, ' benchmark finished', '\n' ) ); } print_summary( repeats, repeats ); } diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/binding.gyp b/lib/node_modules/@stdlib/math/base/special/absgammaln/binding.gyp similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/binding.gyp rename to lib/node_modules/@stdlib/math/base/special/absgammaln/binding.gyp diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/absgammaln/docs/repl.txt similarity index 68% rename from lib/node_modules/@stdlib/math/base/special/gammaln/docs/repl.txt rename to lib/node_modules/@stdlib/math/base/special/absgammaln/docs/repl.txt index fa159390a3b1..dc491be4c812 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/docs/repl.txt @@ -1,6 +1,7 @@ {{alias}}( x ) - Evaluates the natural logarithm of the gamma function. + Evaluates the natural logarithm of the absolute value of the gamma function + for a double-precision floating-point number. Parameters ---------- @@ -10,7 +11,7 @@ Returns ------- y: number - Natural logarithm of the gamma function. + Natural logarithm of the absolute value of the gamma function. Examples -------- diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/absgammaln/docs/types/index.d.ts similarity index 70% rename from lib/node_modules/@stdlib/math/base/special/gammaln/docs/types/index.d.ts rename to lib/node_modules/@stdlib/math/base/special/absgammaln/docs/types/index.d.ts index 9d092feaabff..6df20be3473c 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/docs/types/index.d.ts @@ -19,42 +19,42 @@ // TypeScript Version: 4.1 /** -* Evaluates the natural logarithm of the gamma function. +* Evaluates the natural logarithm of the absolute value of the gamma function for a double-precision floating-point number. * * @param x - input value * @returns function value * * @example -* var v = gammaln( 1.0 ); +* var v = absgammaln( 1.0 ); * // returns 0.0 * * @example -* var v = gammaln( 2.0 ); +* var v = absgammaln( 2.0 ); * // returns 0.0 * * @example -* var v = gammaln( 4.0 ); +* var v = absgammaln( 4.0 ); * // returns ~1.792 * * @example -* var v = gammaln( -0.5 ); +* var v = absgammaln( -0.5 ); * // returns ~1.266 * * @example -* var v = gammaln( 0.5 ); +* var v = absgammaln( 0.5 ); * // returns ~0.572 * * @example -* var v = gammaln( 0.0 ); +* var v = absgammaln( 0.0 ); * // returns Infinity * * @example -* var v = gammaln( NaN ); +* var v = absgammaln( NaN ); * // returns NaN */ -declare function gammaln( x: number ): number; +declare function absgammaln( x: number ): number; // EXPORTS // -export = gammaln; +export = absgammaln; diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/absgammaln/docs/types/test.ts similarity index 66% rename from lib/node_modules/@stdlib/math/base/special/gammaln/docs/types/test.ts rename to lib/node_modules/@stdlib/math/base/special/absgammaln/docs/types/test.ts index 6d134035327d..45ac23d5fc9f 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/docs/types/test.ts +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/docs/types/test.ts @@ -16,29 +16,29 @@ * limitations under the License. */ -import gammaln = require( './index' ); +import absgammaln = require( './index' ); // TESTS // // The function returns a number... { - gammaln( 8 ); // $ExpectType number + absgammaln( 8 ); // $ExpectType number } // The compiler throws an error if the function is provided a value other than a number... { - gammaln( true ); // $ExpectError - gammaln( false ); // $ExpectError - gammaln( null ); // $ExpectError - gammaln( undefined ); // $ExpectError - gammaln( '5' ); // $ExpectError - gammaln( [] ); // $ExpectError - gammaln( {} ); // $ExpectError - gammaln( ( x: number ): number => x ); // $ExpectError + absgammaln( true ); // $ExpectError + absgammaln( false ); // $ExpectError + absgammaln( null ); // $ExpectError + absgammaln( undefined ); // $ExpectError + absgammaln( '5' ); // $ExpectError + absgammaln( [] ); // $ExpectError + absgammaln( {} ); // $ExpectError + absgammaln( ( x: number ): number => x ); // $ExpectError } // The compiler throws an error if the function is provided insufficient arguments... { - gammaln(); // $ExpectError + absgammaln(); // $ExpectError } diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/absgammaln/examples/c/Makefile similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/examples/c/Makefile rename to lib/node_modules/@stdlib/math/base/special/absgammaln/examples/c/Makefile diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/absgammaln/examples/c/example.c similarity index 84% rename from lib/node_modules/@stdlib/math/base/special/gammaln/examples/c/example.c rename to lib/node_modules/@stdlib/math/base/special/absgammaln/examples/c/example.c index e6825b98b96f..2f34a2c75cf5 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/examples/c/example.c +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/examples/c/example.c @@ -16,7 +16,7 @@ * limitations under the License. */ -#include "stdlib/math/base/special/gammaln.h" +#include "stdlib/math/base/special/absgammaln.h" #include int main( void ) { @@ -25,7 +25,7 @@ int main( void ) { double y; int i; for ( i = 0; i < 4; i++ ) { - y = stdlib_base_gammaln( x[ i ] ); - printf( "gammaln(%lf) = %lf\n", x[ i ], y ); + y = stdlib_base_absgammaln( x[ i ] ); + printf( "absgammaln(%lf) = %lf\n", x[ i ], y ); } } diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/examples/index.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/examples/index.js similarity index 89% rename from lib/node_modules/@stdlib/math/base/special/gammaln/examples/index.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/examples/index.js index d02d37c9e7cd..e355166a8b62 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/examples/index.js @@ -20,11 +20,11 @@ var uniform = require( '@stdlib/random/array/uniform' ); var logEachMap = require( '@stdlib/console/log-each-map' ); -var gammaln = require( './../lib' ); +var absgammaln = require( './../lib' ); var opts = { 'dtype': 'float64' }; var x = uniform( 100, -10.0, 10.0, opts ); -logEachMap( 'x: %0.4f, f(x): %0.4f', x, gammaln ); +logEachMap( 'x: %0.4f, f(x): %0.4f', x, absgammaln ); diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/include.gypi b/lib/node_modules/@stdlib/math/base/special/absgammaln/include.gypi similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/include.gypi rename to lib/node_modules/@stdlib/math/base/special/absgammaln/include.gypi diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/include/stdlib/math/base/special/gammaln.h b/lib/node_modules/@stdlib/math/base/special/absgammaln/include/stdlib/math/base/special/absgammaln.h similarity index 72% rename from lib/node_modules/@stdlib/math/base/special/gammaln/include/stdlib/math/base/special/gammaln.h rename to lib/node_modules/@stdlib/math/base/special/absgammaln/include/stdlib/math/base/special/absgammaln.h index c63383772946..c67e9a9ed936 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/include/stdlib/math/base/special/gammaln.h +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/include/stdlib/math/base/special/absgammaln.h @@ -16,8 +16,8 @@ * limitations under the License. */ -#ifndef STDLIB_MATH_BASE_SPECIAL_GAMMALN_H -#define STDLIB_MATH_BASE_SPECIAL_GAMMALN_H +#ifndef STDLIB_MATH_BASE_SPECIAL_ABSGAMMALN_H +#define STDLIB_MATH_BASE_SPECIAL_ABSGAMMALN_H /* * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. @@ -27,12 +27,12 @@ extern "C" { #endif /** -* Evaluates the natural logarithm of the gamma function. +* Evaluates the natural logarithm of the absolute value of the gamma function for a double-precision floating-point number. */ -double stdlib_base_gammaln( const double x ); +double stdlib_base_absgammaln( const double x ); #ifdef __cplusplus } #endif -#endif // !STDLIB_MATH_BASE_SPECIAL_GAMMALN_H +#endif // !STDLIB_MATH_BASE_SPECIAL_ABSGAMMALN_H diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/index.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/index.js similarity index 68% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/index.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/index.js index 4bda03ce7081..8046bf6c4752 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/index.js @@ -19,32 +19,32 @@ 'use strict'; /** -* Evaluate the natural logarithm of the gamma function. +* Evaluate the natural logarithm of the absolute value of the gamma function for a double-precision floating-point number. * -* @module @stdlib/math/base/special/gammaln +* @module @stdlib/math/base/special/absgammaln * * @example -* var gammaln = require( '@stdlib/math/base/special/gammaln' ); +* var absgammaln = require( '@stdlib/math/base/special/absgammaln' ); * -* var v = gammaln( 1.0 ); +* var v = absgammaln( 1.0 ); * // returns 0.0 * -* v = gammaln( 2.0 ); +* v = absgammaln( 2.0 ); * // returns 0.0 * -* v = gammaln( 4.0 ); +* v = absgammaln( 4.0 ); * // returns ~1.792 * -* v = gammaln( -0.5 ); +* v = absgammaln( -0.5 ); * // returns ~1.266 * -* v = gammaln( 0.5 ); +* v = absgammaln( 0.5 ); * // returns ~0.572 * -* v = gammaln( 0.0 ); +* v = absgammaln( 0.0 ); * // returns Infinity * -* v = gammaln( NaN ); +* v = absgammaln( NaN ); * // returns NaN */ diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/main.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/main.js similarity index 95% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/main.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/main.js index 1875af9333dc..1ea1facd81e9 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/main.js @@ -78,7 +78,7 @@ var TT = -3.63867699703950536541e-18; // 0xBC50C7CAA48A971F => TT = -(tail of TF // MAIN // /** -* Evaluates the natural logarithm of the gamma function. +* Evaluates the natural logarithm of the absolute value of the gamma function for a double-precision floating-point number. * * ## Method * @@ -213,34 +213,34 @@ var TT = -3.63867699703950536541e-18; // 0xBC50C7CAA48A971F => TT = -(tail of TF * @returns {number} function value * * @example -* var v = gammaln( 1.0 ); +* var v = absgammaln( 1.0 ); * // returns 0.0 * * @example -* var v = gammaln( 2.0 ); +* var v = absgammaln( 2.0 ); * // returns 0.0 * * @example -* var v = gammaln( 4.0 ); +* var v = absgammaln( 4.0 ); * // returns ~1.792 * * @example -* var v = gammaln( -0.5 ); +* var v = absgammaln( -0.5 ); * // returns ~1.266 * * @example -* var v = gammaln( 0.5 ); +* var v = absgammaln( 0.5 ); * // returns ~0.572 * * @example -* var v = gammaln( 0.0 ); +* var v = absgammaln( 0.0 ); * // returns Infinity * * @example -* var v = gammaln( NaN ); +* var v = absgammaln( NaN ); * // returns NaN */ -function gammaln( x ) { +function absgammaln( x ) { var isNegative; var nadj; var flg; @@ -358,7 +358,7 @@ function gammaln( x ) { p = y * (SC + (y*polyvalS( y ))); q = RC + (y*polyvalR( y )); r = (0.5*y) + (p/q); - z = 1.0; // gammaln(1+s) = ln(s) + gammaln(s) + z = 1.0; // absgammaln(1+s) = ln(s) + absgammaln(s) switch ( flg ) { // eslint-disable-line default-case case 7: z *= y + 6.0; @@ -402,4 +402,4 @@ function gammaln( x ) { // EXPORTS // -module.exports = gammaln; +module.exports = absgammaln; diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/native.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/native.js similarity index 73% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/native.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/native.js index 962c61b10140..f274744ae16c 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/native.js @@ -26,45 +26,45 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the natural logarithm of the gamma function. +* Evaluates the natural logarithm of the absolute value of the gamma function for a double-precision floating-point number. * * @private * @param {number} x - input value * @returns {number} function value * * @example -* var v = gammaln( 1.0 ); +* var v = absgammaln( 1.0 ); * // returns 0.0 * * @example -* var v = gammaln( 2.0 ); +* var v = absgammaln( 2.0 ); * // returns 0.0 * * @example -* var v = gammaln( 4.0 ); +* var v = absgammaln( 4.0 ); * // returns ~1.792 * * @example -* var v = gammaln( -0.5 ); +* var v = absgammaln( -0.5 ); * // returns ~1.266 * * @example -* var v = gammaln( 0.5 ); +* var v = absgammaln( 0.5 ); * // returns ~0.572 * * @example -* var v = gammaln( 0.0 ); +* var v = absgammaln( 0.0 ); * // returns Infinity * * @example -* var v = gammaln( NaN ); +* var v = absgammaln( NaN ); * // returns NaN */ -function gammaln( x ) { +function absgammaln( x ) { return addon( x ); } // EXPORTS // -module.exports = gammaln; +module.exports = absgammaln; diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_a1.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_a1.js similarity index 96% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_a1.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_a1.js index ac2694d47a75..087229c23151 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_a1.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_a1.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_a2.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_a2.js similarity index 96% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_a2.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_a2.js index eb2508895247..f14a76ec845f 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_a2.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_a2.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_r.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_r.js similarity index 96% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_r.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_r.js index 26b94f1ee192..9668daabbb44 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_r.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_r.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_s.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_s.js similarity index 96% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_s.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_s.js index 1df93401c3e9..ef9876b2992f 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_s.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_s.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_t1.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_t1.js similarity index 96% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_t1.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_t1.js index ca2c1f4a5082..78100e70e14a 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_t1.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_t1.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_t2.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_t2.js similarity index 96% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_t2.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_t2.js index b340af8be842..dc1fff68a6ec 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_t2.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_t2.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_t3.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_t3.js similarity index 96% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_t3.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_t3.js index 002cce134253..709cdf906668 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_t3.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_t3.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_u.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_u.js similarity index 96% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_u.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_u.js index 3e63b1634e84..0c083f527cb8 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_u.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_u.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_v.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_v.js similarity index 96% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_v.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_v.js index 96fff3e6975b..bab17ad8c55b 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_v.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_v.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_w.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_w.js similarity index 97% rename from lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_w.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_w.js index 52066128a4eb..8061d22e4fa1 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/lib/polyval_w.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/lib/polyval_w.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/manifest.json b/lib/node_modules/@stdlib/math/base/special/absgammaln/manifest.json similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/manifest.json rename to lib/node_modules/@stdlib/math/base/special/absgammaln/manifest.json diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/package.json b/lib/node_modules/@stdlib/math/base/special/absgammaln/package.json similarity index 83% rename from lib/node_modules/@stdlib/math/base/special/gammaln/package.json rename to lib/node_modules/@stdlib/math/base/special/absgammaln/package.json index fddf7a2a0fc5..db79d28e7c29 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/package.json +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/package.json @@ -1,7 +1,7 @@ { - "name": "@stdlib/math/base/special/gammaln", + "name": "@stdlib/math/base/special/absgammaln", "version": "0.0.0", - "description": "Natural logarithm of the gamma function.", + "description": "Natural logarithm of the absolute value of the gamma function for a double-precision floating-point number.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", @@ -63,6 +63,7 @@ "gamma", "factorial", "natural", + "absolute", "logarithm", "log", "ln", @@ -72,11 +73,11 @@ "__stdlib__": { "scaffold": { "$schema": "math/base@v1.0", - "base_alias": "gammaln", - "alias": "gammaln", - "pkg_desc": "evaluate the natural logarithm of the gamma function", - "desc": "evaluates the natural logarithm of the gamma function", - "short_desc": "natural logarithm of the gamma function", + "base_alias": "absgammaln", + "alias": "absgammaln", + "pkg_desc": "evaluate the natural logarithm of the absolute value of the gamma function", + "desc": "evaluates the natural logarithm of the absolute value of the gamma function", + "short_desc": "natural logarithm of the absolute value of the gamma function", "parameters": [ { "name": "x", @@ -138,6 +139,7 @@ "gamma", "factorial", "natural", + "absolute", "logarithm", "log", "ln", diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/scripts/evalpoly.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/scripts/evalpoly.js similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/scripts/evalpoly.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/scripts/evalpoly.js diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/src/Makefile b/lib/node_modules/@stdlib/math/base/special/absgammaln/src/Makefile similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/src/Makefile rename to lib/node_modules/@stdlib/math/base/special/absgammaln/src/Makefile diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/src/addon.c b/lib/node_modules/@stdlib/math/base/special/absgammaln/src/addon.c similarity index 85% rename from lib/node_modules/@stdlib/math/base/special/gammaln/src/addon.c rename to lib/node_modules/@stdlib/math/base/special/absgammaln/src/addon.c index 71e5d2e88764..74c1e45f607b 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/src/addon.c +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/src/addon.c @@ -16,7 +16,7 @@ * limitations under the License. */ -#include "stdlib/math/base/special/gammaln.h" +#include "stdlib/math/base/special/absgammaln.h" #include "stdlib/math/base/napi/unary.h" -STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_gammaln ) +STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_absgammaln ) diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/src/main.c b/lib/node_modules/@stdlib/math/base/special/absgammaln/src/main.c similarity index 97% rename from lib/node_modules/@stdlib/math/base/special/gammaln/src/main.c rename to lib/node_modules/@stdlib/math/base/special/absgammaln/src/main.c index 0005d74900fb..01209d783540 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/src/main.c @@ -30,7 +30,7 @@ * ``` */ -#include "stdlib/math/base/special/gammaln.h" +#include "stdlib/math/base/special/absgammaln.h" #include "stdlib/math/base/assert/is_nan.h" #include "stdlib/math/base/assert/is_infinite.h" #include "stdlib/math/base/special/abs.h" @@ -264,7 +264,7 @@ static double polyval_w( const double x ) { /* End auto-generated functions. */ /** -* Evaluates the natural logarithm of the gamma function. +* Evaluates the natural logarithm of the absolute value of the gamma function for a double-precision floating-point number. * * ## Method * @@ -399,10 +399,10 @@ static double polyval_w( const double x ) { * @return function value * * @example -* double out = stdlib_base_gammaln( 1.0 ); +* double out = stdlib_base_absgammaln( 1.0 ); * // returns 0.0 */ -double stdlib_base_gammaln( const double x ) { +double stdlib_base_absgammaln( const double x ) { uint8_t isNegative; int32_t flg; double nadj; @@ -512,7 +512,7 @@ double stdlib_base_gammaln( const double x ) { p = y * ( SC + ( y * polyval_s( y ) ) ); q = RC + ( y * polyval_r( y ) ); r = ( 0.5 * y ) + ( p / q ); - z = 1.0; // gammaln(1+s) = ln(s) + gammaln(s) + z = 1.0; // absgammaln(1+s) = ln(s) + absgammaln(s) switch ( flg ) { case 7: z *= y + 6.0; diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/DESCRIPTION b/lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/DESCRIPTION similarity index 84% rename from lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/DESCRIPTION rename to lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/DESCRIPTION index cb3929d04963..4ede445a3a55 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/DESCRIPTION +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/DESCRIPTION @@ -1,4 +1,4 @@ -Package: gammaln-test-fixtures +Package: absgammaln-test-fixtures Title: Test Fixtures Version: 0.0.0 Authors@R: person("stdlib", "js", role = c("aut","cre")) diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/data1.json b/lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/data1.json similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/data1.json rename to lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/data1.json diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/data2.json b/lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/data2.json similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/data2.json rename to lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/data2.json diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/expected1.json b/lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/expected1.json similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/expected1.json rename to lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/expected1.json diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/expected2.json b/lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/expected2.json similarity index 100% rename from lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/expected2.json rename to lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/expected2.json diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/runner.R b/lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/runner.R similarity index 75% rename from lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/runner.R rename to lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/runner.R index 337a2d6c7dbc..1f4c5028457e 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/test/fixtures/r/runner.R +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/test/fixtures/r/runner.R @@ -32,19 +32,19 @@ main <- function() { #' filepath <- get_script_path(); get_script_path <- function() { args <- commandArgs( trailingOnly = FALSE ); - needle <- "--file="; + needle <- '--file='; match <- grep( needle, args ); - if ( length( match ) > 0 ) { + if ( length( match ) > 0.0 ) { # Rscript: - filepath <- sub( needle, "", args[match] ); + filepath <- sub( needle, '', args[match] ); } else { - ls_vars <- ls( sys.frames()[[1]] ) - if ( "fileName" %in% ls_vars ) { + ls_vars <- ls( sys.frames()[[1L]] ) + if ( 'fileName' %in% ls_vars ) { # Source'd via RStudio: - filepath <- sys.frames()[[1]]$fileName; # nolint + filepath <- sys.frames()[[1L]][['fileName']]; # nolint } else { # Source'd via R console: - filepath <- sys.frames()[[1]]$ofile; + filepath <- sys.frames()[[1L]][['ofile']]; } } return( normalizePath( filepath ) ); @@ -59,7 +59,7 @@ main <- function() { #' x <- seq( -6.5, 25, 0.5 ); #' json <- to_json( x ); to_json <- function( x ) { - return( jsonlite::toJSON( x, digits = 16, auto_unbox = TRUE ) ); + return( jsonlite::toJSON( x, digits = 16L, auto_unbox = TRUE ) ); } #' Generate an output absolute filepath based on the script directory. @@ -70,47 +70,47 @@ main <- function() { #' @examples #' filepath <- get_filepath( "data.json" ); get_filepath <- function( name ) { - return( paste( source_dir, "/", name, sep = "" ) ); + return( paste( source_dir, '/', name, sep = '' ) ); } # Get the directory of this script: source_dir <- dirname( get_script_path() ); # Generate integer test data: - x <- seq( 1, 171, 1 ); + x <- seq( 1L, 171L, 1L ); y <- lgamma( x ); # Deal with NaNs: - cat( y, sep = ",\n" ); + cat( y, sep = ',\n' ); # Convert fixture data to JSON: x <- to_json( x ); y <- to_json( y ); # Write the data to file... - filepath <- get_filepath( "data1.json" ); + filepath <- get_filepath( 'data1.json' ); write( x, filepath ); - filepath <- get_filepath( "expected1.json" ); + filepath <- get_filepath( 'expected1.json' ); write( y, filepath ); # Generate decimal test data: - x <- seq( -170.55, 170.5, length.out = 1000 ) + x <- seq( -170.55, 170.5, length.out = 1000L ) y <- lgamma( x ) # Deal with NaNs: - cat( y, sep = ",\n" ); + cat( y, sep = ',\n' ); # Convert fixture data to JSON: x <- to_json( x ); y <- to_json( y ); # Write the data to file... - filepath <- get_filepath( "data2.json" ); + filepath <- get_filepath( 'data2.json' ); write( x, filepath ); - filepath <- get_filepath( "expected2.json" ); + filepath <- get_filepath( 'expected2.json' ); write( y, filepath ); } diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/test/test.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/test/test.js similarity index 86% rename from lib/node_modules/@stdlib/math/base/special/gammaln/test/test.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/test/test.js index b709027ea84b..2f7c8e3f57b9 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/test/test.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/test/test.js @@ -28,7 +28,7 @@ var pow = require( '@stdlib/math/base/special/pow' ); var PINF = require( '@stdlib/constants/float64/pinf' ); var NINF = require( '@stdlib/constants/float64/ninf' ); var EPS = require( '@stdlib/constants/float64/eps' ); -var gammaln = require( './../lib' ); +var absgammaln = require( './../lib' ); // FIXTURES // @@ -43,34 +43,34 @@ var expected2 = require( './fixtures/r/expected2.json' ); tape( 'main export is a function', function test( t ) { t.ok( true, __filename ); - t.strictEqual( typeof gammaln, 'function', 'main export is a function' ); + t.strictEqual( typeof absgammaln, 'function', 'main export is a function' ); t.end(); }); tape( 'if provided `NaN`, the function returns `NaN`', function test( t ) { - var v = gammaln( NaN ); + var v = absgammaln( NaN ); t.strictEqual( isnan( v ), true, 'returns expected value' ); t.end(); }); tape( 'the function returns `infinity` when provided `infinity`', function test( t ) { - var v = gammaln( PINF ); + var v = absgammaln( PINF ); t.strictEqual( v, PINF, 'returns expected value' ); - v = gammaln( NINF ); + v = absgammaln( NINF ); t.strictEqual( v, NINF, 'returns expected value' ); t.end(); }); tape( 'the function returns `+infinity` when provided `0`', function test( t ) { - var v = gammaln( 0.0 ); + var v = absgammaln( 0.0 ); t.strictEqual( v, PINF, 'returns expected value' ); t.end(); }); tape( 'the function returns `+infinity` for x smaller than `-2^52`', function test( t ) { - var v = gammaln( -pow( 2.0, 53 ) ); + var v = absgammaln( -pow( 2.0, 53 ) ); t.strictEqual( v, PINF, 'returns expected value' ); t.end(); }); @@ -80,7 +80,7 @@ tape( 'the function returns `-ln(x)` for very small x', function test( t ) { var v; x = 2.0e-90; - v = gammaln( x ); + v = absgammaln( x ); t.strictEqual( v, -ln( x ), 'returns expected value' ); t.end(); @@ -98,7 +98,7 @@ tape( 'the function evaluates the natural logarithm of the gamma function (posit expected = expected1; for ( i = 0; i < x.length; i++ ) { - y = gammaln( x[ i ] ); + y = absgammaln( x[ i ] ); if ( y === expected[ i ] ) { t.strictEqual( y, expected[ i ], 'x: '+x[i]+'. Expected: '+expected[i] ); } else { @@ -122,7 +122,7 @@ tape( 'the function evaluates the natural logarithm of the gamma function (decim expected = expected2; for ( i = 0; i < x.length; i++ ) { - y = gammaln( x[ i ] ); + y = absgammaln( x[ i ] ); if ( y === expected[ i ] ) { t.strictEqual( y, expected[ i ], 'x: '+x[i]+'. Expected: '+expected[i] ); } else { @@ -139,21 +139,21 @@ tape( 'the function evaluates the natural logarithm of the gamma function for x var v; x = pow( 2.0, 59 ); - v = gammaln( x ); + v = absgammaln( x ); t.strictEqual( v, x * (ln(x)-1.0), 'returns x*(ln(x)-1) for x>2^58' ); t.end(); }); tape( 'if provided a positive integer, the function returns the natural logarithm of the factorial of (n-1)', function test( t ) { - t.strictEqual( gammaln( 4.0 ), ln(6.0), 'returns ln(6)' ); - t.strictEqual( gammaln( 5.0 ), ln(24.0), 'returns ln(24)' ); - t.strictEqual( gammaln( 6.0 ), ln(120.0), 'returns ln(120)' ); + t.strictEqual( absgammaln( 4.0 ), ln(6.0), 'returns ln(6)' ); + t.strictEqual( absgammaln( 5.0 ), ln(24.0), 'returns ln(24)' ); + t.strictEqual( absgammaln( 6.0 ), ln(120.0), 'returns ln(120)' ); t.end(); }); tape( 'returns `+infinity` for `x=-2^51`', function test( t ) { - var v = gammaln( -pow( 2.0, 51 ) ); + var v = absgammaln( -pow( 2.0, 51 ) ); t.strictEqual( v, PINF, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/math/base/special/gammaln/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/absgammaln/test/test.native.js similarity index 85% rename from lib/node_modules/@stdlib/math/base/special/gammaln/test/test.native.js rename to lib/node_modules/@stdlib/math/base/special/absgammaln/test/test.native.js index bef227c0baa5..36d63bca8b65 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaln/test/test.native.js +++ b/lib/node_modules/@stdlib/math/base/special/absgammaln/test/test.native.js @@ -42,9 +42,9 @@ var expected2 = require( './fixtures/r/expected2.json' ); // VARIABLES // -var gammaln = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var absgammaln = tryRequire( resolve( __dirname, './../lib/native.js' ) ); var opts = { - 'skip': ( gammaln instanceof Error ) + 'skip': ( absgammaln instanceof Error ) }; @@ -52,34 +52,34 @@ var opts = { tape( 'main export is a function', opts, function test( t ) { t.ok( true, __filename ); - t.strictEqual( typeof gammaln, 'function', 'main export is a function' ); + t.strictEqual( typeof absgammaln, 'function', 'main export is a function' ); t.end(); }); tape( 'if provided `NaN`, the function returns `NaN`', opts, function test( t ) { - var v = gammaln( NaN ); + var v = absgammaln( NaN ); t.strictEqual( isnan( v ), true, 'returns expected value' ); t.end(); }); tape( 'the function returns `infinity` when provided `infinity`', opts, function test( t ) { - var v = gammaln( PINF ); + var v = absgammaln( PINF ); t.strictEqual( v, PINF, 'returns expected value' ); - v = gammaln( NINF ); + v = absgammaln( NINF ); t.strictEqual( v, NINF, 'returns expected value' ); t.end(); }); tape( 'the function returns `+infinity` when provided `0`', opts, function test( t ) { - var v = gammaln( 0.0 ); + var v = absgammaln( 0.0 ); t.strictEqual( v, PINF, 'returns expected value' ); t.end(); }); tape( 'the function returns `+infinity` for x smaller than `-2^52`', opts, function test( t ) { - var v = gammaln( -pow( 2.0, 53 ) ); + var v = absgammaln( -pow( 2.0, 53 ) ); t.strictEqual( v, PINF, 'returns expected value' ); t.end(); }); @@ -89,7 +89,7 @@ tape( 'the function returns `-ln(x)` for very small x', opts, function test( t ) var v; x = 2.0e-90; - v = gammaln( x ); + v = absgammaln( x ); t.strictEqual( v, -ln( x ), 'returns expected value' ); t.end(); @@ -107,7 +107,7 @@ tape( 'the function evaluates the natural logarithm of the gamma function (posit expected = expected1; for ( i = 0; i < x.length; i++ ) { - y = gammaln( x[ i ] ); + y = absgammaln( x[ i ] ); if ( y === expected[ i ] ) { t.strictEqual( y, expected[ i ], 'x: '+x[i]+'. Expected: '+expected[i] ); } else { @@ -131,7 +131,7 @@ tape( 'the function evaluates the natural logarithm of the gamma function (decim expected = expected2; for ( i = 0; i < x.length; i++ ) { - y = gammaln( x[ i ] ); + y = absgammaln( x[ i ] ); if ( y === expected[ i ] ) { t.strictEqual( y, expected[ i ], 'x: '+x[i]+'. Expected: '+expected[i] ); } else { @@ -148,21 +148,21 @@ tape( 'the function evaluates the natural logarithm of the gamma function for x var v; x = pow( 2.0, 59 ); - v = gammaln( x ); + v = absgammaln( x ); t.strictEqual( v, x * (ln(x)-1.0), 'returns x*(ln(x)-1) for x>2^58' ); t.end(); }); tape( 'if provided a positive integer, the function returns the natural logarithm of the factorial of (n-1)', opts, function test( t ) { - t.strictEqual( gammaln( 4.0 ), ln(6.0), 'returns ln(6)' ); - t.strictEqual( gammaln( 5.0 ), ln(24.0), 'returns ln(24)' ); - t.strictEqual( gammaln( 6.0 ), ln(120.0), 'returns ln(120)' ); + t.strictEqual( absgammaln( 4.0 ), ln(6.0), 'returns ln(6)' ); + t.strictEqual( absgammaln( 5.0 ), ln(24.0), 'returns ln(24)' ); + t.strictEqual( absgammaln( 6.0 ), ln(120.0), 'returns ln(120)' ); t.end(); }); tape( 'returns `+infinity` for `x=-2^51`', opts, function test( t ) { - var v = gammaln( -pow( 2.0, 51 ) ); + var v = absgammaln( -pow( 2.0, 51 ) ); t.strictEqual( v, PINF, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts index dc0fbb78daef..3cbbdbaf938b 100644 --- a/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts @@ -204,7 +204,6 @@ import gammaLanczosSumExpgScaledf = require( '@stdlib/math/base/special/gamma-la import gamma1pm1 = require( '@stdlib/math/base/special/gamma1pm1' ); import gammainc = require( '@stdlib/math/base/special/gammainc' ); import gammaincinv = require( '@stdlib/math/base/special/gammaincinv' ); -import gammaln = require( '@stdlib/math/base/special/gammaln' ); import gammasgn = require( '@stdlib/math/base/special/gammasgn' ); import gammasgnf = require( '@stdlib/math/base/special/gammasgnf' ); import gcd = require( '@stdlib/math/base/special/gcd' ); @@ -5585,42 +5584,6 @@ interface Namespace { */ gammaincinv: typeof gammaincinv; - /** - * Evaluates the natural logarithm of the gamma function. - * - * @param x - input value - * @returns function value - * - * @example - * var v = ns.gammaln( 1.0 ); - * // returns 0.0 - * - * @example - * var v = ns.gammaln( 2.0 ); - * // returns 0.0 - * - * @example - * var v = ns.gammaln( 4.0 ); - * // returns ~1.792 - * - * @example - * var v = ns.gammaln( -0.5 ); - * // returns ~1.266 - * - * @example - * var v = ns.gammaln( 0.5 ); - * // returns ~0.572 - * - * @example - * var v = ns.gammaln( 0.0 ); - * // returns Infinity - * - * @example - * var v = ns.gammaln( NaN ); - * // returns NaN - */ - gammaln: typeof gammaln; - /** * Computes the sign of the gamma function. * diff --git a/lib/node_modules/@stdlib/math/base/special/lib/index.js b/lib/node_modules/@stdlib/math/base/special/lib/index.js index 4d2281574fe3..8afdcdbc4bff 100644 --- a/lib/node_modules/@stdlib/math/base/special/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/lib/index.js @@ -1694,15 +1694,6 @@ setReadOnly( special, 'gammainc', require( '@stdlib/math/base/special/gammainc' */ setReadOnly( special, 'gammaincinv', require( '@stdlib/math/base/special/gammaincinv' ) ); -/** -* @name gammaln -* @memberof special -* @readonly -* @type {Function} -* @see {@link module:@stdlib/math/base/special/gammaln} -*/ -setReadOnly( special, 'gammaln', require( '@stdlib/math/base/special/gammaln' ) ); - /** * @name gammasgn * @memberof special