feat: add C implementation for `math/base/special/heaviside` by sahil20021008 · Pull Request #6823 · stdlib-js/stdlib

sahil20021008 · 2025-04-26T11:36:15Z

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

Resolves #1891 .

Description

What is the purpose of this pull request?

This pull request:

proposes adding C implementation of stdlib/math/base/special/heaviside. This includes benchmarks, examples, tests, README files, etc.

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

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

stdlib-bot · 2025-04-26T11:38:35Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/heaviside	$\color{green}232/232$ $\color{green}+100.00\%$	$\color{green}17/17$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}232/232$ $\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: 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 ---

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

gunjjoshi · 2025-05-02T04:24:11Z

 @license Apache-2.0

-Copyright (c) 2018 The Stdlib Authors.
+Copyright (c) 2025 The Stdlib Authors.


Suggested change

Copyright (c) 2025 The Stdlib Authors.

Copyright (c) 2018 The Stdlib Authors.

We can avoid updating copyright years for pre-existing files.

gunjjoshi · 2025-05-02T04:27:22Z

 # @license Apache-2.0
 #
-# Copyright (c) 2018 The Stdlib Authors.
+# Copyright (c) 2025 The Stdlib Authors.


Suggested change

# Copyright (c) 2025 The Stdlib Authors.

# Copyright (c) 2018 The Stdlib Authors.

gunjjoshi · 2025-05-02T04:27:32Z

 * @license Apache-2.0
 *
-* Copyright (c) 2018 The Stdlib Authors.
+* Copyright (c) 2025 The Stdlib Authors.


Suggested change

* Copyright (c) 2025 The Stdlib Authors.

* Copyright (c) 2018 The Stdlib Authors.

gunjjoshi · 2025-05-02T04:30:03Z

 // The function returns a number...
 {
-	heaviside( 3.141592653589793 ); // $ExpectType number
+	heaviside( 3.141592653589793, 'half-maximum' ); // $ExpectType number


I don't think this is necessary, @sahil20021008. We want to demonstrate the default case here, without the second argument, such as the function is discontinuous at 0.

You can revert this change.

gunjjoshi · 2025-05-02T04:31:02Z

+* @param x 				input value
+* @param continuity 	continuity option
+* @return				function value


The indentation is off here.

gunjjoshi · 2025-05-02T05:10:28Z

+
+#### stdlib_base_heaviside( x )
+
+Evaluate the [Heaviside function][heaviside-function].


Suggested change

Evaluate the [Heaviside function][heaviside-function].

Evaluates the [Heaviside function][heaviside-function].

gunjjoshi · 2025-05-02T05:21:30Z

+#include "stdlib/math/base/special/heaviside.h"
+```
+
+#### stdlib_base_heaviside( x )


Suggested change

#### stdlib_base_heaviside( x )

#### stdlib_base_heaviside( x, continuity )

gunjjoshi · 2025-05-04T17:02:39Z

+	if ( stdlib_base_is_nan( x )) {
+		return 0.0/0.0;
+	}
+	if ( x > 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;


Spacing is off at certain places here, will need to be fixed.

Not exactly sure where the placing has to be improved
For now, I have fixed placing at line 58, but please lmk if changes required anywhere else also.
Thanks

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

sahil20021008

Hi @gunjjoshi
I have addressed your review comments.

sahil20021008 · 2025-05-04T17:39:31Z

 @license Apache-2.0

-Copyright (c) 2018 The Stdlib Authors.
+Copyright (c) 2025 The Stdlib Authors.


sahil20021008 · 2025-05-04T17:40:21Z

+#include "stdlib/math/base/special/heaviside.h"
+```
+
+#### stdlib_base_heaviside( x )


sahil20021008 · 2025-05-04T17:41:00Z

+
+#### stdlib_base_heaviside( x )
+
+Evaluate the [Heaviside function][heaviside-function].


sahil20021008 · 2025-05-04T17:41:31Z

 # @license Apache-2.0
 #
-# Copyright (c) 2018 The Stdlib Authors.
+# Copyright (c) 2025 The Stdlib Authors.


sahil20021008 · 2025-05-04T17:41:45Z

 * @license Apache-2.0
 *
-* Copyright (c) 2018 The Stdlib Authors.
+* Copyright (c) 2025 The Stdlib Authors.


sahil20021008 · 2025-05-04T17:43:01Z

 // The function returns a number...
 {
-	heaviside( 3.141592653589793 ); // $ExpectType number
+	heaviside( 3.141592653589793, 'half-maximum' ); // $ExpectType number


sahil20021008 · 2025-05-04T17:44:21Z

+* @param x 				input value
+* @param continuity 	continuity option
+* @return				function value


sahil20021008 · 2025-05-04T17:48:42Z

+	if ( stdlib_base_is_nan( x )) {
+		return 0.0/0.0;
+	}
+	if ( x > 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;


Not exactly sure where the placing has to be improved
For now, I have fixed placing at line 58, but please lmk if changes required anywhere else also.
Thanks

sahil20021008 · 2025-05-04T18:11:46Z

Receiving the following error while using git push. Not sure why this is happening

Compiling benchmark...
make[1]: Entering directory '/workspaces/stdlib/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c'
benchmark.c:24:10: fatal error: stdlib/math/base/special/heaviside.h: No such file or directory
   24 | #include "stdlib/math/base/special/heaviside.h"
      |          ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.
make[1]: *** [Makefile:105: benchmark.out] Error 1
make[1]: Leaving directory '/workspaces/stdlib/lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c'
Error when attempting to compile benchmark.
ERROR: An error was encountered during execution.

make: *** [/workspaces/stdlib/tools/make/lib/benchmark/c.mk:84: benchmark-c-files] Error 1

Encountered an error when running C benchmarks.

have used git push --no-verify for now.
Any idea what is the issue here @gunjjoshi ?
I was not facing this error earlier

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

kgryte · 2026-03-10T03:28:48Z

Ref: #10196

stdlib-bot · 2026-03-10T03:31:17Z

Thank you for working on this pull request. However, we cannot accept your contribution as the issue this pull request seeks to resolve has already been addressed in a different pull request or commit.

Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions.

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

sahil20021008 added 2 commits April 26, 2025 11:59

gunjjoshi changed the title ~~feat: add c implementation of stdlib/math/base/special/heaviside~~ feat: add C implementation for math/base/special/heaviside May 2, 2025

gunjjoshi reviewed May 4, 2025

View reviewed changes

sahil20021008 commented May 4, 2025

View reviewed changes

kgryte mentioned this pull request Jan 25, 2026

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

Closed

7 tasks

kgryte mentioned this pull request Mar 10, 2026

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

Merged

1 task

kgryte added autoclose: Already Resolved Pull request which should be auto-closed due proposed changes duplicating already included changes. and removed Needs Review A pull request which needs code review. labels Mar 10, 2026

stdlib-bot closed this Mar 10, 2026

	Copyright (c) 2025 The Stdlib Authors.
	Copyright (c) 2018 The Stdlib Authors.

	# Copyright (c) 2025 The Stdlib Authors.
	# Copyright (c) 2018 The Stdlib Authors.

	* Copyright (c) 2025 The Stdlib Authors.
	* Copyright (c) 2018 The Stdlib Authors.


		#### stdlib_base_heaviside( x )

		Evaluate the [Heaviside function][heaviside-function].

	Evaluate the [Heaviside function][heaviside-function].
	Evaluates the [Heaviside function][heaviside-function].

	#### stdlib_base_heaviside( x )
	#### stdlib_base_heaviside( x, continuity )

Uh oh!

Conversation

sahil20021008 commented Apr 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Questions

Other

Checklist

Uh oh!

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

Uh oh!

Coverage Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sahil20021008 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sahil20021008 commented May 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kgryte commented Mar 10, 2026

Uh oh!

stdlib-bot commented Mar 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

sahil20021008 commented Apr 26, 2025 •

edited

Loading

stdlib-bot commented Apr 26, 2025 •

edited

Loading

sahil20021008 commented May 4, 2025 •

edited

Loading