From e6cfc209acec22c4eca248dcb5a7f39ffda00568 Mon Sep 17 00:00:00 2001 From: DhruvArvindSingh Date: Fri, 27 Dec 2024 19:50:23 +0000 Subject: [PATCH 1/5] feat: add C implementation for @stdlib/stats/base/dists/rayleigh/mgf --- 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: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - 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: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../stats/base/dists/rayleigh/mgf/README.md | 84 +++++++++ .../dists/rayleigh/mgf/benchmark/benchmark.js | 15 +- .../mgf/benchmark/benchmark.native.js | 71 ++++++++ .../dists/rayleigh/mgf/benchmark/c/Makefile | 146 +++++++++++++++ .../rayleigh/mgf/benchmark/c/benchmark.c | 141 +++++++++++++++ .../stats/base/dists/rayleigh/mgf/binding.gyp | 170 ++++++++++++++++++ .../dists/rayleigh/mgf/examples/c/Makefile | 146 +++++++++++++++ .../dists/rayleigh/mgf/examples/c/example.c | 39 ++++ .../base/dists/rayleigh/mgf/include.gypi | 53 ++++++ .../stdlib/stats/base/dists/rayleigh/mgf.h | 38 ++++ .../base/dists/rayleigh/mgf/lib/native.js | 66 +++++++ .../base/dists/rayleigh/mgf/manifest.json | 88 +++++++++ .../base/dists/rayleigh/mgf/package.json | 3 + .../base/dists/rayleigh/mgf/src/Makefile | 70 ++++++++ .../stats/base/dists/rayleigh/mgf/src/addon.c | 23 +++ .../stats/base/dists/rayleigh/mgf/src/main.c | 74 ++++++++ .../dists/rayleigh/mgf/test/test.native.js | 79 ++++++++ 17 files changed, 1303 insertions(+), 3 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include/stdlib/stats/base/dists/rayleigh/mgf.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/README.md b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/README.md index 359c6249d107..7af1cfa32656 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/README.md @@ -143,6 +143,90 @@ for ( i = 0; i < 10; i++ ) { + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/rayleigh/mgf.h" +``` + +#### stdlib_base_dists_rayleigh_mgf( t, sigma ) + +Evaluates the mgf for a Rayleigh distribution. + +```c +double out = stdlib_base_dists_rayleigh_mgf( 1.0, 3.0 ); +// returns ~678.508 +``` + +The function accepts the following arguments: + +- **sigma**: `[in] double` scale parameter. + +```c +double stdlib_base_dists_rayleigh_mgf( const double t, const double sigma ); +``` + +
+ + +
+
+ + +
+### Examples +```c +#include "stdlib/stats/base/dists/rayleigh/mgf.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 sigma; + double t; + double y; + int i; + for ( i = 0; i < 25; i++ ) { + t = random_uniform( 0.0, 10.0 ); + sigma = random_uniform( 0.0, 10.0 ); + y = stdlib_base_dists_rayleigh_mgf( t, sigma ); + printf( "t: %lf, σ: %lf, f(x;σ): %lf\n", t, sigma, y ); + } +} +``` + +
+ + + +
+ + + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.js index 7dd6fb1b179c..230e0e067d03 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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' ); @@ -32,15 +33,23 @@ var mgf = require( './../lib' ); bench( pkg, function benchmark( b ) { var sigma; + var len; + var t; var x; var y; var i; + len = 100; + sigma = new Float64Array( len ); + t = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + sigma[ i ] = ( randu()*20.0 ) + EPS; + t[ i ] = ( randu()*20.0 ) + EPS; + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - x = ( randu()*5.0 ) - 5.0; - sigma = ( randu()*5.0 ) + EPS; - y = mgf( x, sigma ); + y = mgf( x[ i % len ], sigma[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..608fe6e1de57 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.native.js @@ -0,0 +1,71 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var Float64Array = require( '@stdlib/array/float64' ); +var randu = require( '@stdlib/random/base/randu' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var mgf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( mgf instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var sigma; + var len; + var t; + var y; + var i; + + len = 100; + sigma = new Float64Array( len ); + t = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + sigma[ i ] = ( randu()*20.0 ) + EPS; + t[ i ] = ( randu()*20.0 ) + EPS; + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = mgf( t[ i % len ], sigma[ 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/rayleigh/mgf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/benchmark.c new file mode 100644 index 000000000000..4875fb6c03a0 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/benchmark.c @@ -0,0 +1,141 @@ +/** +* @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/rayleigh/mgf.h" +#include "stdlib/constants/float64/eps.h" +#include +#include +#include +#include +#include + +#define NAME "rayleigh-mgf" +#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 sigma[ 100 ]; + double x[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + sigma[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + x[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_rayleigh_mgf( x[ i%100 ], sigma[ 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/rayleigh/mgf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/example.c new file mode 100644 index 000000000000..f808936472e4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/example.c @@ -0,0 +1,39 @@ +/** +* @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/rayleigh/mgf.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 sigma; + double t; + double y; + int i; + for ( i = 0; i < 25; i++ ) { + sigma = random_uniform( 0 , 10.0 ); + t = random_uniform( 0 , 10.0 ); + y = stdlib_base_dists_rayleigh_mgf( t, sigma ); + printf( "t: %lf, σ: %lf, mgf(X;t,Y;σ): %lf\n", t, sigma, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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: Mon, 16 Jun 2025 22:36:12 +0000 Subject: [PATCH 2/5] chore: update copyright years --- .../stats/base/dists/rayleigh/mgf/benchmark/benchmark.native.js | 2 +- .../@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/Makefile | 2 +- .../stats/base/dists/rayleigh/mgf/benchmark/c/benchmark.c | 2 +- .../@stdlib/stats/base/dists/rayleigh/mgf/binding.gyp | 2 +- .../@stdlib/stats/base/dists/rayleigh/mgf/examples/c/Makefile | 2 +- .../@stdlib/stats/base/dists/rayleigh/mgf/examples/c/example.c | 2 +- .../@stdlib/stats/base/dists/rayleigh/mgf/include.gypi | 2 +- .../rayleigh/mgf/include/stdlib/stats/base/dists/rayleigh/mgf.h | 2 +- .../@stdlib/stats/base/dists/rayleigh/mgf/lib/native.js | 2 +- .../@stdlib/stats/base/dists/rayleigh/mgf/src/Makefile | 2 +- .../@stdlib/stats/base/dists/rayleigh/mgf/src/addon.c | 2 +- .../@stdlib/stats/base/dists/rayleigh/mgf/src/main.c | 2 +- .../@stdlib/stats/base/dists/rayleigh/mgf/test/test.native.js | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.native.js index 608fe6e1de57..28e0fff36d19 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/Makefile index f69e9da2b4d3..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/benchmark.c index 4875fb6c03a0..6331728aaa6c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/binding.gyp index ec3992233442..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/Makefile index 6aed70daf167..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/example.c index f808936472e4..0b8912a83ac4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include.gypi index 575cb043c0bf..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/include/stdlib/stats/base/dists/rayleigh/mgf.h b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include/stdlib/stats/base/dists/rayleigh/mgf.h index 2dddd5d67d14..17eee436203a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include/stdlib/stats/base/dists/rayleigh/mgf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include/stdlib/stats/base/dists/rayleigh/mgf.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/rayleigh/mgf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/lib/native.js index 8ab2220b7735..067d0023cd75 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/Makefile index bcf18aa46655..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/addon.c index bb2afe1d0a1c..6796b4160e71 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c index 0dcee3260c38..c998e38f278c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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/rayleigh/mgf/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/test/test.native.js index a868cd9f3d26..37870b4b3b44 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/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 781840cccb4ec1533cd8da4c0db8aba17c2b509f Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Mon, 16 Jun 2025 17:50:22 -0500 Subject: [PATCH 3/5] chore: minor clean-up --- 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: passed - 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: passed - 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 --- --- .../stats/base/dists/rayleigh/mgf/README.md | 21 +++++++++++--- .../mgf/benchmark/benchmark.native.js | 6 ++-- .../rayleigh/mgf/benchmark/c/benchmark.c | 8 +++--- .../dists/rayleigh/mgf/examples/c/example.c | 7 +++-- .../stdlib/stats/base/dists/rayleigh/mgf.h | 2 +- .../base/dists/rayleigh/mgf/lib/native.js | 1 + .../stats/base/dists/rayleigh/mgf/src/main.c | 28 +++---------------- 7 files changed, 34 insertions(+), 39 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/README.md b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/README.md index 7af1cfa32656..582c889264f6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/README.md @@ -172,7 +172,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_rayleigh_mgf( t, sigma ) -Evaluates the mgf for a Rayleigh distribution. +Evaluates the [moment-generating function][mgf] for a [Rayleigh][rayleigh-distribution] distribution with scale parameter `sigma`. ```c double out = stdlib_base_dists_rayleigh_mgf( 1.0, 3.0 ); @@ -181,6 +181,7 @@ double out = stdlib_base_dists_rayleigh_mgf( 1.0, 3.0 ); The function accepts the following arguments: +- **t**: `[in] double` input value. - **sigma**: `[in] double` scale parameter. ```c @@ -188,32 +189,44 @@ double stdlib_base_dists_rayleigh_mgf( const double t, const double sigma ); ```
+ + +
+
+ + +
+ ### Examples + ```c #include "stdlib/stats/base/dists/rayleigh/mgf.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 sigma; double t; double y; int i; + for ( i = 0; i < 25; i++ ) { - t = random_uniform( 0.0, 10.0 ); - sigma = random_uniform( 0.0, 10.0 ); + t = random_uniform( 0.0, 1.0 ); + sigma = random_uniform( 0.1, 5.0 ); y = stdlib_base_dists_rayleigh_mgf( t, sigma ); - printf( "t: %lf, σ: %lf, f(x;σ): %lf\n", t, sigma, y ); + printf( "t: %lf, σ: %lf, M_X(t;σ): %lf\n", t, sigma, y ); } } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.native.js index 28e0fff36d19..21a3645489c1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.native.js @@ -23,7 +23,7 @@ var resolve = require( 'path' ).resolve; 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 EPS = require( '@stdlib/constants/float64/eps' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -51,8 +51,8 @@ bench( pkg+'::native', opts, function benchmark( b ) { sigma = new Float64Array( len ); t = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - sigma[ i ] = ( randu()*20.0 ) + EPS; - t[ i ] = ( randu()*20.0 ) + EPS; + t[ i ] = uniform( 0.0, 1.0 ); + sigma[ i ] = uniform( EPS, 5.0 ); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/benchmark.c index 6331728aaa6c..93b215b5d997 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/c/benchmark.c @@ -95,19 +95,19 @@ static double random_uniform( const double min, const double max ) { static double benchmark( void ) { double elapsed; double sigma[ 100 ]; - double x[ 100 ]; + double t_vals[ 100 ]; double y; double t; int i; for ( i = 0; i < 100; i++ ) { - sigma[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; - x[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + t_vals[ i ] = random_uniform( 0.0, 1.0 ); + sigma[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 5.0 ); } t = tic(); for ( i = 0; i < ITERATIONS; i++ ) { - y = stdlib_base_dists_rayleigh_mgf( x[ i%100 ], sigma[ i%100 ] ); + y = stdlib_base_dists_rayleigh_mgf( t_vals[ i%100 ], sigma[ i%100 ] ); if ( y != y ) { printf( "should not return NaN\n" ); break; diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/example.c index 0b8912a83ac4..c661de2c25f7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/examples/c/example.c @@ -30,10 +30,11 @@ int main( void ) { double t; double y; int i; + for ( i = 0; i < 25; i++ ) { - sigma = random_uniform( 0 , 10.0 ); - t = random_uniform( 0 , 10.0 ); + t = random_uniform( 0.0, 1.0 ); + sigma = random_uniform( 0.1, 5.0 ); y = stdlib_base_dists_rayleigh_mgf( t, sigma ); - printf( "t: %lf, σ: %lf, mgf(X;t,Y;σ): %lf\n", t, sigma, y ); + printf( "t: %lf, σ: %lf, M_X(t;σ): %lf\n", t, sigma, y ); } } diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include/stdlib/stats/base/dists/rayleigh/mgf.h b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include/stdlib/stats/base/dists/rayleigh/mgf.h index 17eee436203a..f0bbcd636d11 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include/stdlib/stats/base/dists/rayleigh/mgf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/include/stdlib/stats/base/dists/rayleigh/mgf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Returns the mgf for a Rayleigh distribution. +* Evaluates the moment-generating function (MGF) for a Rayleigh distribution. */ double stdlib_base_dists_rayleigh_mgf( const double t, const double sigma ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/lib/native.js index 067d0023cd75..59774f4acd5b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/lib/native.js @@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' ); /** * Evaluates the moment-generating function (MGF) for a Rayleigh distribution with scale parameter `sigma` at a value `t`. * +* @private * @param {number} t - input value * @param {NonNegativeNumber} sigma - scale parameter * @returns {number} evaluated MGF diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c index c998e38f278c..11abb9e7d6f4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c @@ -29,33 +29,13 @@ /** * Evaluates the moment-generating function (MGF) for a Rayleigh distribution with scale parameter `sigma` at a value `t`. * -* @param {number} t - input value -* @param {NonNegativeNumber} sigma - scale parameter -* @returns {number} evaluated MGF +* @param t input value +* @param sigma scale parameter +* @return evaluated MGF * * @example -* double y = mgf( 1.0, 3.0 ); +* double y = stdlib_base_dists_rayleigh_mgf( 1.0, 3.0 ); * // returns ~678.508 -* -* @example -* double y = stdlib_base_dists_rayleigh_mgf( 1.0, 2.0 ); -* // returns ~38.65 -* -* @example -* double y = stdlib_base_dists_rayleigh_mgf( -1.0, 4.0 ); -* // returns ~-0.947 -* -* @example -* double y = stdlib_base_dists_rayleigh_mgf( NaN, 1.0 ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_rayleigh_mgf( 0.0, NaN ); -* // returns NaN -* -* @example -* double y = stdlib_base_dists_rayleigh_mgf( 0.5, -1.0 ); -* // returns NaN */ double stdlib_base_dists_rayleigh_mgf( const double t, const double sigma ) { double sigmat; From adc427ba6817018f17b644ef85ce63f77919780e Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Mon, 23 Jun 2025 08:42:35 -0500 Subject: [PATCH 4/5] style: fix indentation in Rayleigh MGF C implementation --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: 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/rayleigh/mgf/benchmark/benchmark.js | 11 +++++------ .../@stdlib/stats/base/dists/rayleigh/mgf/src/main.c | 7 +++---- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.js index 230e0e067d03..10c4c15dd380 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/benchmark/benchmark.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; @@ -35,7 +35,6 @@ bench( pkg, function benchmark( b ) { var sigma; var len; var t; - var x; var y; var i; @@ -43,13 +42,13 @@ bench( pkg, function benchmark( b ) { sigma = new Float64Array( len ); t = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - sigma[ i ] = ( randu()*20.0 ) + EPS; - t[ i ] = ( randu()*20.0 ) + EPS; + t[ i ] = uniform( 0.0, 1.0 ); + sigma[ i ] = uniform( EPS, 5.0 ); } b.tic(); for ( i = 0; i < b.iterations; i++ ) { - y = mgf( x[ i % len ], sigma[ i % len ] ); + y = mgf( t[ i % len ], sigma[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } @@ -74,7 +73,7 @@ bench( pkg+':factory', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - x = ( randu()*5.0 ) - 5.0; + x = uniform( -2.5, 2.5 ); y = mymgf( x ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c index 11abb9e7d6f4..ccd5294828f4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c @@ -20,9 +20,8 @@ #include "stdlib/math/base/assert/is_nan.h" #include "stdlib/math/base/special/exp.h" #include "stdlib/math/base/special/erf.h" - -#define STDLIB_CONSTANT_FLOAT64_SQRT_HALF_PI 1.2533141373155002512 -#define STDLIB_CONSTANT_FLOAT64_SQRT2 1.4142135623730950488 +#include "stdlib/constants/float64/sqrt_half_pi.h" +#include "stdlib/constants/float64/sqrt_two.h" // MAIN // @@ -49,6 +48,6 @@ double stdlib_base_dists_rayleigh_mgf( const double t, const double sigma ) { } sigmat = t * sigma; out = 1.0 + (sigmat * stdlib_base_exp( sigmat*sigmat / 2.0 )); - out *= STDLIB_CONSTANT_FLOAT64_SQRT_HALF_PI * ( stdlib_base_erf( sigmat / STDLIB_CONSTANT_FLOAT64_SQRT2 ) + 1.0 ); + out *= STDLIB_CONSTANT_FLOAT64_SQRT_HALF_PI * ( stdlib_base_erf( sigmat / STDLIB_CONSTANT_FLOAT64_SQRT2 ) + 1.0 ); return out; } From a6040c77345023eef4da19ba3deb748b4e5a02be Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Mon, 23 Jun 2025 09:07:19 -0500 Subject: [PATCH 5/5] chore: minor clean-up Signed-off-by: Philipp Burckhardt --- .../@stdlib/stats/base/dists/rayleigh/mgf/manifest.json | 1 + .../@stdlib/stats/base/dists/rayleigh/mgf/src/addon.c | 1 - .../@stdlib/stats/base/dists/rayleigh/mgf/src/main.c | 2 -- 3 files changed, 1 insertion(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/manifest.json index 20cf4ad04e5f..d2acff2f4f29 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/manifest.json @@ -38,6 +38,7 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/math/base/napi/binary", "@stdlib/math/base/assert/is-nan", "@stdlib/math/base/special/exp", "@stdlib/math/base/special/erf", diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/addon.c index 6796b4160e71..635b8b9b9c3c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/addon.c @@ -19,5 +19,4 @@ #include "stdlib/stats/base/dists/rayleigh/mgf.h" #include "stdlib/math/base/napi/binary.h" -// cppcheck-suppress shadowFunction STDLIB_MATH_BASE_NAPI_MODULE_DD_D( stdlib_base_dists_rayleigh_mgf ) diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c index ccd5294828f4..fe01e89e02e1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mgf/src/main.c @@ -23,8 +23,6 @@ #include "stdlib/constants/float64/sqrt_half_pi.h" #include "stdlib/constants/float64/sqrt_two.h" -// MAIN // - /** * Evaluates the moment-generating function (MGF) for a Rayleigh distribution with scale parameter `sigma` at a value `t`. *