From 339164e6d822b1009bd18374b8f6af8383e3e7e0 Mon Sep 17 00:00:00 2001
From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com>
Date: Wed, 18 Dec 2024 19:29:44 +0530
Subject: [PATCH 1/6] feat: add C implementation for rayleigh mean
---
.../stats/base/dists/rayleigh/mean/README.md | 92 ++++++++++
.../rayleigh/mean/benchmark/benchmark.js | 11 +-
.../mean/benchmark/benchmark.native.js | 68 +++++++
.../dists/rayleigh/mean/benchmark/c/Makefile | 146 +++++++++++++++
.../rayleigh/mean/benchmark/c/benchmark.c | 139 ++++++++++++++
.../base/dists/rayleigh/mean/binding.gyp | 170 ++++++++++++++++++
.../dists/rayleigh/mean/examples/c/Makefile | 146 +++++++++++++++
.../dists/rayleigh/mean/examples/c/example.c | 38 ++++
.../base/dists/rayleigh/mean/include.gypi | 53 ++++++
.../stdlib/stats/base/dists/rayleigh/mean.h | 38 ++++
.../base/dists/rayleigh/mean/lib/native.js | 58 ++++++
.../base/dists/rayleigh/mean/manifest.json | 80 +++++++++
.../base/dists/rayleigh/mean/package.json | 3 +
.../base/dists/rayleigh/mean/src/Makefile | 70 ++++++++
.../base/dists/rayleigh/mean/src/addon.c | 23 +++
.../stats/base/dists/rayleigh/mean/src/main.c | 37 ++++
.../dists/rayleigh/mean/test/test.native.js | 92 ++++++++++
17 files changed, 1262 insertions(+), 2 deletions(-)
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/benchmark.native.js
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/Makefile
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/benchmark.c
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/binding.gyp
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/examples/c/Makefile
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/examples/c/example.c
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/include.gypi
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/include/stdlib/stats/base/dists/rayleigh/mean.h
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/lib/native.js
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/manifest.json
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/Makefile
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/addon.c
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/main.c
create mode 100644 lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/test/test.native.js
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/README.md
index f5c429e3c6f2..8bc42983fb03 100644
--- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/README.md
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/README.md
@@ -119,6 +119,98 @@ for ( i = 0; i < 10; i++ ) {
+
+
+* * *
+
+
+
+## C APIs
+
+
+
+
+
+
+
+
+
+
+
+### Usage
+
+```c
+#include "stdlib/stats/base/dists/rayleigh/mean.h"
+```
+
+#### stdlib_base_dists_rayleigh_mean( sigma )
+
+Returns the mean of a Rayleigh distribution.
+
+```c
+double out = stdlib_base_dists_rayleigh_mean( 9.0 );
+// returns ~11.253
+```
+
+The function accepts the following arguments:
+
+- **sigma**: `[in] double` scale parameter.
+
+```c
+double stdlib_base_dists_rayleigh_mean( const double sigma );
+```
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+### Examples
+
+```c
+#include "stdlib/stats/base/dists/rayleigh/mean.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 y;
+ int i;
+
+ for ( i = 0; i < 25; i++ ) {
+ sigma = random_uniform( 0.0, 20.0 );
+ y = stdlib_base_dists_rayleigh_mean( sigma );
+ printf( "σ: %lf, Mean(X;σ): %lf\n", sigma, y );
+ }
+}
+```
+
+
+
+
+
+
+
+
+
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/benchmark.js
index 94bbd6932629..daa2a6d14286 100644
--- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/benchmark.js
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/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,13 +33,19 @@ var mean = require( './../lib' );
bench( pkg, function benchmark( b ) {
var sigma;
+ var len;
var y;
var i;
+ len = 100;
+ sigma = new Float64Array( len );
+ for ( i = 0; i < len; i++ ) {
+ sigma[ i ] = ( randu() * 20.0 ) + EPS;
+ }
+
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
- sigma = ( randu()*20.0 ) + EPS;
- y = mean( sigma );
+ y = mean( sigma[ i % len ] );
if ( isnan( y ) ) {
b.fail( 'should not return NaN' );
}
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/benchmark.native.js
new file mode 100644
index 000000000000..7789b7afe1e7
--- /dev/null
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/benchmark.native.js
@@ -0,0 +1,68 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var resolve = require( 'path' ).resolve;
+var bench = require( '@stdlib/bench' );
+var Float64Array = require( '@stdlib/array/float64' );
+var tryRequire = require( '@stdlib/utils/try-require' );
+var randu = require( '@stdlib/random/base/randu' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var EPS = require( '@stdlib/constants/float64/eps' );
+var pkg = require( './../package.json' ).name;
+
+
+// VARIABLES //
+
+var mean = tryRequire( resolve( __dirname, './../lib/native.js' ) );
+var opts = {
+ 'skip': ( mean instanceof Error )
+};
+
+
+// MAIN //
+
+bench( pkg+'::native', opts, function benchmark( b ) {
+ var sigma;
+ var len;
+ var y;
+ var i;
+
+ len = 100;
+ sigma = new Float64Array( len );
+ for ( i = 0; i < len; i++ ) {
+ sigma[ i ] = ( randu() * 20.0 ) + EPS;
+ }
+
+ b.tic();
+ for ( i = 0; i < b.iterations; i++ ) {
+ y = mean( 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/mean/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/Makefile
new file mode 100644
index 000000000000..f69e9da2b4d3
--- /dev/null
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/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/rayleigh/mean/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/benchmark.c
new file mode 100644
index 000000000000..3d1debb397fc
--- /dev/null
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/benchmark.c
@@ -0,0 +1,139 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+#include "stdlib/stats/base/dists/rayleigh/mean.h"
+#include "stdlib/constants/float64/eps.h"
+#include
+#include
+#include
+#include
+#include
+
+#define NAME "rayleigh-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;
+}
+
+/**
+* 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 y;
+ double t;
+ int i;
+
+ for ( i = 0; i < 100; i++ ) {
+ sigma[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
+ }
+
+ t = tic();
+ for ( i = 0; i < ITERATIONS; i++ ) {
+ y = stdlib_base_dists_rayleigh_mean( 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/mean/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/binding.gyp
new file mode 100644
index 000000000000..ec3992233442
--- /dev/null
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/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/rayleigh/mean/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/examples/c/Makefile
new file mode 100644
index 000000000000..6aed70daf167
--- /dev/null
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/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/rayleigh/mean/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/examples/c/example.c
new file mode 100644
index 000000000000..35c51337b5af
--- /dev/null
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/examples/c/example.c
@@ -0,0 +1,38 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+#include "stdlib/stats/base/dists/rayleigh/mean.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 y;
+ int i;
+
+ for ( i = 0; i < 25; i++ ) {
+ sigma = random_uniform( 0.0, 20.0 );
+ y = stdlib_base_dists_rayleigh_mean( sigma );
+ printf( "σ: %lf, Mean(X;σ): %lf\n", sigma, y );
+ }
+}
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/include.gypi
new file mode 100644
index 000000000000..575cb043c0bf
--- /dev/null
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/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: Thu, 19 Dec 2024 11:38:46 +0530
Subject: [PATCH 2/6] fix: added tab indentation in files
---
.../rayleigh/mean/benchmark/c/benchmark.c | 112 +++++++++---------
.../stats/base/dists/rayleigh/mean/src/main.c | 5 +-
2 files changed, 60 insertions(+), 57 deletions(-)
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/benchmark.c
index 3d1debb397fc..8ce0e56d0523 100644
--- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/benchmark.c
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/benchmark.c
@@ -32,22 +32,22 @@
* Prints the TAP version.
*/
static void print_version( void ) {
- printf( "TAP version 13\n" );
+ printf( "TAP version 13\n" );
}
/**
* Prints the TAP summary.
*
-* @param total total number of tests
-* @param passing total number of passing tests
+* @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" );
+ printf( "#\n" );
+ printf( "1..%d\n", total ); // TAP plan
+ printf( "# total %d\n", total );
+ printf( "# pass %d\n", passing );
+ printf( "#\n" );
+ printf( "# ok\n" );
}
/**
@@ -56,12 +56,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" );
}
/**
@@ -70,21 +70,21 @@ 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;
}
/**
* Generates a random number on the interval [min,max).
*
-* @param min minimum value (inclusive)
-* @param max maximum value (exclusive)
-* @return random number
+* @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) );
+ double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
+ return min + ( v*(max-min) );
}
/**
@@ -93,47 +93,47 @@ static double random_uniform( const double min, const double max ) {
* @return elapsed time in seconds
*/
static double benchmark( void ) {
- double elapsed;
- double sigma[ 100 ];
- double y;
- double t;
- int i;
+ double elapsed;
+ double sigma[ 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;
- }
+ for ( i = 0; i < 100; i++ ) {
+ sigma[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
+ }
- t = tic();
- for ( i = 0; i < ITERATIONS; i++ ) {
- y = stdlib_base_dists_rayleigh_mean( 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;
+ t = tic();
+ for ( i = 0; i < ITERATIONS; i++ ) {
+ y = stdlib_base_dists_rayleigh_mean( 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;
+ 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 );
}
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/main.c
index d2632520e907..76e2e1c163a8 100644
--- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/main.c
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/main.c
@@ -30,7 +30,10 @@
* // returns ~11.253
*/
double stdlib_base_dists_rayleigh_mean( const double sigma ) {
- if ( stdlib_base_is_nan( sigma ) || sigma < 0 ) {
+ if (
+ stdlib_base_is_nan( sigma ) ||
+ sigma < 0
+ ) {
return 0.0 / 0.0; // NaN
}
return sigma * STDLIB_CONSTANT_FLOAT64_SQRT_HALF_PI;
From 27af00b5c43f84a6436ed7d616f80c3882dcd44b Mon Sep 17 00:00:00 2001
From: Philipp Burckhardt
Date: Thu, 19 Dec 2024 19:12:56 -0500
Subject: [PATCH 3/6] style: add empty line
Signed-off-by: Philipp Burckhardt
---
.../@stdlib/stats/base/dists/rayleigh/mean/src/main.c | 1 +
1 file changed, 1 insertion(+)
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/main.c
index 76e2e1c163a8..8de7a89a07fe 100644
--- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/main.c
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/src/main.c
@@ -19,6 +19,7 @@
#include "stdlib/stats/base/dists/rayleigh/mean.h"
#include "stdlib/math/base/assert/is_nan.h"
#include "stdlib/constants/float64/sqrt_half_pi.h"
+
/**
* Returns the mean of a Rayleigh distribution.
*
From 3d7ea4de0f93489c1cd18bb42fbd4d04705f41e4 Mon Sep 17 00:00:00 2001
From: Philipp Burckhardt
Date: Thu, 19 Dec 2024 19:14:31 -0500
Subject: [PATCH 4/6] style: use spaces instead of tabs for horizontal
alignment in C comments
Signed-off-by: Philipp Burckhardt
---
.../stats/base/dists/rayleigh/mean/benchmark/c/benchmark.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/benchmark.c
index 8ce0e56d0523..6de8aeb7773b 100644
--- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/benchmark.c
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/benchmark/c/benchmark.c
@@ -78,9 +78,9 @@ static double tic( void ) {
/**
* Generates a random number on the interval [min,max).
*
-* @param min minimum value (inclusive)
-* @param max maximum value (exclusive)
-* @return random number
+* @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 );
From e33c9aa1bd2bed9cf5749ab065e4ee7ce2a965e1 Mon Sep 17 00:00:00 2001
From: Philipp Burckhardt
Date: Thu, 19 Dec 2024 19:23:15 -0500
Subject: [PATCH 5/6] docs: fix return annotations
Signed-off-by: Philipp Burckhardt
---
.../@stdlib/stats/base/dists/rayleigh/mean/lib/native.js | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/lib/native.js
index 236fd2e35e18..6f4923d072b1 100644
--- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/lib/native.js
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/lib/native.js
@@ -34,11 +34,11 @@ var addon = require( './../src/addon.node' );
*
* @example
* var m = mean( 9.0 );
-* // returns ~11.253
+* // returns ~11.279
*
* @example
* var m = mean( 2.0 );
-* // returns ~2.506
+* // returns ~2.507
*
* @example
* var m = mean( -0.2 );
From d51e14ebd987ff66f7ef042d9fe75c5f5eb99a0c Mon Sep 17 00:00:00 2001
From: Philipp Burckhardt
Date: Thu, 19 Dec 2024 19:44:41 -0500
Subject: [PATCH 6/6] docs: add one more decimal digit
Signed-off-by: Philipp Burckhardt
---
.../@stdlib/stats/base/dists/rayleigh/mean/lib/native.js | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/lib/native.js
index 6f4923d072b1..1455d8ceee82 100644
--- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/lib/native.js
+++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/lib/native.js
@@ -34,7 +34,7 @@ var addon = require( './../src/addon.node' );
*
* @example
* var m = mean( 9.0 );
-* // returns ~11.279
+* // returns ~11.2798
*
* @example
* var m = mean( 2.0 );