From 3f4d43bf9564b52cebff823472cb1fe218f3ef00 Mon Sep 17 00:00:00 2001 From: Vinit Pandit Date: Thu, 2 Jan 2025 10:24:27 +0530 Subject: [PATCH 1/4] feat: add c implementation of stats/base/dists/degenerate/logpmf --- 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: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - 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 --- --- .../base/dists/degenerate/logpmf/README.md | 95 ++++++++++ .../degenerate/logpmf/benchmark/benchmark.js | 14 +- .../logpmf/benchmark/benchmark.native.js | 70 ++++++++ .../degenerate/logpmf/benchmark/c/Makefile | 146 +++++++++++++++ .../degenerate/logpmf/benchmark/c/benchmark.c | 140 +++++++++++++++ .../base/dists/degenerate/logpmf/binding.gyp | 170 ++++++++++++++++++ .../degenerate/logpmf/examples/c/Makefile | 146 +++++++++++++++ .../degenerate/logpmf/examples/c/example.c | 40 +++++ .../base/dists/degenerate/logpmf/include.gypi | 53 ++++++ .../stats/base/dists/degenerate/logpmf.h | 38 ++++ .../dists/degenerate/logpmf/lib/native.js | 59 ++++++ .../dists/degenerate/logpmf/manifest.json | 80 +++++++++ .../base/dists/degenerate/logpmf/package.json | 3 + .../base/dists/degenerate/logpmf/src/Makefile | 70 ++++++++ .../base/dists/degenerate/logpmf/src/addon.c | 23 +++ .../base/dists/degenerate/logpmf/src/main.c | 41 +++++ .../degenerate/logpmf/test/test.native.js | 86 +++++++++ 17 files changed, 1271 insertions(+), 3 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/include/stdlib/stats/base/dists/degenerate/logpmf.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/README.md index 320c6bd066d7..6ea5179b4dfe 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/README.md @@ -97,6 +97,101 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/degenerate/logpmf.h" +``` + +#### stdlib_base_dists_degenerate_logpmf( x, mu ) + +Evaluates the logarithm of the probability mass function (PMF) for a degenerate distribution + +```c +double out = stdlib_base_dists_degenerate_logpmf( 2.0, 3.0 ); +// returns -Infinity +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **mu**: `[in] double` constant value of the distribution. + +```c +double stdlib_base_dists_degenerate_logpmf( const double x, const double mu ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/degenerate/logpmf.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 x; + double y; + int i; + + for ( i = 0; i < 100; i++ ) { + x = random_uniform( 0.0, 5.0 ); + mu = random_uniform( 0.0, 5.0 ); + y = stdlib_base_dists_degenerate_logpmf( x, mu ); + printf( "x: %lf, µ: %lf, ln(P(X=x;µ)): %lf\n", x, mu, y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/benchmark.js index d4570d5632b2..bce20a5d1561 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/benchmark.js @@ -21,6 +21,7 @@ // MODULES // var bench = require( '@stdlib/bench' ); +var Float64Array = require( '@stdlib/array/float64' ); var ceil = require( '@stdlib/math/base/special/ceil' ); var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); @@ -31,16 +32,23 @@ var logpmf = require( './../lib' ); // MAIN // bench( pkg, function benchmark( b ) { + var len; var mu; var x; var y; var i; + len = 100; + x = new Float64Array( len ); + mu = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + x[ i ] = ( randu() * 100.0 ) - 100.0; + mu[ i ] = ( randu() * 100.0 ) - 50.0; + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - x = ceil( ( randu()*100.0 ) - 100.0 ); - mu = ( randu()*100.0 ) - 50.0; - y = logpmf( x, mu ); + y = logpmf( x[ i % len ], mu[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..81f747c4ae1a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/benchmark.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 resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var Float64Array = require( '@stdlib/array/float64' ); +var randu = require( '@stdlib/random/base/randu' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var logpmf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( logpmf instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var len; + var mu; + var x; + var y; + var i; + + len = 100; + x = new Float64Array( len ); + mu = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + x[ i ] = ( randu() * 100.0 ) - 100.0; + mu[ i ] = ( randu() * 100.0 ) - 50.0; + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = logpmf( x[ i % len ], mu[ 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/degenerate/logpmf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/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 := 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/degenerate/logpmf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/c/benchmark.c new file mode 100644 index 000000000000..3256df678917 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/c/benchmark.c @@ -0,0 +1,140 @@ +/** +* @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/stats/base/dists/degenerate/logpmf.h" +#include +#include +#include +#include +#include + +#define NAME "degenrate-logpmf" +#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 x[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = random_uniform( -100.0, 0.0 ); + mu[ i ] = random_uniform( -50.0, 50.0 ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_degenerate_logpmf( x[ i%100 ], mu[ 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/degenerate/logpmf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/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/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/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/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/example.c new file mode 100644 index 000000000000..7aebc6fefad6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/example.c @@ -0,0 +1,40 @@ +/** +* @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/stats/base/dists/degenerate/logpmf.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 x; + double y; + int i; + + for ( i = 0; i < 100; i++ ) { + x = random_uniform( 0.0, 5.0 ); + mu = random_uniform( 0.0, 5.0 ); + y = stdlib_base_dists_degenerate_logpmf( x, mu ); + printf( "x: %lf, µ: %lf, ln(P(X=x;µ)): %lf\n", x, mu, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/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': [ + ' Date: Thu, 2 Jan 2025 10:25:50 +0530 Subject: [PATCH 2/4] fix: fix docs in mainc --- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/stats/base/dists/degenerate/logpmf/src/main.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/main.c index 7a41d50e408e..3b06d5f84fac 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/main.c @@ -25,7 +25,7 @@ * * @param x input value * @param mu constant value of the distribution -* @return evaluated logPDF +* @return evaluated logPMF * * @example * double y = stdlib_base_dists_arcsine_logpmf( 2.0, 3.0 ); From a89159f147f71bbd0293209ca1c14bcaf31b5e4a Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Thu, 2 Jan 2025 05:38:03 +0000 Subject: [PATCH 3/4] chore: update copyright years --- .../base/dists/degenerate/logpmf/benchmark/benchmark.native.js | 2 +- .../stats/base/dists/degenerate/logpmf/benchmark/c/Makefile | 2 +- .../stats/base/dists/degenerate/logpmf/benchmark/c/benchmark.c | 2 +- .../@stdlib/stats/base/dists/degenerate/logpmf/binding.gyp | 2 +- .../stats/base/dists/degenerate/logpmf/examples/c/Makefile | 2 +- .../stats/base/dists/degenerate/logpmf/examples/c/example.c | 2 +- .../@stdlib/stats/base/dists/degenerate/logpmf/include.gypi | 2 +- .../logpmf/include/stdlib/stats/base/dists/degenerate/logpmf.h | 2 +- .../@stdlib/stats/base/dists/degenerate/logpmf/lib/native.js | 2 +- .../@stdlib/stats/base/dists/degenerate/logpmf/src/Makefile | 2 +- .../@stdlib/stats/base/dists/degenerate/logpmf/src/addon.c | 2 +- .../@stdlib/stats/base/dists/degenerate/logpmf/src/main.c | 2 +- .../stats/base/dists/degenerate/logpmf/test/test.native.js | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/benchmark.native.js index 81f747c4ae1a..3500aec55b52 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/benchmark.native.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/stats/base/dists/degenerate/logpmf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/c/Makefile index f69e9da2b4d3..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/c/Makefile @@ -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/stats/base/dists/degenerate/logpmf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/c/benchmark.c index 3256df678917..94c4116d4240 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/benchmark/c/benchmark.c @@ -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/stats/base/dists/degenerate/logpmf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/binding.gyp index ec3992233442..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/binding.gyp @@ -1,6 +1,6 @@ # @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/stats/base/dists/degenerate/logpmf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/Makefile index 6aed70daf167..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/Makefile @@ -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/stats/base/dists/degenerate/logpmf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/example.c index 7aebc6fefad6..bd0bc69e68d7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/examples/c/example.c @@ -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/stats/base/dists/degenerate/logpmf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/include.gypi index 575cb043c0bf..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/include.gypi @@ -1,6 +1,6 @@ # @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/stats/base/dists/degenerate/logpmf/include/stdlib/stats/base/dists/degenerate/logpmf.h b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/include/stdlib/stats/base/dists/degenerate/logpmf.h index 3bfd23bf5e43..15727d3d9213 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/include/stdlib/stats/base/dists/degenerate/logpmf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/include/stdlib/stats/base/dists/degenerate/logpmf.h @@ -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/stats/base/dists/degenerate/logpmf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/lib/native.js index 0818148cbd28..3c327b4bbf34 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/lib/native.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/stats/base/dists/degenerate/logpmf/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/Makefile index bcf18aa46655..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/Makefile @@ -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/stats/base/dists/degenerate/logpmf/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/addon.c index cc523378d639..d307ff9377dd 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/addon.c @@ -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/stats/base/dists/degenerate/logpmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/main.c index 3b06d5f84fac..86011ce8ac91 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/main.c @@ -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/stats/base/dists/degenerate/logpmf/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/test/test.native.js index d766e6250246..6b28f277edf5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/test/test.native.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. From 2f92e6e745d41205c7778d5600f92366f9e331d9 Mon Sep 17 00:00:00 2001 From: Vinit Pandit Date: Tue, 14 Jan 2025 15:40:21 +0000 Subject: [PATCH 4/4] fix: fixing copy past error and fixing Readme --- 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: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: passed - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: passed - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: passed - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/stats/base/dists/degenerate/logpmf/README.md | 2 +- .../@stdlib/stats/base/dists/degenerate/logpmf/src/main.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/README.md index 6ea5179b4dfe..fc2c0774e020 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/README.md @@ -125,7 +125,7 @@ for ( i = 0; i < 100; i++ ) { #### stdlib_base_dists_degenerate_logpmf( x, mu ) -Evaluates the logarithm of the probability mass function (PMF) for a degenerate distribution +Evaluates the natural logarithm of the [PMF][pmf] for a [degenerate distribution][degenerate-distribution] centered at `mu`. ```c double out = stdlib_base_dists_degenerate_logpmf( 2.0, 3.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/main.c index 86011ce8ac91..c513bd32ac37 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/src/main.c @@ -25,7 +25,7 @@ * * @param x input value * @param mu constant value of the distribution -* @return evaluated logPMF +* @return expected value * * @example * double y = stdlib_base_dists_arcsine_logpmf( 2.0, 3.0 );