From 4d2120e47c6dfbf317e2759274af6bcd5988f5f2 Mon Sep 17 00:00:00 2001 From: Nishchay Rajput Date: Mon, 27 Jan 2025 10:45:07 +0530 Subject: [PATCH 1/3] feat: add C implementation for @stdlib/stats/base/dists/levy/entropy --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/base/dists/levy/entropy/README.md | 95 ++++++++++ .../dists/levy/entropy/benchmark/benchmark.js | 14 +- .../entropy/benchmark/benchmark.native.js | 71 ++++++++ .../dists/levy/entropy/benchmark/c/Makefile | 146 +++++++++++++++ .../levy/entropy/benchmark/c/benchmark.c | 141 +++++++++++++++ .../stats/base/dists/levy/entropy/binding.gyp | 170 ++++++++++++++++++ .../dists/levy/entropy/examples/c/Makefile | 146 +++++++++++++++ .../dists/levy/entropy/examples/c/example.c | 40 +++++ .../base/dists/levy/entropy/include.gypi | 53 ++++++ .../stdlib/stats/base/dists/levy/entropy.h | 38 ++++ .../base/dists/levy/entropy/lib/native.js | 63 +++++++ .../base/dists/levy/entropy/manifest.json | 89 +++++++++ .../base/dists/levy/entropy/package.json | 3 + .../base/dists/levy/entropy/src/Makefile | 70 ++++++++ .../stats/base/dists/levy/entropy/src/addon.c | 23 +++ .../stats/base/dists/levy/entropy/src/main.c | 47 +++++ .../dists/levy/entropy/test/test.native.js | 114 ++++++++++++ 17 files changed, 1320 insertions(+), 3 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/include/stdlib/stats/base/dists/levy/entropy.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/levy/entropy/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/README.md b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/README.md index 39c1847c7a82..d79fbc66ddc3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/README.md @@ -133,6 +133,101 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/levy/entropy.h" +``` + +#### stdlib_base_dists_levy_entropy( mu, c ) + +Returns the [entropy][entropy] for a [Lévy][levy-distribution] distribution with location parameter `mu` and scale parameter `c`. + +```c +double out = stdlib_base_dists_levy_entropy( 0.0, 1.0 ); +// returns ~3.324 +``` + +The function accepts the following arguments: + +- **mu**: `[in] double` location parameter. +- **c**: `[in] double` scale parameter. + +```c +double stdlib_base_dists_levy_entropy( const double mu, const double c ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/levy/entropy.h" +#include +#include + +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +int main( void ) { + double mu; + double c; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + mu = random_uniform( -5.0, 5.0 ); + c = random_uniform( 0.0, 20.0 ); + y = stdlib_base_dists_levy_entropy( mu, c ); + printf( "mu = %lf; c = %lf; h(X;µ,c) = %lf\n", mu, c, y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.js index 3a70c9419df9..b617a4ab6d70 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.js @@ -23,6 +23,7 @@ var bench = require( '@stdlib/bench' ); var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Float64Array = require( '@stdlib/array/float64' ); var EPS = require( '@stdlib/constants/float64/eps' ); var pkg = require( './../package.json' ).name; var entropy = require( './../lib' ); @@ -31,16 +32,23 @@ var entropy = require( './../lib' ); // MAIN // bench( pkg, function benchmark( b ) { + var len; var mu; var c; var y; var i; + len = 100; + mu = new Float64Array( len ); + c = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + mu[ i ] = ( randu() * 100.0 ) - 50.0; + c[ i ] = ( randu() * 20.0 ) + EPS; + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - mu = ( randu()*100.0 ) - 50.0; - c = ( randu()*20.0 ) + EPS; - y = entropy( mu, c ); + y = entropy( mu[ i % len ], c[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.native.js new file mode 100644 index 000000000000..d76d03988044 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.native.js @@ -0,0 +1,71 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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 Float64Array = require( '@stdlib/array/float64' ); +var randu = require( '@stdlib/random/base/randu' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var entropy = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( entropy instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var len; + var mu; + var c; + var y; + var i; + + len = 100; + mu = new Float64Array( len ); + c = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + mu[ i ] = ( randu() * 100.0 ) - 50.0; + c[ i ] = ( randu() * 20.0 ) + EPS; + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = entropy( mu[ i % len ], c[ i % len ] ); + 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/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/c/Makefile new file mode 100644 index 000000000000..a4bd7b38fd74 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# 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. +# 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/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/c/benchmark.c new file mode 100644 index 000000000000..dfbb5cacc4bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/c/benchmark.c @@ -0,0 +1,141 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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/stats/base/dists/levy/entropy.h" +#include "stdlib/constants/float64/eps.h" +#include +#include +#include +#include +#include + +#define NAME "levy-entropy" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static 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 +*/ +static 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 +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [min,max). +* +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number +*/ +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double mu[ 100 ]; + double c[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + mu[ i ] = random_uniform( -50.0, 50.0 ); + c[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_levy_entropy( mu[ i%100 ], c[ i%100 ] ); + if ( y != y ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + printf( "should not return NaN\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::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# 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. +# 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/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# 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. +# 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/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/examples/c/example.c new file mode 100644 index 000000000000..0b9a829981dd --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/examples/c/example.c @@ -0,0 +1,40 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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/stats/base/dists/levy/entropy.h" +#include +#include + +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +int main( void ) { + double mu; + double c; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + mu = random_uniform( -5.0, 5.0 ); + c = random_uniform( 0.0, 20.0 ); + y = stdlib_base_dists_levy_entropy( mu, c ); + printf( "mu = %lf; c = %lf; h(X;µ,c) = %lf\n", mu, c, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# 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. +# 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': [ + ' Date: Fri, 7 Mar 2025 04:33:53 +0000 Subject: [PATCH 2/3] fix: PR reviewed changes --- .../dists/levy/entropy/benchmark/benchmark.native.js | 6 +++--- .../include/stdlib/stats/base/dists/levy/entropy.h | 2 +- .../@stdlib/stats/base/dists/levy/entropy/lib/native.js | 2 +- .../@stdlib/stats/base/dists/levy/entropy/manifest.json | 2 +- .../@stdlib/stats/base/dists/levy/entropy/src/main.c | 9 ++++----- 5 files changed, 10 insertions(+), 11 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.native.js index d76d03988044..6cb0c3afbb53 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.native.js @@ -23,7 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var EPS = require( '@stdlib/constants/float64/eps' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -51,8 +51,8 @@ bench( pkg+'::native', opts, function benchmark( b ) { mu = new Float64Array( len ); c = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - mu[ i ] = ( randu() * 100.0 ) - 50.0; - c[ i ] = ( randu() * 20.0 ) + EPS; + mu[ i ] = uniform( -50.0, 50.0); + c[ i ] = uniform( EPS, 20.0); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/include/stdlib/stats/base/dists/levy/entropy.h b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/include/stdlib/stats/base/dists/levy/entropy.h index 0d038119556d..3d94bf1d36d8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/include/stdlib/stats/base/dists/levy/entropy.h +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/include/stdlib/stats/base/dists/levy/entropy.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Returns the standard deviation for a Lévy distribution with location `mu` and scale `c`. +* Returns the differentaial entropy for a Lévy distribution with location `mu` and scale `c`. */ double stdlib_base_dists_levy_entropy( const double mu, const double c ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/lib/native.js index 1a496271e0cf..54ec4865d8fc 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/lib/native.js @@ -31,7 +31,7 @@ var addon = require( './../src/addon.node' ); * @private * @param {number} mu - location parameter * @param {PositiveNumber} c - scale parameter -* @returns {PositiveNumber} standard deviation +* @returns {PositiveNumber} differential entropy * * @example * var y = entropy( 0.0, 1.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/manifest.json index 9ce4cb3fbe4d..f2c45e20dc26 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/manifest.json @@ -1,5 +1,5 @@ { - "options": { + "options": { "task": "build", "wasm": false }, diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/src/main.c index 6fc3f1c8a731..29cc6d6c604d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/src/main.c @@ -23,16 +23,15 @@ #include "stdlib/constants/float64/pi.h" #include "stdlib/math/base/special/pow.h" - /** -* Returns the entropy for a Lévy distribution with location `mu` and scale `c`. +* Returns the differential entropy for a Lévy distribution with location `mu` and scale `c`. * * @param mu location parameter * @param c scale parameter -* @return standard deviation +* @return differential entropy * * @example -* double y = stdlib_base_levy_entropy( 0.0, 1.0 ); +* double y = stdlib_base_dists_levy_entropy( 0.0, 1.0 ); * // returns ~3.324 */ double stdlib_base_dists_levy_entropy( const double mu, const double c ) { @@ -43,5 +42,5 @@ double stdlib_base_dists_levy_entropy( const double mu, const double c ) { ) { return 0.0/0.0; // NaN } - return ( 1.0 + ( 3 * STDLIB_CONSTANT_FLOAT64_EULERGAMMA ) + stdlib_base_ln( 16.0 * stdlib_base_pow( c, 2.0 ) * STDLIB_CONSTANT_FLOAT64_PI ) ) / 2.0; + return ( 1.0 + ( 3.0 * STDLIB_CONSTANT_FLOAT64_EULERGAMMA ) + stdlib_base_ln( 16.0 * stdlib_base_pow( c, 2.0 ) * STDLIB_CONSTANT_FLOAT64_PI ) ) / 2.0; } From bde52a0b4051bb5bb16e7c8812bf0e0cf262adee Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Fri, 4 Apr 2025 20:15:43 -0400 Subject: [PATCH 3/3] chore: remove duplicated require Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.js | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.js index c592ec4f32ec..e4b0285f430e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/entropy/benchmark/benchmark.js @@ -24,7 +24,6 @@ var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); var uniform = require( '@stdlib/random/base/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var Float64Array = require( '@stdlib/array/float64' ); var EPS = require( '@stdlib/constants/float64/eps' ); var pkg = require( './../package.json' ).name; var entropy = require( './../lib' );