From 5f3d5409217fbc916790784aa482aa8ec4393ab1 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Sat, 21 Dec 2024 22:41:53 +0530 Subject: [PATCH 1/4] feat: add C implementation for uniform standard deviation --- .../stats/base/dists/uniform/stdev/README.md | 91 ++++++++++ .../uniform/stdev/benchmark/benchmark.js | 14 +- .../stdev/benchmark/benchmark.native.js | 70 ++++++++ .../dists/uniform/stdev/benchmark/c/Makefile | 146 +++++++++++++++ .../uniform/stdev/benchmark/c/benchmark.c | 141 +++++++++++++++ .../base/dists/uniform/stdev/binding.gyp | 170 ++++++++++++++++++ .../dists/uniform/stdev/examples/c/Makefile | 146 +++++++++++++++ .../dists/uniform/stdev/examples/c/example.c | 40 +++++ .../base/dists/uniform/stdev/include.gypi | 53 ++++++ .../stdlib/stats/base/dists/uniform/stdev.h | 38 ++++ .../base/dists/uniform/stdev/lib/native.js | 67 +++++++ .../base/dists/uniform/stdev/manifest.json | 79 ++++++++ .../base/dists/uniform/stdev/package.json | 16 +- .../base/dists/uniform/stdev/src/Makefile | 70 ++++++++ .../base/dists/uniform/stdev/src/addon.c | 23 +++ .../stats/base/dists/uniform/stdev/src/main.c | 43 +++++ .../dists/uniform/stdev/test/test.native.js | 105 +++++++++++ 17 files changed, 1301 insertions(+), 11 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/binding.gyp create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include.gypi create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include/stdlib/stats/base/dists/uniform/stdev.h create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/lib/native.js create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/manifest.json create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/Makefile create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/addon.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c create mode 100644 lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/test/test.native.js diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/README.md index f2088c2443c7..fc4ed6cadb63 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/README.md @@ -133,6 +133,97 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/uniform/stdev.h" +``` + +#### stdlib_base_dists_uniform_stdev( a, b ) + +Evaluates the [standard-deviation][standard-deviation] of a [uniform][uniform-distribution] distribution with `a` the minimum support and `b` the maximum support. + +```c +double out = stdlib_base_dists_uniform_stdev( 4.0, 12.0 ); +// returns ~2.309 +``` + +The function accepts the following arguments: + +- **a**: `[in] double` minimum support. +- **b**: `[in] double` maximum support. + +```c +double stdlib_base_dists_uniform_stdev( const double a, const double b ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/uniform/stdev.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 a; + double b; + double v; + double i; + + for ( i = 0; i < 25; i++ ) { + a = random_uniform( 0.0, 10.0 ); + b = random_uniform( a, a+10.0 ); + v = stdlib_base_dists_uniform_stdev( a, b ); + printf( "a: %lf, b: %lf, h(X;a,b): %lf\n", a, b, v ); + } +} +``` + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.js index 595f68a56f57..89eb736757fb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/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 pkg = require( './../package.json' ).name; @@ -30,16 +31,23 @@ var stdev = require( './../lib' ); // MAIN // bench( pkg, function benchmark( b ) { + var len; var min; var max; var y; var i; + len = 100; + min = new Float64Array( len ); + max = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + min[ i ] = ( randu()*10.0 ); + max[ i ] = ( randu()*10.0 ) + min[ i ]; + } + b.tic(); for ( i = 0; i < b.iterations; i++ ) { - min = ( randu()*10.0 ); - max = ( randu()*10.0 ) + min; - y = stdev( min, max ); + y = stdev( min[ i % len ], max[ i % len ] ); if ( isnan( y ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.native.js new file mode 100644 index 000000000000..25767d46c7d8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.native.js @@ -0,0 +1,70 @@ +/** +* @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 pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var stdev = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( stdev instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var min; + var max; + var len; + var y; + var i; + + len = 100; + min = new Float64Array( len ); + max = new Float64Array( len ); + for ( i = 0; i < len; i++ ) { + min[ i ] = ( randu()*10.0 ); + max[ i ] = ( randu()*10.0 ) + min[ i ]; + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = stdev( min[ i % len ], max[ 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/uniform/stdev/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/c/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/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/uniform/stdev/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/c/benchmark.c new file mode 100644 index 000000000000..946e667d6185 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/c/benchmark.c @@ -0,0 +1,141 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/stats/base/dists/uniform/stdev.h" +#include +#include +#include +#include +#include + +#define NAME "uniform-stdev" +#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; + int len = 100; + double min[ 100 ]; + double max[ 100 ]; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + min[ i ] = random_uniform( 0.0, 10.0 ); + max[ i ] = random_uniform( min[ i ], min[ i ]+10.0 ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_dists_uniform_stdev( min[ i % len ], max[ i % len ] ); + 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/uniform/stdev/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/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/uniform/stdev/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/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/uniform/stdev/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/examples/c/example.c new file mode 100644 index 000000000000..8b70762731e0 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/examples/c/example.c @@ -0,0 +1,40 @@ +/** +* @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/uniform/stdev.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 a; + double b; + double v; + double i; + + for ( i = 0; i < 25; i++ ) { + a = random_uniform( 0.0, 10.0 ); + b = random_uniform( a, a+10.0 ); + v = stdlib_base_dists_uniform_stdev( a, b ); + printf( "a: %lf, b: %lf, SD(X;a,b): %lf\n", a, b, v ); + } +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/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': [ + '= b + ) { + return 0.0 / 0.0; // NaN + } + return stdlib_base_sqrt( 1.0/12.0 ) * ( b-a ); +} diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/test/test.native.js new file mode 100644 index 000000000000..8f4848d19626 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/test/test.native.js @@ -0,0 +1,105 @@ +/** +* @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 tape = require( 'tape' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var EPS = require( '@stdlib/constants/float64/eps' ); + + +// FIXTURES // + +var data = require( './fixtures/julia/data.json' ); + + +// VARIABLES // + +var stdev = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( stdev instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof stdev, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'if provided `NaN` for any parameter, the function returns `NaN`', opts, function test( t ) { + var v = stdev( NaN, 0.5 ); + t.equal( isnan( v ), true, 'returns NaN' ); + + v = stdev( 10.0, NaN ); + t.equal( isnan( v ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'if provided `a >= b`, the function returns `NaN`', opts, function test( t ) { + var y; + + y = stdev( 3.0, 2.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = stdev( 2.0, 2.0 ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = stdev( NINF, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + y = stdev( PINF, NINF ); + t.equal( isnan( y ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function returns the standard deviation of a uniform distribution', function test( t ) { + var expected; + var delta; + var tol; + var a; + var b; + var i; + var y; + + expected = data.expected; + a = data.a; + b = data.b; + for ( i = 0; i < expected.length; i++ ) { + y = stdev( a[i], b[i] ); + if ( y === expected[i] ) { + t.equal( y, expected[i], 'a: '+a[i]+', b: '+b[i]+', y: '+y+', expected: '+expected[i] ); + } else { + delta = abs( y - expected[ i ] ); + tol = 1.0 * EPS * abs( expected[ i ] ); + t.ok( delta <= tol, 'within tolerance. a: '+a[i]+'. b: '+b[i]+'. y: '+y+'. E: '+expected[ i ]+'. Δ: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); From 92d64a6dc7b3a74d3f969655972d3b21c2aa118f Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sun, 9 Feb 2025 01:08:58 +0000 Subject: [PATCH 2/4] chore: update copyright years --- .../base/dists/uniform/stdev/benchmark/benchmark.native.js | 2 +- .../@stdlib/stats/base/dists/uniform/stdev/benchmark/c/Makefile | 2 +- .../stats/base/dists/uniform/stdev/benchmark/c/benchmark.c | 2 +- .../@stdlib/stats/base/dists/uniform/stdev/binding.gyp | 2 +- .../@stdlib/stats/base/dists/uniform/stdev/examples/c/Makefile | 2 +- .../@stdlib/stats/base/dists/uniform/stdev/examples/c/example.c | 2 +- .../@stdlib/stats/base/dists/uniform/stdev/include.gypi | 2 +- .../stdev/include/stdlib/stats/base/dists/uniform/stdev.h | 2 +- .../@stdlib/stats/base/dists/uniform/stdev/lib/native.js | 2 +- .../@stdlib/stats/base/dists/uniform/stdev/src/Makefile | 2 +- .../@stdlib/stats/base/dists/uniform/stdev/src/addon.c | 2 +- .../@stdlib/stats/base/dists/uniform/stdev/src/main.c | 2 +- .../@stdlib/stats/base/dists/uniform/stdev/test/test.native.js | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.native.js index 25767d46c7d8..1e8d5af8521c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/c/Makefile index f69e9da2b4d3..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/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/uniform/stdev/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/c/benchmark.c index 946e667d6185..d5f57a4cec74 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/c/benchmark.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/binding.gyp b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/binding.gyp index ec3992233442..68a1ca11d160 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/binding.gyp +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/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/uniform/stdev/examples/c/Makefile b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/examples/c/Makefile index 6aed70daf167..25ced822f96a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/examples/c/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/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/uniform/stdev/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/examples/c/example.c index 8b70762731e0..67efb9ccfdaf 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/examples/c/example.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include.gypi b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include.gypi index 575cb043c0bf..ecfaf82a3279 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/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/uniform/stdev/include/stdlib/stats/base/dists/uniform/stdev.h b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include/stdlib/stats/base/dists/uniform/stdev.h index c1f868f0f550..96ee01efc6c2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include/stdlib/stats/base/dists/uniform/stdev.h +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include/stdlib/stats/base/dists/uniform/stdev.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/uniform/stdev/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/lib/native.js index 94fc135de06d..bab17aa5857c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/lib/native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/Makefile b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/Makefile index bcf18aa46655..7733b6180cb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/Makefile +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/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/uniform/stdev/src/addon.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/addon.c index fd0601d15db3..2c5bf2063024 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/addon.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c index 9bfc70734803..b60f0ef45437 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/test/test.native.js index 8f4848d19626..fa1ae4b56ef0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/test/test.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/test/test.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From c66206e5fa740063a815fe3a2a4a610c0290b52a Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Sat, 15 Feb 2025 10:21:15 +0530 Subject: [PATCH 3/4] fix: changes according to given code review --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: passed - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: 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 --- --- .../@stdlib/stats/base/dists/uniform/stdev/src/main.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c index b60f0ef45437..819ad6f4436f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c @@ -36,7 +36,7 @@ double stdlib_base_dists_uniform_stdev( const double a, const double b ) { stdlib_base_is_nan( a ) || stdlib_base_is_nan( b ) || a >= b - ) { + ) { return 0.0 / 0.0; // NaN } return stdlib_base_sqrt( 1.0/12.0 ) * ( b-a ); From 26c56f465377031cf44b806adbb01f4fafda3d54 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Sat, 15 Feb 2025 10:26:52 +0530 Subject: [PATCH 4/4] docs: update README and comments for uniform distribution standard deviation --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: passed - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../stats/base/dists/uniform/stdev/README.md | 4 ++-- .../base/dists/uniform/stdev/benchmark/benchmark.js | 1 - .../uniform/stdev/benchmark/benchmark.native.js | 6 +++--- .../include/stdlib/stats/base/dists/uniform/stdev.h | 2 +- .../stats/base/dists/uniform/stdev/package.json | 13 ++++++++----- .../stats/base/dists/uniform/stdev/src/main.c | 2 +- 6 files changed, 15 insertions(+), 13 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/README.md index fc4ed6cadb63..a16662e3a9ee 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/README.md @@ -161,7 +161,7 @@ for ( i = 0; i < 10; i++ ) { #### stdlib_base_dists_uniform_stdev( a, b ) -Evaluates the [standard-deviation][standard-deviation] of a [uniform][uniform-distribution] distribution with `a` the minimum support and `b` the maximum support. +Returns the [standard deviation][standard-deviation] of a [uniform][uniform-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). ```c double out = stdlib_base_dists_uniform_stdev( 4.0, 12.0 ); @@ -215,7 +215,7 @@ int main( void ) { a = random_uniform( 0.0, 10.0 ); b = random_uniform( a, a+10.0 ); v = stdlib_base_dists_uniform_stdev( a, b ); - printf( "a: %lf, b: %lf, h(X;a,b): %lf\n", a, b, v ); + printf( "a: %lf, b: %lf, SD(X;a,b): %lf\n", a, b, v ); } } ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.js index 140b5f025cbc..bbdec1ff1645 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.js @@ -31,7 +31,6 @@ var stdev = require( './../lib' ); // MAIN // bench( pkg, function benchmark( b ) { - var len; var min; var max; var len; diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.native.js index 1e8d5af8521c..694b4207eaf9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/benchmark/benchmark.native.js @@ -24,7 +24,7 @@ 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 uniform = require( '@stdlib/random/base/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pkg = require( './../package.json' ).name; @@ -50,8 +50,8 @@ bench( pkg+'::native', opts, function benchmark( b ) { min = new Float64Array( len ); max = new Float64Array( len ); for ( i = 0; i < len; i++ ) { - min[ i ] = ( randu()*10.0 ); - max[ i ] = ( randu()*10.0 ) + min[ i ]; + min[ i ] = uniform( 0.0, 10.0 ); + max[ i ] = uniform( min[ i ], 10.0 + min[ i ] ); } b.tic(); diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include/stdlib/stats/base/dists/uniform/stdev.h b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include/stdlib/stats/base/dists/uniform/stdev.h index 96ee01efc6c2..b3c177df47d2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include/stdlib/stats/base/dists/uniform/stdev.h +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/include/stdlib/stats/base/dists/uniform/stdev.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Returns the standard deviation of an uniform distribution. +* Returns the standard deviation of a uniform distribution. */ double stdlib_base_dists_uniform_stdev( const double a, const double b ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/package.json b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/package.json index b2dfb438da42..e94a555addd9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/package.json +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/package.json @@ -1,7 +1,7 @@ { - "name": "@stdlib/stats/base/dists/uniform/kurtosis", + "name": "@stdlib/stats/base/dists/uniform/stdev", "version": "0.0.0", - "description": "Uniform distribution excess kurtosis.", + "description": "Uniform distribution standard deviation.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", @@ -58,9 +58,12 @@ "stats", "distribution", "dist", - "kurtosis", - "excess", - "tails", + "standard", + "deviation", + "stdev", + "std", + "spread", + "dispersion", "continuous", "probability", "prob", diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c index 819ad6f4436f..24e4764d7e24 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/stdev/src/main.c @@ -25,7 +25,7 @@ * * @param n minimum support * @param p maximum support -* @return stdev +* @return standard deviation * * @example * double v = stdev( 4.0, 12.0 );