From 56b3b4e48f98b9b411a0153b693545fe8f298eef Mon Sep 17 00:00:00 2001 From: Divyansh Seth Date: Tue, 17 Dec 2024 14:24:43 +0530 Subject: [PATCH 01/10] feat: add c implementation for cosine dist mean --- .../stats/base/dists/cosine/mean/README.md | 91 ++++++++++ .../dists/cosine/mean/benchmark/benchmark.js | 14 +- .../cosine/mean/benchmark/benchmark.native.js | 62 +++++++ .../dists/cosine/mean/benchmark/c/Makefile | 146 +++++++++++++++ .../dists/cosine/mean/benchmark/c/benchmark.c | 125 +++++++++++++ .../stats/base/dists/cosine/mean/binding.gyp | 170 ++++++++++++++++++ .../dists/cosine/mean/examples/c/Makefile | 146 +++++++++++++++ .../dists/cosine/mean/examples/c/example.c | 35 ++++ .../stats/base/dists/cosine/mean/include.gypi | 53 ++++++ .../stdlib/stats/base/dists/cosine/mean.h | 38 ++++ .../base/dists/cosine/mean/lib/native.js | 62 +++++++ .../base/dists/cosine/mean/manifest.json | 85 +++++++++ .../stats/base/dists/cosine/mean/package.json | 3 + .../stats/base/dists/cosine/mean/src/Makefile | 70 ++++++++ .../stats/base/dists/cosine/mean/src/addon.c | 23 +++ .../stats/base/dists/cosine/mean/src/main.c | 58 ++++++ .../dists/cosine/mean/test/test.native.js | 105 +++++++++++ 17 files changed, 1283 insertions(+), 3 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/include/stdlib/stats/base/dists/cosine/mean.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/cosine/mean/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md index 9527f117ca44..7827ce9a5cee 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md @@ -131,6 +131,97 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/arcsine/variance.h" +``` + +#### stdlib_base_dists_arcsine_variance( a, b ) + +Returns the variance of an arcsine distribution. + +```c +double out = stdlib_base_dists_arcsine_variance( 0.0, 1.0 ); +// returns ~0.125 +``` + +The function accepts the following arguments: + +- **a**: `[in] double` minimum support. +- **b**: `[in] double` maximum support. + +```c +double stdlib_base_dists_arcsine_variance( const double a, const double b ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/cosine/mean.h" +#include +#include + +int main( void ) { + double mu; + double s; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + mu = (double)rand() / ( (double)RAND_MAX + 1.0 ) - 5.0; + s = 20.0*(double)rand() / ( (double)RAND_MAX + 1.0 ); + y = stdlib_base_dists_cosine_mean( mu, s ); + printf( "µ: %lf, s: %lf, E(X;µ,s): %lf\n", mu , s , y ); + } +} + +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.js index a64372a4bb78..10ef72d3104d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.js @@ -20,6 +20,7 @@ // MODULES // +var Float64Array = require( '@stdlib/array/float64' ); var bench = require( '@stdlib/bench' ); var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); @@ -31,16 +32,23 @@ var mean = require( './../lib' ); // MAIN // bench( pkg, function benchmark( b ) { + var len; var mu; var s; var y; var i; + len = 100; + mu = new Float64Array( len ); + s = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + mu[ i ] = ( randu() * 100.0 ) - 50.0; + s[ i ] = ( randu() * 20.0 ) + EPS; + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - mu = ( randu()*100.0 ) - 50.0; - s = ( randu()*20.0 ) + EPS; - y = mean( mu, s ); + y = mean( mu[ i % len], s[ i % len] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.native.js new file mode 100644 index 000000000000..173037013228 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.native.js @@ -0,0 +1,62 @@ +/** +* @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 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 mean = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var len; + var mu; + var s; + var y; + var i; + + len = 100; + mu = new Float64Array( len ); + s = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + mu[ i ] = ( randu() * 100.0 ) - 50.0; + s[ i ] = ( randu() * 20.0 ) + EPS; + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = mean( mu[ i % len ], s[ 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/cosine/mean/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/benchmark.c new file mode 100644 index 000000000000..b1bc4e24ec0b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/benchmark.c @@ -0,0 +1,125 @@ +/** +* @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/cosine/mean.h" +#include +#include +#include +#include +#include + +#define NAME "cosine-mean" +#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; +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double mu; + double s; + double y; + double t; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + mu = 100.0*( (double)rand() / (double)RAND_MAX ) - 50.0; + s = 20.0*( (double)rand() / (double)RAND_MAX ); + y = stdlib_base_dists_cosine_mean( mu, s ); + 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/cosine/mean/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/example.c new file mode 100644 index 000000000000..b10584d2f86a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/example.c @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/base/dists/cosine/mean.h" +#include +#include + +int main( void ) { + double mu; + double s; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + mu = (double)rand() / ( (double)RAND_MAX + 1.0 ) - 5.0; + s = 20.0*(double)rand() / ( (double)RAND_MAX + 1.0 ); + y = stdlib_base_dists_cosine_mean( mu, s ); + printf( "µ: %lf, s: %lf, E(X;µ,s): %lf\n", mu , s , y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + ' Date: Tue, 17 Dec 2024 15:27:33 +0530 Subject: [PATCH 02/10] fix: correct include path for cosine mean implementation --- .../@stdlib/stats/base/dists/cosine/mean/src/addon.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/addon.c index adb96d4eed64..435759dcd444 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/addon.c @@ -16,7 +16,7 @@ * limitations under the License. */ -#include "stdlib/stats/base/dists/arcsine/cdf.h" +#include "stdlib/stats/base/dists/cosine/mean.h" #include "stdlib/math/base/napi/binary.h" // cppcheck-suppress shadowFunction From 76e72718cb79459329c37591573ed5f0e9871b5d Mon Sep 17 00:00:00 2001 From: Divyansh Seth Date: Tue, 17 Dec 2024 16:13:39 +0530 Subject: [PATCH 03/10] docs: update README for cosine mean function with correct usage and parameters --- .../stats/base/dists/cosine/mean/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md index 7827ce9a5cee..123d75fa0c08 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md @@ -154,25 +154,25 @@ for ( i = 0; i < 10; i++ ) { ### Usage ```c -#include "stdlib/stats/base/dists/arcsine/variance.h" +#include "stdlib/stats/base/dists/cosine/mean.h" ``` -#### stdlib_base_dists_arcsine_variance( a, b ) +#### stdlib_base_dists_cosine_mean( a, b ) -Returns the variance of an arcsine distribution. +Returns the mean of an cosine distribution. ```c -double out = stdlib_base_dists_arcsine_variance( 0.0, 1.0 ); -// returns ~0.125 +double out = stdlib_base_dists_cosine_mean( 2.0, 1.0 ); +// returns 2.0 ``` The function accepts the following arguments: -- **a**: `[in] double` minimum support. -- **b**: `[in] double` maximum support. +- **mu**: `[in] double` location parameter. +- **s**: `[in] double` scale parameter. ```c -double stdlib_base_dists_arcsine_variance( const double a, const double b ); +double stdlib_base_dists_cosine_mean( const double mu, const double s ); ```
From a04cc5ecb3f3aa8b00bd555511157f71493c7928 Mon Sep 17 00:00:00 2001 From: Divyansh Seth Date: Tue, 17 Dec 2024 16:31:05 +0530 Subject: [PATCH 04/10] feat: add C implementation for cosine mean --- .../@stdlib/stats/base/dists/cosine/mean/test/test.native.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/test/test.native.js index d4cca2e3cb4c..dc76ea9739ec 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/test/test.native.js @@ -67,6 +67,9 @@ tape( 'if provided `s <= 0.0`, the function returns `NaN`', opts, function test( y = mean( 3.0, 0.0 ); t.equal( isnan( y ), true, 'returns NaN' ); + y = mean( 0.0, 0.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + y = mean( 2.0, -2.0 ); t.equal( isnan( y ), true, 'returns NaN' ); From 7f4ae6aba8e82618c135ad5cabecd894ff700285 Mon Sep 17 00:00:00 2001 From: Divyansh Seth Date: Tue, 17 Dec 2024 17:12:15 +0530 Subject: [PATCH 05/10] fix: update dependencies in cosine mean manifest --- .../stats/base/dists/cosine/mean/manifest.json | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/manifest.json index dbc2e6588b6e..db80b71a4aa4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/manifest.json @@ -38,11 +38,8 @@ "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math/base/napi/ternary", - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/asin", - "@stdlib/math/base/special/sqrt", - "@stdlib/constants/float64/pi" + "@stdlib/math/base/napi/binary", + "@stdlib/math/base/assert/is-nan" ] }, { @@ -57,10 +54,7 @@ "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/asin", - "@stdlib/math/base/special/sqrt", - "@stdlib/constants/float64/pi" + "@stdlib/math/base/assert/is-nan" ] }, { @@ -75,10 +69,7 @@ "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/asin", - "@stdlib/math/base/special/sqrt", - "@stdlib/constants/float64/pi" + "@stdlib/math/base/assert/is-nan" ] } ] From b3efff5b1047a113649174a3cc7e7360a859f4a6 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sun, 6 Apr 2025 12:38:58 +0000 Subject: [PATCH 06/10] chore: update copyright years --- .../stats/base/dists/cosine/mean/benchmark/benchmark.native.js | 2 +- .../@stdlib/stats/base/dists/cosine/mean/benchmark/c/Makefile | 2 +- .../stats/base/dists/cosine/mean/benchmark/c/benchmark.c | 2 +- .../@stdlib/stats/base/dists/cosine/mean/binding.gyp | 2 +- .../@stdlib/stats/base/dists/cosine/mean/examples/c/Makefile | 2 +- .../@stdlib/stats/base/dists/cosine/mean/examples/c/example.c | 2 +- .../@stdlib/stats/base/dists/cosine/mean/include.gypi | 2 +- .../cosine/mean/include/stdlib/stats/base/dists/cosine/mean.h | 2 +- .../@stdlib/stats/base/dists/cosine/mean/lib/native.js | 2 +- .../@stdlib/stats/base/dists/cosine/mean/src/Makefile | 2 +- .../@stdlib/stats/base/dists/cosine/mean/src/addon.c | 2 +- .../@stdlib/stats/base/dists/cosine/mean/src/main.c | 2 +- .../@stdlib/stats/base/dists/cosine/mean/test/test.native.js | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.native.js index 173037013228..8abd6ceb2c33 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/Makefile index f69e9da2b4d3..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/benchmark.c index b1bc4e24ec0b..1ed06c98689e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/binding.gyp index ec3992233442..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/Makefile index 6aed70daf167..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/example.c index b10584d2f86a..42487456aecc 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/include.gypi index 575cb043c0bf..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/include/stdlib/stats/base/dists/cosine/mean.h b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/include/stdlib/stats/base/dists/cosine/mean.h index 15907a0c100b..4ba1e0df252a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/include/stdlib/stats/base/dists/cosine/mean.h +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/include/stdlib/stats/base/dists/cosine/mean.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/cosine/mean/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/lib/native.js index 0ed16b0b1170..69e86a132d87 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/Makefile index bcf18aa46655..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/addon.c index 435759dcd444..cdea1d5599b4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/main.c index 18c909fee060..c4a10f74a447 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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/cosine/mean/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/test/test.native.js index dc76ea9739ec..9b49763f0d45 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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 8436ae482f5989a5f2f61a1e9b4c24a8b54684ce Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 6 Apr 2025 08:55:19 -0400 Subject: [PATCH 07/10] chore: apply suggestions from code review Signed-off-by: Philipp Burckhardt --- .../stats/base/dists/cosine/mean/README.md | 10 +++++--- .../dists/cosine/mean/benchmark/benchmark.js | 1 - .../dists/cosine/mean/examples/c/example.c | 9 +++++-- .../base/dists/cosine/mean/lib/native.js | 1 + .../stats/base/dists/cosine/mean/src/addon.c | 1 - .../stats/base/dists/cosine/mean/src/main.c | 24 ++++--------------- 6 files changed, 19 insertions(+), 27 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md index 123d75fa0c08..396071e84bac 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md @@ -198,6 +198,11 @@ double stdlib_base_dists_cosine_mean( const double mu, const double s ); #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 mu; double s; @@ -205,13 +210,12 @@ int main( void ) { int i; for ( i = 0; i < 10; i++ ) { - mu = (double)rand() / ( (double)RAND_MAX + 1.0 ) - 5.0; - s = 20.0*(double)rand() / ( (double)RAND_MAX + 1.0 ); + mu = random_uniform( -5.0, 5.0 ); + s = random_uniform( 0.0, 20.0 ); y = stdlib_base_dists_cosine_mean( mu, s ); printf( "µ: %lf, s: %lf, E(X;µ,s): %lf\n", mu , s , y ); } } - ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.js index 0f25af5ee83b..b7485a2706bf 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.js @@ -20,7 +20,6 @@ // MODULES // -var Float64Array = require( '@stdlib/array/float64' ); var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); var uniform = require( '@stdlib/random/base/uniform' ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/example.c index 42487456aecc..26a411dee59f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/examples/c/example.c @@ -20,6 +20,11 @@ #include #include +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + int main( void ) { double mu; double s; @@ -27,8 +32,8 @@ int main( void ) { int i; for ( i = 0; i < 10; i++ ) { - mu = (double)rand() / ( (double)RAND_MAX + 1.0 ) - 5.0; - s = 20.0*(double)rand() / ( (double)RAND_MAX + 1.0 ); + mu = random_uniform( -5.0, 5.0 ); + s = random_uniform( 0.0, 20.0 ); y = stdlib_base_dists_cosine_mean( mu, s ); printf( "µ: %lf, s: %lf, E(X;µ,s): %lf\n", mu , s , y ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/lib/native.js index 69e86a132d87..e7daf8b6d67c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/lib/native.js @@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' ); /** * Returns the expected value for a raised cosine distribution with location `mu` and scale `s`. * +* @private * @param {number} mu - location parameter * @param {PositiveNumber} s - scale parameter * @returns {number} expected value diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/addon.c index cdea1d5599b4..3ebe3d5961f4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/addon.c @@ -19,5 +19,4 @@ #include "stdlib/stats/base/dists/cosine/mean.h" #include "stdlib/math/base/napi/binary.h" -// cppcheck-suppress shadowFunction STDLIB_MATH_BASE_NAPI_MODULE_DD_D( stdlib_base_dists_cosine_mean ) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/main.c index c4a10f74a447..ffb2827dfe98 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/src/main.c @@ -22,29 +22,13 @@ /** * Returns the expected value for a raised cosine distribution with location `mu` and scale `s`. * -* @param {number} mu - location parameter -* @param {PositiveNumber} s - scale parameter -* @returns {number} expected value +* @param mu location parameter +* @param s scale parameter +* @returns expected value * * @example -* var y = mean( 0.0, 1.0 ); +* double y = mean( 0.0, 1.0 ); * // returns 0.0 -* -* @example -* var y = mean( 5.0, 2.0 ); -* // returns 5.0 -* -* @example -* var y = mean( NaN, 1.0 ); -* // returns NaN -* -* @example -* var y = mean( 0.0, NaN ); -* // returns NaN -* -* @example -* var y = mean( 0.0, 0.0 ); -* // returns NaN */ double stdlib_base_dists_cosine_mean( const double mu, const double s ) { if ( From f6d6043007650d3dbeee0c7bfd1ecac2e632ff73 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 6 Apr 2025 08:56:31 -0400 Subject: [PATCH 08/10] docs: update description Signed-off-by: Philipp Burckhardt --- lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md index 396071e84bac..d6ed3ff8c954 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md @@ -159,7 +159,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_cosine_mean( a, b ) -Returns the mean of an cosine distribution. +Returns the [expected value][mean] for a [raised cosine][cosine-distribution] distribution with location parameter `mu` and scale parameter `s`. ```c double out = stdlib_base_dists_cosine_mean( 2.0, 1.0 ); From 6005881e033304cd8b2c110d7d4d07c62cff2133 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 6 Apr 2025 08:57:08 -0400 Subject: [PATCH 09/10] bench: replace `randu` with `uniform` in benchmark --- .../base/dists/cosine/mean/benchmark/benchmark.native.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.native.js index 8abd6ceb2c33..c1d42fc70b1b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/benchmark.native.js @@ -22,7 +22,7 @@ var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var EPS = require( '@stdlib/constants/float64/eps' ); var pkg = require( './../package.json' ).name; @@ -42,8 +42,8 @@ bench( pkg, function benchmark( b ) { mu = new Float64Array( len ); s = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - mu[ i ] = ( randu() * 100.0 ) - 50.0; - s[ i ] = ( randu() * 20.0 ) + EPS; + mu[ i ] = uniform( -50.0, 50.0 ); + s[ i ] = uniform( EPS, 20.0 ); } b.tic(); From d3feac0d09ba2ddf6dcfd1f6706ab21d8c16c068 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sun, 6 Apr 2025 08:57:41 -0400 Subject: [PATCH 10/10] style: fix indentation in benchmark.c --- .../dists/cosine/mean/benchmark/c/benchmark.c | 96 +++++++++---------- 1 file changed, 48 insertions(+), 48 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/benchmark.c index 1ed06c98689e..56722f04aaf2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/benchmark/c/benchmark.c @@ -31,7 +31,7 @@ * Prints the TAP version. */ static void print_version( void ) { - printf( "TAP version 13\n" ); + printf( "TAP version 13\n" ); } /** @@ -41,12 +41,12 @@ static void print_version( void ) { * @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" ); + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); } /** @@ -55,12 +55,12 @@ static void print_summary( int total, int passing ) { * @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" ); + 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" ); } /** @@ -69,9 +69,9 @@ static void print_results( double elapsed ) { * @return clock time */ static double tic( void ) { - struct timeval now; - gettimeofday( &now, NULL ); - return (double)now.tv_sec + (double)now.tv_usec/1.0e6; + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; } /** @@ -80,46 +80,46 @@ static double tic( void ) { * @return elapsed time in seconds */ static double benchmark( void ) { - double elapsed; - double mu; + double elapsed; + double mu; double s; - double y; - double t; - int i; + double y; + double t; + int i; - t = tic(); - for ( i = 0; i < ITERATIONS; i++ ) { - mu = 100.0*( (double)rand() / (double)RAND_MAX ) - 50.0; - s = 20.0*( (double)rand() / (double)RAND_MAX ); - y = stdlib_base_dists_cosine_mean( mu, s ); - if ( y != y ) { - printf( "should not return NaN\n" ); - break; - } - } - elapsed = tic() - t; - if ( y != y ) { - printf( "should not return NaN\n" ); - } - return elapsed; + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + mu = 100.0*( (double)rand() / (double)RAND_MAX ) - 50.0; + s = 20.0*( (double)rand() / (double)RAND_MAX ); + y = stdlib_base_dists_cosine_mean( mu, s ); + 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; + double elapsed; + int i; - // Use the current time to seed the random number generator: - srand( time( NULL ) ); + // 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 ); + 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 ); }