From 7c76b9ca3e24663a355e8d4da591f5e9553e5ca7 Mon Sep 17 00:00:00 2001 From: Aadish Jain Date: Sat, 14 Dec 2024 22:54:41 +0000 Subject: [PATCH 1/6] feat(t-mode): adding all the required functionality of t mode --- .../@stdlib/stats/base/dists/t/mode/README.md | 93 ++++++++++ .../base/dists/t/mode/benchmark/benchmark.js | 26 +-- .../t/mode/benchmark/benchmark.native.js | 67 +++++++ .../base/dists/t/mode/benchmark/c/Makefile | 146 +++++++++++++++ .../base/dists/t/mode/benchmark/c/benchmark.c | 138 ++++++++++++++ .../stats/base/dists/t/mode/binding.gyp | 170 ++++++++++++++++++ .../base/dists/t/mode/examples/c/Makefile | 146 +++++++++++++++ .../base/dists/t/mode/examples/c/example.c | 38 ++++ .../stats/base/dists/t/mode/include.gypi | 53 ++++++ .../include/stdlib/stats/base/dists/t/mode.h | 45 +++++ .../stats/base/dists/t/mode/lib/native.js | 58 ++++++ .../stats/base/dists/t/mode/manifest.json | 76 ++++++++ .../stats/base/dists/t/mode/package.json | 3 + .../stats/base/dists/t/mode/src/Makefile | 70 ++++++++ .../stats/base/dists/t/mode/src/addon.c | 23 +++ .../stats/base/dists/t/mode/src/main.c | 37 ++++ .../base/dists/t/mode/test/test.native.js | 76 ++++++++ 17 files changed, 1255 insertions(+), 10 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/include/stdlib/stats/base/dists/t/mode.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/README.md b/lib/node_modules/@stdlib/stats/base/dists/t/mode/README.md index 9ed11279665d..fab48dc55b73 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/README.md @@ -114,6 +114,99 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/t/mode.h" +``` + +#### stdlib_base_dists_t_mode( v ) + +Evaluates the mode for a Student's t-distribution. + +```c +double out = stdlib_base_dists_t_mode( 5.0 ); +// returns 0.0 +``` + +The function accepts the following arguments: + +- **v**: `[in] double` input value. + +```c +double stdlib_base_dists_t_mode( const double v ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/t/mode.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 v; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + v = random_uniform( 0.0, 100.0 ); + y = stdlib_base_dists_t_mode( v ); + printf( "v: %lf, mode: %lf\n", v, y ); + } +} +``` + +
+ + + +
+ + + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.js index b603f97859f2..813767737057 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.js @@ -21,32 +21,38 @@ // MODULES // var bench = require( '@stdlib/bench' ); +var Float64Array = require( '@stdlib/array/float64' ); var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var EPS = require( '@stdlib/constants/float64/eps' ); var pkg = require( './../package.json' ).name; var mode = require( './../lib' ); // MAIN // -bench( pkg, function benchmark( b ) { +bench(pkg, function benchmark(b) { + var len; var v; var y; var i; + len = 100; + v = new Float64Array(len); + for (i = 0; i < len; i++) { + v[i] = (randu() * 100.0); + } + b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = ( randu()*20.0 ) + 1.0 + EPS; - y = mode( v ); - if ( isnan( y ) ) { - b.fail( 'should not return NaN' ); + for (i = 0; i < b.iterations; i++) { + y = mode(v[i % len]); + if (isnan(y)) { + b.fail('should not return NaN'); } } b.toc(); - if ( isnan( y ) ) { - b.fail( 'should not return NaN' ); + if (isnan(y)) { + b.fail('should not return NaN'); } - b.pass( 'benchmark finished' ); + b.pass('benchmark finished'); b.end(); }); diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.native.js new file mode 100644 index 000000000000..e5454a3dac5d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.native.js @@ -0,0 +1,67 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var mode = tryRequire(resolve(__dirname, './../lib/native.js')); +var opts = { + 'skip': (mode instanceof Error) +}; + + +// MAIN // + +bench(pkg + '::native', opts, function benchmark(b) { + var len; + var v; + var y; + var i; + + len = 100; + v = new Float64Array(len); + for (i = 0; i < len; i++) { + v[i] = (randu() * 100.0); + } + + b.tic(); + for (i = 0; i < b.iterations; i++) { + y = mode(v[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/t/mode/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/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/t/mode/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/c/benchmark.c new file mode 100644 index 000000000000..d915f6948ab7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/c/benchmark.c @@ -0,0 +1,138 @@ +/** +* @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 +#include "stdlib/stats/base/dists/t/mode.h" +#include +#include +#include +#include + +#define NAME "t-mode" +#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 v[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + v[ i ] = random_uniform( 0.0, 100.0 ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_t_mode( v[ 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/t/mode/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/t/mode/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/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/t/mode/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/t/mode/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/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/t/mode/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/t/mode/examples/c/example.c new file mode 100644 index 000000000000..32a03ca914e8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/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/t/mode.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 v; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + v = random_uniform( 0.0, 100.0 ); + y = stdlib_base_dists_t_mode( v ); + printf( "v: %lf, mode: %lf\n", v, y ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/t/mode/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/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: Sat, 14 Dec 2024 23:42:56 +0000 Subject: [PATCH 2/6] feat(t-mode): fixing test.native.js --- .../base/dists/t/mode/test/test.native.js | 39 +++++++++++-------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js index 20bcaf616227..313a1b607186 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js @@ -26,11 +26,16 @@ var tryRequire = require( '@stdlib/utils/try-require' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +// FIXTURES // + +var data = require( './fixtures/julia/data.json' ); + + // VARIABLES // -var mode = tryRequire(resolve(__dirname, './../lib/native.js')); +var median = tryRequire(resolve(__dirname, './../lib/native.js')); var opts = { - 'skip': (mode instanceof Error) + 'skip': (median instanceof Error) }; @@ -38,12 +43,12 @@ var opts = { tape('main export is a function', opts, function test(t) { t.ok(true, __filename); - t.strictEqual(typeof mode, 'function', 'main export is a function'); + t.strictEqual(typeof median, 'function', 'main export is a function'); t.end(); }); tape('if provided `NaN` for the parameter, the function returns `NaN`', opts, function test(t) { - var y = mode(NaN); + var y = median(NaN); t.equal(isnan(y), true, 'returns NaN'); t.end(); }); @@ -51,26 +56,26 @@ tape('if provided `NaN` for the parameter, the function returns `NaN`', opts, fu tape('if provided a negative value for `v`, the function returns `NaN`', opts, function test(t) { var y; - y = mode(-1.0); + y = median(-1.0); t.equal(isnan(y), true, 'returns NaN'); - y = mode(-0.5); + y = median(-0.5); t.equal(isnan(y), true, 'returns NaN'); t.end(); }); -tape('the function evaluates the mode for a Student\'s t-distribution', opts, function test(t) { +tape('the function evaluates the median for a Student\'s t-distribution', opts, function test(t) { + var expected; + var v; var y; - - y = mode(3.0); - t.equal(y, 0.0, 'returns 0.0'); - - y = mode(5.0); - t.equal(y, 0.0, 'returns 0.0'); - - y = mode(10.0); - t.equal(y, 0.0, 'returns 0.0'); - + var i; + + for (i = 0; i < data.v.length; i++) { + v = data.v[i]; + expected = data.expected[i]; + y = median(v); + t.equal(y, expected, 'v: ' + v + ', y: ' + y + ', expected: ' + expected); + } t.end(); }); From 2ab3175fb1f42cd1918faa7b33a056473cf6566e Mon Sep 17 00:00:00 2001 From: Aadish Jain Date: Sun, 15 Dec 2024 05:31:42 +0000 Subject: [PATCH 3/6] feat(t-mode): fixing styling --- .../base/dists/t/mode/benchmark/benchmark.js | 24 +++++----- .../t/mode/benchmark/benchmark.native.js | 28 +++++------ .../stats/base/dists/t/mode/lib/native.js | 4 +- .../base/dists/t/mode/test/test.native.js | 46 +++++++++---------- 4 files changed, 51 insertions(+), 51 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.js index 813767737057..b4a41e8d09b8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.js @@ -30,29 +30,29 @@ var mode = require( './../lib' ); // MAIN // -bench(pkg, function benchmark(b) { +bench( pkg, function benchmark( b ) { var len; var v; var y; var i; len = 100; - v = new Float64Array(len); - for (i = 0; i < len; i++) { - v[i] = (randu() * 100.0); + v = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + v[ i ] = ( randu() * 100.0 ); } b.tic(); - for (i = 0; i < b.iterations; i++) { - y = mode(v[i % len]); - if (isnan(y)) { - b.fail('should not return NaN'); + for ( i = 0; i < b.iterations; i++ ) { + y = mode( v[ i % len ] ); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); } } b.toc(); - if (isnan(y)) { - b.fail('should not return NaN'); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); } - b.pass('benchmark finished'); + b.pass( 'benchmark finished' ); b.end(); -}); +} ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.native.js index e5454a3dac5d..9a30849b76e8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.native.js @@ -31,37 +31,37 @@ var pkg = require( './../package.json' ).name; // VARIABLES // -var mode = tryRequire(resolve(__dirname, './../lib/native.js')); +var mode = tryRequire( resolve( __dirname, './../lib/native.js' ) ); var opts = { - 'skip': (mode instanceof Error) + 'skip': ( mode instanceof Error ) }; // MAIN // -bench(pkg + '::native', opts, function benchmark(b) { +bench( pkg + '::native', opts, function benchmark( b ) { var len; var v; var y; var i; len = 100; - v = new Float64Array(len); - for (i = 0; i < len; i++) { - v[i] = (randu() * 100.0); + v = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + v[ i ] = ( randu() * 100.0 ); } b.tic(); - for (i = 0; i < b.iterations; i++) { - y = mode(v[i % len]); - if (isnan(y)) { - b.fail('should not return NaN'); + for ( i = 0; i < b.iterations; i++ ) { + y = mode( v[ i % len ] ); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); } } b.toc(); - if (isnan(y)) { - b.fail('should not return NaN'); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); } - b.pass('benchmark finished'); + b.pass( 'benchmark finished' ); b.end(); -}); +} ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/t/mode/lib/native.js index 9d5ed7d2a019..bcfc1141c2b2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/lib/native.js @@ -48,8 +48,8 @@ var addon = require( './../src/addon.node' ); * var y = mode( -1.0 ); * // returns NaN */ -function mode(v) { - return addon(v); +function mode( v ) { + return addon( v ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js index 313a1b607186..244ed902d540 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js @@ -33,49 +33,49 @@ var data = require( './fixtures/julia/data.json' ); // VARIABLES // -var median = tryRequire(resolve(__dirname, './../lib/native.js')); +var median = tryRequire( resolve( __dirname, './../lib/native.js' ) ); var opts = { - 'skip': (median instanceof Error) + 'skip': ( median instanceof Error ) }; // TESTS // -tape('main export is a function', opts, function test(t) { - t.ok(true, __filename); - t.strictEqual(typeof median, 'function', 'main export is a function'); +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof median, 'function', 'main export is a function' ); t.end(); -}); +} ); -tape('if provided `NaN` for the parameter, the function returns `NaN`', opts, function test(t) { - var y = median(NaN); - t.equal(isnan(y), true, 'returns NaN'); +tape( 'if provided `NaN` for the parameter, the function returns `NaN`', opts, function test( t ) { + var y = median( NaN ); + t.equal( isnan( y ), true, 'returns NaN' ); t.end(); -}); +} ); -tape('if provided a negative value for `v`, the function returns `NaN`', opts, function test(t) { +tape( 'if provided a negative value for `v`, the function returns `NaN`', opts, function test( t ) { var y; - y = median(-1.0); - t.equal(isnan(y), true, 'returns NaN'); + y = median( -1.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); - y = median(-0.5); - t.equal(isnan(y), true, 'returns NaN'); + y = median( -0.5 ); + t.equal( isnan( y ), true, 'returns NaN' ); t.end(); -}); +} ); -tape('the function evaluates the median for a Student\'s t-distribution', opts, function test(t) { +tape( 'the function evaluates the median for a Student\'s t-distribution', opts, function test( t ) { var expected; var v; var y; var i; - for (i = 0; i < data.v.length; i++) { - v = data.v[i]; - expected = data.expected[i]; - y = median(v); - t.equal(y, expected, 'v: ' + v + ', y: ' + y + ', expected: ' + expected); + for ( i = 0; i < data.v.length; i++ ) { + v = data.v[ i ]; + expected = data.expected[ i ]; + y = median( v ); + t.equal( y, expected, 'v: ' + v + ', y: ' + y + ', expected: ' + expected ); } t.end(); -}); +} ); From 83c2e14a3703ada6dc27c717e39b07955291be00 Mon Sep 17 00:00:00 2001 From: Aadish Jain Date: Sun, 15 Dec 2024 05:49:00 +0000 Subject: [PATCH 4/6] feat(t-mode): fixing styling --- .../stats/base/dists/t/mode/benchmark/benchmark.js | 2 +- .../stats/base/dists/t/mode/benchmark/benchmark.native.js | 2 +- .../@stdlib/stats/base/dists/t/mode/test/test.native.js | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.js index b4a41e8d09b8..e456bafe9daa 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.js @@ -55,4 +55,4 @@ bench( pkg, function benchmark( b ) { } b.pass( 'benchmark finished' ); b.end(); -} ); +}); diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.native.js index 9a30849b76e8..15e15ab082d9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/benchmark/benchmark.native.js @@ -64,4 +64,4 @@ bench( pkg + '::native', opts, function benchmark( b ) { } b.pass( 'benchmark finished' ); b.end(); -} ); +}); diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js index 244ed902d540..f17dd41b04b3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js @@ -45,13 +45,13 @@ tape( 'main export is a function', opts, function test( t ) { t.ok( true, __filename ); t.strictEqual( typeof median, 'function', 'main export is a function' ); t.end(); -} ); +}); tape( 'if provided `NaN` for the parameter, the function returns `NaN`', opts, function test( t ) { var y = median( NaN ); t.equal( isnan( y ), true, 'returns NaN' ); t.end(); -} ); +}); tape( 'if provided a negative value for `v`, the function returns `NaN`', opts, function test( t ) { var y; @@ -63,7 +63,7 @@ tape( 'if provided a negative value for `v`, the function returns `NaN`', opts, t.equal( isnan( y ), true, 'returns NaN' ); t.end(); -} ); +}); tape( 'the function evaluates the median for a Student\'s t-distribution', opts, function test( t ) { var expected; @@ -78,4 +78,4 @@ tape( 'the function evaluates the median for a Student\'s t-distribution', opts, t.equal( y, expected, 'v: ' + v + ', y: ' + y + ', expected: ' + expected ); } t.end(); -} ); +}); From c3fcf4d9dde3f6bf8eef5df13665232aae58f7c6 Mon Sep 17 00:00:00 2001 From: Aadish Jain Date: Mon, 16 Dec 2024 00:28:58 +0000 Subject: [PATCH 5/6] feat(t-mode): fixing readme and test.native.js --- .../@stdlib/stats/base/dists/t/mode/README.md | 4 ++-- .../stats/base/dists/t/mode/test/test.native.js | 16 ++++++++-------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/README.md b/lib/node_modules/@stdlib/stats/base/dists/t/mode/README.md index fab48dc55b73..080c218db0c4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/README.md @@ -142,7 +142,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_t_mode( v ) -Evaluates the mode for a Student's t-distribution. +Returns the [mode][mode] of a [Student's t][t-distribution] distribution with degrees of freedom `v`. ```c double out = stdlib_base_dists_t_mode( 5.0 ); @@ -151,7 +151,7 @@ double out = stdlib_base_dists_t_mode( 5.0 ); The function accepts the following arguments: -- **v**: `[in] double` input value. +- **v**: `[in] double` degrees of freedom. ```c double stdlib_base_dists_t_mode( const double v ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js index f17dd41b04b3..011e6c68328e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/test/test.native.js @@ -33,9 +33,9 @@ var data = require( './fixtures/julia/data.json' ); // VARIABLES // -var median = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var mode = tryRequire( resolve( __dirname, './../lib/native.js' ) ); var opts = { - 'skip': ( median instanceof Error ) + 'skip': ( mode instanceof Error ) }; @@ -43,12 +43,12 @@ var opts = { tape( 'main export is a function', opts, function test( t ) { t.ok( true, __filename ); - t.strictEqual( typeof median, 'function', 'main export is a function' ); + t.strictEqual( typeof mode, 'function', 'main export is a function' ); t.end(); }); tape( 'if provided `NaN` for the parameter, the function returns `NaN`', opts, function test( t ) { - var y = median( NaN ); + var y = mode( NaN ); t.equal( isnan( y ), true, 'returns NaN' ); t.end(); }); @@ -56,16 +56,16 @@ tape( 'if provided `NaN` for the parameter, the function returns `NaN`', opts, f tape( 'if provided a negative value for `v`, the function returns `NaN`', opts, function test( t ) { var y; - y = median( -1.0 ); + y = mode( -1.0 ); t.equal( isnan( y ), true, 'returns NaN' ); - y = median( -0.5 ); + y = mode( -0.5 ); t.equal( isnan( y ), true, 'returns NaN' ); t.end(); }); -tape( 'the function evaluates the median for a Student\'s t-distribution', opts, function test( t ) { +tape( 'the function evaluates the mode for a Student\'s t-distribution', opts, function test( t ) { var expected; var v; var y; @@ -74,7 +74,7 @@ tape( 'the function evaluates the median for a Student\'s t-distribution', opts, for ( i = 0; i < data.v.length; i++ ) { v = data.v[ i ]; expected = data.expected[ i ]; - y = median( v ); + y = mode( v ); t.equal( y, expected, 'v: ' + v + ', y: ' + y + ', expected: ' + expected ); } t.end(); From 088689ad8478090a8b1ce56444d0993edd063552 Mon Sep 17 00:00:00 2001 From: Aadish Jain Date: Mon, 16 Dec 2024 00:39:22 +0000 Subject: [PATCH 6/6] feat(t-mode): fixing main.c --- lib/node_modules/@stdlib/stats/base/dists/t/mode/src/main.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/mode/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/t/mode/src/main.c index a6c8760afb73..5aa29e7f1dd5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/mode/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/t/mode/src/main.c @@ -30,7 +30,7 @@ * // returns 0.0 */ double stdlib_base_dists_t_mode( const double v ) { - if ( stdlib_base_is_nan( v ) || v < 0.0) { + if ( stdlib_base_is_nan( v ) || v < 0.0 ) { return 0.0 / 0.0; // NaN } return 0.0;