-
-
Notifications
You must be signed in to change notification settings - Fork 825
feat: add C implementation for math/base/special/heaviside
#6972
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Changes from 13 commits
7824100
adfae95
d01e42c
c931698
5e764f7
9500391
337a10a
0086b19
b9e90e0
da7da24
3de8d33
98f0d2b
c8a3c52
18f54b6
8b773c4
f771e63
5b47b9f
1cc46be
06dcd6d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -164,6 +164,104 @@ logEachMap( 'H(%0.4f) = %0.4f', x, heaviside ); | |
|
||
<!-- /.examples --> | ||
|
||
<!-- C interface documentation. --> | ||
|
||
* * * | ||
|
||
<section class="c"> | ||
|
||
## C APIs | ||
|
||
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> | ||
|
||
<section class="intro"> | ||
|
||
</section> | ||
|
||
<!-- /.intro --> | ||
|
||
<!-- C usage documentation. --> | ||
|
||
<section class="usage"> | ||
|
||
### Usage | ||
|
||
```c | ||
#include "stdlib/math/base/special/heaviside.h" | ||
``` | ||
|
||
#### stdlib_base_heaviside( x, continuity ) | ||
|
||
Evaluates the [Heaviside function][heaviside-function]. | ||
|
||
```c | ||
double y = stdlib_base_heaviside( 0.0, STDLIB_BASE_HEAVISIDE_CONTINUITY_HALF_MAXIMUM ); | ||
// returns 0.5 | ||
|
||
y = stdlib_base_heaviside( 0.0, STDLIB_BASE_HEAVISIDE_CONTINUITY_LEFT_CONTINUOUS ); | ||
// returns 0.0 | ||
``` | ||
|
||
The function accepts the following arguments: | ||
|
||
- **x**: `[in] double` input value. | ||
- **continuity**: `[in] STDLIB_BASE_HEAVISIDE_CONTINUITY` continuity option | ||
|
||
The `continuity` parameter may be one of the following values: | ||
|
||
- `STDLIB_BASE_HEAVISIDE_CONTINUITY_HALF_MAXIMUM`: if `x == 0`, the function returns `0.5`. | ||
- `STDLIB_BASE_HEAVISIDE_CONTINUITY_LEFT_CONTINUOUS`: if `x == 0`, the function returns `0.0`. | ||
- `STDLIB_BASE_HEAVISIDE_CONTINUITY_RIGHT_CONTINUOUS`: if `x == 0`, the function returns `1.0`. | ||
- `STDLIB_BASE_HEAVISIDE_CONTINUITY_DISCONTINUOUS`: if `x == 0`, the function returns `NaN`. | ||
|
||
If not provided a valid `continuity` parameter, the function returns `NaN` for `x == 0`, behaving like the discontinuous case. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Does this line look correct then? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Did you confirm that C allows the continuity parameter to be a value other than an allowed enum value? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @kgryte It behaves like the discontinuous case if you pass a number (other than 0,1,2,3), say,
anandkaranubc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```c | ||
double stdlib_base_heaviside( const double x, const STDLIB_BASE_HEAVISIDE_CONTINUITY continuity ); | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
||
<section class="notes"> | ||
|
||
</section> | ||
|
||
<!-- /.notes --> | ||
|
||
<!-- C API usage examples. --> | ||
|
||
<section class="examples"> | ||
|
||
### Examples | ||
|
||
```c | ||
#include "stdlib/math/base/special/heaviside.h" | ||
#include <stdio.h> | ||
|
||
int main( void ) { | ||
const double x[] = { -4.0, -3.0, -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 }; | ||
|
||
double y; | ||
int i; | ||
for ( i = 0; i < 10; i++ ) { | ||
y = stdlib_base_heaviside( x[ i ], STDLIB_BASE_HEAVISIDE_CONTINUITY_HALF_MAXIMUM ); | ||
printf( "H(%lf) = %lf\n", x[ i ], y ); | ||
} | ||
} | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.examples --> | ||
|
||
</section> | ||
|
||
<!-- /.c --> | ||
|
||
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
|
||
<section class="related"> | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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, -50.0, 50.0 ); | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
y = heaviside( x[ i%x.length ], 'half-maximum' ); | ||
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(); | ||
}); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 := 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 |
Uh oh!
There was an error while loading. Please reload this page.