From 36208d7dd475e7d123016f79412b3dc55d1b8e23 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 15:34:13 -0800 Subject: [PATCH 1/6] feat: add the C src files --- .../stdlib/stats/base/dists/chi/stdev.h | 41 +++++++++++ .../stats/base/dists/chi/stdev/src/Makefile | 70 +++++++++++++++++++ .../stats/base/dists/chi/stdev/src/addon.c | 23 ++++++ .../stats/base/dists/chi/stdev/src/main.c | 51 ++++++++++++++ 4 files changed, 185 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/include/stdlib/stats/base/dists/chi/stdev.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/main.c diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/include/stdlib/stats/base/dists/chi/stdev.h b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/include/stdlib/stats/base/dists/chi/stdev.h new file mode 100644 index 000000000000..64b77317ca36 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/include/stdlib/stats/base/dists/chi/stdev.h @@ -0,0 +1,41 @@ +/** +* @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_CHI_STDEV_H +#define STDLIB_STATS_BASE_DISTS_CHI_STDEV_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 + +/** +* Returns the standard deviation of a chi distribution. +* +* @param k degrees of freedom (must be positive) +* @return standard deviation +*/ +double stdlib_base_dists_chi_stdev( const double k ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_STATS_BASE_DISTS_CHI_STDEV_H diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/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/chi/stdev/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/addon.c new file mode 100644 index 000000000000..77aacc6642b4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/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/unary.h" +#include "stdlib/stats/base/dists/chi/stdev.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_dists_chi_stdev ) diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/main.c new file mode 100644 index 000000000000..38a2f70f8a03 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/main.c @@ -0,0 +1,51 @@ +/** +* @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" +#include "stdlib/math/base/special/sqrt.h" +#include "stdlib/stats/base/dists/chi/mean.h" + +/** +* Returns the standard deviation of a chi distribution. +* +* @param k degrees of freedom (must be positive) +* @return standard deviation, or NaN if input is invalid +* +* @example +* double v = stdlib_base_dists_chi_stdev( 9.0 ); +* // returns ~0.697 +* +* @example +* double v = stdlib_base_dists_chi_stdev( 1.0 ); +* // returns ~0.603 +* +* @example +* double v = stdlib_base_dists_chi_stdev( -0.2 ); +* // returns NaN +* +* @example +* double v = stdlib_base_dists_chi_stdev( NAN ); +* // returns NaN +*/ +double stdlib_base_dists_chi_stdev( const double k ) { + if ( stdlib_base_is_nan( k ) || k <= 0.0 ) { + return 0.0 / 0.0; // NaN + } + double mu = stdlib_base_dists_chi_mean( k ); + return stdlib_base_sqrt( k - ( mu * mu ) ); +} From b3ca5456a83f7a573d91c1d5e29ddc44d625a984 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 15:34:27 -0800 Subject: [PATCH 2/6] feat: add the C benchmark and example files --- .../base/dists/chi/stdev/benchmark/c/Makefile | 146 ++++++++++++++++++ .../dists/chi/stdev/benchmark/c/benchmark.c | 105 +++++++++++++ .../base/dists/chi/stdev/examples/c/Makefile | 146 ++++++++++++++++++ .../base/dists/chi/stdev/examples/c/example.c | 41 +++++ 4 files changed, 438 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/examples/c/example.c diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/benchmark/c/Makefile new file mode 100644 index 000000000000..a4bd7b38fd74 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/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/chi/stdev/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/benchmark/c/benchmark.c new file mode 100644 index 000000000000..af2413c3541b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/benchmark/c/benchmark.c @@ -0,0 +1,105 @@ +/** +* @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/chi/stdev.h" +#include +#include +#include +#include +#include + +#define NAME "chi-stdev" +#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 k[ 100 ]; + double y; + double start; + int i; + + for ( i = 0; i < 100; i++ ) { + k[ i ] = random_uniform( 0.1, 10.0 ); + } + + start = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_chi_stdev( k[ i%100 ] ); + if ( isnan( y ) ) { + 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/chi/stdev/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/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/chi/stdev/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/examples/c/example.c new file mode 100644 index 000000000000..a582c7eb034c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/examples/c/example.c @@ -0,0 +1,41 @@ +/** +* @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/chi/stdev.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 k; + double result; + int i; + + for ( i = 0; i < 10; i++ ) { + k = random_uniform( 0.1, 10.0 ); // Ensure `k` is positive + result = stdlib_base_dists_chi_stdev( k ); + + printf( "k: %lf, Standard Deviation: %lf \n", k, result ); + } + + return 0; +} From 53472d06d3f918953a55eba40f4a576fe7d3583b Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 15:34:42 -0800 Subject: [PATCH 3/6] feat: add the JS native files --- .../chi/stdev/benchmark/benchmark.native.js | 67 ++++++++++++++ .../stats/base/dists/chi/stdev/lib/native.js | 58 ++++++++++++ .../base/dists/chi/stdev/test/test.native.js | 92 +++++++++++++++++++ 3 files changed, 217 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/benchmark/benchmark.native.js new file mode 100644 index 000000000000..c01b2ff2e6e6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/benchmark/benchmark.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 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 stdev = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( stdev instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var len; + var k; + var y; + var i; + + len = 100; + k = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + k[ i ] = ( randu() * 10.0 ) + 0.1; // Ensure k > 0 + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = stdev( k[ 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/chi/stdev/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/lib/native.js new file mode 100644 index 000000000000..1251a3d0acc5 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/lib/native.js @@ -0,0 +1,58 @@ +/** +* @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 // + +/** +* Returns the standard deviation of a chi distribution. +* +* @private +* @param {PositiveNumber} k - degrees of freedom +* @returns {number} standard deviation +* +* @example +* var v = stdev( 9.0 ); +* // returns ~0.697 +* +* @example +* var v = stdev( 1.0 ); +* // returns ~0.603 +* +* @example +* var v = stdev( -0.2 ); +* // returns NaN +* +* @example +* var v = stdev( NaN ); +* // returns NaN +*/ +function stdev( k ) { + return addon( k ); +} + + +// EXPORTS // + +module.exports = stdev; diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/test/test.native.js new file mode 100644 index 000000000000..8ebad14ccb90 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/test/test.native.js @@ -0,0 +1,92 @@ +/** +* @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 abs = require( '@stdlib/math/base/special/abs' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); + + +// VARIABLES // + +var stdev = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( stdev instanceof Error ) +}; + + +// FIXTURES // + +var data = require( './fixtures/python/data.json' ); + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof stdev, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'if provided `NaN` for `k`, the function returns `NaN`', opts, function test( t ) { + var v = stdev( NaN ); + t.equal( isnan( v ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if provided a degrees of freedom parameter `k` that is not a nonnegative number, the function returns `NaN`', opts, function test( t ) { + var v; + + v = stdev( -1.0 ); + t.equal( isnan( v ), true, 'returns NaN' ); + + v = stdev( NINF ); + t.equal( isnan( v ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function returns the standard deviation of a chi distribution', opts, function test( t ) { + var expected; + var delta; + var tol; + var k; + var i; + var y; + + expected = data.expected; + k = data.k; + for ( i = 0; i < expected.length; i++ ) { + y = stdev( k[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'k:'+k[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 50.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. k: '+k[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); From 2dae2043bbbef4d5e422c7347179ffcac3e3927d Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Sun, 5 Jan 2025 15:34:56 -0800 Subject: [PATCH 4/6] build: added the json and gyp dependency files --- .../stats/base/dists/chi/stdev/binding.gyp | 149 ++++++++++++++++++ .../stats/base/dists/chi/stdev/include.gypi | 48 ++++++ .../stats/base/dists/chi/stdev/manifest.json | 82 ++++++++++ .../stats/base/dists/chi/stdev/package.json | 3 + 4 files changed, 282 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/chi/stdev/manifest.json diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/binding.gyp new file mode 100644 index 000000000000..114dcb77c6aa --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/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/chi/stdev/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/include.gypi new file mode 100644 index 000000000000..235be47d6d3b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/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 15:35:08 -0800 Subject: [PATCH 5/6] 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 --- --- .../stats/base/dists/chi/stdev/README.md | 95 +++++++++++++++++++ 1 file changed, 95 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/README.md index 289ace4c55f8..bfab7ee249ef 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/README.md @@ -116,6 +116,101 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/chi/stdev.h" +``` + +#### stdlib_base_dists_chi_stdev( k ) + +Returns the standard deviation of a chi distribution. + +```c +double out = stdlib_base_dists_chi_stdev( 9.0 ); +// returns ~0.697 +``` + +The function accepts the following arguments: + +- **k**: `[in] double` degrees of freedom (must be positive) + +```c +double stdlib_base_dists_chi_stdev( const double k ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/chi/stdev.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 k; + double result; + int i; + + for ( i = 0; i < 10; i++ ) { + k = random_uniform( 0.1, 10.0 ); // Ensure `k` is positive + result = stdlib_base_dists_chi_stdev( k ); + + printf( "k: %lf, Standard Deviation: %lf \n", k, result ); + } + + return 0; +} +``` + +
+ + + +
+ + +
From 6ebe281a996e89d0d943a06961608beac2ccc279 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Wed, 30 Apr 2025 00:51:20 +0000 Subject: [PATCH 6/6] chore: update copyright years --- lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/main.c | 2 +- .../@stdlib/stats/base/dists/chi/stdev/test/test.native.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/main.c index 38a2f70f8a03..ce682849ba46 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/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/chi/stdev/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/test/test.native.js index 8ebad14ccb90..8f9cf14de7b0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/chi/stdev/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.