diff --git a/CHANGELOG.md b/CHANGELOG.md index 9d054fd49..15351e4bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2853,6 +2853,28 @@ This release closes the following issue: +
+ +#### [@stdlib/math/base/special/factorial](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/factorial) + +
+ +
+ +##### Features + +- [`cc98b20`](https://github.com/stdlib-js/stdlib/commit/cc98b20ab91590c526896d547e447f107fc714aa) - add C implementation for `math/base/special/factorial` [(##2618)](#2618 ) + +
+ + + +
+ +
+ + +
#### [@stdlib/math/base/special/factorial2](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/factorial2) @@ -5198,6 +5220,7 @@ A total of 29 people contributed to this release. Thank you to the following con
+- [`cc98b20`](https://github.com/stdlib-js/stdlib/commit/cc98b20ab91590c526896d547e447f107fc714aa) - **feat:** add C implementation for `math/base/special/factorial` [(##2618)](#2618 ) _(by Gunj Joshi)_ - [`1f99cd7`](https://github.com/stdlib-js/stdlib/commit/1f99cd7f06bd5e3027f29c6d816ea39e8624cab1) - **feat:** add C implementation for `math/base/special/floor10` [(##2619)](#2619) _(by Gunj Joshi)_ - [`0d796b2`](https://github.com/stdlib-js/stdlib/commit/0d796b2a86fe0a08d1f3ed1827aaf2ce355f9b4f) - **refactor:** use stdlib APIs and adjust test tolerances _(by Athan Reines)_ - [`d6c4251`](https://github.com/stdlib-js/stdlib/commit/d6c4251492f60d2a3871e679fb67a35c57973056) - **feat:** add C implementation for `math/base/special/sinpi` [(##2610)](#2610) _(by Gunj Joshi)_ diff --git a/base/special/factorial/README.md b/base/special/factorial/README.md index df62c86b6..3b3cec527 100644 --- a/base/special/factorial/README.md +++ b/base/special/factorial/README.md @@ -151,6 +151,94 @@ for ( i = 0; i < x.length; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/factorial.h" +``` + +#### stdlib_base_factorial( x ) + +Evaluates the [factorial][factorial-function] function. + +```c +double out = stdlib_base_factorial( 3.0 ); +// returns 6.0 + +out = stdlib_base_factorial( -1.5 ); +// returns ~-3.545 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +double stdlib_base_factorial( const double n ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/factorial.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_factorial( x[ i ] ); + printf( "factorial(%lf) = %lf\n", x[ i ], y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/base/special/factorial/benchmark/benchmark.native.js b/base/special/factorial/benchmark/benchmark.native.js new file mode 100644 index 000000000..e70ace7aa --- /dev/null +++ b/base/special/factorial/benchmark/benchmark.native.js @@ -0,0 +1,76 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var isnan = require( './../../../../base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var factorial = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( factorial instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native,integers', opts, function benchmark( b ) { + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = factorial( i % 171 ); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::native,decimals', opts, function benchmark( b ) { + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = factorial( ( i % 171 ) * 0.68163 ); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/base/special/factorial/benchmark/c/native/Makefile b/base/special/factorial/benchmark/c/native/Makefile new file mode 100644 index 000000000..f69e9da2b --- /dev/null +++ b/base/special/factorial/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/base/special/factorial/benchmark/c/native/benchmark.c b/base/special/factorial/benchmark/c/native/benchmark.c new file mode 100644 index 000000000..410fa43d8 --- /dev/null +++ b/base/special/factorial/benchmark/c/native/benchmark.c @@ -0,0 +1,136 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/** +* Benchmark `factorial`. +*/ +#include "stdlib/math/base/special/factorial.h" +#include +#include +#include +#include +#include + +#define NAME "factorial" +#define ITERATIONS 100 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +void print_version() { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param elapsed elapsed time in seconds +*/ +void print_results( double elapsed ) { + double rate = (double)ITERATIONS / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", ITERATIONS ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +double tic() { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1]. +* +* @return random number +*/ +double rand_double() { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +double benchmark() { + double elapsed; + int32_t x; + double t; + double y; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + x = (int32_t)floor( 33.0 * rand_double() ); + y = stdlib_base_factorial( x ); + if ( y != y ) { + printf( "should return a nonnegative integer\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + printf( "should return a nonnegative integer\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::native::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/base/special/factorial/binding.gyp b/base/special/factorial/binding.gyp new file mode 100644 index 000000000..ec3992233 --- /dev/null +++ b/base/special/factorial/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/base/special/factorial/examples/c/Makefile b/base/special/factorial/examples/c/Makefile new file mode 100644 index 000000000..6aed70daf --- /dev/null +++ b/base/special/factorial/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/base/special/factorial/examples/c/example.c b/base/special/factorial/examples/c/example.c new file mode 100644 index 000000000..308e657d3 --- /dev/null +++ b/base/special/factorial/examples/c/example.c @@ -0,0 +1,31 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/factorial.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_factorial( x[ i ] ); + printf( "factorial(%lf) = %lf\n", x[ i ], y ); + } +} diff --git a/base/special/factorial/include.gypi b/base/special/factorial/include.gypi new file mode 100644 index 000000000..575cb043c --- /dev/null +++ b/base/special/factorial/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + ' + +/* +* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. +*/ +#ifdef __cplusplus +extern "C" { +#endif + +/** +* Evaluates the factorial of `x`. +*/ +double stdlib_base_factorial( const double x ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_MATH_BASE_SPECIAL_FACTORIAL_H diff --git a/base/special/factorial/lib/native.js b/base/special/factorial/lib/native.js new file mode 100644 index 000000000..3c4428784 --- /dev/null +++ b/base/special/factorial/lib/native.js @@ -0,0 +1,70 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Evaluates the factorial of `x`. +* +* @private +* @param {number} x - input value +* @returns {number} factorial +* +* @example +* var v = factorial( 3.0 ); +* // returns 6.0 +* +* @example +* var v = factorial( -1.5 ); +* // returns ~-3.545 +* +* @example +* var v = factorial( -0.5 ); +* // returns ~1.772 +* +* @example +* var v = factorial( 0.5 ); +* // returns ~0.886 +* +* @example +* var v = factorial( -10.0 ); +* // returns NaN +* +* @example +* var v = factorial( 171.0 ); +* // returns Infinity +* +* @example +* var v = factorial( NaN ); +* // returns NaN +*/ +function factorial( x ) { + return addon( x ); +} + + +// EXPORTS // + +module.exports = factorial; diff --git a/base/special/factorial/manifest.json b/base/special/factorial/manifest.json new file mode 100644 index 000000000..9473810a1 --- /dev/null +++ b/base/special/factorial/manifest.json @@ -0,0 +1,81 @@ +{ + "options": { + "task": "build" + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { + "task": "build", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/napi/unary", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-integer", + "@stdlib/math/base/special/gamma", + "@stdlib/constants/float64/pinf" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-integer", + "@stdlib/math/base/special/gamma", + "@stdlib/constants/float64/pinf" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/assert/is-integer", + "@stdlib/math/base/special/gamma", + "@stdlib/constants/float64/pinf" + ] + } + ] +} diff --git a/base/special/factorial/src/Makefile b/base/special/factorial/src/Makefile new file mode 100644 index 000000000..bcf18aa46 --- /dev/null +++ b/base/special/factorial/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/base/special/factorial/src/addon.c b/base/special/factorial/src/addon.c new file mode 100644 index 000000000..f3d7406fc --- /dev/null +++ b/base/special/factorial/src/addon.c @@ -0,0 +1,23 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/factorial.h" +#include "stdlib/math/base/napi/unary.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_factorial ) diff --git a/base/special/factorial/src/main.c b/base/special/factorial/src/main.c new file mode 100644 index 000000000..83cd7478a --- /dev/null +++ b/base/special/factorial/src/main.c @@ -0,0 +1,226 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/factorial.h" +#include "stdlib/math/base/assert/is_nan.h" +#include "stdlib/math/base/assert/is_integer.h" +#include "stdlib/math/base/special/gamma.h" +#include "stdlib/constants/float64/pinf.h" +#include + +static const double MAX_FACTORIAL = 170.0; +static const double FACTORIALS[ 171 ] = { + 1.0, + 1.0, + 2.0, + 6.0, + 24.0, + 120.0, + 720.0, + 5040.0, + 40320.0, + 362880.0, + 3628800.0, + 39916800.0, + 479001600.0, + 6227020800.0, + 87178291200.0, + 1307674368000.0, + 20922789888000.0, + 355687428096000.0, + 6402373705728000.0, + 121645100408832000.0, + 0.243290200817664e19, + 0.5109094217170944e20, + 0.112400072777760768e22, + 0.2585201673888497664e23, + 0.62044840173323943936e24, + 0.15511210043330985984e26, + 0.403291461126605635584e27, + 0.10888869450418352160768e29, + 0.304888344611713860501504e30, + 0.8841761993739701954543616e31, + 0.26525285981219105863630848e33, + 0.822283865417792281772556288e34, + 0.26313083693369353016721801216e36, + 0.868331761881188649551819440128e37, + 0.29523279903960414084761860964352e39, + 0.103331479663861449296666513375232e41, + 0.3719933267899012174679994481508352e42, + 0.137637530912263450463159795815809024e44, + 0.5230226174666011117600072241000742912e45, + 0.203978820811974433586402817399028973568e47, + 0.815915283247897734345611269596115894272e48, + 0.3345252661316380710817006205344075166515e50, + 0.1405006117752879898543142606244511569936e52, + 0.6041526306337383563735513206851399750726e53, + 0.265827157478844876804362581101461589032e55, + 0.1196222208654801945619631614956577150644e57, + 0.5502622159812088949850305428800254892962e58, + 0.2586232415111681806429643551536119799692e60, + 0.1241391559253607267086228904737337503852e62, + 0.6082818640342675608722521633212953768876e63, + 0.3041409320171337804361260816606476884438e65, + 0.1551118753287382280224243016469303211063e67, + 0.8065817517094387857166063685640376697529e68, + 0.427488328406002556429801375338939964969e70, + 0.2308436973392413804720927426830275810833e72, + 0.1269640335365827592596510084756651695958e74, + 0.7109985878048634518540456474637249497365e75, + 0.4052691950487721675568060190543232213498e77, + 0.2350561331282878571829474910515074683829e79, + 0.1386831185456898357379390197203894063459e81, + 0.8320987112741390144276341183223364380754e82, + 0.507580213877224798800856812176625227226e84, + 0.3146997326038793752565312235495076408801e86, + 0.1982608315404440064116146708361898137545e88, + 0.1268869321858841641034333893351614808029e90, + 0.8247650592082470666723170306785496252186e91, + 0.5443449390774430640037292402478427526443e93, + 0.3647111091818868528824985909660546442717e95, + 0.2480035542436830599600990418569171581047e97, + 0.1711224524281413113724683388812728390923e99, + 0.1197857166996989179607278372168909873646e101, + 0.8504785885678623175211676442399260102886e102, + 0.6123445837688608686152407038527467274078e104, + 0.4470115461512684340891257138125051110077e106, + 0.3307885441519386412259530282212537821457e108, + 0.2480914081139539809194647711659403366093e110, + 0.188549470166605025498793226086114655823e112, + 0.1451830920282858696340707840863082849837e114, + 0.1132428117820629783145752115873204622873e116, + 0.8946182130782975286851441715398316520698e117, + 0.7156945704626380229481153372318653216558e119, + 0.5797126020747367985879734231578109105412e121, + 0.4753643337012841748421382069894049466438e123, + 0.3945523969720658651189747118012061057144e125, + 0.3314240134565353266999387579130131288001e127, + 0.2817104114380550276949479442260611594801e129, + 0.2422709538367273238176552320344125971528e131, + 0.210775729837952771721360051869938959523e133, + 0.1854826422573984391147968456455462843802e135, + 0.1650795516090846108121691926245361930984e137, + 0.1485715964481761497309522733620825737886e139, + 0.1352001527678402962551665687594951421476e141, + 0.1243841405464130725547532432587355307758e143, + 0.1156772507081641574759205162306240436215e145, + 0.1087366156656743080273652852567866010042e147, + 0.103299784882390592625997020993947270954e149, + 0.9916779348709496892095714015418938011582e150, + 0.9619275968248211985332842594956369871234e152, + 0.942689044888324774562618574305724247381e154, + 0.9332621544394415268169923885626670049072e156, + 0.9332621544394415268169923885626670049072e158, + 0.9425947759838359420851623124482936749562e160, + 0.9614466715035126609268655586972595484554e162, + 0.990290071648618040754671525458177334909e164, + 0.1029901674514562762384858386476504428305e167, + 0.1081396758240290900504101305800329649721e169, + 0.1146280563734708354534347384148349428704e171, + 0.1226520203196137939351751701038733888713e173, + 0.132464181945182897449989183712183259981e175, + 0.1443859583202493582204882102462797533793e177, + 0.1588245541522742940425370312709077287172e179, + 0.1762952551090244663872161047107075788761e181, + 0.1974506857221074023536820372759924883413e183, + 0.2231192748659813646596607021218715118256e185, + 0.2543559733472187557120132004189335234812e187, + 0.2925093693493015690688151804817735520034e189, + 0.339310868445189820119825609358857320324e191, + 0.396993716080872089540195962949863064779e193, + 0.4684525849754290656574312362808384164393e195, + 0.5574585761207605881323431711741977155627e197, + 0.6689502913449127057588118054090372586753e199, + 0.8094298525273443739681622845449350829971e201, + 0.9875044200833601362411579871448208012564e203, + 0.1214630436702532967576624324188129585545e206, + 0.1506141741511140879795014161993280686076e208, + 0.1882677176888926099743767702491600857595e210, + 0.237217324288004688567714730513941708057e212, + 0.3012660018457659544809977077527059692324e214, + 0.3856204823625804217356770659234636406175e216, + 0.4974504222477287440390234150412680963966e218, + 0.6466855489220473672507304395536485253155e220, + 0.8471580690878820510984568758152795681634e222, + 0.1118248651196004307449963076076169029976e225, + 0.1487270706090685728908450891181304809868e227, + 0.1992942746161518876737324194182948445223e229, + 0.269047270731805048359538766214698040105e231, + 0.3659042881952548657689727220519893345429e233, + 0.5012888748274991661034926292112253883237e235, + 0.6917786472619488492228198283114910358867e237, + 0.9615723196941089004197195613529725398826e239, + 0.1346201247571752460587607385894161555836e242, + 0.1898143759076170969428526414110767793728e244, + 0.2695364137888162776588507508037290267094e246, + 0.3854370717180072770521565736493325081944e248, + 0.5550293832739304789551054660550388118e250, + 0.80479260574719919448490292577980627711e252, + 0.1174997204390910823947958271638517164581e255, + 0.1727245890454638911203498659308620231933e257, + 0.2556323917872865588581178015776757943262e259, + 0.380892263763056972698595524350736933546e261, + 0.571338395644585459047893286526105400319e263, + 0.8627209774233240431623188626544191544816e265, + 0.1311335885683452545606724671234717114812e268, + 0.2006343905095682394778288746989117185662e270, + 0.308976961384735088795856467036324046592e272, + 0.4789142901463393876335775239063022722176e274, + 0.7471062926282894447083809372938315446595e276, + 0.1172956879426414428192158071551315525115e279, + 0.1853271869493734796543609753051078529682e281, + 0.2946702272495038326504339507351214862195e283, + 0.4714723635992061322406943211761943779512e285, + 0.7590705053947218729075178570936729485014e287, + 0.1229694218739449434110178928491750176572e290, + 0.2004401576545302577599591653441552787813e292, + 0.3287218585534296227263330311644146572013e294, + 0.5423910666131588774984495014212841843822e296, + 0.9003691705778437366474261723593317460744e298, + 0.1503616514864999040201201707840084015944e301, + 0.2526075744973198387538018869171341146786e303, + 0.4269068009004705274939251888899566538069e305, + 0.7257415615307998967396728211129263114717e307 +}; + + +/** +* Evaluates the factorial of `x`. +* +* @param x input value +* @return factorial +* +* @example +* double out = stdlib_base_factorial( 3.0 ); +* // returns 6.0 +*/ +double stdlib_base_factorial( const double x ) { + if ( stdlib_base_is_nan( x ) ) { + return 0.0 / 0.0; // NaN + } + if ( stdlib_base_is_integer( x ) ) { + if ( x < 0.0 ) { + return 0.0 / 0.0; // NaN + } + if ( x <= MAX_FACTORIAL ) { + return FACTORIALS[ (int32_t)x ]; + } + return STDLIB_CONSTANT_FLOAT64_PINF; + } + return stdlib_base_gamma( x + 1.0 ); +} diff --git a/base/special/factorial/test/test.native.js b/base/special/factorial/test/test.native.js new file mode 100644 index 000000000..ed0ac8879 --- /dev/null +++ b/base/special/factorial/test/test.native.js @@ -0,0 +1,163 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var isnan = require( './../../../../base/assert/is-nan' ); +var incrspace = require( '@stdlib/array/base/incrspace' ); +var abs = require( './../../../../base/special/abs' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// FIXTURES // + +var integers = require( './fixtures/julia/integers.json' ); +var decimals = require( './fixtures/julia/decimals.json' ); + + +// VARIABLES // + +var factorial = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( factorial instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof factorial, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'if provided a negative integer, the function returns `NaN`', opts, function test( t ) { + var values; + var v; + var i; + + values = incrspace( -1.0, -1000.0, -1.0 ); + for ( i = 0; i < values.length; i++ ) { + v = factorial( values[ i ] ); + t.strictEqual( isnan( v ), true, 'returns expected value when provided ' + values[ i ] ); + } + t.end(); +}); + +tape( 'if provided negative infinity, the function returns `NaN`', opts, function test( t ) { + var v = factorial( NINF ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided positive infinity, the function returns `+infinity`', opts, function test( t ) { + var v = factorial( PINF ); + t.strictEqual( v, PINF, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided `NaN`, the function returns `NaN`', opts, function test( t ) { + var v = factorial( NaN ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'if `x > 170.6144...`, the function returns positive infinity', opts, function test( t ) { + var values; + var v; + var i; + + values = incrspace( 170.615, 1000.0, 10.1234 ); + for ( i = 0; i < values.length; i++ ) { + v = factorial( values[ i ] ); + t.strictEqual( v, PINF, 'returns expected value when provided ' + values[ i ] ); + } + t.end(); +}); + +tape( 'if `x < -171.56749...`, the function returns zero', opts, function test( t ) { + var values; + var v; + var i; + + values = incrspace( -171.57, -1000.0, -10.1234 ); + for ( i = 0; i < values.length; i++ ) { + v = factorial( values[ i ] ); + t.strictEqual( v, 0.0, 'returns expected value when provided ' + values[ i ] ); + } + t.end(); +}); + +tape( 'the function evaluates the factorial function (positive integers < 171)', opts, function test( t ) { + var expected; + var delta; + var tol; + var x; + var v; + var i; + + x = integers.x; + expected = integers.expected; + for ( i = 0; i < x.length; i++ ) { + v = factorial( x[ i ] ); + if ( v === expected[ i ] ) { + t.strictEqual( v, expected[ i ], 'returns '+expected[i]+' when provided '+x[i] ); + } else { + delta = abs( v - expected[ i ] ); + tol = EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. x: ' + x[ i ] + '. Value: ' + v + '. Expected: ' + expected[ i ] + '. Tolerance: ' + tol + '. Delta: ' + delta + '.' ); + } + } + t.end(); +}); + +tape( 'if provided positive integers greater than `170`, the function returns positive infinity', opts, function test( t ) { + var i; + var v; + for ( i = 171; i < 500; i++ ) { + v = factorial( i ); + t.strictEqual( v, PINF, 'returns expected value when provided ' + i ); + } + t.end(); +}); + +tape( 'the function evaluates the factorial function (decimal values)', opts, function test( t ) { + var expected; + var delta; + var tol; + var x; + var v; + var i; + + x = decimals.x; + expected = decimals.expected; + for ( i = 0; i < x.length; i++ ) { + v = factorial( x[ i ] ); + delta = abs( v - expected[ i ] ); + tol = 3.5 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. x: ' + x[ i ] + '. Value: ' + v + '. Expected: ' + expected[ i ] + '. Tolerance: ' + tol + '. Delta: ' + delta + '.' ); + } + t.end(); +});