From 748785501732b27c98918aef149e81ca30115d44 Mon Sep 17 00:00:00 2001 From: Vivek Maurya Date: Wed, 11 Dec 2024 11:16:27 +0530 Subject: [PATCH 1/9] feat(add C implementation): add stats/base/dists/bernoulli/kurtosis --- .../bernoulli/kurtosis/benchmark/c/Makefile | 146 +++++++++++++++ .../kurtosis/benchmark/c/benchmark.c | 133 ++++++++++++++ .../base/dists/bernoulli/kurtosis/binding.gyp | 170 ++++++++++++++++++ .../bernoulli/kurtosis/examples/c/Makefile | 146 +++++++++++++++ .../bernoulli/kurtosis/examples/c/example.c | 33 ++++ .../dists/bernoulli/kurtosis/include.gypi | 53 ++++++ .../stats/base/dists/bernoulli/kurtosis.h | 38 ++++ .../dists/bernoulli/kurtosis/lib/native.js | 61 +++++++ .../dists/bernoulli/kurtosis/manifest.json | 94 ++++++++++ .../dists/bernoulli/kurtosis/src/Makefile | 70 ++++++++ .../base/dists/bernoulli/kurtosis/src/addon.c | 23 +++ .../base/dists/bernoulli/kurtosis/src/main.c | 47 +++++ .../bernoulli/kurtosis/test/test.native.js | 109 +++++++++++ 13 files changed, 1123 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/include/stdlib/stats/base/dists/bernoulli/kurtosis.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/Makefile new file mode 100644 index 000000000000..0ebf4545e1a9 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/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 \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/benchmark.c new file mode 100644 index 000000000000..bc7cb7c9bde6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/benchmark.c @@ -0,0 +1,133 @@ +/** +* @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/bernoulli/kurtosis.h" +#include +#include +#include +#include +#include + +#define NAME "bernoulli-kurtosis" +#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 p; + double y; + double t; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + p = ( (double)rand() / (double)RAND_MAX ) ; + y = stdlib_base_dists_bernoulli_kurtosis( p ); + 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 ); +} \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/binding.gyp new file mode 100644 index 000000000000..507cb00291e7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/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 +} \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/Makefile new file mode 100644 index 000000000000..d53ef397c77d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/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 \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c new file mode 100644 index 000000000000..9fd359775082 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c @@ -0,0 +1,33 @@ +/** +* @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/bernoulli/kurtosis.h" +#include +#include + +int main( void ) { + double p; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = ( (double)rand() / (double)RAND_MAX ) ; + y = stdlib_base_dists_bernoulli_kurtosis( p ); + printf( "x: %lf , H(X;p): %lf\n", p , y ); + } +} \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/include.gypi new file mode 100644 index 000000000000..c6495fc1da3f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + ' 1.0 + ) { + return 0.0 / 0.0; + } + pq = p * ( 1.0 - p ); + return ( 1.0/pq ) - 6.0; + +} \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/test/test.native.js new file mode 100644 index 000000000000..194bde2a489f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/test/test.native.js @@ -0,0 +1,109 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2018 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var EPS = require( '@stdlib/constants/float64/eps' ); + + +// FIXTURES // + +var data = require( './fixtures/julia/data.json' ); + + +// VARIABLES // + +var kurtosis = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( kurtosis instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof kurtosis, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'if provided `NaN` for `p`, the function returns `NaN`', function test( t ) { + var v = kurtosis( NaN ); + t.equal( isnan( v ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if provided `1` or `0` for `p`, the function returns `+infinity`', function test( t ) { + var v = kurtosis( 0.0 ); + t.strictEqual( v, PINF, 'returns +infinity' ); + + v = kurtosis( 1.0 ); + t.strictEqual( v, PINF, 'returns +infinity' ); + + t.end(); +}); + +tape( 'if provided a success probability `p` outside of `[0,1]`, the function returns `NaN`', function test( t ) { + var v; + + v = kurtosis( -1.0 ); + t.equal( isnan( v ), true, 'returns NaN' ); + + v = kurtosis( 1.5 ); + t.equal( isnan( v ), true, 'returns NaN' ); + + v = kurtosis( NINF ); + t.equal( isnan( v ), true, 'returns NaN' ); + + v = kurtosis( PINF ); + t.equal( isnan( v ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function returns the excess kurtosis of a Bernoulli distribution', function test( t ) { + var expected; + var delta; + var tol; + var i; + var p; + var y; + + expected = data.expected; + p = data.p; + for ( i = 0; i < expected.length; i++ ) { + y = kurtosis( p[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'p: '+p[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 1.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. p: '+p[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); From 0bf689f238e08755a61d184347dab8eab5a6dea2 Mon Sep 17 00:00:00 2001 From: Vivek Maurya Date: Wed, 11 Dec 2024 20:54:00 +0530 Subject: [PATCH 2/9] feat(add c implementation): add stats/base/dists/bernoulli/kurtosis --- .../base/dists/bernoulli/kurtosis/README.md | 85 ++++++++++++++++++- .../bernoulli/kurtosis/benchmark/c/Makefile | 2 +- .../base/dists/bernoulli/kurtosis/binding.gyp | 2 +- .../bernoulli/kurtosis/examples/c/Makefile | 2 +- .../bernoulli/kurtosis/examples/c/example.c | 6 +- .../dists/bernoulli/kurtosis/include.gypi | 2 +- .../dists/bernoulli/kurtosis/lib/native.js | 2 +- .../dists/bernoulli/kurtosis/manifest.json | 26 +----- .../dists/bernoulli/kurtosis/package.json | 3 + .../dists/bernoulli/kurtosis/src/Makefile | 2 +- .../base/dists/bernoulli/kurtosis/src/main.c | 6 +- 11 files changed, 100 insertions(+), 38 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md index adcde8cccd5c..13893f19b6ff 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md @@ -120,15 +120,92 @@ for ( i = 0; i < 10; i++ ) { - + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/bernoulli/kurtosis.h" +``` + +#### stdlib_base_dists_bernoulli_kurtosis( p ) + +Returns the [excess kurtosis][kurtosis] of a [Bernoulli][bernoulli-distribution] distribution with success probability `p`. + +```c +double out = stdlib_base_dists_bernoulli_kurtosis( 0.1 ); +// returns ~5.111 +``` - +The function accepts the following arguments: -
+- **p**: `[in] double` maximum support. + +```c +double stdlib_base_dists_bernoulli_kurtosis( const double p ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/bernoulli/kurtosis.h" +#include +#include + +int main( void ) { + double p; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = ( (double)rand() / (double)RAND_MAX ); + y = stdlib_base_dists_arcsine_entropy( p ); + printf( "p: %lf, Kurt(X;p): %lf\n", p, y ); + } +} +``` + +
+ +
- + diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/Makefile index 0ebf4545e1a9..f69e9da2b4d3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/Makefile @@ -143,4 +143,4 @@ run: $(c_targets) clean: $(QUIET) -rm -f *.o *.out -.PHONY: clean \ No newline at end of file +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/binding.gyp index 507cb00291e7..ec3992233442 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/binding.gyp @@ -167,4 +167,4 @@ ], # end actions }, # end target copy_addon ], # end targets -} \ No newline at end of file +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/Makefile index d53ef397c77d..6aed70daf167 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/Makefile @@ -143,4 +143,4 @@ run: $(c_targets) clean: $(QUIET) -rm -f *.o *.out -.PHONY: clean \ No newline at end of file +.PHONY: clean diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c index 9fd359775082..2bb107af9353 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c @@ -26,8 +26,8 @@ int main( void ) { int i; for ( i = 0; i < 25; i++ ) { - p = ( (double)rand() / (double)RAND_MAX ) ; + p = ( (double)rand() / (double)RAND_MAX ); y = stdlib_base_dists_bernoulli_kurtosis( p ); - printf( "x: %lf , H(X;p): %lf\n", p , y ); + printf( "x: %lf , H(X;p): %lf\n", p, y ); } -} \ No newline at end of file +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/include.gypi index c6495fc1da3f..575cb043c0bf 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/include.gypi @@ -50,4 +50,4 @@ ' Date: Fri, 13 Dec 2024 18:21:44 +0530 Subject: [PATCH 3/9] feat(add c implementation): add stats/base/dists/bernoulli/kurtosis --- .../base/dists/bernoulli/kurtosis/README.md | 6 +- .../bernoulli/kurtosis/benchmark/benchmark.js | 11 ++- .../kurtosis/benchmark/benchmark.native.js | 67 +++++++++++++++++++ .../kurtosis/benchmark/c/benchmark.c | 11 +-- .../bernoulli/kurtosis/examples/c/example.c | 4 +- .../dists/bernoulli/kurtosis/lib/native.js | 9 +-- .../dists/bernoulli/kurtosis/manifest.json | 2 +- .../bernoulli/kurtosis/test/test.native.js | 10 +-- 8 files changed, 97 insertions(+), 23 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/benchmark.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md index 13893f19b6ff..bc4410c6ebb0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md @@ -157,7 +157,7 @@ double out = stdlib_base_dists_bernoulli_kurtosis( 0.1 ); The function accepts the following arguments: -- **p**: `[in] double` maximum support. +- **p**: `[in] double` success probability. ```c double stdlib_base_dists_bernoulli_kurtosis( const double p ); @@ -192,8 +192,8 @@ int main( void ) { int i; for ( i = 0; i < 25; i++ ) { - p = ( (double)rand() / (double)RAND_MAX ); - y = stdlib_base_dists_arcsine_entropy( p ); + p = (double)rand() / ( (double)RAND_MAX + 1.0 ); + y = stdlib_base_dists_bernoulli_kurtosis( p ); printf( "p: %lf, Kurt(X;p): %lf\n", p, y ); } } diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/benchmark.js index c53005a17531..09f84b42de04 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/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 pkg = require( './../package.json' ).name; @@ -30,14 +31,20 @@ var kurtosis = require( './../lib' ); // MAIN // bench( pkg, function benchmark( b ) { + var len; var p; var y; var i; + len = 100; + p = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + p[ i ] = randu(); + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - p = randu(); - y = kurtosis( p ); + y = kurtosis( p[ i%len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/benchmark.native.js new file mode 100644 index 000000000000..363a04659fea --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/benchmark.native.js @@ -0,0 +1,67 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var Float64Array = require( '@stdlib/array/float64' ); +var 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 kurtosis = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( kurtosis instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var len; + var p; + var y; + var i; + + len = 100; + p = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + p[ i ] = randu(); + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = kurtosis( p[ 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/bernoulli/kurtosis/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/benchmark.c index bc7cb7c9bde6..a1a96c9b8835 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/benchmark/c/benchmark.c @@ -91,15 +91,18 @@ static double rand_double( void ) { */ static double benchmark( void ) { double elapsed; - double p; + double p[ 100 ]; double y; double t; int i; + for ( i = 0; i < 100; i++ ) { + p[ i ] = rand_double(); + } + t = tic(); for ( i = 0; i < ITERATIONS; i++ ) { - p = ( (double)rand() / (double)RAND_MAX ) ; - y = stdlib_base_dists_bernoulli_kurtosis( p ); + y = stdlib_base_dists_bernoulli_kurtosis( p[ i%100 ] ); if ( y != y ) { printf( "should not return NaN\n" ); break; @@ -130,4 +133,4 @@ int main( void ) { printf( "ok %d benchmark finished\n", i+1 ); } print_summary( REPEATS, REPEATS ); -} \ No newline at end of file +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c index 2bb107af9353..05dec002dcd0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/examples/c/example.c @@ -26,8 +26,8 @@ int main( void ) { int i; for ( i = 0; i < 25; i++ ) { - p = ( (double)rand() / (double)RAND_MAX ); + p = (double)rand() / ( (double)RAND_MAX + 1.0 ); y = stdlib_base_dists_bernoulli_kurtosis( p ); - printf( "x: %lf , H(X;p): %lf\n", p, y ); + printf( "x: %lf , Kurt(X;p): %lf\n", p, y ); } } diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/lib/native.js index b38a5d583d74..367cf615aa65 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/lib/native.js @@ -28,20 +28,17 @@ var addon = require( './../src/addon.node' ); /** * Returns the kurtosis of a Bernoulli distribution. * +* @private * @param {Probability} p - success probability * @returns {PositiveNumber} kurtosis * * @example * var v = kurtosis( 0.1 ); -* // returns ~0.325 +* // returns ~5.111 * * @example * var v = kurtosis( 0.5 ); -* // returns ~0.693 -* -* @example -* var v = kurtosis( 0.9 ); -* // returns ~0.325 +* // returns -2.0 * * @example * var v = kurtosis( 1.1 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/manifest.json index 1ddd78773f49..4cae68d18f93 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/manifest.json @@ -73,4 +73,4 @@ ] } ] - } \ No newline at end of file +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/test/test.native.js index 194bde2a489f..34c26c2a6bf0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/test/test.native.js @@ -45,19 +45,19 @@ var opts = { // TESTS // -tape( 'main export is a function', function test( t ) { +tape( 'main export is a function', opts, function test( t ) { t.ok( true, __filename ); t.strictEqual( typeof kurtosis, 'function', 'main export is a function' ); t.end(); }); -tape( 'if provided `NaN` for `p`, the function returns `NaN`', function test( t ) { +tape( 'if provided `NaN` for `p`, the function returns `NaN`', opts, function test( t ) { var v = kurtosis( NaN ); t.equal( isnan( v ), true, 'returns NaN' ); t.end(); }); -tape( 'if provided `1` or `0` for `p`, the function returns `+infinity`', function test( t ) { +tape( 'if provided `1` or `0` for `p`, the function returns `+infinity`', opts, function test( t ) { var v = kurtosis( 0.0 ); t.strictEqual( v, PINF, 'returns +infinity' ); @@ -67,7 +67,7 @@ tape( 'if provided `1` or `0` for `p`, the function returns `+infinity`', functi t.end(); }); -tape( 'if provided a success probability `p` outside of `[0,1]`, the function returns `NaN`', function test( t ) { +tape( 'if provided a success probability `p` outside of `[0,1]`, the function returns `NaN`', opts, function test( t ) { var v; v = kurtosis( -1.0 ); @@ -85,7 +85,7 @@ tape( 'if provided a success probability `p` outside of `[0,1]`, the function re t.end(); }); -tape( 'the function returns the excess kurtosis of a Bernoulli distribution', function test( t ) { +tape( 'the function returns the excess kurtosis of a Bernoulli distribution', opts, function test( t ) { var expected; var delta; var tol; From 49f547a9e4781a79908a9ab8c83bda9dc16680b7 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Fri, 13 Dec 2024 13:51:27 +0000 Subject: [PATCH 4/9] chore: update copyright years --- .../@stdlib/stats/base/dists/bernoulli/kurtosis/src/main.c | 2 +- .../stats/base/dists/bernoulli/kurtosis/test/test.native.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/src/main.c index 747ddf28e286..12d075c6b735 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/src/main.c @@ -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/bernoulli/kurtosis/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/test/test.native.js index 34c26c2a6bf0..1f387be22f69 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/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 ff0d4152bf250520d6b60d7f6c3beec91892f30b Mon Sep 17 00:00:00 2001 From: Vivek Maurya Date: Sun, 15 Dec 2024 10:02:10 +0530 Subject: [PATCH 5/9] feat(add c implementation): add stats/base/dists/bernoulli/kurtosis --- .../@stdlib/stats/base/dists/bernoulli/kurtosis/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md index bc4410c6ebb0..b7da7ec4bcc7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/kurtosis/README.md @@ -207,6 +207,14 @@ int main( void ) { + + +
+ +
+ + +