From 601c4a585e777e9e31306030efea47604305a1de Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Thu, 12 Dec 2024 01:44:17 +0530 Subject: [PATCH 1/7] feat: add c implementation for betaprime stdev --- .../base/dists/betaprime/stdev/README.md | 90 ++++++++++ .../stdev/benchmark/benchmark.native.js | 63 +++++++ .../betaprime/stdev/benchmark/c/Makefile | 146 +++++++++++++++ .../betaprime/stdev/benchmark/c/benchmark.c | 135 ++++++++++++++ .../base/dists/betaprime/stdev/binding.gyp | 170 ++++++++++++++++++ .../dists/betaprime/stdev/examples/c/Makefile | 146 +++++++++++++++ .../betaprime/stdev/examples/c/example.c | 35 ++++ .../base/dists/betaprime/stdev/include.gypi | 53 ++++++ .../stdlib/stats/base/dists/betaprime/stdev.h | 38 ++++ .../base/dists/betaprime/stdev/lib/native.js | 74 ++++++++ .../base/dists/betaprime/stdev/manifest.json | 79 ++++++++ .../base/dists/betaprime/stdev/package.json | 3 + .../base/dists/betaprime/stdev/src/Makefile | 70 ++++++++ .../base/dists/betaprime/stdev/src/addon.c | 23 +++ .../base/dists/betaprime/stdev/src/main.c | 46 +++++ .../dists/betaprime/stdev/test/test.native.js | 138 ++++++++++++++ 16 files changed, 1309 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/include/stdlib/stats/base/dists/betaprime/stdev.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md index 51c74a128973..42a489fd5efa 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md @@ -147,6 +147,96 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/betaprime/stdev.h" +``` + +#### stdlib_base_dists_betaprime_stdev( alpha, beta ) + +Returns the standard deviation of an betaprime distribution. + +```c +double out = stdlib_base_dists_betaprime_stdev( 1.0, 3.0 ); +// returns ~0.866 +``` + +The function accepts the following arguments: + +- **alpha**: `[in] double` first shape parameter +- **beta**: `[in] double` second shape parameter + +```c +double stdlib_base_dists_betaprime_stdev( const double alpha, const double beta ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/betaprime/stdev.h" +#include +#include + +int main( void ) { + double alpha; + double beta; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + alpha = ( (double)rand() / (double)RAND_MAX ) * 20.0; + beta = ( (double)rand() / (double)RAND_MAX ) * 20.0 + 2.0; + y = stdlib_base_dists_betaprime_stdev( alpha, beta ); + printf( "α: %lf, β: %lf, SD(X;α,β): %lf\n", alpha, beta, y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js new file mode 100644 index 000000000000..b71d2cd52130 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js @@ -0,0 +1,63 @@ +/** +* @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 bench = require( '@stdlib/bench' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var randu = require( '@stdlib/random/base/randu' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var stdev = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( stdev instanceof Error ) +}; + + +// MAIN // + +bench( pkg, opts, function benchmark( b ) { + var alpha; + var beta; + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + alpha = ( randu() * 10.0 ) + EPS; + beta = ( randu() * 10.0 ) + 2.0 + EPS; + y = stdev( alpha, beta ); + 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/betaprime/stdev/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c new file mode 100644 index 000000000000..53d297423204 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c @@ -0,0 +1,135 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/base/dists/betaprime/stdev.h" +#include +#include +#include +#include +#include + +#define NAME "betaprime-stdev" +#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 [0,1). +* +* @return random number +*/ +static double rand_double( void ) { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double alpha; + double beta; + double y; + double t; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + alpha = 20.0 * rand_double(); + beta = 20.0 * rand_double() + 2.0; + y = stdlib_base_dists_betaprime_stdev( alpha, beta ); + 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/betaprime/stdev/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/example.c new file mode 100644 index 000000000000..1d7cbb21c7c9 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/example.c @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/base/dists/betaprime/stdev.h" +#include +#include + +int main( void ) { + double alpha; + double beta; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + alpha = ( (double)rand() / (double)RAND_MAX ) * 20.0; + beta = ( (double)rand() / (double)RAND_MAX ) * 20.0 + 2.0; + y = stdlib_base_dists_betaprime_stdev( alpha, beta ); + printf( "α: %lf, β: %lf, SD(X;α,β): %lf\n", alpha, beta, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + ' Date: Wed, 11 Dec 2024 20:17:21 +0000 Subject: [PATCH 2/7] chore: update copyright years --- .../base/dists/betaprime/stdev/benchmark/benchmark.native.js | 2 +- .../stats/base/dists/betaprime/stdev/test/test.native.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js index b71d2cd52130..cc26bcc37b27 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2018 The Stdlib Authors. +* Copyright (c) 2024 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/test/test.native.js index 58ef4ff33b9f..8bdc5135b4ec 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/test/test.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2018 The Stdlib Authors. +* Copyright (c) 2024 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From e63a40a82a692c02535e05710b9a7ccf6a472afb Mon Sep 17 00:00:00 2001 From: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Date: Thu, 12 Dec 2024 02:21:58 +0530 Subject: [PATCH 3/7] chore: typo fix --- .../@stdlib/stats/base/dists/betaprime/stdev/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md index 42a489fd5efa..bda3d1713bd5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md @@ -175,7 +175,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_betaprime_stdev( alpha, beta ) -Returns the standard deviation of an betaprime distribution. +Returns the standard deviation of a betaprime distribution. ```c double out = stdlib_base_dists_betaprime_stdev( 1.0, 3.0 ); From 20951840b6d2cf11d1754d7c8f43b2ca7f557687 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Thu, 12 Dec 2024 12:53:06 +0000 Subject: [PATCH 4/7] chore: stuff from code review --- .../base/dists/betaprime/stdev/README.md | 13 +++++++--- .../betaprime/stdev/benchmark/benchmark.js | 14 ++++++++--- .../stdev/benchmark/benchmark.native.js | 14 ++++++++--- .../betaprime/stdev/benchmark/c/benchmark.c | 25 +++++++++++-------- .../betaprime/stdev/examples/c/example.c | 9 +++++-- .../base/dists/betaprime/stdev/lib/native.js | 1 + .../base/dists/betaprime/stdev/src/main.c | 6 ++--- 7 files changed, 57 insertions(+), 25 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md index bda3d1713bd5..cc9112a2df35 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md @@ -184,8 +184,8 @@ double out = stdlib_base_dists_betaprime_stdev( 1.0, 3.0 ); The function accepts the following arguments: -- **alpha**: `[in] double` first shape parameter -- **beta**: `[in] double` second shape parameter +- **alpha**: `[in] double` first shape parameter. +- **beta**: `[in] double` second shape parameter. ```c double stdlib_base_dists_betaprime_stdev( const double alpha, const double beta ); @@ -220,9 +220,14 @@ int main( void ) { double y; int i; + static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v * ( max - min ) ); + } + for ( i = 0; i < 25; i++ ) { - alpha = ( (double)rand() / (double)RAND_MAX ) * 20.0; - beta = ( (double)rand() / (double)RAND_MAX ) * 20.0 + 2.0; + alpha = random_uniform( 0, 20 ); + beta = random_uniform( 0, 20 ) + 2.0; y = stdlib_base_dists_betaprime_stdev( alpha, beta ); printf( "α: %lf, β: %lf, SD(X;α,β): %lf\n", alpha, beta, y ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.js index 2f76a7664275..329d864470cc 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.js @@ -21,6 +21,7 @@ // MODULES // var bench = require( '@stdlib/bench' ); +var Float64Array = require( '@stdlib/array/float64' ); var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var EPS = require( '@stdlib/constants/float64/eps' ); @@ -33,14 +34,21 @@ var stdev = require( './../lib' ); bench( pkg, function benchmark( b ) { var alpha; var beta; + var len; var y; var i; + len = 100; + alpha = new Float64Array( len ); + beta = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + alpha[ i ] = ( randu() * 20.0 ) + EPS; + beta = ( randu() * 20.0 ) + 2.0 + EPS; + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - alpha = ( randu()*10.0 ) + EPS; - beta = ( randu()*10.0 ) + 2.0 + EPS; - y = stdev( alpha, beta ); + y = stdev( alpha[ i % len ], beta[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js index cc26bcc37b27..cb7e4585b916 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js @@ -22,6 +22,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); +var Float64Array = require( '@stdlib/array/float64' ); var tryRequire = require( '@stdlib/utils/try-require' ); var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); @@ -42,14 +43,21 @@ var opts = { bench( pkg, opts, function benchmark( b ) { var alpha; var beta; + var len; var y; var i; + len = 100; + alpha = new Float64Array( len ); + beta = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + alpha[ i ] = ( randu() * 20.0 ) + EPS; + beta = ( randu() * 20.0 ) + 2.0 + EPS; + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - alpha = ( randu() * 10.0 ) + EPS; - beta = ( randu() * 10.0 ) + 2.0 + EPS; - y = stdev( alpha, beta ); + y = stdev( alpha[ i % len ], beta[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c index 53d297423204..f6ebbbfc4957 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c @@ -75,13 +75,15 @@ static double tic( void ) { } /** -* Generates a random number on the interval [0,1). +* Generates a random number on the interval [min,max). * -* @return random number +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number */ -static double rand_double( void ) { - int r = rand(); - return (double)r / ( (double)RAND_MAX + 1.0 ); +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); } /** @@ -91,17 +93,20 @@ static double rand_double( void ) { */ static double benchmark( void ) { double elapsed; - double alpha; - double beta; + double alpha[ 100 ]; + double beta[ 100 ]; double y; double t; int i; + for ( i = 0; i < 100; i++ ) { + alpha[ i ] = random_uniform( 1, 20 ); + beta[ i ] = random_uniform( 3, 20 ); + } + t = tic(); for ( i = 0; i < ITERATIONS; i++ ) { - alpha = 20.0 * rand_double(); - beta = 20.0 * rand_double() + 2.0; - y = stdlib_base_dists_betaprime_stdev( alpha, beta ); + y = stdlib_base_dists_betaprime_stdev( alpha[ i % 100 ], beta[ i % 100 ] ); if ( y != y ) { printf( "should not return NaN\n" ); break; diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/example.c index 1d7cbb21c7c9..6c6000c25777 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/example.c @@ -20,6 +20,11 @@ #include #include +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + int main( void ) { double alpha; double beta; @@ -27,8 +32,8 @@ int main( void ) { int i; for ( i = 0; i < 25; i++ ) { - alpha = ( (double)rand() / (double)RAND_MAX ) * 20.0; - beta = ( (double)rand() / (double)RAND_MAX ) * 20.0 + 2.0; + alpha = random_uniform( 1, 20 ); + beta = random_uniform( 3, 20 ); y = stdlib_base_dists_betaprime_stdev( alpha, beta ); printf( "α: %lf, β: %lf, SD(X;α,β): %lf\n", alpha, beta, y ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/lib/native.js index 6b1dd5c7ea8a..0d42e03cca6b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/lib/native.js @@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' ); /** * Returns the standard deviation of a beta prime distribution. * +* @private * @param {PositiveNumber} alpha - first shape parameter * @param {PositiveNumber} beta - second shape parameter * @returns {PositiveNumber} standard deviation diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/src/main.c index 3acbed2652b9..3b1c313c46f4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/src/main.c @@ -21,11 +21,11 @@ #include "stdlib/math/base/special/sqrt.h" /** -* Returns the standard deviation of an beta prime distribution. +* Returns the standard deviation of a beta prime distribution. * * @param alpha first shape parameter -* @param beta second shape paramter -* @return stdandard deviation +* @param beta second shape paramter +* @return stdandard deviation * * @example * double y = stdlib_base_betaprime_stdev( 1.0, 3.0 ); From 30529345b3aebb241568a746a12488ccda219904 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Thu, 12 Dec 2024 13:00:24 +0000 Subject: [PATCH 5/7] chore: bugs fixing --- .../stats/base/dists/betaprime/stdev/benchmark/benchmark.js | 2 +- .../base/dists/betaprime/stdev/benchmark/benchmark.native.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.js index 329d864470cc..ba1a5040525c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.js @@ -43,7 +43,7 @@ bench( pkg, function benchmark( b ) { beta = new Float64Array( len ); for ( i = 0; i < len; i++ ) { alpha[ i ] = ( randu() * 20.0 ) + EPS; - beta = ( randu() * 20.0 ) + 2.0 + EPS; + beta[ i ] = ( randu() * 20.0 ) + 2.0 + EPS; } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js index cb7e4585b916..db4cfbda995c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/benchmark.native.js @@ -52,7 +52,7 @@ bench( pkg, opts, function benchmark( b ) { beta = new Float64Array( len ); for ( i = 0; i < len; i++ ) { alpha[ i ] = ( randu() * 20.0 ) + EPS; - beta = ( randu() * 20.0 ) + 2.0 + EPS; + beta[ i ] = ( randu() * 20.0 ) + 2.0 + EPS; } b.tic(); From 5837bb911d344fd2f778eafd7a1d87c3dc499ff5 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Thu, 12 Dec 2024 13:15:16 +0000 Subject: [PATCH 6/7] chore: styling errors --- .../stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c | 4 ++-- .../stats/base/dists/betaprime/stdev/examples/c/example.c | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c index f6ebbbfc4957..d7bd31e4fb9f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/benchmark/c/benchmark.c @@ -100,8 +100,8 @@ static double benchmark( void ) { int i; for ( i = 0; i < 100; i++ ) { - alpha[ i ] = random_uniform( 1, 20 ); - beta[ i ] = random_uniform( 3, 20 ); + alpha[ i ] = random_uniform( 0, 20 ); + beta[ i ] = random_uniform( 0, 20 ) + 2.0; } t = tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/example.c index 6c6000c25777..ce37e56223a3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/examples/c/example.c @@ -32,8 +32,8 @@ int main( void ) { int i; for ( i = 0; i < 25; i++ ) { - alpha = random_uniform( 1, 20 ); - beta = random_uniform( 3, 20 ); + alpha = random_uniform( 0, 20 ); + beta = random_uniform( 0, 20 ) + 2.0; y = stdlib_base_dists_betaprime_stdev( alpha, beta ); printf( "α: %lf, β: %lf, SD(X;α,β): %lf\n", alpha, beta, y ); } From d488fd6a18b2891448a6c94e1f314aa9b44fe3db Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Fri, 13 Dec 2024 08:58:23 -0500 Subject: [PATCH 7/7] chore: move function to outer scope and update spelling Signed-off-by: Philipp Burckhardt --- .../stats/base/dists/betaprime/stdev/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md index cc9112a2df35..adf5948dd1fc 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/README.md @@ -175,7 +175,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_betaprime_stdev( alpha, beta ) -Returns the standard deviation of a betaprime distribution. +Returns the standard deviation of a beta prime distribution. ```c double out = stdlib_base_dists_betaprime_stdev( 1.0, 3.0 ); @@ -214,17 +214,17 @@ double stdlib_base_dists_betaprime_stdev( const double alpha, const double beta #include #include +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v * ( max - min ) ); +} + int main( void ) { double alpha; double beta; double y; int i; - static double random_uniform( const double min, const double max ) { - double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); - return min + ( v * ( max - min ) ); - } - for ( i = 0; i < 25; i++ ) { alpha = random_uniform( 0, 20 ); beta = random_uniform( 0, 20 ) + 2.0;