From f809f17b09ff5891ca55f598e9e96e10d463a8ac Mon Sep 17 00:00:00 2001 From: yuvi-mittal Date: Sat, 1 Feb 2025 02:08:18 +0530 Subject: [PATCH 1/3] feat: Add C implementation for @stdlib/stats/base/dists/planck/logpmf --- 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 --- --- .../stats/base/dists/planck/logpmf/README.md | 100 ++++++++++- .../planck/logpmf/benchmark/benchmark.js | 16 +- .../logpmf/benchmark/benchmark.native.js | 71 ++++++++ .../dists/planck/logpmf/benchmark/c/Makefile | 146 +++++++++++++++ .../planck/logpmf/benchmark/c/benchmark.c | 146 +++++++++++++++ .../base/dists/planck/logpmf/binding.gyp | 170 ++++++++++++++++++ .../dists/planck/logpmf/examples/c/Makefile | 146 +++++++++++++++ .../dists/planck/logpmf/examples/c/example.c | 45 +++++ .../base/dists/planck/logpmf/include.gypi | 53 ++++++ .../stdlib/stats/base/dists/planck/logpmf.h | 38 ++++ .../base/dists/planck/logpmf/lib/native.js | 67 +++++++ .../base/dists/planck/logpmf/manifest.json | 92 ++++++++++ .../base/dists/planck/logpmf/package.json | 3 + .../base/dists/planck/logpmf/src/Makefile | 70 ++++++++ .../base/dists/planck/logpmf/src/addon.c | 23 +++ .../stats/base/dists/planck/logpmf/src/main.c | 49 +++++ .../dists/planck/logpmf/test/test.native.js | 149 +++++++++++++++ 17 files changed, 1379 insertions(+), 5 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md index bd177c1db4d7..fe1d5564e1ab 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md @@ -101,7 +101,7 @@ y = mylogpmf( 1.0 ); ## Notes -- In virtually all cases, using the `logpmf` or `logcdf` functions is preferable to manually computing the logarithm of the `pmf` or `cdf`, respectively, since the latter is prone to overflow and underflow. +- In virtually all cases, using the `logpmf` or `loglogpmf` functions is preferable to manually computing the logarithm of the `pmf` or `logpmf`, respectively, since the latter is prone to overflow and underflow. @@ -133,6 +133,104 @@ for ( i = 0; i < lambda.length; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/planck/logpmf.h" +``` + +#### stdlib_base_dists_planck_logpmf( x, lambda ) + +Evaluates the logarithm of the [probability mass function][pmf] (PMF) of a Planck (discrete exponential) distribution with shape parameter `lambda`. + +```c +double out = stdlib_base_dists_planck_logpmf( 4.0 , 0.3 ); +// returns ~-2.5502 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **lambda**: `[in] double` shape parameter. + +```c +double stdlib_base_dists_planck_logpmf( const double x, const double lambda ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/planck/logpmf.h" +#include +#include +static int random_discrete_uniform( const int min, const int max ) { + return min + ( rand() % ( max - min + 1 ) ); +} + +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 lambda; + double y; + int x; + int i; + + for ( i = 0; i < 10; i++ ) { + x = random_discrete_uniform( 0, 5 ); + lambda = random_uniform( 0.1, 5.0 ); + y = stdlib_base_dists_planck_logpmf( x, lambda ); + printf( "x: %d, lambda: %lf, F(x; lambda): %lf\n", x, lambda ,y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/benchmark.js index 2d48249bfa8f..c5b74e8474e6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/benchmark.js @@ -21,8 +21,10 @@ // MODULES // var bench = require( '@stdlib/bench' ); +var Float64Array = require( '@stdlib/array/float64' ); var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); -var uniform = require( '@stdlib/random/array/uniform' ); +var uniformBase = require( '@stdlib/random/base/uniform' ); +var discreteUniformBase = require( '@stdlib/random/base/discrete-uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pkg = require( './../package.json' ).name; var logpmf = require( './../lib' ); @@ -32,16 +34,22 @@ var logpmf = require( './../lib' ); bench( pkg, function benchmark( b ) { var lambda; + var len; var x; var y; var i; - x = discreteUniform( 100, 0, 40 ); - lambda = uniform( 100, 0.1, 10.0 ); + len = 100; + x = new Float64Array( len ); + lambda = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + x[i] = discreteUniformBase(0, 40); + lambda[i] = uniformBase(1.0, 10.0); + } b.tic(); for ( i = 0; i < b.iterations; i++ ) { - y = logpmf( x[ i % x.length ], lambda[ i % lambda.length ] ); + y = logpmf( x[ i % len ], lambda[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..9341596821cb --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/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 uniformBase = require( '@stdlib/random/base/uniform' ); +var discreteUniformBase = require( '@stdlib/random/base/discrete-uniform' ); +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 lambda; + var len; + var x; + var y; + var i; + + len = 100; + x = new Float64Array( len ); + lambda = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + x[i] = discreteUniformBase(0, 40); + lambda[i] = uniformBase(1.0, 10.0); + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = logpmf( x[ i % len ], lambda[ 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/planck/logpmf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/logpmf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/c/benchmark.c new file mode 100644 index 000000000000..6e97dc7ff802 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/c/benchmark.c @@ -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. +*/ + +#include "stdlib/stats/base/dists/planck/logpmf.h" +#include +#include +#include +#include +#include + +#define NAME "planck-logpmf" +#define ITERATIONS 1000000 +#define REPEATS 3 + +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 ); + 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 int random_discrete_uniform( int min, int max ) { + return min + rand() % ( max - min + 1 ); +} + +static double random_uniform( double min, 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; + int x[ 100 ]; + double lambda[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = random_discrete_uniform( 0, 40 ); + lambda[ i ] = random_uniform( 0.1, 10.0 ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_planck_logpmf( x[ i % 100 ], lambda[ 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; + + 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/planck/logpmf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/logpmf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/logpmf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/examples/c/example.c new file mode 100644 index 000000000000..01e7a57d26aa --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/examples/c/example.c @@ -0,0 +1,45 @@ +/** +* @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/planck/logpmf.h" +#include +#include +#include + +static int random_discrete_uniform( const int min, const int max ) { + return min + ( rand() % ( max - min + 1 ) ); +} + +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 lambda; + double y; + int x; + int i; + + for ( i = 0; i < 10; i++ ) { + x = random_discrete_uniform( 0, 5 ); + lambda = random_uniform( 0.1, 5.0 ); + y = stdlib_base_dists_planck_logpmf( x, lambda ); + printf( "x: %d, lambda: %lf, F(x; lambda): %lf\n", x, lambda ,y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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: Sun, 2 Feb 2025 15:47:11 +0530 Subject: [PATCH 2/3] documentation update --- 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/planck/logpmf/README.md | 4 ++-- .../logpmf/include/stdlib/stats/base/dists/planck/logpmf.h | 2 +- .../@stdlib/stats/base/dists/planck/logpmf/manifest.json | 4 ---- .../@stdlib/stats/base/dists/planck/logpmf/src/main.c | 2 +- 4 files changed, 4 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md index fe1d5564e1ab..83b5da545fe6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md @@ -101,7 +101,7 @@ y = mylogpmf( 1.0 ); ## Notes -- In virtually all cases, using the `logpmf` or `loglogpmf` functions is preferable to manually computing the logarithm of the `pmf` or `logpmf`, respectively, since the latter is prone to overflow and underflow. +In virtually all cases, using the `logpmf` or `logcdf` functions is preferable to manually computing the logarithm of the `pmf` or `cdf`, respectively, since the latter is prone to overflow and underflow.
@@ -161,7 +161,7 @@ for ( i = 0; i < lambda.length; i++ ) { #### stdlib_base_dists_planck_logpmf( x, lambda ) -Evaluates the logarithm of the [probability mass function][pmf] (PMF) of a Planck (discrete exponential) distribution with shape parameter `lambda`. +Evaluates the logarithm of the probability mass function (PMF) of a Planck distribution with shape parameter `lambda`. ```c double out = stdlib_base_dists_planck_logpmf( 4.0 , 0.3 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h index b8519ce17627..94b534a66684 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logpmf for an planck distribution. +* Evaluates the logarithm of the probability mass function (PMF) of a Planck distribution with shape parameter `lambda`. */ double stdlib_base_dists_planck_logpmf( const double x, const double lambda ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/manifest.json index 9acc7ff41fbb..30aa2f4b82cb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/manifest.json @@ -42,10 +42,8 @@ "@stdlib/math/base/assert/is-nan", "@stdlib/math/base/assert/is-nonnegative-integer", "@stdlib/math/base/special/expm1", - "@stdlib/constants/float64/pi", "@stdlib/math/base/special/ln", "@stdlib/constants/float64/ninf" - ] }, { @@ -63,7 +61,6 @@ "@stdlib/math/base/assert/is-nan", "@stdlib/math/base/assert/is-nonnegative-integer", "@stdlib/math/base/special/expm1", - "@stdlib/constants/float64/pi", "@stdlib/math/base/special/ln", "@stdlib/constants/float64/ninf" ] @@ -83,7 +80,6 @@ "@stdlib/math/base/assert/is-nan", "@stdlib/math/base/assert/is-nonnegative-integer", "@stdlib/math/base/special/expm1", - "@stdlib/constants/float64/pi", "@stdlib/math/base/special/ln", "@stdlib/constants/float64/ninf" ] diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/main.c index e60ebbc7c04b..8f46c78ff621 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/main.c @@ -24,7 +24,7 @@ #include "stdlib/constants/float64/ninf.h" /** -* Evaluates the logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda` at a value `x`. +* Evaluates the logarithm of the probability mass function (PMF) of a Planck distribution with shape parameter `lambda`. * * @param x input value * @param lambda shape parameter From 65564045c7646372968a02bfaf4953613ffec9d8 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sat, 15 Feb 2025 22:51:34 +0000 Subject: [PATCH 3/3] chore: update copyright years --- .../@stdlib/stats/base/dists/planck/logpmf/benchmark/c/Makefile | 2 +- .../@stdlib/stats/base/dists/planck/logpmf/binding.gyp | 2 +- .../@stdlib/stats/base/dists/planck/logpmf/examples/c/Makefile | 2 +- .../@stdlib/stats/base/dists/planck/logpmf/include.gypi | 2 +- .../logpmf/include/stdlib/stats/base/dists/planck/logpmf.h | 2 +- .../@stdlib/stats/base/dists/planck/logpmf/src/Makefile | 2 +- .../@stdlib/stats/base/dists/planck/logpmf/src/addon.c | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/c/Makefile index f69e9da2b4d3..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/logpmf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/binding.gyp index ec3992233442..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/logpmf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/examples/c/Makefile index 6aed70daf167..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/logpmf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include.gypi index 575cb043c0bf..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h index 94b534a66684..6e3fe49c8a13 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/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/planck/logpmf/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/Makefile index bcf18aa46655..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/logpmf/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/addon.c index 5a6d1a9d82eb..97ba5aad758d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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.