From 320a38117665118560b5f65d45c3231fb9590f94 Mon Sep 17 00:00:00 2001 From: Nishchay Rajput Date: Mon, 13 Jan 2025 18:17:29 +0530 Subject: [PATCH 1/8] feat: add C implementation for @stdlib/stats/base/dists/frechet/cdf --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/base/dists/frechet/cdf/README.md | 103 ++++++++ .../dists/frechet/cdf/benchmark/benchmark.js | 21 +- .../frechet/cdf/benchmark/benchmark.native.js | 76 ++++++ .../dists/frechet/cdf/benchmark/c/Makefile | 146 ++++++++++++ .../dists/frechet/cdf/benchmark/c/benchmark.c | 145 ++++++++++++ .../stats/base/dists/frechet/cdf/binding.gyp | 170 +++++++++++++ .../dists/frechet/cdf/examples/c/Makefile | 146 ++++++++++++ .../dists/frechet/cdf/examples/c/example.c | 44 ++++ .../stats/base/dists/frechet/cdf/include.gypi | 53 +++++ .../stdlib/stats/base/dists/frechet/cdf.h | 38 +++ .../base/dists/frechet/cdf/lib/native.js | 81 +++++++ .../base/dists/frechet/cdf/manifest.json | 83 +++++++ .../stats/base/dists/frechet/cdf/package.json | 3 + .../stats/base/dists/frechet/cdf/src/Makefile | 70 ++++++ .../stats/base/dists/frechet/cdf/src/addon.c | 23 ++ .../stats/base/dists/frechet/cdf/src/main.c | 55 +++++ .../dists/frechet/cdf/test/test.native.js | 223 ++++++++++++++++++ 17 files changed, 1474 insertions(+), 6 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/include/stdlib/stats/base/dists/frechet/cdf.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md index a69c3ccc2770..ab7bbea37a8b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md @@ -160,6 +160,109 @@ for ( i = 0; i < 100; i++ ) { + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/frechet/cdf.h" +``` + +#### stdlib_base_dists_frechet_cdf( x, alpha, s, m ) + +Returns the cumulative distribution function (CDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. + +```c +double y = stdlib_base_frechet_cdf( 10.0, 2.0, 3.0, 2.0 ); +// returns ~0.869 +``` + +The function accepts the following arguments: + +- **alpha**: `[in] double` shape parameter. +- **x**: `[in] double` input value. +- **s**: `[in] double` scale parameter. +- **m**: `[in] double` location parameter. + +```c +double stdlib_base_dists_frechet_cdf( const double x, const double alpha, const double s, const double m ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/frechet/cdf.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 x; + double s; + double m; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + x = random_uniform( 0.0, 10.0 ); + alpha = random_uniform( 0.0, 10.0 ); + s = random_uniform( 0.0, 10.0 ); + m = random_uniform( 0.0, 10.0 ); + y = stdlib_base_dists_frechet_cdf( x, alpha, s, m ); + printf( "x: %lf, alpha: %lf, s: %lf, m: %lf, F(x;alpha,s,m): %lf\n", x, alpha, s, m, y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.js index a6f8f315bd34..77aefe1cf8aa 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.js @@ -22,6 +22,7 @@ var bench = require( '@stdlib/bench' ); var randu = require( '@stdlib/random/base/randu' ); +var Float64Array = require( '@stdlib/array/float64' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var EPS = require( '@stdlib/constants/float64/eps' ); var pkg = require( './../package.json' ).name; @@ -32,19 +33,27 @@ var cdf = require( './../lib' ); bench( pkg, function benchmark( b ) { var alpha; - var m; + var len; var s; var x; + var m; var y; var i; + len = 100; + alpha = new Float64Array( len ); + x = new Float64Array( len ); + s = new Float64Array( len ); + m = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + x = ( randu()*100.0 ) - 50.0; + alpha[ i ] = ( randu()*20.0 ) + EPS; + m[ i ] = ( randu()*60.0 ) - 20.0; + s[ i ] = ( randu()*20.0 ) + EPS; + } b.tic(); for ( i = 0; i < b.iterations; i++ ) { - x = ( randu()*100.0 ) - 50.0; - alpha = ( randu()*20.0 ) + EPS; - m = ( randu()*60.0 ) - 20.0; - s = ( randu()*20.0 ) + EPS; - y = cdf( x, alpha, s, m ); + y = cdf( x[ i % len ], alpha[ i % len ], s[ i % len ], m[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..e546979c2c79 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.native.js @@ -0,0 +1,76 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var Float64Array = require( '@stdlib/array/float64' ); +var randu = require( '@stdlib/random/base/randu' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var cdf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( cdf instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var alpha; + var len; + var s; + var x; + var m; + var y; + var i; + + len = 100; + alpha = new Float64Array( len ); + x = new Float64Array( len ); + s = new Float64Array( len ); + m = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + x = ( randu()*100.0 ) - 50.0; + alpha[ i ] = ( randu()*20.0 ) + EPS; + m[ i ] = ( randu()*60.0 ) - 20.0; + s[ i ] = ( randu()*20.0 ) + EPS; + } + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = cdf( x[ i % len ], alpha[ i % len ], s[ i % len ], m[ 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/frechet/cdf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/c/Makefile new file mode 100644 index 000000000000..a4bd7b38fd74 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/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/frechet/cdf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/c/benchmark.c new file mode 100644 index 000000000000..4bcf67a8c766 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/c/benchmark.c @@ -0,0 +1,145 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/base/dists/frechet/cdf.h" +#include "stdlib/constants/float64/eps.h" +#include +#include +#include +#include +#include + +#define NAME "frechet-cdf" +#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 s[ 100 ]; + double x[ 100 ]; + double m[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = random_uniform( 0.0, 100.0 ) - 50.0; + alpha[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + m[ i ] = random_uniform( 0.0, 60.0 ) - 20.0; + s[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_frechet_cdf( x[ i % 100 ], alpha[ i % 100 ], s[ i % 100 ], m[ 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/frechet/cdf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/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/frechet/cdf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/example.c new file mode 100644 index 000000000000..6f1f03dd28d7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/example.c @@ -0,0 +1,44 @@ +/** +* @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/frechet/cdf.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 x; + double s; + double m; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + x = random_uniform( 0.0, 10.0 ); + alpha = random_uniform( 0.0, 10.0 ); + s = random_uniform( 0.0, 10.0 ); + m = random_uniform( 0.0, 10.0 ); + y = stdlib_base_dists_frechet_cdf( x, alpha, s, m ); + printf( "x: %lf, alpha: %lf, s: %lf, m: %lf, F(x;alpha,s,m): %lf\n", x, alpha, s, m, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + ' Date: Mon, 13 Jan 2025 23:15:43 +0530 Subject: [PATCH 2/8] fix: benchmark --- 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 --- --- 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/frechet/cdf/benchmark/benchmark.js | 2 +- .../stats/base/dists/frechet/cdf/benchmark/benchmark.native.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.js index 77aefe1cf8aa..4678469f9cd4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.js @@ -46,7 +46,7 @@ bench( pkg, function benchmark( b ) { s = new Float64Array( len ); m = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - x = ( randu()*100.0 ) - 50.0; + x[ i ] = ( randu()*100.0 ) - 50.0; alpha[ i ] = ( randu()*20.0 ) + EPS; m[ i ] = ( randu()*60.0 ) - 20.0; s[ i ] = ( randu()*20.0 ) + EPS; diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.native.js index e546979c2c79..204b8e1fd0cb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.native.js @@ -55,7 +55,7 @@ bench( pkg+'::native', opts, function benchmark( b ) { s = new Float64Array( len ); m = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - x = ( randu()*100.0 ) - 50.0; + x[ i ] = ( randu()*100.0 ) - 50.0; alpha[ i ] = ( randu()*20.0 ) + EPS; m[ i ] = ( randu()*60.0 ) - 20.0; s[ i ] = ( randu()*20.0 ) + EPS; From 35660ae051a90243aeeb3df59efe6e4d189df998 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 22 Jun 2025 12:14:01 -0500 Subject: [PATCH 3/8] fix: update documentation and examples to use proper uniform distributions --- 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: passed - 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 --- --- .../stats/base/dists/frechet/cdf/README.md | 20 ++++++++++--------- .../dists/frechet/cdf/benchmark/benchmark.js | 12 +++++------ .../frechet/cdf/benchmark/benchmark.native.js | 10 +++++----- .../dists/frechet/cdf/benchmark/c/benchmark.c | 8 ++++---- .../dists/frechet/cdf/examples/c/example.c | 9 +++++---- .../base/dists/frechet/cdf/examples/index.js | 11 +++++----- .../stdlib/stats/base/dists/frechet/cdf.h | 2 +- .../base/dists/frechet/cdf/manifest.json | 1 + .../stats/base/dists/frechet/cdf/src/main.c | 6 +++--- 9 files changed, 42 insertions(+), 37 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md index ab7bbea37a8b..cfac53c6906e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md @@ -136,7 +136,8 @@ y = mycdf( 7.0 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var EPS = require( '@stdlib/constants/float64/eps' ); var cdf = require( '@stdlib/stats/base/dists/frechet/cdf' ); var alpha; @@ -147,10 +148,10 @@ var y; var i; for ( i = 0; i < 100; i++ ) { - alpha = randu() * 10.0; - x = randu() * 10.0; - s = randu() * 10.0; - m = randu() * 10.0; + alpha = uniform( EPS, 5.0 ); + s = uniform( EPS, 5.0 ); + m = uniform( -2.0, 2.0 ); + x = uniform( m + 0.1, m + 10.0 ); y = cdf( x, alpha, s, m ); console.log( 'x: %d, α: %d, s: %d, m: %d, F(x;α,s,m): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), s.toFixed( 4 ), m.toFixed( 4 ), y.toFixed( 4 ) ); } @@ -228,6 +229,7 @@ double stdlib_base_dists_frechet_cdf( const double x, const double alpha, const ```c #include "stdlib/stats/base/dists/frechet/cdf.h" +#include "stdlib/constants/float64/eps.h" #include #include @@ -245,10 +247,10 @@ int main( void ) { int i; for ( i = 0; i < 10; i++ ) { - x = random_uniform( 0.0, 10.0 ); - alpha = random_uniform( 0.0, 10.0 ); - s = random_uniform( 0.0, 10.0 ); - m = random_uniform( 0.0, 10.0 ); + alpha = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 5.0 ); + s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 5.0 ); + m = random_uniform( -2.0, 2.0 ); + x = random_uniform( m + 0.1, m + 10.0 ); y = stdlib_base_dists_frechet_cdf( x, alpha, s, m ); printf( "x: %lf, alpha: %lf, s: %lf, m: %lf, F(x;alpha,s,m): %lf\n", x, alpha, s, m, y ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.js index 4678469f9cd4..920cf9fb69ef 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.js @@ -21,7 +21,7 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var Float64Array = require( '@stdlib/array/float64' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var EPS = require( '@stdlib/constants/float64/eps' ); @@ -46,10 +46,10 @@ bench( pkg, function benchmark( b ) { s = new Float64Array( len ); m = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - x[ i ] = ( randu()*100.0 ) - 50.0; - alpha[ i ] = ( randu()*20.0 ) + EPS; - m[ i ] = ( randu()*60.0 ) - 20.0; - s[ i ] = ( randu()*20.0 ) + EPS; + alpha[ i ] = uniform( EPS, 5.0 ); + s[ i ] = uniform( EPS, 5.0 ); + m[ i ] = uniform( -2.0, 2.0 ); + x[ i ] = uniform( m[ i ] + 0.1, m[ i ] + 20.0 ); } b.tic(); for ( i = 0; i < b.iterations; i++ ) { @@ -82,7 +82,7 @@ bench( pkg+':factory', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - x = randu() * 50.0; + x = uniform( m + 0.1, m + 50.0 ); y = mycdf( x ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.native.js index 204b8e1fd0cb..e8efeb1a84e6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/benchmark.native.js @@ -23,7 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var tryRequire = require( '@stdlib/utils/try-require' ); var EPS = require( '@stdlib/constants/float64/eps' ); @@ -55,10 +55,10 @@ bench( pkg+'::native', opts, function benchmark( b ) { s = new Float64Array( len ); m = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - x[ i ] = ( randu()*100.0 ) - 50.0; - alpha[ i ] = ( randu()*20.0 ) + EPS; - m[ i ] = ( randu()*60.0 ) - 20.0; - s[ i ] = ( randu()*20.0 ) + EPS; + alpha[ i ] = uniform( EPS, 5.0 ); + s[ i ] = uniform( EPS, 5.0 ); + m[ i ] = uniform( -2.0, 2.0 ); + x[ i ] = uniform( m[ i ] + 0.1, m[ i ] + 20.0 ); } b.tic(); for ( i = 0; i < b.iterations; i++ ) { diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/c/benchmark.c index 4bcf67a8c766..44cca35d4093 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/benchmark/c/benchmark.c @@ -103,10 +103,10 @@ static double benchmark( void ) { int i; for ( i = 0; i < 100; i++ ) { - x[ i ] = random_uniform( 0.0, 100.0 ) - 50.0; - alpha[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; - m[ i ] = random_uniform( 0.0, 60.0 ) - 20.0; - s[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + alpha[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 5.0 ); + s[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 5.0 ); + m[ i ] = random_uniform( -2.0, 2.0 ); + x[ i ] = random_uniform( m[ i ] + 0.1, m[ i ] + 20.0 ); } t = tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/example.c index 6f1f03dd28d7..9913c719c50e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/example.c @@ -17,6 +17,7 @@ */ #include "stdlib/stats/base/dists/frechet/cdf.h" +#include "stdlib/constants/float64/eps.h" #include #include @@ -34,10 +35,10 @@ int main( void ) { int i; for ( i = 0; i < 10; i++ ) { - x = random_uniform( 0.0, 10.0 ); - alpha = random_uniform( 0.0, 10.0 ); - s = random_uniform( 0.0, 10.0 ); - m = random_uniform( 0.0, 10.0 ); + alpha = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 5.0 ); + s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 5.0 ); + m = random_uniform( -2.0, 2.0 ); + x = random_uniform( m + 0.1, m + 10.0 ); y = stdlib_base_dists_frechet_cdf( x, alpha, s, m ); printf( "x: %lf, alpha: %lf, s: %lf, m: %lf, F(x;alpha,s,m): %lf\n", x, alpha, s, m, y ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/index.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/index.js index 13cd7ab63be5..8acbd1051b10 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/index.js @@ -18,7 +18,8 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var EPS = require( '@stdlib/constants/float64/eps' ); var cdf = require( './../lib' ); var alpha; @@ -29,10 +30,10 @@ var y; var i; for ( i = 0; i < 100; i++ ) { - alpha = randu() * 10.0; - x = randu() * 10.0; - s = randu() * 10.0; - m = randu() * 10.0; + alpha = uniform( EPS, 5.0 ); + s = uniform( EPS, 5.0 ); + m = uniform( -2.0, 2.0 ); + x = uniform( m + 0.1, m + 10.0 ); y = cdf( x, alpha, s, m ); console.log( 'x: %d, α: %d, s: %d, m: %d, F(x;α,s,m): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), s.toFixed( 4 ), m.toFixed( 4 ), y.toFixed( 4 ) ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/include/stdlib/stats/base/dists/frechet/cdf.h b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/include/stdlib/stats/base/dists/frechet/cdf.h index c38b8b027bbe..4402992b0a62 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/include/stdlib/stats/base/dists/frechet/cdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/include/stdlib/stats/base/dists/frechet/cdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Returns the cumulative distribution function (CDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. +* Evaluates the cumulative distribution function (CDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. */ double stdlib_base_dists_frechet_cdf( const double x, const double alpha, const double s, const double m ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/manifest.json index d93b20baac7b..c26b67314aff 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/manifest.json @@ -75,6 +75,7 @@ "libpath": [], "dependencies": [ "@stdlib/math/base/assert/is-nan", + "@stdlib/constants/float64/eps", "@stdlib/math/base/special/pow", "@stdlib/math/base/special/exp" ] diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/main.c index 25d52879067d..5bd40d42e07e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/main.c @@ -23,16 +23,16 @@ /** -* Returns the cumulative distribution function (CDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. +* Evaluates the cumulative distribution function (CDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. * * @param x input value * @param alpha shape parameter * @param s scale parameter * @param m location parameter -* @return skewness +* @return evaluated CDF * * @example -* double y = stdlib_base_frechet_cdf( 10.0, 2.0, 3.0, 2.0 ); +* double y = stdlib_base_dists_frechet_cdf( 10.0, 2.0, 3.0, 2.0 ); * // returns ~0.869 */ double stdlib_base_dists_frechet_cdf( const double x, const double alpha, const double s, const double m ) { From 7345f952840803ae384438002c4f6935ad81b319 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 22 Jun 2025 13:45:11 -0400 Subject: [PATCH 4/8] style: fix indentation Signed-off-by: Philipp Burckhardt --- .../base/dists/frechet/cdf/manifest.json | 162 +++++++++--------- 1 file changed, 81 insertions(+), 81 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/manifest.json index c26b67314aff..3447347cba3d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/manifest.json @@ -1,84 +1,84 @@ { - "options": { + "options": { + "task": "build", + "wasm": false + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { "task": "build", - "wasm": false + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/napi/quaternary", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/pow", + "@stdlib/math/base/special/exp" + ] + }, + { + "task": "benchmark", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/pow", + "@stdlib/math/base/special/exp", + "@stdlib/constants/float64/eps" + ] }, - "fields": [ - { - "field": "src", - "resolve": true, - "relative": true - }, - { - "field": "include", - "resolve": true, - "relative": true - }, - { - "field": "libraries", - "resolve": false, - "relative": false - }, - { - "field": "libpath", - "resolve": true, - "relative": false - } - ], - "confs": [ - { - "task": "build", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/math/base/napi/quaternary", - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/pow", - "@stdlib/math/base/special/exp" - ] - }, - { - "task": "benchmark", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/pow", - "@stdlib/math/base/special/exp", - "@stdlib/constants/float64/eps" - ] - }, - { - "task": "examples", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/constants/float64/eps", - "@stdlib/math/base/special/pow", - "@stdlib/math/base/special/exp" - ] - } - ] - } + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/constants/float64/eps", + "@stdlib/math/base/special/pow", + "@stdlib/math/base/special/exp" + ] + } + ] +} From dacda3a377220d229d87e35b2fda63152e0cd3b1 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 22 Jun 2025 13:48:45 -0400 Subject: [PATCH 5/8] chore: minor clean-up Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/frechet/cdf/src/addon.c | 1 - lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/main.c | 1 - 2 files changed, 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/addon.c index 59bec18e7249..8add5e0a031b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/addon.c @@ -19,5 +19,4 @@ #include "stdlib/stats/base/dists/frechet/cdf.h" #include "stdlib/math/base/napi/quaternary.h" -// cppcheck-suppress shadowFunction STDLIB_MATH_BASE_NAPI_MODULE_DDDD_D( stdlib_base_dists_frechet_cdf ) diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/main.c index 5bd40d42e07e..17b5a6b8a7c1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/src/main.c @@ -21,7 +21,6 @@ #include "stdlib/math/base/special/pow.h" #include "stdlib/math/base/special/exp.h" - /** * Evaluates the cumulative distribution function (CDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. * From 2f3cfe06dcff6ecbd44ed172f2a0065787b50047 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 22 Jun 2025 12:36:57 -0500 Subject: [PATCH 6/8] fix: use Greek symbols in C printf format strings --- 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: passed - 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 --- --- lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md | 2 +- .../@stdlib/stats/base/dists/frechet/cdf/examples/c/example.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md index cfac53c6906e..4fd23419c901 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md @@ -252,7 +252,7 @@ int main( void ) { m = random_uniform( -2.0, 2.0 ); x = random_uniform( m + 0.1, m + 10.0 ); y = stdlib_base_dists_frechet_cdf( x, alpha, s, m ); - printf( "x: %lf, alpha: %lf, s: %lf, m: %lf, F(x;alpha,s,m): %lf\n", x, alpha, s, m, y ); + printf( "x: %lf, α: %lf, s: %lf, m: %lf, F(x;α,s,m): %lf\n", x, alpha, s, m, y ); } } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/example.c index 9913c719c50e..ed5783d59d33 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/examples/c/example.c @@ -40,6 +40,6 @@ int main( void ) { m = random_uniform( -2.0, 2.0 ); x = random_uniform( m + 0.1, m + 10.0 ); y = stdlib_base_dists_frechet_cdf( x, alpha, s, m ); - printf( "x: %lf, alpha: %lf, s: %lf, m: %lf, F(x;alpha,s,m): %lf\n", x, alpha, s, m, y ); + printf( "x: %lf, α: %lf, s: %lf, m: %lf, F(x;α,s,m): %lf\n", x, alpha, s, m, y ); } } From fac6b271b97796c30eb75c024dd07ded561713b7 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 22 Jun 2025 12:48:46 -0500 Subject: [PATCH 7/8] fix: update documentation to use "Evaluates" and correct parameter order --- 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: passed - 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 --- --- .../@stdlib/stats/base/dists/frechet/cdf/README.md | 4 ++-- .../@stdlib/stats/base/dists/frechet/cdf/lib/native.js | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md index 4fd23419c901..308aa7f878a7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/README.md @@ -191,7 +191,7 @@ for ( i = 0; i < 100; i++ ) { #### stdlib_base_dists_frechet_cdf( x, alpha, s, m ) -Returns the cumulative distribution function (CDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. +Evaluates the cumulative distribution function (CDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. ```c double y = stdlib_base_frechet_cdf( 10.0, 2.0, 3.0, 2.0 ); @@ -200,8 +200,8 @@ double y = stdlib_base_frechet_cdf( 10.0, 2.0, 3.0, 2.0 ); The function accepts the following arguments: -- **alpha**: `[in] double` shape parameter. - **x**: `[in] double` input value. +- **alpha**: `[in] double` shape parameter. - **s**: `[in] double` scale parameter. - **m**: `[in] double` location parameter. diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/lib/native.js index 59a0a8dacb4a..dcc1fdfdaba7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Returns the cdf for a Frechet distribution with shape `alpha`, scale `s`, and location `m`. +* Evaluates the cdf for a Frechet distribution with shape `alpha`, scale `s`, and location `m`. * * @private * @param {number} x - input value From c35d2fcf67d32dfdef63193c9ee4606288eccf76 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 22 Jun 2025 13:51:14 -0400 Subject: [PATCH 8/8] docs: update description Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/frechet/cdf/lib/native.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/lib/native.js index dcc1fdfdaba7..c579095bffe3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/cdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the cdf for a Frechet distribution with shape `alpha`, scale `s`, and location `m`. +* Evaluates the cumulative distribution function (CDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. * * @private * @param {number} x - input value