From 04004ea3805eea9711b84e2d31812562b05be0a5 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 13:26:25 -0800 Subject: [PATCH 01/13] feat: add the C src files --- .../stats/base/dists/degenerate/quantile.h | 42 +++++++++++ .../dists/degenerate/quantile/src/Makefile | 70 +++++++++++++++++++ .../dists/degenerate/quantile/src/addon.c | 23 ++++++ .../base/dists/degenerate/quantile/src/main.c | 53 ++++++++++++++ 4 files changed, 188 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include/stdlib/stats/base/dists/degenerate/quantile.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include/stdlib/stats/base/dists/degenerate/quantile.h b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include/stdlib/stats/base/dists/degenerate/quantile.h new file mode 100644 index 000000000000..4b88e5d1d4b7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include/stdlib/stats/base/dists/degenerate/quantile.h @@ -0,0 +1,42 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#ifndef STDLIB_STATS_BASE_DISTS_DEGENERATE_QUANTILE_H +#define STDLIB_STATS_BASE_DISTS_DEGENERATE_QUANTILE_H + +/* +* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. +*/ +#ifdef __cplusplus +extern "C" { +#endif + +/** +* Evaluates the quantile function for a degenerate distribution centered at `mu`. +* +* @param p input value +* @param mu constant value of the distribution +* @return evaluated quantile function +*/ +double stdlib_base_dists_degenerate_quantile( const double p, const double mu ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_STATS_BASE_DISTS_DEGENERATE_QUANTILE_H diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/addon.c new file mode 100644 index 000000000000..0afa4f6cb37f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/addon.c @@ -0,0 +1,23 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/napi/binary.h" +#include "stdlib/stats/base/dists/degenerate/quantile.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_DD_D( stdlib_base_dists_degenerate_quantile ) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c new file mode 100644 index 000000000000..6b14903a1ed1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c @@ -0,0 +1,53 @@ +/** +* @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. +*/ + +#include "stdlib/math/base/assert/is_nan.h" + +/** +* Evaluates the quantile function for a degenerate distribution centered at `mu`. +* +* @param p input value (probability) +* @param mu constant value of the distribution +* @return evaluated quantile function, or NaN if input is invalid +* +* @example +* double y = stdlib_base_dists_degenerate_quantile( 0.5, 2.0 ); +* // returns 2.0 +* +* @example +* double y = stdlib_base_dists_degenerate_quantile( 0.9, 4.0 ); +* // returns 4.0 +* +* @example +* double y = stdlib_base_dists_degenerate_quantile( 1.1, 0.0 ); +* // returns NaN +* +* @example +* double y = stdlib_base_dists_degenerate_quantile( -0.2, 0.0 ); +* // returns NaN +* +* @example +* double y = stdlib_base_dists_degenerate_quantile( NAN, 0.0 ); +* // returns NaN +*/ +double stdlib_base_dists_degenerate_quantile( const double p, const double mu ) { + if ( stdlib_base_is_nan( p ) || p < 0.0 || p > 1.0 ) { + return 0.0 / 0.0; // NaN + } + return mu; +} From 361aabf34bd6c377d54839e761ba0038145bc588 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 13:26:43 -0800 Subject: [PATCH 02/13] feat: add the C benchmark and example files --- .../degenerate/quantile/benchmark/c/Makefile | 146 ++++++++++++++++++ .../quantile/benchmark/c/benchmark.c | 107 +++++++++++++ .../degenerate/quantile/examples/c/Makefile | 146 ++++++++++++++++++ .../degenerate/quantile/examples/c/example.c | 43 ++++++ 4 files changed, 442 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/Makefile new file mode 100644 index 000000000000..a4bd7b38fd74 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c new file mode 100644 index 000000000000..35f4785a568a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c @@ -0,0 +1,107 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/base/dists/degenerate/quantile.h" +#include +#include +#include +#include +#include + +#define NAME "degenerate-quantile" +#define ITERATIONS 1000000 +#define REPEATS 3 + +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +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" ); +} + +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" ); +} + +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +static double benchmark( void ) { + double elapsed; + double p[ 100 ]; + double mu[ 100 ]; + double y; + double start; + int i; + + for ( i = 0; i < 100; i++ ) { + p[ i ] = random_uniform( 0.0, 1.0 ); + mu[ i ] = random_uniform( -20.0, 20.0 ); + } + + start = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_degenerate_quantile( p[ i%100 ], mu[ i%100 ] ); + if ( isnan( y ) ) { // Check for NaN + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - start; + + if ( isnan( y ) ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +int main( void ) { + double elapsed; + int i; + + // 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/degenerate/quantile/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c new file mode 100644 index 000000000000..69e68404222b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c @@ -0,0 +1,43 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/base/dists/degenerate/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 p; + double mu; + double result; + int i; + + for ( i = 0; i < 10; i++ ) { + p = random_uniform( 0.0, 1.0 ); + mu = random_uniform( -20.0, 20.0 ); + result = stdlib_base_dists_degenerate_quantile( p, mu ); + + printf( "p: %lf, mu: %lf, Quantile: %lf \n", p, mu, result ); + } + + return 0; +} From 54e2e9a876034d0acac751865677e52437985a68 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 13:26:56 -0800 Subject: [PATCH 03/13] feat: add the JS native files --- .../quantile/benchmark/benchmark.native.js | 70 +++++++++++++++ .../dists/degenerate/quantile/lib/native.js | 67 +++++++++++++++ .../degenerate/quantile/test/test.native.js | 85 +++++++++++++++++++ 3 files changed, 222 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.native.js new file mode 100644 index 000000000000..61d635794a42 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.native.js @@ -0,0 +1,70 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var Float64Array = require( '@stdlib/array/float64' ); +var randu = require( '@stdlib/random/base/randu' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var 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 len; + var p; + var mu; + var y; + var i; + + len = 100; + p = new Float64Array( len ); + mu = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + p[ i ] = randu(); + mu[ i ] = ( randu() * 40.0 ) - 20.0; + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = quantile( p[ i % len ], mu[ 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/degenerate/quantile/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/lib/native.js new file mode 100644 index 000000000000..8e22616fe919 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/lib/native.js @@ -0,0 +1,67 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Evaluates the quantile function for a degenerate distribution centered at `mu`. +* +* @private +* @param {Probability} p - input value +* @param {number} mu - constant value of the distribution +* @returns {number} evaluated quantile function +* +* @example +* var y = quantile( 0.5, 2.0 ); +* // returns 2.0 +* +* @example +* var y = quantile( 0.9, 4.0 ); +* // returns 4.0 +* +* @example +* var y = quantile( 1.1, 0.0 ); +* // returns NaN +* +* @example +* var y = quantile( -0.2, 0.0 ); +* // returns NaN +* +* @example +* var y = quantile( NaN, 0.0 ); +* // returns NaN +* +* @example +* var y = quantile( 0.0, NaN ); +* // returns NaN +*/ +function quantile( p, mu ) { + return addon( p, mu ); +} + + +// EXPORTS // + +module.exports = quantile; diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/test/test.native.js new file mode 100644 index 000000000000..84ca4809d2bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/test/test.native.js @@ -0,0 +1,85 @@ +/** +* @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' ); + + +// VARIABLES // + +var quantile = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( quantile instanceof Error ) +}; + + +// 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; + + y = quantile( NaN, 0.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( 0.0, NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( NaN, NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'if provided a number outside the interval `[0,1]` for `p`, the function returns `NaN`', opts, function test( t ) { + var y; + + y = quantile( 1.1, 2.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = quantile( -0.1, 2.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'if provided a number on the interval `[0,1]` for `p`, the function returns `mu`', opts, function test( t ) { + var mu; + var y; + + mu = 2.0; + + y = quantile( 0.3, mu ); + t.equal( y, mu, 'returns `mu`' ); + + y = quantile( 0.8, mu ); + t.equal( y, mu, 'returns `mu`' ); + + t.end(); +}); From 646fc0a44eeabce41e718b792a6971faa9cf3a2c Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 13:27:10 -0800 Subject: [PATCH 04/13] build: added the json and gyp dependency files --- .../dists/degenerate/quantile/binding.gyp | 149 ++++++++++++++++++ .../dists/degenerate/quantile/include.gypi | 48 ++++++ .../dists/degenerate/quantile/manifest.json | 76 +++++++++ .../dists/degenerate/quantile/package.json | 3 + 4 files changed, 276 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/manifest.json diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/binding.gyp new file mode 100644 index 000000000000..114dcb77c6aa --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/binding.gyp @@ -0,0 +1,149 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + "includes": [ + "./include.gypi", + ], + # Define variables to be used throughout the configuration for all targets: + "variables": { + # Target name should match the add-on export name: + "addon_target_name%": "addon", + # Set variables based on the host OS: + "conditions": [ + [ + 'OS=="win"', + { + # Define the object file suffix: + "obj": "obj", + }, + { + # Define the object file suffix: + "obj": "o", + }, + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + # Define compile targets: + "targets": [ + # Target to generate an add-on: + { + # The target name should match the add-on export name: + "target_name": "<(addon_target_name)", + # Define dependencies: + "dependencies": [], + # Define directories which contain relevant include headers: + "include_dirs": [ + # Local include directory: + "<@(include_dirs)", + ], + # List of source files: + "sources": [ + "<@(src_files)", + "src/addon.c", + ], + # 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/degenerate/quantile/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include.gypi new file mode 100644 index 000000000000..235be47d6d3b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include.gypi @@ -0,0 +1,48 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + "variables": { + # Source directory: + "src_dir": "./src", + # Include directories: + "include_dirs": [ + " Date: Sun, 5 Jan 2025 13:27:22 -0800 Subject: [PATCH 05/13] docs: update README with C API documentation --- 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/degenerate/quantile/README.md | 98 +++++++++++++++++++ 1 file changed, 98 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md index d88ee8a4a413..d95f63b43e72 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md @@ -110,6 +110,104 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/degenerate/quantile.h" +``` + +#### stdlib_base_dists_degenerate_quantile( p, mu ) + +Evaluates the quantile function for a degenerate distribution centered at `mu`. + +```c +double out = stdlib_base_dists_degenerate_quantile( 0.5, 2.0 ); +// returns 2.0 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` input value (probability). +- **mu**: `[in] double` constant value of the distribution. + +```c +double stdlib_base_dists_degenerate_quantile( const double p, const double mu ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/degenerate/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 p; + double mu; + double result; + int i; + + for ( i = 0; i < 10; i++ ) { + p = random_uniform( 0.0, 1.0 ); + mu = random_uniform( -20.0, 20.0 ); + result = stdlib_base_dists_degenerate_quantile( p, mu ); + + printf( "p: %lf, mu: %lf, Quantile: %lf \n", p, mu, result ); + } + + return 0; +} +``` + +
+ + + +
+ + +
From 2e279a57e2bf648426958c897c4f09764d4eae6b Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Tue, 7 Jan 2025 19:45:04 -0800 Subject: [PATCH 06/13] refactor: fixed the formatting issues --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: 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: passed - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: passed - 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/degenerate/quantile/README.md | 4 +- .../quantile/benchmark/c/benchmark.c | 16 +- .../dists/degenerate/quantile/binding.gyp | 267 ++++++++++-------- .../degenerate/quantile/examples/c/example.c | 28 +- .../dists/degenerate/quantile/include.gypi | 53 ++-- .../dists/degenerate/quantile/package.json | 2 +- .../base/dists/degenerate/quantile/src/main.c | 24 +- 7 files changed, 202 insertions(+), 192 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md index d95f63b43e72..ef68f30aca36 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md @@ -183,9 +183,9 @@ static double random_uniform( const double min, const double max ) { } int main( void ) { + double result; double p; double mu; - double result; int i; for ( i = 0; i < 10; i++ ) { @@ -193,7 +193,7 @@ int main( void ) { mu = random_uniform( -20.0, 20.0 ); result = stdlib_base_dists_degenerate_quantile( p, mu ); - printf( "p: %lf, mu: %lf, Quantile: %lf \n", p, mu, result ); + printf( "p: %lf, µ: %lf, Q(p;µ): %lf \n", p, mu, result ); } return 0; diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c index 35f4785a568a..7722fa4428ab 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c @@ -16,12 +16,12 @@ * limitations under the License. */ +#include #include "stdlib/stats/base/dists/degenerate/quantile.h" -#include -#include #include +#include +#include #include -#include #define NAME "degenerate-quantile" #define ITERATIONS 1000000 @@ -52,12 +52,12 @@ static void print_results( double elapsed ) { static double tic( void ) { struct timeval now; gettimeofday( &now, NULL ); - return (double)now.tv_sec + (double)now.tv_usec/1.0e6; + return (double)now.tv_sec + (double)now.tv_usec / 1.0e6; } static double random_uniform( const double min, const double max ) { double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); - return min + ( v*(max-min) ); + return min + ( v * ( max - min ) ); } static double benchmark( void ) { @@ -75,7 +75,7 @@ static double benchmark( void ) { start = tic(); for ( i = 0; i < ITERATIONS; i++ ) { - y = stdlib_base_dists_degenerate_quantile( p[ i%100 ], mu[ i%100 ] ); + y = stdlib_base_dists_degenerate_quantile( p[ i % 100 ], mu[ i % 100 ] ); if ( isnan( y ) ) { // Check for NaN printf( "should not return NaN\n" ); break; @@ -93,7 +93,7 @@ int main( void ) { double elapsed; int i; - // Seed the random number generator: + // Seed the random number generator: srand( time( NULL ) ); print_version(); @@ -101,7 +101,7 @@ int main( void ) { printf( "# c::%s\n", NAME ); elapsed = benchmark(); print_results( elapsed ); - printf( "ok %d benchmark finished\n", i+1 ); + printf( "ok %d benchmark finished\n", i + 1 ); } print_summary( REPEATS, REPEATS ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/binding.gyp index 114dcb77c6aa..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/binding.gyp @@ -19,131 +19,152 @@ # [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: + # 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"', { - # 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)", - "src/addon.c", - ], - # 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", + # 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', ], - # C++ specific compiler flags: - "cflags_cpp": [ - # Specify the C++ standard to which a program is expected to conform: - "-std=c++11", + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', ], - # 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: + }, + ], # 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': [ { - "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 + '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/degenerate/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c index 69e68404222b..8b979a069b89 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c @@ -17,27 +17,27 @@ */ #include "stdlib/stats/base/dists/degenerate/quantile.h" -#include #include +#include static double random_uniform( const double min, const double max ) { - double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); - return min + ( v * ( max - min ) ); + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v * ( max - min ) ); } int main( void ) { - double p; - double mu; - double result; - int i; + double result; + double p; + double mu; + int i; - for ( i = 0; i < 10; i++ ) { - p = random_uniform( 0.0, 1.0 ); - mu = random_uniform( -20.0, 20.0 ); - result = stdlib_base_dists_degenerate_quantile( p, mu ); + for ( i = 0; i < 10; i++ ) { + p = random_uniform( 0.0, 1.0 ); + mu = random_uniform( -20.0, 20.0 ); + result = stdlib_base_dists_degenerate_quantile( p, mu ); - printf( "p: %lf, mu: %lf, Quantile: %lf \n", p, mu, result ); - } + printf( "p: %lf, µ: %lf, Q(p;µ): %lf \n", p, mu, result ); + } - return 0; + return 0; } diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include.gypi index 235be47d6d3b..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include.gypi @@ -21,28 +21,33 @@ # [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; + if ( stdlib_base_is_nan( p ) || p < 0.0 || p > 1.0 ) { + return 0.0 / 0.0; // NaN + } + return mu; } From 508c92f581e07b52b51c72b4590c7ad598b244a7 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Wed, 8 Jan 2025 18:45:41 -0800 Subject: [PATCH 07/13] refactor: fixed extra spaces and tabs --- 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: passed - task: lint_javascript_benchmarks status: na - 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: passed - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: passed - 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: passed --- --- .../@stdlib/stats/base/dists/degenerate/quantile/README.md | 3 --- .../base/dists/degenerate/quantile/benchmark/c/benchmark.c | 2 +- .../stats/base/dists/degenerate/quantile/examples/c/example.c | 3 --- .../@stdlib/stats/base/dists/degenerate/quantile/src/main.c | 2 +- .../stats/base/dists/degenerate/quantile/test/test.native.js | 2 +- 5 files changed, 3 insertions(+), 9 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md index ef68f30aca36..68e554342ae4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md @@ -192,11 +192,8 @@ int main( void ) { p = random_uniform( 0.0, 1.0 ); mu = random_uniform( -20.0, 20.0 ); result = stdlib_base_dists_degenerate_quantile( p, mu ); - printf( "p: %lf, µ: %lf, Q(p;µ): %lf \n", p, mu, result ); } - - return 0; } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c index 7722fa4428ab..0032f70af3ab 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c @@ -93,7 +93,7 @@ int main( void ) { double elapsed; int i; - // Seed the random number generator: + // Seed the random number generator: srand( time( NULL ) ); print_version(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c index 8b979a069b89..23cae90cdd1d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c @@ -35,9 +35,6 @@ int main( void ) { p = random_uniform( 0.0, 1.0 ); mu = random_uniform( -20.0, 20.0 ); result = stdlib_base_dists_degenerate_quantile( p, mu ); - printf( "p: %lf, µ: %lf, Q(p;µ): %lf \n", p, mu, result ); } - - return 0; } diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c index d58c05f32347..e2fef3e74613 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c @@ -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. diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/test/test.native.js index 84ca4809d2bf..e191e3ae4e8b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/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 f497e9e3aee7bdfefc98289c7d5a7fe252f80365 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Thu, 9 Jan 2025 03:01:07 +0000 Subject: [PATCH 08/13] fix: resolve lint errors --- .../dists/degenerate/quantile/benchmark/benchmark.native.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.native.js index 61d635794a42..3ced7a2e1e5b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.native.js @@ -41,8 +41,8 @@ var opts = { bench( pkg+'::native', opts, function benchmark( b ) { var len; - var p; var mu; + var p; var y; var i; From f0193c6e7176cce9aa5eae8b4745dbacc91de4ab Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Fri, 10 Jan 2025 22:02:49 -0800 Subject: [PATCH 09/13] refactor: apply suggestions from previous PRs --- 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: missing_dependencies - task: lint_c_examples status: na - 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: passed - task: run_c_benchmarks status: passed - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/stats/base/dists/degenerate/quantile/README.md | 2 +- .../base/dists/degenerate/quantile/benchmark/c/benchmark.c | 2 +- .../@stdlib/stats/base/dists/degenerate/quantile/src/main.c | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md index 68e554342ae4..79a206b8db20 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md @@ -138,7 +138,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_degenerate_quantile( p, mu ) -Evaluates the quantile function for a degenerate distribution centered at `mu`. +Evaluates the [quantile function][quantile-function] of a [degenerate distribution][degenerate-distribution] centered at `mu`. ```c double out = stdlib_base_dists_degenerate_quantile( 0.5, 2.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c index 0032f70af3ab..ff4cee8c78fe 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c @@ -16,12 +16,12 @@ * limitations under the License. */ -#include #include "stdlib/stats/base/dists/degenerate/quantile.h" #include #include #include #include +#include #define NAME "degenerate-quantile" #define ITERATIONS 1000000 diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c index e2fef3e74613..d3af202c8b18 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c @@ -23,7 +23,7 @@ * * @param p input value (probability) * @param mu constant value of the distribution -* @return evaluated quantile function, or NaN if input is invalid +* @return evaluated quantile function * * @example * double y = stdlib_base_dists_degenerate_quantile( 0.5, 2.0 ); From 012edd151e7c14a6bff7445785fb0ae7a389bc12 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Mon, 13 Jan 2025 19:51:07 -0800 Subject: [PATCH 10/13] refactor: update JS benchmarks number generation --- 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: na - 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: 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 --- --- .../base/dists/degenerate/quantile/benchmark/benchmark.js | 3 ++- .../dists/degenerate/quantile/benchmark/benchmark.native.js | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.js index ab818a910db9..d17acf324032 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.js @@ -22,6 +22,7 @@ var bench = require( '@stdlib/bench' ); var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pkg = require( './../package.json' ).name; var quantile = require( './../lib' ); @@ -38,7 +39,7 @@ bench( pkg, function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { p = randu(); - mu = ( randu()*100.0 ) - 50.0; + mu = uniform( -50.0, 50.0 ); y = quantile( p, mu ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.native.js index 3ced7a2e1e5b..7e3e85a76884 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/benchmark.native.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -51,7 +52,7 @@ bench( pkg+'::native', opts, function benchmark( b ) { mu = new Float64Array( len ); for ( i = 0; i < len; i++ ) { p[ i ] = randu(); - mu[ i ] = ( randu() * 40.0 ) - 20.0; + mu[ i ] = uniform( -50.0, 50.0 ); } b.tic(); From 2e8682da707d52d2c43999a5ee4d1f4a4b5bc851 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Mon, 13 Jan 2025 19:52:07 -0800 Subject: [PATCH 11/13] refactor: added the include header --- 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: na - 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: missing_dependencies - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: passed - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/stats/base/dists/degenerate/quantile/src/main.c | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c index d3af202c8b18..92de88653890 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c @@ -17,6 +17,7 @@ */ #include "stdlib/math/base/assert/is_nan.h" +#include "stdlib/stats/base/dists/degenerate/quantile.h" /** * Evaluates the quantile function for a degenerate distribution centered at `mu`. From 988bcd889383c5779a30b30661afef4f8c5b2a33 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 14 Jan 2025 22:28:31 -0500 Subject: [PATCH 12/13] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/degenerate/quantile/README.md | 2 +- .../base/dists/degenerate/quantile/benchmark/c/benchmark.c | 6 +++--- .../include/stdlib/stats/base/dists/degenerate/quantile.h | 4 ---- 3 files changed, 4 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md index 79a206b8db20..91b1573217d1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md @@ -184,8 +184,8 @@ static double random_uniform( const double min, const double max ) { int main( void ) { double result; - double p; double mu; + double p; int i; for ( i = 0; i < 10; i++ ) { diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c index ff4cee8c78fe..12a7b91d9db6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c @@ -61,11 +61,11 @@ static double random_uniform( const double min, const double max ) { } static double benchmark( void ) { - double elapsed; - double p[ 100 ]; double mu[ 100 ]; - double y; + double p[ 100 ]; + double elapsed; double start; + double y; int i; for ( i = 0; i < 100; i++ ) { diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include/stdlib/stats/base/dists/degenerate/quantile.h b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include/stdlib/stats/base/dists/degenerate/quantile.h index 4b88e5d1d4b7..0a4cac16bf9f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include/stdlib/stats/base/dists/degenerate/quantile.h +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/include/stdlib/stats/base/dists/degenerate/quantile.h @@ -28,10 +28,6 @@ extern "C" { /** * Evaluates the quantile function for a degenerate distribution centered at `mu`. -* -* @param p input value -* @param mu constant value of the distribution -* @return evaluated quantile function */ double stdlib_base_dists_degenerate_quantile( const double p, const double mu ); From 57dd3dcef6f390ee3ca9acf754d66ccdabb9f0bc Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Wed, 15 Jan 2025 20:16:19 -0800 Subject: [PATCH 13/13] chore: reapply suggestions from PR review --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - 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: 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: passed - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: passed - 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 --- --- .../quantile/benchmark/c/benchmark.c | 48 ++++++++++++++++--- .../degenerate/quantile/examples/c/example.c | 4 +- .../dists/degenerate/quantile/src/addon.c | 2 +- .../base/dists/degenerate/quantile/src/main.c | 4 +- 4 files changed, 46 insertions(+), 12 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c index 12a7b91d9db6..a5e86444a6c6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/benchmark/c/benchmark.c @@ -17,9 +17,9 @@ */ #include "stdlib/stats/base/dists/degenerate/quantile.h" -#include -#include #include +#include +#include #include #include @@ -27,10 +27,19 @@ #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 @@ -40,6 +49,11 @@ static void print_summary( int total, int passing ) { 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" ); @@ -49,17 +63,34 @@ static void print_results( double elapsed ) { 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; + 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 ) ); + return min + ( v*(max-min) ); } +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ static double benchmark( void ) { double mu[ 100 ]; double p[ 100 ]; @@ -70,13 +101,13 @@ static double benchmark( void ) { for ( i = 0; i < 100; i++ ) { p[ i ] = random_uniform( 0.0, 1.0 ); - mu[ i ] = random_uniform( -20.0, 20.0 ); + mu[ i ] = random_uniform( -50.0, 50.0 ); } start = tic(); for ( i = 0; i < ITERATIONS; i++ ) { y = stdlib_base_dists_degenerate_quantile( p[ i % 100 ], mu[ i % 100 ] ); - if ( isnan( y ) ) { // Check for NaN + if ( isnan( y ) ) { printf( "should not return NaN\n" ); break; } @@ -89,11 +120,14 @@ static double benchmark( void ) { return elapsed; } +/** +* Main execution sequence. +*/ int main( void ) { double elapsed; int i; - // Seed the random number generator: + // Use the current time to seed the random number generator: srand( time( NULL ) ); print_version(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c index 23cae90cdd1d..f4a9a709960a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/examples/c/example.c @@ -17,8 +17,8 @@ */ #include "stdlib/stats/base/dists/degenerate/quantile.h" -#include #include +#include static double random_uniform( const double min, const double max ) { double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); @@ -27,8 +27,8 @@ static double random_uniform( const double min, const double max ) { int main( void ) { double result; - double p; double mu; + double p; int i; for ( i = 0; i < 10; i++ ) { diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/addon.c index 0afa4f6cb37f..5ad245e7551e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/addon.c @@ -16,8 +16,8 @@ * limitations under the License. */ -#include "stdlib/math/base/napi/binary.h" #include "stdlib/stats/base/dists/degenerate/quantile.h" +#include "stdlib/math/base/napi/binary.h" // cppcheck-suppress shadowFunction STDLIB_MATH_BASE_NAPI_MODULE_DD_D( stdlib_base_dists_degenerate_quantile ) diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c index 92de88653890..cbc437d0a65b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/src/main.c @@ -16,13 +16,13 @@ * limitations under the License. */ -#include "stdlib/math/base/assert/is_nan.h" #include "stdlib/stats/base/dists/degenerate/quantile.h" +#include "stdlib/math/base/assert/is_nan.h" /** * Evaluates the quantile function for a degenerate distribution centered at `mu`. * -* @param p input value (probability) +* @param p input value * @param mu constant value of the distribution * @return evaluated quantile function *