From 77fd0d8584db06238945163bb6c1e4e4c6cef2bc Mon Sep 17 00:00:00 2001 From: yuvi-mittal Date: Wed, 29 Jan 2025 13:44:07 +0530 Subject: [PATCH 1/3] Add C implementation for @stdlib/stats/base/dists/planck/mgf --- 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/planck/mgf/README.md | 96 ++++++++++ .../dists/planck/mgf/benchmark/benchmark.js | 18 +- .../planck/mgf/benchmark/benchmark.native.js | 70 ++++++++ .../dists/planck/mgf/benchmark/c/Makefile | 146 +++++++++++++++ .../dists/planck/mgf/benchmark/c/benchmark.c | 141 +++++++++++++++ .../stats/base/dists/planck/mgf/binding.gyp | 170 ++++++++++++++++++ .../base/dists/planck/mgf/examples/c/Makefile | 146 +++++++++++++++ .../dists/planck/mgf/examples/c/example.c | 41 +++++ .../stats/base/dists/planck/mgf/include.gypi | 53 ++++++ .../stdlib/stats/base/dists/planck/mgf.h | 38 ++++ .../stats/base/dists/planck/mgf/lib/native.js | 63 +++++++ .../stats/base/dists/planck/mgf/manifest.json | 83 +++++++++ .../stats/base/dists/planck/mgf/package.json | 3 + .../stats/base/dists/planck/mgf/src/Makefile | 70 ++++++++ .../stats/base/dists/planck/mgf/src/addon.c | 23 +++ .../stats/base/dists/planck/mgf/src/main.c | 43 +++++ .../base/dists/planck/mgf/test/test.native.js | 121 +++++++++++++ 17 files changed, 1320 insertions(+), 5 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include/stdlib/stats/base/dists/planck/mgf.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/planck/mgf/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/README.md b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/README.md index c0230d074d18..995e6481c213 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/README.md @@ -138,6 +138,102 @@ for ( i = 0; i < lambda.length; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/planck/mgf.h" +``` + +#### stdlib_base_dists_planck_mgf( t, lambda ) + +Evaluates the moment-generating function (MGF) for a Planck distribution with shape parameter `lambda` at a value `t`. + +```c +double out = stdlib_base_dists_planck_mgf( 0.2, 0.5 ); +// returns ~1.5181 +``` + +The function accepts the following arguments: + +- **t**: `[in] double` input value. +- **lambda**: `[in] double` shape parameter. + +```c +double stdlib_base_dists_planck_mgf( const double t, const double lambda ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/planck/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 t; + double lambda; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + t = random_uniform( 0.0, 10.0 ); + lambda = random_uniform( 0.1, 5.0 ); + y = stdlib_base_dists_planck_mgf( t, lambda ); + printf( "t: %lf, lambda: %lf, M_X(t; lambda): %lf\n", t, lambda, y ); + } + return 0; +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/benchmark.js index f40aad933643..946e0945bbfd 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/benchmark.js @@ -21,7 +21,9 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/array/uniform' ); +var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var uniformArray = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pkg = require( './../package.json' ).name; var mgf = require( './../lib' ); @@ -31,16 +33,22 @@ var mgf = require( './../lib' ); bench( pkg, function benchmark( b ) { var lambda; + var len; var t; var y; var i; - lambda = uniform( 100, 0.1, 10.0 ); - t = uniform( 100, 0.0, 10.0 ); + len = 100; + t = new Float64Array( len ); + lambda = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + t[ i ] = uniform(0.0, 10.0); + lambda[ i ] = uniform(0.1, 10.0); + } b.tic(); for ( i = 0; i < b.iterations; i++ ) { - y = mgf( t[ i % t.length ], lambda[ i % lambda.length ] ); + y = mgf( t[ i % len ], lambda[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } @@ -59,7 +67,7 @@ bench( pkg+':factory', function benchmark( b ) { var y; var i; - t = uniform( 100, 0.0, 10.0 ); + t = uniformArray( 100, 0.0, 10.0 ); mymgf = mgf.factory( 0.3 ); b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..8bd4ebd3f9be --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/benchmark.native.js @@ -0,0 +1,70 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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 uniform = require( '@stdlib/random/base/uniform' ); +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 lambda; + var len; + var t; + var y; + var i; + + len = 100; + t = new Float64Array( len ); + lambda = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + t[ i ] = uniform(0.0, 10.0); + lambda[ i ] = uniform(0.1, 10.0); + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = mgf( t[ i % len ], lambda[ 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/planck/mgf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/mgf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/c/benchmark.c new file mode 100644 index 000000000000..c69fa62c09f8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/c/benchmark.c @@ -0,0 +1,141 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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/planck/mgf.h" +#include +#include +#include +#include +#include + +#define NAME "planck-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 t[100]; + double lambda[100]; + double y; + int i; + + for (i = 0; i < 100; i++) { + t[i] = random_uniform(0.0, 10.0); + lambda[i] = random_uniform(0.1, 10.0); + } + + elapsed = tic(); + for (i = 0; i < ITERATIONS; i++) { + y = stdlib_base_dists_planck_mgf(t[i % 100], lambda[i % 100]); + if (isnan(y)) { + printf("should not return NaN\n"); + break; + } + } + elapsed = tic() - elapsed; + + if (isnan(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/planck/mgf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/mgf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/mgf/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/examples/c/example.c new file mode 100644 index 000000000000..fd4bc44658c0 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/examples/c/example.c @@ -0,0 +1,41 @@ +/** +* @license Apache-2.0 +* +* 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. +* 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/planck/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 t; + double lambda; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + t = random_uniform( 0.0, 10.0 ); + lambda = random_uniform( 0.1, 5.0 ); + y = stdlib_base_dists_planck_mgf( t, lambda ); + printf( "t: %lf, lambda: %lf, M_X(t; lambda): %lf\n", t, lambda, y ); + } + return 0; +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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, 3 Feb 2025 12:54:45 +0530 Subject: [PATCH 2/3] Refactor random number generation in JS benchmarks --- 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 --- --- .../dists/planck/mgf/benchmark/benchmark.js | 3 +- .../stdlib/stats/base/dists/planck/mgf.h | 2 +- .../stats/base/dists/planck/mgf/lib/native.js | 2 +- .../stats/base/dists/planck/mgf/manifest.json | 159 +++++++++--------- .../stats/base/dists/planck/mgf/src/main.c | 2 +- 5 files changed, 83 insertions(+), 85 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/benchmark.js index 946e0945bbfd..df228ee58f14 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/benchmark.js @@ -23,7 +23,6 @@ var bench = require( '@stdlib/bench' ); var Float64Array = require( '@stdlib/array/float64' ); var uniform = require( '@stdlib/random/base/uniform' ); -var uniformArray = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pkg = require( './../package.json' ).name; var mgf = require( './../lib' ); @@ -67,7 +66,7 @@ bench( pkg+':factory', function benchmark( b ) { var y; var i; - t = uniformArray( 100, 0.0, 10.0 ); + t = uniform( 0.0, 10.0 ); mymgf = mgf.factory( 0.3 ); b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include/stdlib/stats/base/dists/planck/mgf.h b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include/stdlib/stats/base/dists/planck/mgf.h index bf2f2a0f30fb..69c7430c340b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include/stdlib/stats/base/dists/planck/mgf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include/stdlib/stats/base/dists/planck/mgf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the moment-generating function (MGF) for a Planck distribution with shape parameter `lambda` at a value `t`. +* Evaluates the moment-generating function (MGF) for a Planck distribution with shape parameter `lambda` . */ double stdlib_base_dists_planck_mgf( const double t, const double lambda ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/lib/native.js index 56e018d58597..ff45eeef8d3d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the moment-generating function (MGF) for a Planck distribution with shape parameter `lambda` at a value `t`. +* Evaluates the moment-generating function (MGF) for a Planck distribution with shape parameter `lambda` . * * @private * @param {number} t - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/manifest.json index dd106ca13eb7..22ba06ce9053 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/manifest.json @@ -1,83 +1,82 @@ { - "options": { + "options": { + "task": "build", + "wasm": false + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { "task": "build", - "wasm": false + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/napi/binary", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/expm1", + "@stdlib/math/base/special/pow" + ] + }, + { + "task": "benchmark", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/expm1", + "@stdlib/math/base/special/pow" + ] }, - "fields": [ - { - "field": "src", - "resolve": true, - "relative": true - }, - { - "field": "include", - "resolve": true, - "relative": true - }, - { - "field": "libraries", - "resolve": false, - "relative": false - }, - { - "field": "libpath", - "resolve": true, - "relative": false - } - ], - "confs": [ - { - "task": "build", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/math/base/napi/binary", - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/expm1", - "@stdlib/math/base/special/pow" - ] - }, - { - "task": "benchmark", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/constants/float64/eps", - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/expm1", - "@stdlib/math/base/special/pow" - ] - }, - { - "task": "examples", - "wasm": false, - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [ - "@stdlib/math/base/assert/is-nan", - "@stdlib/math/base/special/expm1", - "@stdlib/math/base/special/pow" - ] - } - ] - } + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/expm1", + "@stdlib/math/base/special/pow" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/src/main.c index 95010981dd01..b9fedceff630 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/src/main.c @@ -21,7 +21,7 @@ #include "stdlib/math/base/special/expm1.h" /** -* Evaluates the moment-generating function (MGF) for a Planck distribution with shape parameter `lambda` at a value `t`. +* Evaluates the moment-generating function (MGF) for a Planck distribution with shape parameter `lambda` . * * @param t input value * @param lambda shape parameter (must be positive) From dc9a1f425d85a3e42fb604f1849e3e937e2037e9 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sat, 15 Feb 2025 22:51:28 +0000 Subject: [PATCH 3/3] chore: update copyright years --- .../@stdlib/stats/base/dists/planck/mgf/benchmark/c/Makefile | 2 +- .../@stdlib/stats/base/dists/planck/mgf/binding.gyp | 2 +- .../@stdlib/stats/base/dists/planck/mgf/examples/c/Makefile | 2 +- .../@stdlib/stats/base/dists/planck/mgf/include.gypi | 2 +- .../planck/mgf/include/stdlib/stats/base/dists/planck/mgf.h | 2 +- .../@stdlib/stats/base/dists/planck/mgf/src/Makefile | 2 +- .../@stdlib/stats/base/dists/planck/mgf/src/addon.c | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/c/Makefile index f69e9da2b4d3..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/mgf/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/binding.gyp index ec3992233442..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/mgf/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/examples/c/Makefile index 6aed70daf167..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/mgf/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include.gypi index 575cb043c0bf..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/mgf/include/stdlib/stats/base/dists/planck/mgf.h b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include/stdlib/stats/base/dists/planck/mgf.h index 69c7430c340b..d3e517350306 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include/stdlib/stats/base/dists/planck/mgf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/include/stdlib/stats/base/dists/planck/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/planck/mgf/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/src/Makefile index bcf18aa46655..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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/planck/mgf/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/src/addon.c index 4aa693f9cb2a..2bb4c40c104a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mgf/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/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.