-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat: add C implementation for math/base/special/heaviside
#10196
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
Open
rautelaKamal
wants to merge
3
commits into
stdlib-js:develop
Choose a base branch
from
rautelaKamal:feature/math/special/heaviside-c-implementation
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+853
−0
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
166 changes: 166 additions & 0 deletions
166
lib/node_modules/@stdlib/math/base/special/heaviside/binding.gyp
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| # @license Apache-2.0 | ||
| # | ||
| # Copyright (c) 2026 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. | ||
|
|
||
| { | ||
| # 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 | ||
| } |
47 changes: 47 additions & 0 deletions
47
lib/node_modules/@stdlib/math/base/special/heaviside/include.gypi
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # @license Apache-2.0 | ||
| # | ||
| # Copyright (c) 2026 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. | ||
|
|
||
| { | ||
| # Define variables to be used throughout the configuration for all targets: | ||
| 'variables': { | ||
| # Source directory: | ||
| 'src_dir': './src', | ||
|
|
||
| # Include directories: | ||
| 'include_dirs': [ | ||
| '<!@(node -e "var arr = require(\'@stdlib/utils/library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).include; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")', | ||
| ], | ||
|
|
||
| # Add-on destination directory: | ||
| 'addon_output_dir': './src', | ||
|
|
||
| # Source files: | ||
| 'src_files': [ | ||
| '<(src_dir)/addon.c', | ||
| '<!@(node -e "var arr = require(\'@stdlib/utils/library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).src; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")', | ||
| ], | ||
|
|
||
| # Library dependencies: | ||
| 'libraries': [ | ||
| '<!@(node -e "var arr = require(\'@stdlib/utils/library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).libraries; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")', | ||
| ], | ||
|
|
||
| # Library directories: | ||
| 'library_dirs': [ | ||
| '<!@(node -e "var arr = require(\'@stdlib/utils/library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).libpath; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")', | ||
| ], | ||
| }, # end variables | ||
| } |
53 changes: 53 additions & 0 deletions
53
..._modules/@stdlib/math/base/special/heaviside/include/stdlib/math/base/special/heaviside.h
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2026 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. | ||
| */ | ||
|
|
||
| #ifndef STDLIB_MATH_BASE_SPECIAL_HEAVISIDE_H | ||
| #define STDLIB_MATH_BASE_SPECIAL_HEAVISIDE_H | ||
|
|
||
| /* | ||
| * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. | ||
| */ | ||
| #ifdef __cplusplus | ||
| extern "C" { | ||
| #endif | ||
|
|
||
| // Enumeration of function continuity: | ||
| enum STDLIB_BASE_HEAVISIDE_CONTINUITY { | ||
| // Half-maximum: | ||
| STDLIB_BASE_HEAVISIDE_CONTINUITY_HALF_MAXIMUM = 0, | ||
|
|
||
| // Left-continuous: | ||
| STDLIB_BASE_HEAVISIDE_CONTINUITY_LEFT_CONTINUOUS = 1, | ||
|
|
||
| // Right-continuous: | ||
| STDLIB_BASE_HEAVISIDE_CONTINUITY_RIGHT_CONTINUOUS = 2, | ||
|
|
||
| // Discontinuous: | ||
| STDLIB_BASE_HEAVISIDE_CONTINUITY_DISCONTINUOUS = 3 | ||
| }; | ||
|
|
||
| /** | ||
| * Evaluates the Heaviside function for a double-precision floating-point number. | ||
| */ | ||
| double stdlib_base_heaviside( const double x, const enum STDLIB_BASE_HEAVISIDE_CONTINUITY continuity ); | ||
|
|
||
| #ifdef __cplusplus | ||
| } | ||
| #endif | ||
|
|
||
| #endif // !STDLIB_MATH_BASE_SPECIAL_HEAVISIDE_H |
52 changes: 52 additions & 0 deletions
52
lib/node_modules/@stdlib/math/base/special/heaviside/lib/enum.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2026 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'; | ||
|
|
||
| // MAIN // | ||
|
|
||
| /** | ||
| * Returns an object mapping supported function continuity type strings to enumeration constants. | ||
| * | ||
| * @private | ||
| * @returns {Object} object mapping supported function continuity types to enumeration constants | ||
| * | ||
| * @example | ||
| * var table = enumeration(); | ||
| * // returns <Object> | ||
| */ | ||
| function enumeration() { | ||
| return { | ||
| // Half-maximum: | ||
| 'half-maximum': 0, | ||
|
|
||
| // Left-continuous: | ||
| 'left-continuous': 1, | ||
|
|
||
| // Right-continuous: | ||
| 'right-continuous': 2, | ||
|
|
||
| // Discontinuous: | ||
| 'discontinuous': 3 | ||
| }; | ||
| } | ||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| module.exports = enumeration; | ||
72 changes: 72 additions & 0 deletions
72
lib/node_modules/@stdlib/math/base/special/heaviside/lib/native.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2026 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 addon = require( './../src/addon.node' ); | ||
| var str2enum = require( './str2enum.js' ); | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| /** | ||
| * Evaluates the Heaviside function. | ||
| * | ||
| * @private | ||
| * @param {number} x - input value | ||
| * @param {string} [continuity] - continuity option | ||
| * @returns {number} function value | ||
| * | ||
| * @example | ||
| * var v = heaviside( 3.14 ); | ||
| * // returns 1.0 | ||
| * | ||
| * @example | ||
| * var v = heaviside( -3.14 ); | ||
| * // returns 0.0 | ||
| * | ||
| * @example | ||
| * var v = heaviside( 0.0, 'half-maximum' ); | ||
| * // returns 0.5 | ||
| * | ||
| * @example | ||
| * var v = heaviside( 0.0, 'left-continuous' ); | ||
| * // returns 0.0 | ||
| * | ||
| * @example | ||
| * var v = heaviside( 0.0, 'right-continuous' ); | ||
| * // returns 1.0 | ||
| * | ||
| * @example | ||
| * var v = heaviside( 0.0, 'discontinuous' ); | ||
| * // returns NaN | ||
| * | ||
| * @example | ||
| * var v = heaviside( NaN, 'right-continuous' ); | ||
| * // returns NaN | ||
| */ | ||
| function heaviside( x, continuity ) { | ||
| return addon( x, str2enum( continuity ) ); | ||
| } | ||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| module.exports = heaviside; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file uses 4-space indentation, but stdlib JS files must use TAB indentation per the
.editorconfig. Compare withheavisidef/lib/enum.jswhich uses tabs.