From d8c4cd79468e5f1bb2132c589f9505b66b7dc7e8 Mon Sep 17 00:00:00 2001 From: Sahil Goyal <87982509+sahil20021008@users.noreply.github.com> Date: Sat, 26 Apr 2025 11:31:39 +0000 Subject: [PATCH 1/5] feat: add c implementation of stdlib/math/base/special/heaviside --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../math/base/special/heaviside/README.md | 101 ++++++++++- .../heaviside/benchmark/benchmark.native.js | 61 +++++++ .../special/heaviside/benchmark/c/Makefile | 2 +- .../special/heaviside/benchmark/c/benchmark.c | 40 +++-- .../math/base/special/heaviside/binding.gyp | 170 ++++++++++++++++++ .../base/special/heaviside/docs/types/test.ts | 2 +- .../special/heaviside/examples/c/Makefile | 146 +++++++++++++++ .../special/heaviside/examples/c/example.c | 41 +++++ .../math/base/special/heaviside/include.gypi | 53 ++++++ .../stdlib/math/base/special/heaviside.h | 47 +++++ .../math/base/special/heaviside/lib/native.js | 84 +++++++++ .../math/base/special/heaviside/manifest.json | 68 +++++++ .../math/base/special/heaviside/package.json | 3 + .../math/base/special/heaviside/src/Makefile | 70 ++++++++ .../math/base/special/heaviside/src/addon.c | 22 +++ .../math/base/special/heaviside/src/main.c | 76 ++++++++ .../special/heaviside/test/test.native.js | 146 +++++++++++++++ 17 files changed, 1111 insertions(+), 21 deletions(-) create mode 100644 lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/heaviside/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/heaviside/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/heaviside/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/heaviside/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/heaviside/include/stdlib/math/base/special/heaviside.h create mode 100644 lib/node_modules/@stdlib/math/base/special/heaviside/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/heaviside/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/heaviside/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/heaviside/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/heaviside/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/heaviside/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/README.md b/lib/node_modules/@stdlib/math/base/special/heaviside/README.md index 394facdae803..6da2cb6e7421 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/README.md +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2018 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. @@ -164,6 +164,105 @@ logEachMap( 'H(%0.4f) = %0.4f', x, heaviside ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/heaviside.h" +``` + +#### stdlib_base_heaviside( x ) + +Evaluate the [Heaviside function][heaviside-function]. + +```c +double out = stdlib_base_heaviside( 0.0, 0 ); +// returns 0.0 + +out = stdlib_base_heaviside( 3.141592653589793 / 2.0, 0 ); +// returns 1.0 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **continuity**: `[in] int` input value. + +```c +double stdlib_base_heaviside( const double x, int continuity ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/heaviside.h" +#include + +int main( void ) { + const double x[] = { 0.0, -0.523, 0.785, -1.047, 3.14 }; + + double y; + int i; + for ( i = 0; i < 5; i++ ) { + y = stdlib_base_heaviside( x[ i ], STDLIB_HEAVISIDE_CONTINUITY_HALF ); + printf( "heaviside(%lf, half-maximum) = %lf\n", x[ i ], y ); + } + + for ( i = 0; i < 5; i++ ) { + y = stdlib_base_heaviside( x[ i ], STDLIB_HEAVISIDE_CONTINUITY_LEFT ); + printf( "heaviside(%lf, left-continuous) = %lf\n", x[ i ], y ); + } + + for ( i = 0; i < 5; i++ ) { + y = stdlib_base_heaviside( x[ i ], STDLIB_HEAVISIDE_CONTINUITY_RIGHT ); + printf( "heaviside(%lf, right-continuous) = %lf\n", x[ i ], y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/benchmark.native.js new file mode 100644 index 000000000000..df926ffdb39d --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/benchmark.native.js @@ -0,0 +1,61 @@ +/** +* @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 uniform = require( '@stdlib/random/array/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 heaviside = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( heaviside instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var x; + var y; + var i; + + x = uniform( 100, -10.0, 10.0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = heaviside( x[ i%x.length ] ); + 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/math/base/special/heaviside/benchmark/c/Makefile b/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile index e64c0050f3da..d564e8b2d6f9 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2018 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/math/base/special/heaviside/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/benchmark.c index 77516b044516..3958cccba558 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/benchmark.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2018 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. @@ -21,9 +21,10 @@ #include #include #include +#include "stdlib/math/base/special/heaviside.h" #define NAME "heaviside" -#define ITERATIONS 1000000 +#define ITERATIONS 10000 #define REPEATS 3 /** @@ -83,25 +84,12 @@ static double rand_double( void ) { return (double)r / ( (double)RAND_MAX + 1.0 ); } -/** -* Computes the Heaviside function. -* -* @param x input value -* @return function result -*/ -double heaviside( double x ) { - if ( x >= 0.0 ) { - return 1.0; - } - return 0.0; -} - /** * Runs a benchmark. * * @return elapsed time in seconds */ -static double benchmark( void ) { +static double benchmark( stdlib_heaviside_continuity_t continuity ) { double elapsed; double x[ 100 ]; double y; @@ -114,7 +102,7 @@ static double benchmark( void ) { t = tic(); for ( i = 0; i < ITERATIONS; i++ ) { - y = heaviside( x[ i%100 ] ); + y = stdlib_base_heaviside( x[ i%100 ], continuity ); if ( y != y ) { printf( "should not return NaN\n" ); break; @@ -140,7 +128,23 @@ int main( void ) { print_version(); for ( i = 0; i < REPEATS; i++ ) { printf( "# c::%s\n", NAME ); - elapsed = benchmark(); + elapsed = benchmark(STDLIB_HEAVISIDE_CONTINUITY_LEFT); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); + + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::%s\n", NAME ); + elapsed = benchmark(STDLIB_HEAVISIDE_CONTINUITY_HALF); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); + + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::%s\n", NAME ); + elapsed = benchmark(STDLIB_HEAVISIDE_CONTINUITY_RIGHT); print_results( elapsed ); printf( "ok %d benchmark finished\n", i+1 ); } diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/binding.gyp b/lib/node_modules/@stdlib/math/base/special/heaviside/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/binding.gyp @@ -0,0 +1,170 @@ +# @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. + +# 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/math/base/special/heaviside/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/heaviside/docs/types/test.ts index 2b4bb9f71e22..bdbbe93ac5a4 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/docs/types/test.ts +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/docs/types/test.ts @@ -23,7 +23,7 @@ import heaviside = require( './index' ); // The function returns a number... { - heaviside( 3.141592653589793 ); // $ExpectType number + heaviside( 3.141592653589793, 'half-maximum' ); // $ExpectType number heaviside( 0, 'half-maximum' ); // $ExpectType number heaviside( 0, 'left-continuous' ); // $ExpectType number heaviside( 0, 'right-continuous' ); // $ExpectType number diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/heaviside/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @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. +#/ + +# 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/math/base/special/heaviside/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/heaviside/examples/c/example.c new file mode 100644 index 000000000000..7075daedb36a --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/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/math/base/special/heaviside.h" +#include + +int main( void ) { + const double x[] = { 0.0, -0.523, 0.785, -1.047, 3.14 }; + + double y; + int i; + for ( i = 0; i < 5; i++ ) { + y = stdlib_base_heaviside( x[ i ], STDLIB_HEAVISIDE_CONTINUITY_HALF ); + printf( "heaviside(%lf, half-maximum) = %lf\n", x[ i ], y ); + } + + for ( i = 0; i < 5; i++ ) { + y = stdlib_base_heaviside( x[ i ], STDLIB_HEAVISIDE_CONTINUITY_LEFT ); + printf( "heaviside(%lf, left-continuous) = %lf\n", x[ i ], y ); + } + + for ( i = 0; i < 5; i++ ) { + y = stdlib_base_heaviside( x[ i ], STDLIB_HEAVISIDE_CONTINUITY_RIGHT ); + printf( "heaviside(%lf, right-continuous) = %lf\n", x[ i ], y ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/include.gypi b/lib/node_modules/@stdlib/math/base/special/heaviside/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/include.gypi @@ -0,0 +1,53 @@ +# @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. + +# 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': [ + ' 0.0 ) { + return 1.0; + } + if ( x == 0.0 ) { + if ( continuity == 0 ) { + return 0.0; + }else if ( continuity == 1 ) { + return 1.0; + }else if ( continuity == 2 ) { + return 0.5; + } + // Default behaviour is discontinuity + return 0.0/0.0; + } + return 0.0; +} diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/heaviside/test/test.native.js new file mode 100644 index 000000000000..88570003a9cf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/test/test.native.js @@ -0,0 +1,146 @@ +/** +* @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 tape = require( 'tape' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var heaviside = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( heaviside instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof heaviside, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `0` if `x` is negative', opts, function test( t ) { + var x; + var y; + var v; + var i; + + x = uniform( 1e3, -10, 0); + + for ( i = 0; i < 1e3; i++ ) { + y = x[ i%x.length ] - EPS; + v = heaviside( y ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value when provided ' + x ); + } + t.end(); +}); + +tape( 'the function returns `1` if `x` is positive', function test( t ) { + var x; + var y; + var v; + var i; + + x = uniform( 1e3, 0, 10); + + for ( i = 0; i < 1e3; i++ ) { + y = x[ i%x.length ] + EPS; + v = heaviside( y ); + t.strictEqual( v, 1.0, 'returns expected value when provided '+x ); + } + t.end(); +}); + +tape( 'by default, the function returns `NaN` if provided `+-0`', function test( t ) { + var v; + + v = heaviside( -0.0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = heaviside( +0.0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if the `continuity` option is `half-maximum`, the function returns `0.5` if provided `+-0`', function test( t ) { + var v; + + v = heaviside( -0.0, 'half-maximum' ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + v = heaviside( +0.0, 'half-maximum' ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + t.end(); +}); + +tape( 'if the `continuity` option is `left-continuous`, the function returns `0.0` if provided `+-0`', function test( t ) { + var v; + + v = heaviside( -0.0, 'left-continuous' ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + v = heaviside( +0.0, 'left-continuous' ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if the `continuity` option is `right-continuous`, the function returns `1` if provided `+-0`', function test( t ) { + var v; + + v = heaviside( -0.0, 'right-continuous' ); + t.strictEqual( v, 1, 'returns expected value' ); + + v = heaviside( +0.0, 'right-continuous' ); + t.strictEqual( v, 1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `NaN` if provided `NaN`', function test( t ) { + var v = heaviside( NaN ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `0` if provided `-infinity`', function test( t ) { + var v = heaviside( NINF ); + t.strictEqual( v, 0.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `+1` if provided `+infinity`', function test( t ) { + var v = heaviside( PINF ); + t.strictEqual( v, 1.0, 'returns expected value' ); + t.end(); +}); From a3796f7cfd161798dde763c33e2e796f07f32546 Mon Sep 17 00:00:00 2001 From: Sahil Goyal <87982509+sahil20021008@users.noreply.github.com> Date: Sat, 26 Apr 2025 11:59:58 +0000 Subject: [PATCH 2/5] feat: add implementation of stdlib/math/base/special/heaviside --- 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: passed - 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 --- --- .../@stdlib/math/base/special/heaviside/examples/c/example.c | 2 +- lib/node_modules/@stdlib/math/base/special/heaviside/src/main.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/heaviside/examples/c/example.c index 7075daedb36a..da5e808c77b5 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/examples/c/example.c +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/examples/c/example.c @@ -16,8 +16,8 @@ * limitations under the License. */ -#include "stdlib/math/base/special/heaviside.h" #include +#include "stdlib/math/base/special/heaviside.h" int main( void ) { const double x[] = { 0.0, -0.523, 0.785, -1.047, 3.14 }; diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/src/main.c b/lib/node_modules/@stdlib/math/base/special/heaviside/src/main.c index 43cb88d9ed95..c9dfaf960310 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/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. From 86d0252384d91c9b681327e4f1634abaa28c1be3 Mon Sep 17 00:00:00 2001 From: Sahil Goyal <87982509+sahil20021008@users.noreply.github.com> Date: Sat, 26 Apr 2025 12:04:44 +0000 Subject: [PATCH 3/5] feat: add implementation of stdlib/math/base/special/heaviside --- 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: na - 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 --- --- .../@stdlib/math/base/special/heaviside/manifest.json | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/manifest.json b/lib/node_modules/@stdlib/math/base/special/heaviside/manifest.json index c3bbeb12252b..80656ac17472 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/manifest.json +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/manifest.json @@ -50,7 +50,9 @@ ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/math/base/assert/is-nan" + ] }, { "task": "examples", @@ -62,7 +64,9 @@ ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/math/base/assert/is-nan" + ] } ] } From ad3eeccf09ef3f12d2622c04efe2f4cdda74bcaf Mon Sep 17 00:00:00 2001 From: Sahil Goyal <87982509+sahil20021008@users.noreply.github.com> Date: Sun, 4 May 2025 18:03:08 +0000 Subject: [PATCH 4/5] feat: add c implementation of heaviside --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: 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: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../@stdlib/math/base/special/heaviside/README.md | 8 ++++---- .../math/base/special/heaviside/benchmark/c/Makefile | 2 +- .../math/base/special/heaviside/benchmark/c/benchmark.c | 2 +- .../math/base/special/heaviside/docs/types/test.ts | 2 +- .../@stdlib/math/base/special/heaviside/src/main.c | 8 ++++---- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/README.md b/lib/node_modules/@stdlib/math/base/special/heaviside/README.md index 6da2cb6e7421..6e05b3c3af26 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/README.md +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2025 The Stdlib Authors. +Copyright (c) 2018 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. @@ -20,7 +20,7 @@ limitations under the License. # Heaviside Function -> Evaluate the [Heaviside function][heaviside-function]. +> Evaluates the [Heaviside function][heaviside-function].
@@ -190,9 +190,9 @@ logEachMap( 'H(%0.4f) = %0.4f', x, heaviside ); #include "stdlib/math/base/special/heaviside.h" ``` -#### stdlib_base_heaviside( x ) +#### stdlib_base_heaviside( x, continuity ) -Evaluate the [Heaviside function][heaviside-function]. +Evaluates the [Heaviside function][heaviside-function]. ```c double out = stdlib_base_heaviside( 0.0, 0 ); diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile b/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile index d564e8b2d6f9..e64c0050f3da 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2025 The Stdlib Authors. +# Copyright (c) 2018 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/math/base/special/heaviside/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/benchmark.c index 3958cccba558..a5fb675ba3c9 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/benchmark.c +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/benchmark.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2018 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/math/base/special/heaviside/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/heaviside/docs/types/test.ts index bdbbe93ac5a4..2b4bb9f71e22 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/docs/types/test.ts +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/docs/types/test.ts @@ -23,7 +23,7 @@ import heaviside = require( './index' ); // The function returns a number... { - heaviside( 3.141592653589793, 'half-maximum' ); // $ExpectType number + heaviside( 3.141592653589793 ); // $ExpectType number heaviside( 0, 'half-maximum' ); // $ExpectType number heaviside( 0, 'left-continuous' ); // $ExpectType number heaviside( 0, 'right-continuous' ); // $ExpectType number diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/src/main.c b/lib/node_modules/@stdlib/math/base/special/heaviside/src/main.c index c9dfaf960310..6fac610fde4d 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/src/main.c @@ -22,9 +22,9 @@ /** * Evaluates the Heaviside function. * -* @param x input value -* @param continuity continuity option -* @return function value +* @param x input value +* @param continuity continuity option +* @return function value * * @example * double v = stdlib_base_heaviside( 3.14, 0 ); @@ -55,7 +55,7 @@ * // returns NaN */ double stdlib_base_heaviside( const double x, int continuity ) { - if ( stdlib_base_is_nan( x )) { + if ( stdlib_base_is_nan( x ) ) { return 0.0/0.0; } if ( x > 0.0 ) { From 4160ea6ade29cd43a49728c62dc05f158521db05 Mon Sep 17 00:00:00 2001 From: Sahil Goyal <87982509+sahil20021008@users.noreply.github.com> Date: Wed, 7 May 2025 15:21:10 +0000 Subject: [PATCH 5/5] feat: add implementation of stdlib/math/base/special/heaviside --- 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: na - 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 --- --- .../special/heaviside/benchmark/c/Makefile | 39 ++++++++++++++----- 1 file changed, 29 insertions(+), 10 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile b/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile index e64c0050f3da..a4bd7b38fd74 100644 --- a/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile +++ b/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2018 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. @@ -16,7 +16,6 @@ # limitations under the License. #/ - # VARIABLES # ifndef VERBOSE @@ -70,6 +69,18 @@ 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 @@ -77,11 +88,15 @@ c_targets := benchmark.out # RULES # #/ -# Compiles C source files. +# Compiles source files. # -# @param {string} [C_COMPILER] - C compiler -# @param {string} [CFLAGS] - C compiler flags -# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code +# @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 @@ -97,12 +112,16 @@ all: $(c_targets) # Compiles C source files. # # @private -# @param {string} CC - C compiler -# @param {string} CFLAGS - C compiler flags -# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code +# @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) -o $@ $< -lm + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) #/ # Runs compiled benchmarks.