From 210301ca97472791a6efabef9c19ea64b2243d17 Mon Sep 17 00:00:00 2001 From: DhruvArvindSingh Date: Wed, 1 Jan 2025 10:46:14 +0000 Subject: [PATCH 1/6] feat: add c implementation for @stdlib/stats/base/dists/laplace/quantile --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../base/dists/laplace/quantile/README.md | 86 ++++++++ .../laplace/quantile/benchmark/benchmark.js | 17 +- .../quantile/benchmark/benchmark.native.js | 74 +++++++ .../laplace/quantile/benchmark/c/Makefile | 146 ++++++++++++++ .../laplace/quantile/benchmark/c/benchmark.c | 143 +++++++++++++ .../base/dists/laplace/quantile/binding.gyp | 170 ++++++++++++++++ .../laplace/quantile/examples/c/Makefile | 146 ++++++++++++++ .../laplace/quantile/examples/c/example.c | 42 ++++ .../base/dists/laplace/quantile/include.gypi | 53 +++++ .../stats/base/dists/laplace/quantile.h | 38 ++++ .../base/dists/laplace/quantile/lib/native.js | 76 +++++++ .../base/dists/laplace/quantile/manifest.json | 86 ++++++++ .../base/dists/laplace/quantile/package.json | 3 + .../base/dists/laplace/quantile/src/Makefile | 70 +++++++ .../base/dists/laplace/quantile/src/addon.c | 23 +++ .../base/dists/laplace/quantile/src/main.c | 79 ++++++++ .../laplace/quantile/test/test.native..js | 189 ++++++++++++++++++ 17 files changed, 1437 insertions(+), 4 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include/stdlib/stats/base/dists/laplace/quantile.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/test/test.native..js diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/README.md index 3b6cbad2f058..e4011e485875 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/README.md @@ -145,6 +145,92 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/laplace/quantile.h" +``` + +#### stdlib_base_dists_laplace_quantile( p, mu, b ) + +Evaluates the quantile function for a Laplace distribution with location parameter `mu` and scale parameter `b` at a probability `p`. + +```c +double out = stdlib_base_dists_laplace_quantile( 2.0, 0.0, 1.0 ); +// returns ~-0.07 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` probability paarmeter. +- **mu**: `[in] double` location parameter. +- **b**: `[in] double` rate parameter. + +```c +double stdlib_base_dists_laplace_quantile( const double p, const double mu, const double b ); +``` + +
+ + +
+
+ + +
+### Examples +```c +#include "stdlib/stats/base/dists/laplace/quantile.h" +#include +#include +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} +int main( void ) { + double mu; + double b; + double p; + double y; + int i; + for ( i = 0; i < 25; i++ ) { + mu = random_uniform( -5.0, 5.0 ); + b = random_uniform( 0.0, 20.0 ); + p = random_uniform( 0.0, 1.0 ); + y = stdlib_base_dists_laplace_quantile( p, mu, b ); + printf( "p: %lf, µ: %lf, b: %lf, quantile(X;x,µ,b): %lf\n", p, mu, b, y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.js index b36bb9c5cc5c..37656694212d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.js @@ -21,6 +21,7 @@ // MODULES // 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 EPS = require( '@stdlib/constants/float64/eps' ); @@ -32,17 +33,25 @@ var quantile = require( './../lib' ); bench( pkg, function benchmark( b ) { var scale; + var len; var mu; var p; var y; var i; + len = 100; + mu = new Float64Array( len ); + scale = new Float64Array( len ); + p = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + p[ i ] = randu(); + mu[ i ] = ( randu() * 100.0 ) - 50.0; + scale[ i ] = ( randu()*20.0 ) + EPS; + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - p = randu(); - mu = ( randu()*100.0 ) - 50.0; - scale = ( randu()*20.0 ) + EPS; - y = quantile( p, mu, scale ); + y = quantile( p[ i % len ], mu[ i % len ], scale[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.native.js new file mode 100644 index 000000000000..2d90e3300d48 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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 tryRequire = require( '@stdlib/utils/try-require' ); +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; + + +// VARIABLES // + +var quantile = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( quantile instanceof Error ) +}; + + +// MAIN // + +bench( pkg, opts, function benchmark( b ) { + var scale; + var len; + var mu; + var p; + var y; + var i; + + len = 100; + mu = new Float64Array( len ); + scale = new Float64Array( len ); + p = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + p[ i ] = randu(); + mu[ i ] = ( randu() * 100.0 ) - 50.0; + scale[ i ] = ( randu()*20.0 ) + EPS; + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = quantile( p[ i % len ], mu[ i % len ], scale[ 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/laplace/quantile/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/c/benchmark.c new file mode 100644 index 000000000000..11d907b34e63 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile.h" +#include "stdlib/constants/float64/eps.h" +#include +#include +#include +#include +#include + +#define NAME "laplace-quantile" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param elapsed elapsed time in seconds +*/ +static void print_results( double elapsed ) { + double rate = (double)ITERATIONS / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", ITERATIONS ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [min,max). +* +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number +*/ +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double mu[ 100 ]; + double b[ 100 ]; + double p[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + p[ i ] = random_uniform( 0.0, 1.0 ); + mu[ i ] = random_uniform( -50.0, 50.0 ); + b[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_laplace_quantile( p[ i%100 ], mu[ i%100 ], b[ 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/laplace/quantile/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/example.c new file mode 100644 index 000000000000..5573f2ce8e6b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/example.c @@ -0,0 +1,42 @@ +/** +* @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/laplace/quantile.h" +#include +#include + +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +int main( void ) { + double mu; + double b; + double p; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + mu = random_uniform( -5.0, 5.0 ); + b = random_uniform( 0.0, 20.0 ); + y = stdlib_base_dists_laplace_quantile( p, mu, b ); + printf( "p: %lf, µ: %lf, b: %lf, quantile(X;p,µ,b): %lf\n", p, mu, b, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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 0.0/0.0; // NaN + } + return mu - ( b * stdlib_base_signum( p-0.5 ) * stdlib_base_ln( 1.0 - ( 2.0 * stdlib_base_abs( p-0.5 ) ) ) ); +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/test/test.native..js b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/test/test.native..js new file mode 100644 index 000000000000..7e0cf594d023 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/test/test.native..js @@ -0,0 +1,189 @@ +/** +* @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' ); + + +// VARIABLES // + +var quantile = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( quantile instanceof Error ) +}; + + +// FIXTURES // + +var positiveMean = require( './fixtures/julia/positive_mean.json' ); +var negativeMean = require( './fixtures/julia/negative_mean.json' ); +var largeVariance = require( './fixtures/julia/large_variance.json' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof quantile, '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 = quantile( NaN, 0.0, 1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + y = quantile( 0.0, NaN, 1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + y = quantile( 0.0, 1.0, NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if provided a number outside `[0,1]` for `p` and a finite `mu` and `b`, the function returns `NaN`', opts, function test( t ) { + var y = quantile( 1.1, 0.0, 1.0 ); + t.equal( isnan( y ), true, 'returns true' ); + y = quantile( -0.1, 0.0, 1.0 ); + t.equal( isnan( y ), true, 'returns true' ); + t.end(); +}); + +tape( 'if provided a nonpositive `b`, the function returns `NaN`', opts, function test( t ) { + var y; + + y = quantile( 0.5, 2.0, -1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.2, 2.0, -1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, 2.0, 0.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.2, 2.0, 0.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.8, 1.0, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.7, PINF, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.7, NINF, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.2, NaN, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function evaluates the quantile function at `p` given positive `mu`', opts, function test( t ) { + var expected; + var delta; + var tol; + var mu; + var b; + var i; + var p; + var y; + + expected = positiveMean.expected; + p = positiveMean.p; + mu = positiveMean.mu; + b = positiveMean.b; + for ( i = 0; i < p.length; i++ ) { + y = quantile( p[i], mu[i], b[i] ); + if ( expected[i] !== null ) { + if ( y === expected[i] ) { + t.equal( y, expected[i], 'p: '+p[i]+', mu:'+mu[i]+', b: '+b[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 1.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. p: '+p[ i ]+'. mu: '+mu[i]+'. b: '+b[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + } + t.end(); +}); + +tape( 'the function evaluates the quantile function at `p` given negative `mu`', opts, function test( t ) { + var expected; + var delta; + var tol; + var mu; + var b; + var i; + var p; + var y; + + expected = negativeMean.expected; + p = negativeMean.p; + mu = negativeMean.mu; + b = negativeMean.b; + for ( i = 0; i < p.length; i++ ) { + y = quantile( p[i], mu[i], b[i] ); + if ( expected[i] !== null ) { + if ( y === expected[i] ) { + t.equal( y, expected[i], 'p: '+p[i]+', mu:'+mu[i]+', b: '+b[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 1.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. p: '+p[ i ]+'. mu: '+mu[i]+'. b: '+b[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + } + t.end(); +}); + +tape( 'the function evaluates the quantile function at `p` given large variance ( = large `b` )', opts, function test( t ) { + var expected; + var delta; + var tol; + var mu; + var b; + var i; + var p; + var y; + + expected = largeVariance.expected; + p = largeVariance.p; + mu = largeVariance.mu; + b = largeVariance.b; + for ( i = 0; i < p.length; i++ ) { + y = quantile( p[i], mu[i], b[i] ); + if ( expected[i] !== null ) { + if ( y === expected[i] ) { + t.equal( y, expected[i], 'p: '+p[i]+', mu:'+mu[i]+', b: '+b[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 1.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. p: '+p[ i ]+'. mu: '+mu[i]+'. b: '+b[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + } + t.end(); +}); From 84e21cf29442fb0ec8bca9dc06b5e37048659d53 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sun, 6 Apr 2025 19:51:11 +0000 Subject: [PATCH 2/6] chore: update copyright years --- .../base/dists/laplace/quantile/benchmark/benchmark.native.js | 2 +- .../stats/base/dists/laplace/quantile/benchmark/c/Makefile | 2 +- .../stats/base/dists/laplace/quantile/benchmark/c/benchmark.c | 2 +- .../@stdlib/stats/base/dists/laplace/quantile/binding.gyp | 2 +- .../stats/base/dists/laplace/quantile/examples/c/Makefile | 2 +- .../stats/base/dists/laplace/quantile/examples/c/example.c | 2 +- .../@stdlib/stats/base/dists/laplace/quantile/include.gypi | 2 +- .../quantile/include/stdlib/stats/base/dists/laplace/quantile.h | 2 +- .../@stdlib/stats/base/dists/laplace/quantile/lib/native.js | 2 +- .../@stdlib/stats/base/dists/laplace/quantile/src/Makefile | 2 +- .../@stdlib/stats/base/dists/laplace/quantile/src/addon.c | 2 +- .../@stdlib/stats/base/dists/laplace/quantile/src/main.c | 2 +- .../stats/base/dists/laplace/quantile/test/test.native..js | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.native.js index 2d90e3300d48..d8c689d5b828 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/c/Makefile index f69e9da2b4d3..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/c/benchmark.c index 11d907b34e63..99fced242119 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/binding.gyp index ec3992233442..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/Makefile index 6aed70daf167..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/example.c index 5573f2ce8e6b..4bb7fa8b08b0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include.gypi index 575cb043c0bf..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/include/stdlib/stats/base/dists/laplace/quantile.h b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include/stdlib/stats/base/dists/laplace/quantile.h index 3ad42058e550..db5d3bfb684a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include/stdlib/stats/base/dists/laplace/quantile.h +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include/stdlib/stats/base/dists/laplace/quantile.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/laplace/quantile/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/lib/native.js index f9dc9382e368..5c886b4feeef 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/Makefile index bcf18aa46655..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/addon.c index 3f30ac70ba5e..a8b85efff7b5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/main.c index 6e2dc26e4a22..05070614a7da 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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/laplace/quantile/test/test.native..js b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/test/test.native..js index 7e0cf594d023..0e6358122ed2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/test/test.native..js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/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 eef498e8c8f85dec0153cc3ee6cc1b2f0313af7d Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 6 Apr 2025 15:59:29 -0400 Subject: [PATCH 3/6] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../laplace/quantile/benchmark/c/benchmark.c | 2 +- .../laplace/quantile/examples/c/example.c | 2 +- .../stats/base/dists/laplace/quantile.h | 2 +- .../base/dists/laplace/quantile/lib/native.js | 1 + .../base/dists/laplace/quantile/src/addon.c | 1 - .../base/dists/laplace/quantile/src/main.c | 38 ++----------------- 6 files changed, 8 insertions(+), 38 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/c/benchmark.c index 99fced242119..8926a0a252dc 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/c/benchmark.c @@ -104,7 +104,7 @@ static double benchmark( void ) { for ( i = 0; i < 100; i++ ) { p[ i ] = random_uniform( 0.0, 1.0 ); mu[ i ] = random_uniform( -50.0, 50.0 ); - b[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + b[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 ); } t = tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/example.c index 4bb7fa8b08b0..6da01940cec6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/examples/c/example.c @@ -37,6 +37,6 @@ int main( void ) { mu = random_uniform( -5.0, 5.0 ); b = random_uniform( 0.0, 20.0 ); y = stdlib_base_dists_laplace_quantile( p, mu, b ); - printf( "p: %lf, µ: %lf, b: %lf, quantile(X;p,µ,b): %lf\n", p, mu, b, y ); + printf( "p: %lf, µ: %lf, b: %lf, Q(p;µ,b): %lf\n", p, mu, b, y ); } } diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include/stdlib/stats/base/dists/laplace/quantile.h b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include/stdlib/stats/base/dists/laplace/quantile.h index db5d3bfb684a..e6ab66d3c631 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include/stdlib/stats/base/dists/laplace/quantile.h +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/include/stdlib/stats/base/dists/laplace/quantile.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Returns the quantile function for a Laplace distribution with location parameter `mu` and scale parameter `b` at a probability `p`. +* Evaluates the quantile function for a Laplace distribution with location parameter `mu` and scale parameter `b` at a probability `p`. */ double stdlib_base_dists_laplace_quantile( const double p, const double mu, const double b ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/lib/native.js index 5c886b4feeef..53edd3e3d39e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/lib/native.js @@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' ); /** * Evaluates the quantile function for a Laplace distribution with location parameter `mu` and scale parameter `b` at a probability `p`. * +* @private * @param {Probability} p - input value * @param {number} mu - location parameter * @param {PositiveNumber} b - scale parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/addon.c index a8b85efff7b5..606cdd4dfdde 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/addon.c @@ -19,5 +19,4 @@ #include "stdlib/stats/base/dists/laplace/quantile.h" #include "stdlib/math/base/napi/ternary.h" -// cppcheck-suppress shadowFunction STDLIB_MATH_BASE_NAPI_MODULE_DDD_D( stdlib_base_dists_laplace_quantile ) diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/main.c index 05070614a7da..3d5d4cdcf072 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/main.c @@ -22,47 +22,17 @@ #include "stdlib/math/base/special/abs.h" #include "stdlib/math/base/special/ln.h" - /** * Returns the quantile function for a Laplace distribution with location parameter `mu` and scale parameter `b` at a probability `p`. * -* @param {Probability} p - input value -* @param {number} mu - location parameter -* @param {PositiveNumber} b - scale parameter -* @returns {number} evaluated quantile function +* @param p input value +* @param mu location parameter +* @param b scale parameter +* @returns evaluated quantile function * * @example * double y = stdlib_base_dists_laplace_quantile( 0.8, 0.0, 1.0 ); * // returns ~0.916 -* -* @example -* double y = stdlib_base_dists_laplace_quantile( 0.5, 4.0, 2.0 ); -* // returns 4.0 -* -* @example -* double y = stdlib_base_dists_laplace_quantile( 1.1, 0.0, 1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_laplace_quantile( -0.2, 0.0, 1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_laplace_quantile( NaN, 0.0, 1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_laplace_quantile( 0.0, NaN, 1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_laplace_quantile( 0.0, 0.0, NaN ); -* // returns NaN -* -* @example -* // Negative scale parameter: -* double y = stdlib_base_dists_laplace_quantile( 0.5, 0.0, -1.0 ); -* // returns NaN */ double stdlib_base_dists_laplace_quantile( const double p, const double mu, const double b ) { if ( From fe40b70d8c5358fbc6b50a2359c7bf518c7b317f Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 6 Apr 2025 16:32:32 -0400 Subject: [PATCH 4/6] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/laplace/quantile/README.md | 4 ++-- .../@stdlib/stats/base/dists/laplace/quantile/src/main.c | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/README.md index e4011e485875..cc0f4a69f85c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/README.md @@ -176,8 +176,8 @@ for ( i = 0; i < 100; i++ ) { Evaluates the quantile function for a Laplace distribution with location parameter `mu` and scale parameter `b` at a probability `p`. ```c -double out = stdlib_base_dists_laplace_quantile( 2.0, 0.0, 1.0 ); -// returns ~-0.07 +double out = stdlib_base_dists_laplace_quantile( 0.8, 0.0, 1.0 ); +// returns ~0.916 ``` The function accepts the following arguments: diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/main.c index 3d5d4cdcf072..1cb81bd06ff0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/src/main.c @@ -28,7 +28,7 @@ * @param p input value * @param mu location parameter * @param b scale parameter -* @returns evaluated quantile function +* @return evaluated quantile function * * @example * double y = stdlib_base_dists_laplace_quantile( 0.8, 0.0, 1.0 ); From 9d9dbb524cfd13eb6c93d801c79a73ffb925e39d Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 6 Apr 2025 16:34:06 -0400 Subject: [PATCH 5/6] bench: replace `randu` with `uniform` in benchmark --- .../dists/laplace/quantile/benchmark/benchmark.native.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.native.js index d8c689d5b828..063552cdb370 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/benchmark/benchmark.native.js @@ -24,7 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); var tryRequire = require( '@stdlib/utils/try-require' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var EPS = require( '@stdlib/constants/float64/eps' ); var pkg = require( './../package.json' ).name; @@ -53,9 +53,9 @@ bench( pkg, opts, function benchmark( b ) { scale = new Float64Array( len ); p = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - p[ i ] = randu(); - mu[ i ] = ( randu() * 100.0 ) - 50.0; - scale[ i ] = ( randu()*20.0 ) + EPS; + p[ i ] = uniform( 0.0, 1.0 ); + mu[ i ] = uniform( -50.0, 50.0 ); + scale[ i ] = uniform( EPS, 20.0 ); } b.tic(); From 38ef4f31402feb09dbfbbe2a07670307356b76a7 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 6 Apr 2025 16:35:10 -0400 Subject: [PATCH 6/6] chore: add empty lines and update printf format --- .../stats/base/dists/laplace/quantile/README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/README.md index cc0f4a69f85c..aeaeedeca940 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/quantile/README.md @@ -191,34 +191,46 @@ double stdlib_base_dists_laplace_quantile( const double p, const double mu, cons ```
+ + +
+
+ + +
+ ### Examples + ```c #include "stdlib/stats/base/dists/laplace/quantile.h" #include #include + static double random_uniform( const double min, const double max ) { double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); return min + ( v*(max-min) ); } + int main( void ) { double mu; double b; double p; double y; int i; + for ( i = 0; i < 25; i++ ) { mu = random_uniform( -5.0, 5.0 ); b = random_uniform( 0.0, 20.0 ); p = random_uniform( 0.0, 1.0 ); y = stdlib_base_dists_laplace_quantile( p, mu, b ); - printf( "p: %lf, µ: %lf, b: %lf, quantile(X;x,µ,b): %lf\n", p, mu, b, y ); + printf( "p: %lf, µ: %lf, b: %lf, Q(p;µ,b): %lf\n", p, mu, b, y ); } } ```