From 5350555236e8c4f40f5a8330212b17f6bb8b1496 Mon Sep 17 00:00:00 2001 From: DhruvArvindSingh Date: Sat, 28 Dec 2024 07:15:01 +0000 Subject: [PATCH 1/8] feat: added C implementation for @stdlib/stats/base/dists/pareto-type1/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: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - 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 --- --- 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 --- --- .../dists/pareto-type1/quantile/README.md | 84 +++++++ .../quantile/benchmark/benchmark.js | 17 +- .../quantile/benchmark/benchmark.native.js | 74 +++++++ .../quantile/benchmark/c/Makefile | 146 ++++++++++++ .../quantile/benchmark/c/benchmark.c | 142 ++++++++++++ .../dists/pareto-type1/quantile/binding.gyp | 170 ++++++++++++++ .../pareto-type1/quantile/examples/c/Makefile | 146 ++++++++++++ .../quantile/examples/c/example.c | 42 ++++ .../dists/pareto-type1/quantile/include.gypi | 53 +++++ .../stats/base/dists/pareto-type1/quantile.h | 38 ++++ .../dists/pareto-type1/quantile/lib/native.js | 83 +++++++ .../dists/pareto-type1/quantile/manifest.json | 79 +++++++ .../dists/pareto-type1/quantile/package.json | 3 + .../dists/pareto-type1/quantile/src/Makefile | 70 ++++++ .../dists/pareto-type1/quantile/src/addon.c | 23 ++ .../dists/pareto-type1/quantile/src/main.c | 85 +++++++ .../pareto-type1/quantile/test/test.native.js | 207 ++++++++++++++++++ 17 files changed, 1458 insertions(+), 4 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include/stdlib/stats/base/dists/pareto-type1/quantile.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md index 99cc5d125829..dad85b4ff0bd 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md @@ -157,6 +157,90 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/pareto-type1/quantile.h" +``` + +#### stdlib_base_dists_pareto_type1_quantile( p, alpha, beta ) + +Returns the quantile of a Pareto (Type I) distribution. + +```c +double y = stdlib_base_dists_pareto_type1_quantile( 0.8, 2.0, 1.0 ); +// returns ~2.236 +``` + +The function accepts the following arguments: + +- **alpha**: `[in] double` first shape parameter. +- **beta**: `[in] double` second shape parameter. + +```c +double stdlib_base_dists_pareto_type1_quantile( const double alpha, const double alpha, const double beta ); +``` + +
+ + +
+
+ + +
+### Examples +```c +#include "stdlib/stats/base/dists/pareto-type1/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 alpha; + double beta; + double y; + int i; + for ( i = 0; i < 25; i++ ) { + alpha = random_uniform( 0, 10 ) + 3.0; + beta = random_uniform( 0, 10 ); + y = stdlib_base_dists_pareto_type1_quantile( p, alpha, beta ); + printf( "p: %lf, α: %lf, β: %lf, quantile(X;α,β): %lf\n", p, alpha, beta, y ); + } +} +``` + +
+ + + +
+ + + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.js index a8eed82660e0..5f43bd9f6e78 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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' ); @@ -33,16 +34,24 @@ var quantile = require( './../lib' ); bench( pkg, function benchmark( b ) { var alpha; var beta; + var len; var p; var y; var i; + len = 100; + alpha = new Float64Array( len ); + beta = new Float64Array( len ); + p = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + p[ i ] = ( randu() * 1.0 ); + alpha[ i ] = ( randu() * 10.0 ) + 3.0 + EPS; + beta[ i ] = ( randu() * 10.0 ) + EPS; + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - p = randu(); - alpha = ( randu()*100.0 ) + EPS; - beta = ( randu()*100.0 ) + EPS; - y = quantile( p, alpha, beta ); + y = quantile( p[ i % len ], alpha[ i % len ], beta[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.native.js new file mode 100644 index 000000000000..f97e3e963244 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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+'::native', opts, function benchmark( b ) { + var alpha; + var beta; + var len; + var p; + var y; + var i; + + len = 100; + alpha = new Float64Array( len ); + beta = new Float64Array( len ); + p = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + p[ i ] = ( randu() * 1.0 ); + alpha[ i ] = ( randu() * 10.0 ) + 3.0 + EPS; + beta[ i ] = ( randu() * 10.0 ) + EPS; + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = quantile( p[ i % len ], alpha[ i % len ], beta[ 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/pareto-type1/quantile/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/benchmark.c new file mode 100644 index 000000000000..ad44fc1fb0c5 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/benchmark.c @@ -0,0 +1,142 @@ +/** +* @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/pareto-type1/quantile.h" +#include +#include +#include +#include +#include + +#define NAME "pareto-type1-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 alpha[ 100 ]; + double beta[ 100 ]; + double p[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + p[ i ] = random_uniform( 0.0, 1.0 ); + alpha[ i ] = random_uniform( 0.0, 10.0 ) + 3.0; + beta[ i ] = random_uniform( 0.0, 10.0 ) + 3.0; + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_pareto_type1_quantile( p[ i % 100 ], alpha[ i % 100 ], beta[ 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/pareto-type1/quantile/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/examples/c/example.c new file mode 100644 index 000000000000..484935c78a81 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/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 alpha; + double beta; + double p; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0, 1 ); + alpha = random_uniform( 0, 10 ) + 3.0; + beta = random_uniform( 0, 10 ); + y = stdlib_base_dists_pareto_type1_quantile( p, alpha, beta ); + printf( "p: %lf, α: %lf, β: %lf, skew(X;α,β): %lf\n", p, alpha, beta, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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 beta / stdlib_base_pow( 1.0 - p, 1.0/alpha ); +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/test/test.native.js new file mode 100644 index 000000000000..80864be98c86 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/test/test.native.js @@ -0,0 +1,207 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2018 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 largeAlpha = require( './fixtures/julia/large_alpha.json' ); +var largeBeta = require( './fixtures/julia/large_beta.json' ); +var bothLarge = require( './fixtures/julia/both_large.json' ); + + +// TESTS // + +tape( 'main export is a function', opts, 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, 1.0, 1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + y = quantile( 0.1, NaN, 1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + y = quantile( 0.1, 1.0, NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if provided a number outside `[0,1]` for `p` and a valid `alpha` and `beta`, the function returns `NaN`', opts, function test( t ) { + var y = quantile( 1.1, 1.0, 1.0 ); + t.equal( isnan( y ), true, 'returns true' ); + y = quantile( -0.1, 1.0, 1.0 ); + t.equal( isnan( y ), true, 'returns true' ); + t.end(); +}); + +tape( 'if provided a nonpositive `alpha`, the function returns `NaN`', opts, function test( t ) { + var y; + + y = quantile( 0.5, 0.0, 2.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, -1.0, 2.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, -1.0, 2.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, NINF, 1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, NINF, PINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, NINF, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, NINF, NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'if provided a nonpositive `beta`, the function returns `NaN`', opts, function test( t ) { + var y; + + y = quantile( 0.5, 2.0, 0.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, 2.0, -1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, 2.0, -1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, 1.0, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, PINF, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, NINF, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.5, NaN, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function evaluates the quantile for `x` given large parameters `alpha` and `beta`', opts, function test( t ) { + var expected; + var delta; + var alpha; + var beta; + var tol; + var i; + var p; + var y; + + expected = bothLarge.expected; + p = bothLarge.p; + alpha = bothLarge.alpha; + beta = bothLarge.beta; + for ( i = 0; i < p.length; i++ ) { + y = quantile( p[i], alpha[i], beta[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'p: '+p[i]+', alpha: '+alpha[i]+', beta: '+beta[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 ]+'. alpha: '+alpha[i]+'. beta: '+beta[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); + +tape( 'the function evaluates the quantile for `x` given large parameter `alpha`', opts, function test( t ) { + var expected; + var delta; + var alpha; + var beta; + var tol; + var i; + var p; + var y; + + expected = largeAlpha.expected; + p = largeAlpha.p; + alpha = largeAlpha.alpha; + beta = largeAlpha.beta; + for ( i = 0; i < p.length; i++ ) { + y = quantile( p[i], alpha[i], beta[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'p: '+p[i]+', alpha: '+alpha[i]+', beta: '+beta[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 ]+'. alpha: '+alpha[i]+'. beta: '+beta[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); + +tape( 'the function evaluates the quantile for `x` given large parameter `beta`', opts, function test( t ) { + var expected; + var delta; + var alpha; + var beta; + var tol; + var i; + var p; + var y; + + expected = largeBeta.expected; + p = largeBeta.p; + alpha = largeBeta.alpha; + beta = largeBeta.beta; + for ( i = 0; i < p.length; i++ ) { + y = quantile( p[i], alpha[i], beta[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'p: '+p[i]+', alpha: '+alpha[i]+', beta: '+beta[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 ]+'. alpha: '+alpha[i]+'. beta: '+beta[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); From 4aac4909cf236685902010c213d4d7d657e664ac Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Mon, 16 Jun 2025 22:36:29 +0000 Subject: [PATCH 2/8] chore: update copyright years --- .../dists/pareto-type1/quantile/benchmark/benchmark.native.js | 2 +- .../stats/base/dists/pareto-type1/quantile/benchmark/c/Makefile | 2 +- .../base/dists/pareto-type1/quantile/benchmark/c/benchmark.c | 2 +- .../@stdlib/stats/base/dists/pareto-type1/quantile/binding.gyp | 2 +- .../stats/base/dists/pareto-type1/quantile/examples/c/Makefile | 2 +- .../stats/base/dists/pareto-type1/quantile/examples/c/example.c | 2 +- .../@stdlib/stats/base/dists/pareto-type1/quantile/include.gypi | 2 +- .../include/stdlib/stats/base/dists/pareto-type1/quantile.h | 2 +- .../stats/base/dists/pareto-type1/quantile/lib/native.js | 2 +- .../@stdlib/stats/base/dists/pareto-type1/quantile/src/Makefile | 2 +- .../@stdlib/stats/base/dists/pareto-type1/quantile/src/addon.c | 2 +- .../@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c | 2 +- .../stats/base/dists/pareto-type1/quantile/test/test.native.js | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.native.js index f97e3e963244..bd0be8b1065c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/Makefile index f69e9da2b4d3..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/benchmark.c index ad44fc1fb0c5..a91e2909dbe8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/binding.gyp index ec3992233442..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/examples/c/Makefile index 6aed70daf167..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/examples/c/example.c index 484935c78a81..f398abe07873 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include.gypi index 575cb043c0bf..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/include/stdlib/stats/base/dists/pareto-type1/quantile.h b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include/stdlib/stats/base/dists/pareto-type1/quantile.h index aafef68c2ec0..9df05d4c675e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include/stdlib/stats/base/dists/pareto-type1/quantile.h +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include/stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/lib/native.js index 0f8baadeb799..b2d3b9b8a287 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/Makefile index bcf18aa46655..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/addon.c index 23de97d12b62..891c66ca4783 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c index 07f75e125f50..3b749bc73e15 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/quantile/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/test/test.native.js index 80864be98c86..e972b97fae1e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/test/test.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2018 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 2784d457b187e9f39f451c01ccfd05c766969e62 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Wed, 9 Jul 2025 21:38:34 -0500 Subject: [PATCH 3/8] chore: minor clean-up --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: 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 --- --- .../dists/pareto-type1/quantile/README.md | 25 ++++++++--- .../quantile/benchmark/benchmark.js | 22 +++------- .../quantile/benchmark/benchmark.native.js | 15 ++----- .../quantile/benchmark/c/benchmark.c | 4 +- .../quantile/examples/c/example.c | 8 ++-- .../stats/base/dists/pareto-type1/quantile.h | 2 +- .../dists/pareto-type1/quantile/src/main.c | 44 ++----------------- 7 files changed, 40 insertions(+), 80 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md index dad85b4ff0bd..0a325b7350ad 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md @@ -194,22 +194,32 @@ double y = stdlib_base_dists_pareto_type1_quantile( 0.8, 2.0, 1.0 ); The function accepts the following arguments: -- **alpha**: `[in] double` first shape parameter. -- **beta**: `[in] double` second shape parameter. +- **p**: `[in] double` input probability. +- **alpha**: `[in] double` shape parameter. +- **beta**: `[in] double` scale parameter. ```c -double stdlib_base_dists_pareto_type1_quantile( const double alpha, const double alpha, const double beta ); +double stdlib_base_dists_pareto_type1_quantile( const double p, const double alpha, const double beta ); ```
+ + +
+
+ + +
+ ### Examples + ```c #include "stdlib/stats/base/dists/pareto-type1/quantile.h" #include @@ -221,13 +231,16 @@ static double random_uniform( const double min, const double max ) { int main( void ) { double alpha; double beta; + double p; double y; int i; + for ( i = 0; i < 25; i++ ) { - alpha = random_uniform( 0, 10 ) + 3.0; - beta = random_uniform( 0, 10 ); + p = random_uniform( 0.0, 1.0 ); + alpha = random_uniform( 1.0, 10.0 ); + beta = random_uniform( 1.0, 10.0 ); y = stdlib_base_dists_pareto_type1_quantile( p, alpha, beta ); - printf( "p: %lf, α: %lf, β: %lf, quantile(X;α,β): %lf\n", p, alpha, beta, y ); + printf( "p: %lf, α: %lf, β: %lf, Q(p;α,β): %lf\n", p, alpha, beta, y ); } } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.js index 3207c93cec3b..05b0c762b7b6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.js @@ -21,10 +21,8 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var Float64Array = require( '@stdlib/array/float64' ); -var uniform = require( '@stdlib/random/base/uniform' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var EPS = require( '@stdlib/constants/float64/eps' ); var pkg = require( './../package.json' ).name; var quantile = require( './../lib' ); @@ -40,14 +38,9 @@ bench( pkg, function benchmark( b ) { var i; len = 100; - alpha = new Float64Array( len ); - beta = new Float64Array( len ); - p = new Float64Array( len ); - for ( i = 0; i < len; i++ ) { - p[ i ] = uniform( 0.0, 1.0 ); - alpha[ i ] = uniform( 3.0 + EPS, 100.0 ); - beta[ i ] = uniform( EPS, 100.0 ); - } + p = uniform( len, 0.0, 1.0 ); + alpha = uniform( len, 1.0, 100.0 ); + beta = uniform( len, 1.0, 100.0 ); b.tic(); for ( i = 0; i < b.iterations; i++ ) { @@ -74,13 +67,10 @@ bench( pkg+':factory', function benchmark( b ) { var i; alpha = 100.56789; - len = 100; beta = 55.54321; myquantile = quantile.factory( alpha, beta ); - p = new Float64Array( len ); - for ( i = 0; i < len; i++ ) { - p[ i ] = uniform( 0.0, 1.0 ); - } + len = 100; + p = uniform( len, 0.0, 1.0 ); b.tic(); for ( i = 0; i < b.iterations; i++ ) { diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.native.js index bd0be8b1065c..4d1a80b703ff 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/benchmark.native.js @@ -22,11 +22,9 @@ 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/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var EPS = require( '@stdlib/constants/float64/eps' ); var pkg = require( './../package.json' ).name; @@ -49,14 +47,9 @@ bench( pkg+'::native', opts, function benchmark( b ) { var i; len = 100; - alpha = new Float64Array( len ); - beta = new Float64Array( len ); - p = new Float64Array( len ); - for ( i = 0; i < len; i++ ) { - p[ i ] = ( randu() * 1.0 ); - alpha[ i ] = ( randu() * 10.0 ) + 3.0 + EPS; - beta[ i ] = ( randu() * 10.0 ) + EPS; - } + p = uniform( len, 0.0, 1.0 ); + alpha = uniform( len, 1.0, 10.0 ); + beta = uniform( len, 1.0, 10.0 ); b.tic(); for ( i = 0; i < b.iterations; i++ ) { diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/benchmark.c index a91e2909dbe8..eb4be282f905 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/benchmark/c/benchmark.c @@ -102,8 +102,8 @@ static double benchmark( void ) { for ( i = 0; i < 100; i++ ) { p[ i ] = random_uniform( 0.0, 1.0 ); - alpha[ i ] = random_uniform( 0.0, 10.0 ) + 3.0; - beta[ i ] = random_uniform( 0.0, 10.0 ) + 3.0; + alpha[ i ] = random_uniform( 1.0, 10.0 ); + beta[ i ] = random_uniform( 1.0, 10.0 ); } t = tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/examples/c/example.c index f398abe07873..ec0d5593a9dd 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/examples/c/example.c @@ -33,10 +33,10 @@ int main( void ) { int i; for ( i = 0; i < 25; i++ ) { - p = random_uniform( 0, 1 ); - alpha = random_uniform( 0, 10 ) + 3.0; - beta = random_uniform( 0, 10 ); + p = random_uniform( 0.0, 1.0 ); + alpha = random_uniform( 1.0, 10.0 ); + beta = random_uniform( 1.0, 10.0 ); y = stdlib_base_dists_pareto_type1_quantile( p, alpha, beta ); - printf( "p: %lf, α: %lf, β: %lf, skew(X;α,β): %lf\n", p, alpha, beta, y ); + printf( "p: %lf, α: %lf, β: %lf, Q(p;α,β): %lf\n", p, alpha, beta, y ); } } diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include/stdlib/stats/base/dists/pareto-type1/quantile.h b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include/stdlib/stats/base/dists/pareto-type1/quantile.h index 9df05d4c675e..44fb085a4697 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include/stdlib/stats/base/dists/pareto-type1/quantile.h +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/include/stdlib/stats/base/dists/pareto-type1/quantile.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Returns the qunatile of a Pareto (Type I) distribution. +* Evaluates the quantile function for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta` at a probability `p`. */ double stdlib_base_dists_pareto_type1_quantile( const double p, const double alpha, const double beta ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c index 3b749bc73e15..1ac4970da727 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c @@ -24,50 +24,14 @@ /** * Evaluates the quantile function for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta` at a probability `p`. * -* @param {Probability} p - input value -* @param {PositiveNumber} alpha - shape parameter -* @param {PositiveNumber} beta - scale parameter -* @returns {number} evaluated quantile function +* @param p input probability +* @param alpha shape parameter +* @param beta scale parameter +* @return evaluated quantile function * * @example * double y = stdlib_base_dists_pareto_type1_quantile( 0.8, 2.0, 1.0 ); * // returns ~2.236 -* -* @example -* double y = stdlib_base_dists_pareto_type1_quantile( 0.8, 1.0, 10.0 ); -* // returns ~50.0 -* -* @example -* double y = stdlib_base_dists_pareto_type1_quantile( 0.1, 1.0, 10.0 ); -* // returns ~11.111 -* -* @example -* double y = stdlib_base_dists_pareto_type1_quantile( 1.1, 1.0, 1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_pareto_type1_quantile( -0.2, 1.0, 1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_pareto_type1_quantile( NaN, 1.0, 1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_pareto_type1_quantile( 0.5, NaN, 1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_pareto_type1_quantile( 0.5, 1.0, NaN ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_pareto_type1_quantile( 0.5, -1.0, 1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_pareto_type1_quantile( 0.5, 1.0, -1.0 ); -* // returns NaN */ double stdlib_base_dists_pareto_type1_quantile( const double p, const double alpha, const double beta ) { if ( From bdb8233b6bdb5b8099ecb2eab3394032dcfc8ba1 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Wed, 9 Jul 2025 21:45:01 -0500 Subject: [PATCH 4/8] docs: fix up descriptions --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/base/dists/pareto-type1/quantile/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md index 0a325b7350ad..9013126ee933 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md @@ -55,7 +55,7 @@ var quantile = require( '@stdlib/stats/base/dists/pareto-type1/quantile' ); #### quantile( p, alpha, beta ) -Evaluates the [quantile function][quantile-function] for a [Pareto (Type I)][pareto-distribution] distribution with parameters `alpha` (shape parameter) and `beta` ( scale parameter). +Evaluates the [quantile function][quantile-function] for a [Pareto (Type I)][pareto-distribution] distribution with parameters `alpha` (shape parameter) and `beta` (scale parameter). ```javascript var y = quantile( 0.8, 2.0, 1.0 ); @@ -113,7 +113,7 @@ y = quantile( 0.4, 1.0, 0.0 ); #### quantile.factory( alpha, beta ) -Returns a function for evaluating the [quantile function][quantile-function] of a [Pareto (Type I)][pareto-distribution] distribution with parameters `alpha` (shape parameter) and `beta` ( scale parameter). +Returns a function for evaluating the [quantile function][quantile-function] of a [Pareto (Type I)][pareto-distribution] distribution with parameters `alpha` (shape parameter) and `beta` (scale parameter). ```javascript var myquantile = quantile.factory( 2.5, 0.5 ); @@ -185,7 +185,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_pareto_type1_quantile( p, alpha, beta ) -Returns the quantile of a Pareto (Type I) distribution. +Evaluates the [quantile function][quantile-function] for a [Pareto (Type I)][pareto-distribution] distribution with parameters `alpha` (shape parameter) and `beta` (scale parameter). ```c double y = stdlib_base_dists_pareto_type1_quantile( 0.8, 2.0, 1.0 ); From 4064b5fd95abb168fa5b535fddc2e49b325cecee Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Wed, 9 Jul 2025 22:46:35 -0400 Subject: [PATCH 5/8] style: remove extra empty line Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c index 1ac4970da727..699108a330b3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/main.c @@ -20,7 +20,6 @@ #include "stdlib/math/base/assert/is_nan.h" #include "stdlib/math/base/special/pow.h" - /** * Evaluates the quantile function for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta` at a probability `p`. * From e8f17a65430af523a8a2b3756a27ea76e668d27c Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Wed, 9 Jul 2025 22:48:48 -0400 Subject: [PATCH 6/8] style: add empty lines Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/pareto-type1/quantile/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md index 9013126ee933..70a3755aa8ea 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md @@ -224,10 +224,12 @@ double stdlib_base_dists_pareto_type1_quantile( const double p, const double alp #include "stdlib/stats/base/dists/pareto-type1/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 alpha; double beta; From e22e78a1930dbf3ea96192b10af43ae9bfb94cf8 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Wed, 9 Jul 2025 23:03:21 -0400 Subject: [PATCH 7/8] style: remove extra empty line Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/pareto-type1/quantile/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md index 70a3755aa8ea..8b4aa1084069 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/README.md @@ -255,7 +255,6 @@ int main( void ) { -
From b13ac2be139a2111cd9305477399cf74bda05be6 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Wed, 9 Jul 2025 23:05:05 -0400 Subject: [PATCH 8/8] chore: remove unused directive Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/pareto-type1/quantile/src/addon.c | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/addon.c index 891c66ca4783..d338dc79d3f1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/quantile/src/addon.c @@ -19,5 +19,4 @@ #include "stdlib/stats/base/dists/pareto-type1/quantile.h" #include "stdlib/math/base/napi/ternary.h" -// cppcheck-suppress shadowFunction STDLIB_MATH_BASE_NAPI_MODULE_DDD_D( stdlib_base_dists_pareto_type1_quantile )