feat: add C implementation for `math/base/special/heaviside` #6972

anandkaranubc · 2025-05-10T19:41:55Z

Progresses #649

Description

What is the purpose of this pull request?

This pull request:

Adds the complete C implementation for math/base/special/heaviside

Related Issues

Does this pull request have any related issues?

This pull request:

Progresses [RFC]: Add C implementations to base special math functions (tracking issue) #649

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

stdlib-bot · 2025-05-10T19:43:02Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/heaviside	$\color{green}316/316$ $\color{green}+100.00\%$	$\color{green}22/22$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}316/316$ $\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

--- 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: passed - 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 ---

--- 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: na - 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: na - task: lint_license_headers status: passed ---

anandkaranubc · 2025-05-10T20:56:44Z

/stdlib update-copyright-years

--- 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: passed - 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 ---

...ode_modules/@stdlib/math/base/special/heaviside/include/stdlib/math/base/special/heaviside.h

lib/node_modules/@stdlib/math/base/special/heaviside/src/addon.c

--- 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: 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: na - task: lint_license_headers status: passed ---

lib/node_modules/@stdlib/math/base/special/heaviside/lib/str2enum.js

Planeshifter

Looks good to me overall; one question.

--- 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: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - 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 ---

lib/node_modules/@stdlib/math/base/special/heaviside/README.md

Co-authored-by: Athan <[email protected]> Signed-off-by: Karan Anand <[email protected]>

--- 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: passed - 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 ---

--- 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: 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 ---

lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/native/benchmark.c

Planeshifter · 2025-06-11T03:03:18Z

lib/node_modules/@stdlib/math/base/special/heaviside/lib/native.js

+*
+* @private
+* @param {number} x - input value
+* @param {string} [continuity] - continuity option


Should we mark the parameter as mandatory here?

Suggested change

* @param {string} [continuity] - continuity option

* @param {string} continuity - continuity option

The JS implementation does have it as optional, too, so probably better to leave as-is for now. There is an argument to be made to make the parameter mandatory overall in this package as we have moved to avoid variadic functions for performance reasons, but that could be handled in a separate PR.

cc @kgryte

I suggest going ahead and making mandatory across the package.

Cool! Updating the PR accordingly....

Thanks @Planeshifter and @kgryte for the feedback!

--- 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: passed - 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 ---

Planeshifter

LGTM!

anandkaranubc · 2025-06-11T03:11:14Z

lib/node_modules/@stdlib/math/base/special/heaviside/test/test.native.js

+tape( 'the function returns `1` if `x` is positive', opts, function test( t ) {
+	var x;
+	var v;
+	var i;
+
+	for ( i = 0; i < 1e3; i++ ) {
+		x = ( randu()*100.0 ) + EPS;
+		v = heaviside( x );
+		t.strictEqual( v, 1.0, 'returns expected value' );
+	}
+	t.end();
+});


@Planeshifter As far as I remember, I kept the continuity parameter as optional because the str2enum function handles the condition when it's missing.

Very open to update this too if we need to make the second parameter as mandatory.

feat: initial commit for feedback

7824100

anandkaranubc marked this pull request as draft May 10, 2025 19:42

stdlib-bot added Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review. and removed Needs Review A pull request which needs code review. labels May 10, 2025

anandkaranubc added 6 commits May 10, 2025 13:16

feat: add support for enums

adfae95

docs: fix paramater name

d01e42c

feat: remove enum2str

c931698

test: add tests

9500391

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label May 10, 2025

chore: update copyright years

0086b19

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label May 10, 2025

anandkaranubc marked this pull request as ready for review May 10, 2025 21:09

stdlib-bot added the Needs Review A pull request which needs code review. label May 10, 2025

anandkaranubc added Feature Issue or pull request for adding a new feature. C Issue involves or relates to C. and removed Needs Review A pull request which needs code review. labels May 10, 2025

anandkaranubc commented May 13, 2025

View reviewed changes

...ode_modules/@stdlib/math/base/special/heaviside/include/stdlib/math/base/special/heaviside.h Outdated Show resolved Hide resolved

anandkaranubc commented May 13, 2025

View reviewed changes

...ode_modules/@stdlib/math/base/special/heaviside/include/stdlib/math/base/special/heaviside.h Outdated Show resolved Hide resolved

anandkaranubc commented May 13, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/heaviside/src/addon.c Outdated Show resolved Hide resolved

anandkaranubc added 2 commits May 13, 2025 10:22

Merge branch 'develop' into feat/heaviside

3de8d33

Planeshifter reviewed May 14, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/heaviside/lib/str2enum.js Outdated Show resolved Hide resolved

Planeshifter previously approved these changes May 14, 2025

View reviewed changes

Merge branch 'develop' into feat/heaviside

98f0d2b

anandkaranubc dismissed Planeshifter’s stale review via c8a3c52 May 16, 2025 05:48

anandkaranubc commented May 16, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/heaviside/README.md Outdated Show resolved Hide resolved

kgryte reviewed May 16, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/heaviside/README.md Outdated Show resolved Hide resolved

kgryte reviewed May 16, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/heaviside/README.md Outdated Show resolved Hide resolved

anandkaranubc and others added 4 commits May 16, 2025 08:06

Update lib/node_modules/@stdlib/math/base/special/heaviside/README.md

18f54b6

Co-authored-by: Athan <[email protected]> Signed-off-by: Karan Anand <[email protected]>

docs: update the README

8b773c4

Co-authored-by: Athan <[email protected]> Signed-off-by: Karan Anand <[email protected]>

anandkaranubc added GSoC Google Summer of Code. gsoc: 2025 Google Summer of Code (2025). labels May 20, 2025

anandkaranubc marked this pull request as draft May 21, 2025 16:44

anandkaranubc added 2 commits May 21, 2025 10:33

Merge branch 'develop' into feat/heaviside

1cc46be

anandkaranubc marked this pull request as ready for review May 21, 2025 17:37

stdlib-bot added the Needs Review A pull request which needs code review. label May 21, 2025

Planeshifter reviewed Jun 11, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/native/benchmark.c Outdated Show resolved Hide resolved

Merge branch 'develop' into feat/heaviside

032d53b

Planeshifter reviewed Jun 11, 2025

View reviewed changes

Planeshifter approved these changes Jun 11, 2025

View reviewed changes

anandkaranubc commented Jun 11, 2025

View reviewed changes

anandkaranubc marked this pull request as draft June 11, 2025 03:25

stdlib-bot removed the Needs Review A pull request which needs code review. label Jun 11, 2025

	* @param {string} [continuity] - continuity option
	* @param {string} continuity - continuity option

Uh oh!

feat: add C implementation for math/base/special/heaviside #6972

Are you sure you want to change the base?

feat: add C implementation for math/base/special/heaviside #6972

Conversation

anandkaranubc commented May 10, 2025

Description

Related Issues

Questions

Other

Checklist

Uh oh!

stdlib-bot commented May 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

anandkaranubc commented May 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Planeshifter Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

Planeshifter Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

kgryte Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

anandkaranubc Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

anandkaranubc Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat: add C implementation for `math/base/special/heaviside` #6972

feat: add C implementation for `math/base/special/heaviside` #6972

stdlib-bot commented May 10, 2025 •

edited

Loading