From 6ad84b23ef17cfd9bcbe1af13bdc2cbfa3ee7cb0 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Fri, 20 Dec 2024 16:59:30 +0530 Subject: [PATCH 1/7] feat: add C implementation for geometric kurtosis --- .../base/dists/geometric/kurtosis/README.md | 88 +++++++++ .../geometric/kurtosis/benchmark/benchmark.js | 11 +- .../kurtosis/benchmark/benchmark.native.js | 68 +++++++ .../geometric/kurtosis/benchmark/c/Makefile | 146 +++++++++++++++ .../kurtosis/benchmark/c/benchmark.c | 139 ++++++++++++++ .../base/dists/geometric/kurtosis/binding.gyp | 170 ++++++++++++++++++ .../geometric/kurtosis/examples/c/Makefile | 146 +++++++++++++++ .../geometric/kurtosis/examples/c/example.c | 38 ++++ .../dists/geometric/kurtosis/include.gypi | 53 ++++++ .../stats/base/dists/geometric/kurtosis.h | 38 ++++ .../dists/geometric/kurtosis/lib/native.js | 57 ++++++ .../dists/geometric/kurtosis/manifest.json | 77 ++++++++ .../dists/geometric/kurtosis/package.json | 3 + .../dists/geometric/kurtosis/src/Makefile | 70 ++++++++ .../base/dists/geometric/kurtosis/src/addon.c | 23 +++ .../base/dists/geometric/kurtosis/src/main.c | 41 +++++ .../geometric/kurtosis/test/test.native.js | 99 ++++++++++ 17 files changed, 1265 insertions(+), 2 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include/stdlib/stats/base/dists/geometric/kurtosis.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md index 0416b41137fa..377212e14518 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md @@ -122,6 +122,94 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/geometric/kurtosis.h" +``` + +#### stdlib_base_dists_geometric_kurtosis( p ) + +Returns the excess kurtosis of a geometric distribution. + +```c +double out = stdlib_base_dists_geometric_kurtosis( 0.5 ); +// returns 6.0 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` success probability. + +```c +double stdlib_base_dists_geometric_kurtosis( const double p ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/geometric/kurtosis.h" +#include +#include + +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +int main( void ) { + double p; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + y = stdlib_base_dists_geometric_kurtosis( p ); + printf( "p: %lf, Kurt[X]: %lf\n", p, y ); + } +} +``` + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.js index 253212098d23..a85e5d11ca47 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/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 EPS = require( '@stdlib/constants/float64/eps' ); @@ -31,14 +32,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() * 1.0 ) + EPS; + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - p = ( randu()*1.0 ) + EPS; - y = kurtosis( p ); + y = kurtosis( p[ i % 100 ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js new file mode 100644 index 000000000000..00cd13068bf6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js @@ -0,0 +1,68 @@ +/** +* @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 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 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() * 1.0 ) + EPS; + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = kurtosis( p[ i % 100 ] ); + 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/geometric/kurtosis/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/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 diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c new file mode 100644 index 000000000000..c70224beda68 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c @@ -0,0 +1,139 @@ +/** +* @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/geometric/kurtosis.h" +#include "stdlib/constants/float64/eps.h" +#include +#include +#include +#include +#include + +#define NAME "geometric-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 [min,max). +* +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number +*/ +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double p[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + p[ i ] = random_uniform( 0.0, 1.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_geometric_kurtosis( p[ i % 100 ] ); + if ( y != y ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/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 +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/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 diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/example.c new file mode 100644 index 000000000000..7c08cdab116e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/example.c @@ -0,0 +1,38 @@ +/** +* @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/geometric/kurtosis.h" +#include +#include + +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +int main( void ) { + double p; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + y = stdlib_base_dists_geometric_kurtosis( p ); + printf( "p: %lf, Kurt[X]: %lf\n", p, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/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; + } + return ( 6.0 + ( ( p * p ) / ( 1.0 - p ) ) ); +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/test/test.native.js new file mode 100644 index 000000000000..6283563f8370 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/test/test.native.js @@ -0,0 +1,99 @@ +/** +* @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 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' ); + + +// VARIABLES // + +var kurtosis = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( kurtosis instanceof Error ) +}; + + +// FIXTURES // + +var data = require( './fixtures/julia/data.json' ); + + +// TESTS // + +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`', opts, function test( t ) { + var k = kurtosis( NaN ); + t.equal( isnan( k ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if provided a success probability `p` outside of `[0,1]`, the function returns `NaN`', opts, function test( t ) { + var k; + + k = kurtosis( -1.0 ); + t.equal( isnan( k ), true, 'returns NaN' ); + + k = kurtosis( 1.5 ); + t.equal( isnan( k ), true, 'returns NaN' ); + + k = kurtosis( NINF ); + t.equal( isnan( k ), true, 'returns NaN' ); + + k = kurtosis( PINF ); + t.equal( isnan( k ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function returns the kurtosis of a geometric distribution', opts, 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 40a633f24b863cad18866c376e4ab2068aa9c502 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Fri, 20 Dec 2024 17:08:41 +0530 Subject: [PATCH 2/7] fix: added constrain on p --- .../@stdlib/stats/base/dists/geometric/kurtosis/src/main.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/main.c index b63fd86f7e10..592fa1ac8673 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/main.c @@ -33,7 +33,7 @@ double stdlib_base_dists_geometric_kurtosis( const double p ) { if ( stdlib_base_is_nan( p ) || p <= 0.0 || - p > 1.0 + p >= 1.0 ) { return 0.0 / 0.0; } From 120d83deda246bb92f0542b86d267a51e28c7a41 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Fri, 3 Jan 2025 17:29:11 +0530 Subject: [PATCH 3/7] chore: completed the code review task --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: passed - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: passed - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/stats/base/dists/geometric/kurtosis/README.md | 2 +- .../stats/base/dists/geometric/kurtosis/benchmark/benchmark.js | 3 +-- .../dists/geometric/kurtosis/benchmark/benchmark.native.js | 3 +-- .../base/dists/geometric/kurtosis/benchmark/c/benchmark.c | 3 +-- .../@stdlib/stats/base/dists/geometric/kurtosis/manifest.json | 3 +-- .../@stdlib/stats/base/dists/geometric/kurtosis/src/main.c | 2 +- 6 files changed, 6 insertions(+), 10 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md index 377212e14518..b95474a13f52 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md @@ -150,7 +150,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_geometric_kurtosis( p ) -Returns the excess kurtosis of a geometric distribution. +Returns the [excess kurtosis][kurtosis] of a [geometric][geometric-distribution] distribution with success probability `p`. ```c double out = stdlib_base_dists_geometric_kurtosis( 0.5 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.js index a85e5d11ca47..1009686209ed 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.js @@ -24,7 +24,6 @@ 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' ); var pkg = require( './../package.json' ).name; var kurtosis = require( './../lib' ); @@ -40,7 +39,7 @@ bench( pkg, function benchmark( b ) { len = 100; p = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - p[ i ] = ( randu() * 1.0 ) + EPS; + p[ i ] = ( randu() * 1.0 ); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js index 00cd13068bf6..f22422076e6e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js @@ -26,7 +26,6 @@ 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' ); -var EPS = require( '@stdlib/constants/float64/eps' ); var pkg = require( './../package.json' ).name; @@ -49,7 +48,7 @@ bench( pkg+'::native', opts, function benchmark( b ) { len = 100; p = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - p[ i ] = ( randu() * 1.0 ) + EPS; + p[ i ] = ( randu() * 1.0 ); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c index c70224beda68..6e55a577f39d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c @@ -17,7 +17,6 @@ */ #include "stdlib/stats/base/dists/geometric/kurtosis.h" -#include "stdlib/constants/float64/eps.h" #include #include #include @@ -100,7 +99,7 @@ static double benchmark( void ) { int i; for ( i = 0; i < 100; i++ ) { - p[ i ] = random_uniform( 0.0, 1.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + p[ i ] = random_uniform( 0.0, 1.0 ); } t = tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/manifest.json index 2b010801d0ba..7b4b4c8eae44 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/manifest.json @@ -54,8 +54,7 @@ "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/constants/float64/eps" + "@stdlib/math/base/assert/is-nan" ] }, { diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/main.c index 592fa1ac8673..e4db07a5047f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/main.c @@ -35,7 +35,7 @@ double stdlib_base_dists_geometric_kurtosis( const double p ) { p <= 0.0 || p >= 1.0 ) { - return 0.0 / 0.0; + return 0.0 / 0.0; // NaN } return ( 6.0 + ( ( p * p ) / ( 1.0 - p ) ) ); } From 2e35d3020f76c04afe0dd6aa9f6c7fa038d0cc91 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Fri, 3 Jan 2025 12:11:44 +0000 Subject: [PATCH 4/7] chore: update copyright years --- .../base/dists/geometric/kurtosis/benchmark/benchmark.native.js | 2 +- .../stats/base/dists/geometric/kurtosis/benchmark/c/Makefile | 2 +- .../stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c | 2 +- .../@stdlib/stats/base/dists/geometric/kurtosis/binding.gyp | 2 +- .../stats/base/dists/geometric/kurtosis/examples/c/Makefile | 2 +- .../stats/base/dists/geometric/kurtosis/examples/c/example.c | 2 +- .../@stdlib/stats/base/dists/geometric/kurtosis/include.gypi | 2 +- .../include/stdlib/stats/base/dists/geometric/kurtosis.h | 2 +- .../@stdlib/stats/base/dists/geometric/kurtosis/lib/native.js | 2 +- .../@stdlib/stats/base/dists/geometric/kurtosis/src/Makefile | 2 +- .../@stdlib/stats/base/dists/geometric/kurtosis/src/addon.c | 2 +- .../@stdlib/stats/base/dists/geometric/kurtosis/src/main.c | 2 +- .../stats/base/dists/geometric/kurtosis/test/test.native.js | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js index f22422076e6e..afe7394e3faa 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 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/geometric/kurtosis/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/Makefile index f69e9da2b4d3..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2024 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/geometric/kurtosis/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c index 6e55a577f39d..28e91f2c3fb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 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/geometric/kurtosis/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/binding.gyp index ec3992233442..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/binding.gyp @@ -1,6 +1,6 @@ # @license Apache-2.0 # -# Copyright (c) 2024 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/geometric/kurtosis/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/Makefile index 6aed70daf167..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2024 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/geometric/kurtosis/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/example.c index 7c08cdab116e..37e7acb64f80 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/example.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 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/geometric/kurtosis/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include.gypi index 575cb043c0bf..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include.gypi @@ -1,6 +1,6 @@ # @license Apache-2.0 # -# Copyright (c) 2024 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/geometric/kurtosis/include/stdlib/stats/base/dists/geometric/kurtosis.h b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include/stdlib/stats/base/dists/geometric/kurtosis.h index 2482ea400744..3c476e67961a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include/stdlib/stats/base/dists/geometric/kurtosis.h +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include/stdlib/stats/base/dists/geometric/kurtosis.h @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 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/geometric/kurtosis/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/lib/native.js index b2f98a0ae909..a28fe6b8d4a0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/lib/native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 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/geometric/kurtosis/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/Makefile index bcf18aa46655..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2024 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/geometric/kurtosis/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/addon.c index 26810069bcb6..5c54867ff145 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/addon.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 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/geometric/kurtosis/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/main.c index e4db07a5047f..e8515ee29e35 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/src/main.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 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/geometric/kurtosis/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/test/test.native.js index 6283563f8370..3edec486953a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/test/test.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From 859e5e73a1b4d1336c1b379654db7489827a0f93 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Sat, 15 Feb 2025 11:22:22 +0530 Subject: [PATCH 5/7] feat: update benchmarks to use EPS constant for uniform distribution --- 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: passed - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: passed - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../base/dists/geometric/kurtosis/benchmark/benchmark.js | 1 + .../dists/geometric/kurtosis/benchmark/benchmark.native.js | 7 ++++--- .../base/dists/geometric/kurtosis/benchmark/c/benchmark.c | 3 ++- .../stats/base/dists/geometric/kurtosis/manifest.json | 3 ++- 4 files changed, 9 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.js index 104a0f31bab8..d3c2c61f3bd1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.js @@ -22,6 +22,7 @@ var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); +var EPS = require( '@stdlib/constants/float64/eps' ); var uniform = require( '@stdlib/random/base/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pkg = require( './../package.json' ).name; diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js index afe7394e3faa..02d3aa796aad 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/benchmark.native.js @@ -24,8 +24,9 @@ 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 uniform = require( '@stdlib/random/base/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var EPS = require( '@stdlib/constants/float64/eps' ); var pkg = require( './../package.json' ).name; @@ -48,12 +49,12 @@ bench( pkg+'::native', opts, function benchmark( b ) { len = 100; p = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - p[ i ] = ( randu() * 1.0 ); + p[ i ] = uniform( EPS, 1.0 ); } b.tic(); for ( i = 0; i < b.iterations; i++ ) { - y = kurtosis( p[ i % 100 ] ); + y = kurtosis( p[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c index 28e91f2c3fb4..122494e670cb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/benchmark/c/benchmark.c @@ -17,6 +17,7 @@ */ #include "stdlib/stats/base/dists/geometric/kurtosis.h" +#include "stdlib/constants/float64/eps.h" #include #include #include @@ -99,7 +100,7 @@ static double benchmark( void ) { int i; for ( i = 0; i < 100; i++ ) { - p[ i ] = random_uniform( 0.0, 1.0 ); + p[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 1.0 ); } t = tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/manifest.json index 7b4b4c8eae44..2b010801d0ba 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/manifest.json @@ -54,7 +54,8 @@ "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math/base/assert/is-nan" + "@stdlib/math/base/assert/is-nan", + "@stdlib/constants/float64/eps" ] }, { From 391d2d33b31e4f9950bd54500b618927309133d6 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 4 Mar 2025 22:31:21 -0500 Subject: [PATCH 6/7] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/geometric/kurtosis/README.md | 2 +- .../stats/base/dists/geometric/kurtosis/examples/c/example.c | 2 +- .../include/stdlib/stats/base/dists/geometric/kurtosis.h | 2 +- .../@stdlib/stats/base/dists/geometric/kurtosis/lib/native.js | 3 ++- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md index b95474a13f52..2426d672e939 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md @@ -201,7 +201,7 @@ int main( void ) { for ( i = 0; i < 25; i++ ) { p = random_uniform( 0.0, 1.0 ); y = stdlib_base_dists_geometric_kurtosis( p ); - printf( "p: %lf, Kurt[X]: %lf\n", p, y ); + printf( "p: %lf, Kurt(X;p): %lf\n", p, y ); } } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/example.c index 37e7acb64f80..daf7637daa67 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/examples/c/example.c @@ -33,6 +33,6 @@ int main( void ) { for ( i = 0; i < 25; i++ ) { p = random_uniform( 0.0, 1.0 ); y = stdlib_base_dists_geometric_kurtosis( p ); - printf( "p: %lf, Kurt[X]: %lf\n", p, y ); + printf( "p: %lf, Kurt(X;p): %lf\n", p, y ); } } diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include/stdlib/stats/base/dists/geometric/kurtosis.h b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include/stdlib/stats/base/dists/geometric/kurtosis.h index 3c476e67961a..d9e60fb2f7b1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include/stdlib/stats/base/dists/geometric/kurtosis.h +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/include/stdlib/stats/base/dists/geometric/kurtosis.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Returns the kurtosis of a geometric distribution. +* Returns the excess kurtosis of a geometric distribution. */ double stdlib_base_dists_geometric_kurtosis( const double p ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/lib/native.js index a28fe6b8d4a0..23435d8dd47b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/lib/native.js @@ -28,8 +28,9 @@ var addon = require( './../src/addon.node' ); /** * Returns the excess kurtosis of a geometric distribution. * +* @private * @param {Probability} p - success probability -* @returns {PositiveNumber} kurtosis +* @returns {PositiveNumber} excess kurtosis * * @example * var v = kurtosis( 0.1 ); From 6a6bf59357a7783cb47c3699db4f1bf58e3081b2 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 4 Mar 2025 22:32:43 -0500 Subject: [PATCH 7/7] chore: add closing section tag in README.md --- .../@stdlib/stats/base/dists/geometric/kurtosis/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md index 2426d672e939..ad38119acb62 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/kurtosis/README.md @@ -210,6 +210,10 @@ int main( void ) { +
+ + +