From b20e724bac4d8b469d3987cbf15e9466e573efb0 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Thu, 9 Jan 2025 23:10:18 +0530 Subject: [PATCH 1/3] feat: add C implementation for triangular logpdf --- .../base/dists/triangular/logpdf/README.md | 103 +++++++++ .../triangular/logpdf/benchmark/benchmark.js | 21 +- .../logpdf/benchmark/benchmark.native.js | 78 +++++++ .../triangular/logpdf/benchmark/c/Makefile | 146 ++++++++++++ .../triangular/logpdf/benchmark/c/benchmark.c | 145 ++++++++++++ .../base/dists/triangular/logpdf/binding.gyp | 170 ++++++++++++++ .../triangular/logpdf/examples/c/Makefile | 146 ++++++++++++ .../triangular/logpdf/examples/c/example.c | 46 ++++ .../base/dists/triangular/logpdf/include.gypi | 53 +++++ .../stats/base/dists/triangular/logpdf.h | 38 +++ .../dists/triangular/logpdf/lib/native.js | 81 +++++++ .../dists/triangular/logpdf/manifest.json | 90 ++++++++ .../base/dists/triangular/logpdf/package.json | 11 +- .../base/dists/triangular/logpdf/src/Makefile | 70 ++++++ .../base/dists/triangular/logpdf/src/addon.c | 23 ++ .../base/dists/triangular/logpdf/src/main.c | 63 +++++ .../triangular/logpdf/test/test.native.js | 216 ++++++++++++++++++ 17 files changed, 1489 insertions(+), 11 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/include/stdlib/stats/base/dists/triangular/logpdf.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md index 24706c185e2f..692ac11b824e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md @@ -158,6 +158,109 @@ for ( i = 0; i < 25; i++ ) { + + +
+ + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/geometric/logpdf.h" +``` + +#### stdlib_base_dists_geometric_logpdf( x, a, b, c ) + +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [triangular][triangular-distribution] distribution with parameters `a` (lower limit), `b` (upper limit) and `c` (mode). + +```c +double y = stdlib_base_dists_geometric_logpdf( 0.5, -1.0, 1.0, 0.0 ); +// returns ~-0.693 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **a**: `[in] double` lower limit +- **b**: `[in] double` upper limit +- **c**: `[in] double` mode + +```c +double stdlib_base_dists_geometric_logpdf( const double x, const double a, const double b, const double c ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/triangular/logpdf.h" +#include "stdlib/constants/float64/eps.h" +#include +#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 a; + double b; + double c; + double x; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + x = random_uniform( 0.0, 30.0 ); + a = random_uniform( 0.0, 10.0 ); + b = random_uniform( a, 40.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + c = a + random_uniform( 0.0, b - a ); + y = stdlib_base_dists_triangular_logpdf( x, a, b, c ); + printf( "x: %lf, a: %lf, b: %lf, c: %lf, ln(f(x;a,b,c)): %lf\n", x, a, b, c, y ); + } +} +``` + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/benchmark.js index 622b1c297b96..b7584d0ab496 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/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 logpdf = require( './../lib' ); @@ -34,17 +35,27 @@ bench( pkg, function benchmark( b ) { var mode; var min; var max; + var len; var x; var y; var i; + len = 100; + x = new Float64Array( len ); + min = new Float64Array( len ); + max = new Float64Array( len ); + mode = new Float64Array( len ); + + for ( i = 0; i < len; i++ ) { + x[ i ] = randu() * 30.0; + min[ i ] = randu() * 10.0; + max[ i ] = min[ i ] + ( randu() * 40.0 ) + EPS; + mode[ i ] = min[ i ] + ( ( max[ i ] - min[ i ] ) * randu() ); + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - x = randu() * 30.0; - min = randu() * 10.0; - max = min + ( randu() * 40.0 ) + EPS; - mode = min + ( ( max - min ) * randu() ); - y = logpdf( x, min, max, mode ); + y = logpdf( x[ i%len ], min[ i%len ], max[ i%len ], mode[ i%len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..92de1db930bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/benchmark.native.js @@ -0,0 +1,78 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var logpdf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( logpdf instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var mode; + var min; + var max; + var len; + var x; + var y; + var i; + + len = 100; + x = new Float64Array( len ); + min = new Float64Array( len ); + max = new Float64Array( len ); + mode = new Float64Array( len ); + + for ( i = 0; i < len; i++ ) { + x[ i ] = randu() * 30.0; + min[ i ] = randu() * 10.0; + max[ i ] = min[ i ] + ( randu() * 40.0 ) + EPS; + mode[ i ] = min[ i ] + ( ( max[ i ] - min[ i ] ) * randu() ); + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = logpdf( x[ i%len ], min[ i%len ], max[ i%len ], mode[ 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/triangular/logpdf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/c/Makefile new file mode 100644 index 000000000000..a4bd7b38fd74 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/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/triangular/logpdf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/c/benchmark.c new file mode 100644 index 000000000000..8e3e0b1089c7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/c/benchmark.c @@ -0,0 +1,145 @@ +/** +* @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/triangular/logpdf.h" +#include "stdlib/constants/float64/eps.h" +#include +#include +#include +#include +#include + +#define NAME "triangular-logpdf" +#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 a[ 100 ]; + double b[ 100 ]; + double c[ 100 ]; + double x[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = random_uniform( 0.0, 30.0 ); + a[ i ] = random_uniform( 0.0, 10.0 ); + b[ i ] = random_uniform( a[ i ], 40.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + c[ i ] = a[ i ] + random_uniform( 0.0, b[ i ] - a[ i ] ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_triangular_logpdf( x[ i % 100 ], a[ i % 100 ], b[ 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/triangular/logpdf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/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/triangular/logpdf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/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/triangular/logpdf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/examples/c/example.c new file mode 100644 index 000000000000..d8d96b358159 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/examples/c/example.c @@ -0,0 +1,46 @@ +/** +* @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/triangular/logpdf.h" +#include "stdlib/constants/float64/eps.h" +#include +#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 a; + double b; + double c; + double x; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + x = random_uniform( 0.0, 30.0 ); + a = random_uniform( 0.0, 10.0 ); + b = random_uniform( a, 40.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + c = a + random_uniform( 0.0, b - a ); + y = stdlib_base_dists_triangular_logpdf( x, a, b, c ); + printf( "x: %lf, a: %lf, b: %lf, c: %lf, ln(f(x;a,b,c)): %lf\n", x, a, b, c, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/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': [ + ' c || + c > b + ) { + return 0.0/0.0; // NaN + } + if ( x < a ) { + return STDLIB_CONSTANT_FLOAT64_NINF; + } + if ( x < c ) { + return STDLIB_CONSTANT_FLOAT64_LN2 + stdlib_base_ln( x - a ) - stdlib_base_ln( c - a ) - stdlib_base_ln( b - a ); + } + if ( x == c ) { + return STDLIB_CONSTANT_FLOAT64_LN2 - stdlib_base_ln( b - a ); + } + if( x <= b ){ + return STDLIB_CONSTANT_FLOAT64_LN2 + stdlib_base_ln( b - x ) - stdlib_base_ln( b - c ) - stdlib_base_ln( b - a ); + } + return STDLIB_CONSTANT_FLOAT64_NINF; +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/test/test.native.js new file mode 100644 index 000000000000..68f5ed5a7039 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/test/test.native.js @@ -0,0 +1,216 @@ +/** +* @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 tape = require( 'tape' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var ln = require( '@stdlib/math/base/special/ln' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// FIXTURES // + +var smallRange = require( './fixtures/julia/small_range.json' ); +var mediumRange = require( './fixtures/julia/medium_range.json' ); +var largeRange = require( './fixtures/julia/large_range.json' ); + + +// VARIABLES // + +var logpdf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( logpdf instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof logpdf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'if provided `NaN` for any parameter, the function returns `NaN`', opts, function test( t ) { + var y = logpdf( NaN, 0.0, 1.0, 0.5 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logpdf( 0.0, NaN, 1.0, 0.5 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logpdf( 0.0, 1.0, NaN, 0.5 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logpdf( 0.0, 0.0, 1.0, NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'if provided a number greater than `b` for `x` and valid parameters, the function returns `-infinity`', opts, function test( t ) { + var y = logpdf( PINF, 0.0, 1.0, 0.5 ); + t.equal( y, NINF, 'returns -infinity' ); + + y = logpdf( 20.0, 0.0, 1.0, 0.5 ); + t.equal( y, NINF, 'returns -infinity' ); + + y = logpdf( 2.0, 0.0, 1.0, 0.5 ); + t.equal( y, NINF, 'returns -infinity' ); + + y = logpdf( 1.1, 0.0, 1.0, 0.5 ); + t.equal( y, NINF, 'returns -infinity' ); + + t.end(); +}); + +tape( 'if provided a number smaller than `a` for `x` and valid parameters, the function returns `-infinity`', opts, function test( t ) { + var y = logpdf( NINF, 0.0, 1.0, 0.5 ); + t.equal( y, NINF, 'returns -infinity' ); + + y = logpdf( -20.0, 0.0, 1.0, 0.5 ); + t.equal( y, NINF, 'returns -infinity' ); + + y = logpdf( -2.0, 0.0, 1.0, 0.5 ); + t.equal( y, NINF, 'returns -infinity' ); + + y = logpdf( -0.5, 0.0, 1.0, 0.5 ); + t.equal( y, NINF, 'returns -infinity' ); + + t.end(); +}); + +tape( 'if provided parameters not satisfying `a <= c <= b`, the function returns `NaN`', opts, function test( t ) { + var y; + + y = logpdf( 2.0, 3.0, 2.0, 2.5 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logpdf( 0.0, 2.0, 3.0, 4.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logpdf( 2.0, 2.0, 3.0, 1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logpdf( 2.0, PINF, NINF, 0.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function returns `ln(2/(b-a))` if provided `x = c`', opts, function test( t ) { + var a = 0.0; + var b = 2.0; + var c = 1.5; + t.equal( logpdf( c, a, b, c ), ln( 2.0/(b-a) ), 'returns ln(2/(b-a))' ); + t.end(); +}); + +tape( 'the function evaluates the logpdf for `x` given a small range `b - a`', opts, function test( t ) { + var expected; + var delta; + var tol; + var x; + var a; + var b; + var c; + var y; + var i; + + expected = smallRange.expected; + x = smallRange.x; + a = smallRange.a; + b = smallRange.b; + c = smallRange.c; + for ( i = 0; i < x.length; i++ ) { + y = logpdf( x[i], a[i], b[i], c[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'x: '+x[i]+', a: '+a[i]+', b: '+b[i]+', c: '+c[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 40.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[ i ]+'. a: '+a[i]+'. b: '+b[i]+'. c: '+c[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); + +tape( 'the function evaluates the logpdf for `x` given a medium range `b - a`', opts, function test( t ) { + var expected; + var delta; + var tol; + var x; + var a; + var b; + var c; + var y; + var i; + + expected = mediumRange.expected; + x = mediumRange.x; + a = mediumRange.a; + b = mediumRange.b; + c = mediumRange.c; + for ( i = 0; i < x.length; i++ ) { + y = logpdf( x[i], a[i], b[i], c[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'x: '+x[i]+', a: '+a[i]+', b: '+b[i]+', c: '+c[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 60.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[ i ]+'. a: '+a[i]+'. b: '+b[i]+'. c: '+c[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); + +tape( 'the function evaluates the logpdf for `x` given a large range `b - a`', opts, function test( t ) { + var expected; + var delta; + var tol; + var x; + var a; + var b; + var c; + var y; + var i; + + expected = largeRange.expected; + x = largeRange.x; + a = largeRange.a; + b = largeRange.b; + c = largeRange.c; + for ( i = 0; i < x.length; i++ ) { + y = logpdf( x[i], a[i], b[i], c[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'x: '+x[i]+', a: '+a[i]+', b: '+b[i]+', c: '+c[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 50.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[ i ]+'. a: '+a[i]+'. b: '+b[i]+'. c: '+c[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); From a1280c4472e923d939b8a97fc36c59e57b74cd73 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Fri, 10 Jan 2025 21:00:47 +0530 Subject: [PATCH 2/3] chore: made changes as per code review --- 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: 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: na - 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: 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/triangular/logpdf/README.md | 8 ++++---- .../include/stdlib/stats/base/dists/triangular/logpdf.h | 2 +- .../stats/base/dists/triangular/logpdf/package.json | 8 ++++++-- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md index 692ac11b824e..73682c35c8a9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md @@ -185,15 +185,15 @@ for ( i = 0; i < 25; i++ ) { ### Usage ```c -#include "stdlib/stats/base/dists/geometric/logpdf.h" +#include "stdlib/stats/base/dists/triangular/logpdf.h" ``` -#### stdlib_base_dists_geometric_logpdf( x, a, b, c ) +#### stdlib_base_dists_triangular_logpdf( x, a, b, c ) Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [triangular][triangular-distribution] distribution with parameters `a` (lower limit), `b` (upper limit) and `c` (mode). ```c -double y = stdlib_base_dists_geometric_logpdf( 0.5, -1.0, 1.0, 0.0 ); +double y = stdlib_base_dists_triangular_logpdf( 0.5, -1.0, 1.0, 0.0 ); // returns ~-0.693 ``` @@ -205,7 +205,7 @@ The function accepts the following arguments: - **c**: `[in] double` mode ```c -double stdlib_base_dists_geometric_logpdf( const double x, const double a, const double b, const double c ); +double stdlib_base_dists_triangular_logpdf( const double x, const double a, const double b, const double c ); ```
diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/include/stdlib/stats/base/dists/triangular/logpdf.h b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/include/stdlib/stats/base/dists/triangular/logpdf.h index 3f4a7ba3e11b..1f03803b9c94 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/include/stdlib/stats/base/dists/triangular/logpdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/include/stdlib/stats/base/dists/triangular/logpdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the natural logarithm of the probability density function (PDF) for the triangular distribution with parameters a, b, and c. +* Evaluates the natural logarithm of the probability density function (PDF) for a triangular distribution with lower limit `a` and upper limit `b` and mode `c` at a value `x`. */ double stdlib_base_dists_triangular_logpdf( const double x, const double a, const double b, const double c ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/package.json b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/package.json index 1c9d32bea456..967b3d6131cb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/package.json +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/package.json @@ -1,7 +1,7 @@ { - "name": "@stdlib/stats/base/dists/triangular/pdf", + "name": "@stdlib/stats/base/dists/triangular/logpdf", "version": "0.0.0", - "description": "Triangular distribution probability density function (PDF).", + "description": "Triangular distribution logarithm of probability density function (PDF).", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", @@ -61,6 +61,10 @@ "probability", "pdf", "continuous", + "logarithm", + "log", + "ln", + "natural", "triangular", "univariate" ] From 6e71faab22f303330f83bb6e34188c15dd6eaecc Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 19 Jan 2025 09:49:38 -0500 Subject: [PATCH 3/3] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/triangular/logpdf/README.md | 8 ++++---- .../base/dists/triangular/logpdf/benchmark/c/benchmark.c | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md index 73682c35c8a9..a0a91873cce5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md @@ -200,9 +200,9 @@ double y = stdlib_base_dists_triangular_logpdf( 0.5, -1.0, 1.0, 0.0 ); The function accepts the following arguments: - **x**: `[in] double` input value. -- **a**: `[in] double` lower limit -- **b**: `[in] double` upper limit -- **c**: `[in] double` mode +- **a**: `[in] double` lower limit. +- **b**: `[in] double` upper limit. +- **c**: `[in] double` mode. ```c double stdlib_base_dists_triangular_logpdf( const double x, const double a, const double b, const double c ); @@ -249,7 +249,7 @@ int main( void ) { for ( i = 0; i < 25; i++ ) { x = random_uniform( 0.0, 30.0 ); a = random_uniform( 0.0, 10.0 ); - b = random_uniform( a, 40.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + b = random_uniform( a + STDLIB_CONSTANT_FLOAT64_EPS, 40.0 ); c = a + random_uniform( 0.0, b - a ); y = stdlib_base_dists_triangular_logpdf( x, a, b, c ); printf( "x: %lf, a: %lf, b: %lf, c: %lf, ln(f(x;a,b,c)): %lf\n", x, a, b, c, y ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/c/benchmark.c index 8e3e0b1089c7..f84f024dbb8c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/benchmark/c/benchmark.c @@ -105,7 +105,7 @@ static double benchmark( void ) { for ( i = 0; i < 100; i++ ) { x[ i ] = random_uniform( 0.0, 30.0 ); a[ i ] = random_uniform( 0.0, 10.0 ); - b[ i ] = random_uniform( a[ i ], 40.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + b[ i ] = random_uniform( a[ i ] + STDLIB_CONSTANT_FLOAT64_EPS, 40.0 ); c[ i ] = a[ i ] + random_uniform( 0.0, b[ i ] - a[ i ] ); }