From 8a25861e88f196bc432d3355b26dcf0d2189c8f9 Mon Sep 17 00:00:00 2001 From: Manvith <148960168+manvith2003@users.noreply.github.com> Date: Tue, 17 Dec 2024 15:37:08 +0530 Subject: [PATCH 1/9] feat: add C implementation for stats/base/dists/normal/logcdf --- .../stats/base/dists/normal/logcdf/README.md | 98 ++++++++++ .../normal/logcdf/benchmark/benchmark.js | 22 ++- .../logcdf/benchmark/benchmark.native.js | 74 ++++++++ .../dists/normal/logcdf/benchmark/c/Makefile | 146 +++++++++++++++ .../normal/logcdf/benchmark/c/benchmark.c | 143 +++++++++++++++ .../base/dists/normal/logcdf/binding.gyp | 170 ++++++++++++++++++ .../dists/normal/logcdf/examples/c/Makefile | 146 +++++++++++++++ .../dists/normal/logcdf/examples/c/example.c | 43 +++++ .../base/dists/normal/logcdf/include.gypi | 53 ++++++ .../stdlib/stats/base/dists/normal/logcdf.h | 38 ++++ .../base/dists/normal/logcdf/lib/native.js | 77 ++++++++ .../base/dists/normal/logcdf/manifest.json | 94 ++++++++++ .../base/dists/normal/logcdf/package.json | 3 + .../base/dists/normal/logcdf/src/Makefile | 70 ++++++++ .../base/dists/normal/logcdf/src/addon.c | 23 +++ .../stats/base/dists/normal/logcdf/src/main.c | 66 +++++++ .../dists/normal/logcdf/test/test.native.js | 160 +++++++++++++++++ 17 files changed, 1420 insertions(+), 6 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/include/stdlib/stats/base/dists/normal/logcdf.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md index 52d505ed7363..226535ccba82 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md @@ -128,6 +128,104 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/normal/logcdf.h" +``` + +#### stdlib_base_dists_normal_logcdf( x, a, b ) + +Evaluates the logarithm of the cumulative distribution function (logCDF) for a normal distribution. + +```c +double out = stdlib_base_dists_normal_cdf( 2.0, 0.0, 1.0 ); +// returns ~-0.023 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **mu**: `[in] double` mean. +- **sigma**: `[in] double` standard deviation. + +```c +double stdlib_base_dists_normal_logcdf( cconst double x, const double mu, const double sigma ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/normal/logcdf.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 x; + double mu; + double sigma; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + x = random_uniform( 0.0, 10.0 ); + mu = random_uniform( -5.0, 5.0 ); + sigma = random_uniform( 0.1, 20.0 ); + y = stdlib_base_dists_normal_logcdf( x, mu, sigma ); + printf( "x: %lf, µ: %lf, σ: %lf, ln(F(x;µ,σ)): %lf\n", x, mu, sigma, y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.js index 56ab2fc449c7..ab409325275e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.js @@ -21,6 +21,8 @@ // MODULES // var bench = require( '@stdlib/bench' ); +var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var EPS = require( '@stdlib/constants/float64/eps' ); @@ -32,17 +34,25 @@ var logcdf = require( './../lib' ); bench( pkg, function benchmark( b ) { var sigma; + var len; var mu; var x; var y; var i; + len = 100; + x = new Float64Array( len ); + mu = new Float64Array( len ); + sigma = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + x[ i ] = ( randu() * 200.0 ) - 100.0; + mu[ i ] = ( randu() * 100.0 ) - 50.0; + sigma[ i ] = ( randu() * 20.0 ) + EPS; + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - x = ( randu()*200.0 ) - 100; - mu = ( randu()*100.0 ) - 50.0; - sigma = ( randu()*20.0 ) + EPS; - y = logcdf( x, mu, sigma ); + y = logcdf( x[ i % len ], mu[ i % len ], sigma[ i % len ]); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } @@ -66,11 +76,11 @@ bench( pkg+':factory', function benchmark( b ) { mu = 0.0; sigma = 1.5; mylogcdf = logcdf.factory( mu, sigma ); + x = uniform( 100, -3.0, 3.0 ); b.tic(); for ( i = 0; i < b.iterations; i++ ) { - x = ( randu()*6.0 ) - 3.0; - y = mylogcdf( x ); + y = mylogcdf( x[ i % x.length ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..5d8fd0f7961f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js @@ -0,0 +1,74 @@ +/** +* @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 EPS = require( '@stdlib/constants/float64/eps' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var logcdf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( logcdf instanceof Error ) +}; + + +// MAIN // + +bench( pkg, opts, function benchmark( b ) { + var sigma; + var len; + var mu; + var x; + var y; + var i; + + len = 100; + x = new Float64Array( len ); + mu = new Float64Array( len ); + sigma = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + x[ i ] = ( randu() * 200.0 ) - 100.0; + mu[ i ] = ( randu() * 100.0 ) - 50.0; + sigma[ i ] = ( randu() * 20.0 ) + EPS; + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = logcdf( x[ i % len ], mu[ i % len ], sigma[ 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/normal/logcdf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/c/Makefile new file mode 100644 index 000000000000..806c5057b575 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/c/benchmark.c new file mode 100644 index 000000000000..2fff9522c994 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/c/benchmark.c @@ -0,0 +1,143 @@ +/** +* @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/normal/logcdf.h" +#include +#include +#include +#include +#include + +#define NAME "normal-logcdf" +#define ITERATIONS 1000000 +#define REPEATS 3 +#define LEN 100 + +/** +* 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 x[ LEN ]; + double mu[ LEN ]; + double sigma[ LEN ]; + double y; + double t; + int i; + + for ( i = 0; i < LEN; i++ ) { + x[ i ] = random_uniform( -100.0, 100.0 ); + mu[ i ] = random_uniform( -50.0, 50.0 ); + sigma[ i ] = random_uniform( 0.1, 20.0 ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_normal_logcdf( x[ i%LEN ], mu[ i%LEN ], sigma[ i%LEN ] ); + 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/normal/logcdf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c new file mode 100644 index 000000000000..69d81b5efb4f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c @@ -0,0 +1,43 @@ +/** +* @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/normal/logcdf.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 x; + double mu; + double sigma; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + x = random_uniform( 0.0, 10.0 ); + mu = random_uniform( -5.0, 5.0 ); + sigma = random_uniform( 0.0, 20.0 ); + y = stdlib_base_dists_normal_logcdf( x, mu, sigma ); + printf( "x: %lf, µ: %lf, σ: %lf, ln(F(x;µ,σ)): %lf\n", x, mu, sigma, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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': [ + '= -1.0: + return stdlib_base_log1p( -stdlib_base_erfc( z * INV_SQRT_TWO ) / 2.0 ); +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/test/test.native.js new file mode 100644 index 000000000000..b7ca703be32e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/test/test.native.js @@ -0,0 +1,160 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var EPS = require( '@stdlib/constants/float64/eps' ); + + +// FIXTURES // + +var data = require( './fixtures/r/data.json' ); + + +// VARIABLES // + +var logcdf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof logcdf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'if provided `NaN` for any parameter, the function returns `NaN`', function test( t ) { + var y; + + y = logcdf( NaN, 0.0, 1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logcdf( 0.0, NaN, 1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logcdf( 0.0, 1.0, NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logcdf( 0.0, NaN, NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logcdf( NaN, 1.0, NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logcdf( NaN, NaN, 1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logcdf( NaN, NaN, NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'if provided `Infinity` for `x` and a finite `mu` and `sigma`, the function returns `0`', function test( t ) { + var y = logcdf( PINF, 0.0, 1.0 ); + t.equal( y, 0, 'returns 0' ); + t.end(); +}); + +tape( 'if provided `-Infinity` for `x` and a finite `mu` and `sigma`, the function returns `-Infinity`', function test( t ) { + var y = logcdf( NINF, 0.0, 1.0 ); + t.equal( y, NINF, 'returns -Infinity' ); + t.end(); +}); + +tape( 'if provided a negative `sigma`, the function always returns `NaN`', function test( t ) { + var y; + + y = logcdf( 2.0, 0.0, -1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logcdf( 0.0, 0.0, -1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logcdf( 2.0, 0.0, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logcdf( 2.0, PINF, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logcdf( 2.0, NINF, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = logcdf( 2.0, NaN, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'if provided `sigma` equals `0`, the function evaluates a degenerate distribution centered at `mu`', function test( t ) { + var y; + + y = logcdf( PINF, 2.0, 0.0 ); + t.equal( y, 0, 'returns 0' ); + + y = logcdf( 2.0, 2.0, 0.0 ); + t.equal( y, 0, 'returns 0 for x equal to mu' ); + + y = logcdf( 1.0, 2.0, 0.0 ); + t.equal( y, NINF, 'returns -Infinity' ); + + y = logcdf( NINF, 2.0, 0.0 ); + t.equal( y, NINF, 'returns -Infinity' ); + + y = logcdf( NaN, 2.0, 0.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function evaluates the logcdf for `x` given parameters `mu` and `sigma`', function test( t ) { + var expected; + var delta; + var sigma; + var tol; + var mu; + var x; + var y; + var i; + + expected = data.expected; + x = data.x; + mu = data.mu; + sigma = data.sigma; + for ( i = 0; i < x.length; i++ ) { + y = logcdf( x[i], mu[i], sigma[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'x: '+x[i]+', mu:'+mu[i]+', sigma: '+sigma[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 1500.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[ i ]+'. mu: '+mu[i]+'. sigma: '+sigma[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); From a394bfdcb4890b55e815a1a2f038757241ae7772 Mon Sep 17 00:00:00 2001 From: Manvith <148960168+manvith2003@users.noreply.github.com> Date: Wed, 18 Dec 2024 19:53:09 +0530 Subject: [PATCH 2/9] docs: resolve the issue --- .../@stdlib/stats/base/dists/normal/logcdf/README.md | 4 +++- .../@stdlib/stats/base/dists/normal/logcdf/src/main.c | 3 +-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md index 226535ccba82..ababb6568ca9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md @@ -128,6 +128,8 @@ for ( i = 0; i < 10; i++ ) { + + * * * @@ -154,7 +156,7 @@ for ( i = 0; i < 10; i++ ) { #include "stdlib/stats/base/dists/normal/logcdf.h" ``` -#### stdlib_base_dists_normal_logcdf( x, a, b ) +#### stdlib_base_dists_normal_logcdf( x, mu, sigma ) Evaluates the logarithm of the cumulative distribution function (logCDF) for a normal distribution. diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/main.c index 64f8cd7e481d..403498e7ce26 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/main.c @@ -28,8 +28,7 @@ #define INV_SQRT_TWO 0.7071067811865475 // 1/sqrt(2) /** -* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Normal distribution -* with mean `mu` and standard deviation `sigma` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Normal distribution with mean `mu` and standard deviation `sigma` at a value `x`. * * @param x input value * @param mu mean of the distribution From f8b8b8495a6b950dcd19d25dfc90c29ea5dc2701 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Fri, 21 Feb 2025 01:53:25 +0000 Subject: [PATCH 3/9] chore: update copyright years --- .../base/dists/normal/logcdf/benchmark/benchmark.native.js | 2 +- .../@stdlib/stats/base/dists/normal/logcdf/benchmark/c/Makefile | 2 +- .../stats/base/dists/normal/logcdf/benchmark/c/benchmark.c | 2 +- .../@stdlib/stats/base/dists/normal/logcdf/binding.gyp | 2 +- .../@stdlib/stats/base/dists/normal/logcdf/examples/c/Makefile | 2 +- .../@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c | 2 +- .../@stdlib/stats/base/dists/normal/logcdf/include.gypi | 2 +- .../logcdf/include/stdlib/stats/base/dists/normal/logcdf.h | 2 +- .../@stdlib/stats/base/dists/normal/logcdf/lib/native.js | 2 +- .../@stdlib/stats/base/dists/normal/logcdf/src/Makefile | 2 +- .../@stdlib/stats/base/dists/normal/logcdf/src/addon.c | 2 +- .../@stdlib/stats/base/dists/normal/logcdf/src/main.c | 2 +- .../@stdlib/stats/base/dists/normal/logcdf/test/test.native.js | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js index 5d8fd0f7961f..9fa9b31988c6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/c/Makefile index 806c5057b575..07f5a7752db4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/c/benchmark.c index 2fff9522c994..6f29d8d21d51 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/binding.gyp index ec3992233442..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/Makefile index 6aed70daf167..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c index 69d81b5efb4f..136f02861b9f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/include.gypi index 575cb043c0bf..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/include/stdlib/stats/base/dists/normal/logcdf.h b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/include/stdlib/stats/base/dists/normal/logcdf.h index c4f3e98972fa..6d1ff07b5a6f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/include/stdlib/stats/base/dists/normal/logcdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/include/stdlib/stats/base/dists/normal/logcdf.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/normal/logcdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/lib/native.js index 3fbdcb1dbfc1..2cd8a6ff51be 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/Makefile index bcf18aa46655..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/addon.c index 8a459e0619f4..1d8bc9667f6f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/main.c index 403498e7ce26..3f05a959b02c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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/normal/logcdf/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/test/test.native.js index b7ca703be32e..255c1136f08c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/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 186efa69e50165e31ce49712d499eb880adfee04 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 17 Jun 2025 21:41:45 -0500 Subject: [PATCH 4/9] refactor: address PR review comments for normal/logcdf C implementation --- .../stats/base/dists/normal/logcdf/README.md | 6 +-- .../dists/normal/logcdf/examples/c/example.c | 29 ++++++------- .../stats/base/dists/normal/logcdf/src/main.c | 42 +++++++++---------- 3 files changed, 39 insertions(+), 38 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md index ababb6568ca9..c2aea5a07599 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md @@ -158,7 +158,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_normal_logcdf( x, mu, sigma ) -Evaluates the logarithm of the cumulative distribution function (logCDF) for a normal distribution. +Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [normal][normal-distribution] distribution with parameters `mu` (mean) and `sigma` (standard deviation). ```c double out = stdlib_base_dists_normal_cdf( 2.0, 0.0, 1.0 ); @@ -204,9 +204,9 @@ static double random_uniform( const double min, const double max ) { } int main( void ) { - double x; - double mu; double sigma; + double mu; + double x; double y; int i; diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c index 136f02861b9f..ac79015a91c7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c @@ -22,22 +22,23 @@ #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) ); + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); } int main( void ) { - double x; - double mu; - double sigma; - double y; - int i; + double x; + double mu; + double sigma; + double y; + int i; - for ( i = 0; i < 10; i++ ) { - x = random_uniform( 0.0, 10.0 ); - mu = random_uniform( -5.0, 5.0 ); - sigma = random_uniform( 0.0, 20.0 ); - y = stdlib_base_dists_normal_logcdf( x, mu, sigma ); - printf( "x: %lf, µ: %lf, σ: %lf, ln(F(x;µ,σ)): %lf\n", x, mu, sigma, y ); - } + for ( i = 0; i < 10; i++ ) { + x = random_uniform( 0.0, 10.0 ); + mu = random_uniform( -5.0, 5.0 ); + sigma = random_uniform( 0.0, 20.0 ); + y = stdlib_base_dists_normal_logcdf( x, mu, sigma ); + printf( "x: %lf, µ: %lf, σ: %lf, ln(F(x;µ,σ)): %lf\n", x, mu, sigma, y ); + } } + diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/main.c index 3f05a959b02c..8d48a4e34287 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/src/main.c @@ -25,14 +25,14 @@ #include "stdlib/math/base/special/abs2.h" #include "stdlib/constants/float64/ninf.h" -#define INV_SQRT_TWO 0.7071067811865475 // 1/sqrt(2) +static const double INV_SQRT_TWO = 0.7071067811865475; // 1/sqrt(2) /** -* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Normal distribution with mean `mu` and standard deviation `sigma` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a normal distribution with mean `mu` and standard deviation `sigma` at a value `x`. * -* @param x input value -* @param mu mean of the distribution -* @param sigma standard deviation of the distribution +* @param x input value +* @param mu mean of the distribution +* @param sigma standard deviation of the distribution * @return evaluated log CDF * * @example @@ -40,26 +40,26 @@ * // returns ~-0.023 */ double stdlib_base_dists_normal_logcdf( const double x, const double mu, const double sigma ) { - - double xc; - double z; + double xc; + double z; if ( - stdlib_base_is_nan( x ) || - stdlib_base_is_nan( mu ) || - stdlib_base_is_nan( sigma ) || - sigma < 0.0 - ) { - return 0.0 / 0.0; // NaN - } + stdlib_base_is_nan( x ) || + stdlib_base_is_nan( mu ) || + stdlib_base_is_nan( sigma ) || + sigma < 0.0 + ) { + return 0.0 / 0.0; // NaN + } if ( sigma == 0.0 ) { return (x < mu) ? STDLIB_CONSTANT_FLOAT64_NINF : 0.0; } - xc = x - mu; - z = xc / sigma; - if ( z < -1.0 ) { - return stdlib_base_ln( stdlib_base_erfcx( -z * INV_SQRT_TWO ) / 2.0 ) - ( stdlib_base_abs2( z ) / 2.0 ); - } - // Case: z >= -1.0: + xc = x - mu; + z = xc / sigma; + if ( z < -1.0 ) { + return stdlib_base_ln( stdlib_base_erfcx( -z * INV_SQRT_TWO ) / 2.0 ) - ( stdlib_base_abs2( z ) / 2.0 ); + } + // Case: z >= -1.0: return stdlib_base_log1p( -stdlib_base_erfc( z * INV_SQRT_TWO ) / 2.0 ); } + From 6e8e986ed92adda9a0bfafcd91d43899066b0df5 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 17 Jun 2025 22:44:57 -0400 Subject: [PATCH 5/9] docs: remove stray comment Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/normal/logcdf/README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md index c2aea5a07599..1ef754b8eed3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/README.md @@ -128,8 +128,6 @@ for ( i = 0; i < 10; i++ ) { - - * * * From dbb310eabb7120165af1d20289b586e93816ecb6 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 17 Jun 2025 21:46:52 -0500 Subject: [PATCH 6/9] refactor: remove unused time.h include from example --- .../@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c index ac79015a91c7..81abce71b866 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/examples/c/example.c @@ -19,7 +19,6 @@ #include "stdlib/stats/base/dists/normal/logcdf.h" #include #include -#include static double random_uniform( const double min, const double max ) { double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); From 23d0db04084e0b5c240444d9bd85cbcd1578c7b4 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 17 Jun 2025 21:49:56 -0500 Subject: [PATCH 7/9] refactor: update JS benchmarks to use array/uniform --- .../base/dists/normal/logcdf/benchmark/benchmark.js | 12 +++--------- .../normal/logcdf/benchmark/benchmark.native.js | 13 ++++--------- 2 files changed, 7 insertions(+), 18 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.js index ab409325275e..bc24e6b9ffa1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.js @@ -23,7 +23,6 @@ var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); var uniform = require( '@stdlib/random/array/uniform' ); -var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var EPS = require( '@stdlib/constants/float64/eps' ); var pkg = require( './../package.json' ).name; @@ -41,14 +40,9 @@ bench( pkg, function benchmark( b ) { var i; len = 100; - x = new Float64Array( len ); - mu = new Float64Array( len ); - sigma = new Float64Array( len ); - for ( i = 0; i < len; i++ ) { - x[ i ] = ( randu() * 200.0 ) - 100.0; - mu[ i ] = ( randu() * 100.0 ) - 50.0; - sigma[ i ] = ( randu() * 20.0 ) + EPS; - } + x = uniform( len, -100.0, 100.0 ); + mu = uniform( len, -50.0, 50.0 ); + sigma = uniform( len, EPS, 20.0 + EPS ); b.tic(); for ( i = 0; i < b.iterations; i++ ) { diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js index 9fa9b31988c6..d453ee7bbd68 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js @@ -23,7 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var tryRequire = require( '@stdlib/utils/try-require' ); var EPS = require( '@stdlib/constants/float64/eps' ); @@ -49,14 +49,9 @@ bench( pkg, opts, function benchmark( b ) { var i; len = 100; - x = new Float64Array( len ); - mu = new Float64Array( len ); - sigma = new Float64Array( len ); - for ( i = 0; i < len; i++ ) { - x[ i ] = ( randu() * 200.0 ) - 100.0; - mu[ i ] = ( randu() * 100.0 ) - 50.0; - sigma[ i ] = ( randu() * 20.0 ) + EPS; - } + x = uniform( len, -100.0, 100.0 ); + mu = uniform( len, -50.0, 50.0 ); + sigma = uniform( len, EPS, 20.0 + EPS ); b.tic(); for ( i = 0; i < b.iterations; i++ ) { From 510e1d03fd6e5088f68f16ca46854b6ed2effd18 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 17 Jun 2025 22:58:18 -0400 Subject: [PATCH 8/9] bench: remove unused require Signed-off-by: Philipp Burckhardt --- .../stats/base/dists/normal/logcdf/benchmark/benchmark.js | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.js index bc24e6b9ffa1..fe0d9990d5dc 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.js @@ -21,7 +21,6 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var Float64Array = require( '@stdlib/array/float64' ); var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var EPS = require( '@stdlib/constants/float64/eps' ); From a8abb0fb035b1b86b9fd1893dd9296bdf2cda529 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 17 Jun 2025 23:00:03 -0400 Subject: [PATCH 9/9] bench: remove unused require Signed-off-by: Philipp Burckhardt --- .../stats/base/dists/normal/logcdf/benchmark/benchmark.native.js | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js index d453ee7bbd68..04ebcefc5d1c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/normal/logcdf/benchmark/benchmark.native.js @@ -22,7 +22,6 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var Float64Array = require( '@stdlib/array/float64' ); var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var tryRequire = require( '@stdlib/utils/try-require' );