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

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

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

 @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

lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile

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

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

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

lib/node_modules/@stdlib/math/base/special/heaviside/docs/types/test.ts

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

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

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


The indentation is off here.

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

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

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

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

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

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

+	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

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

 @license Apache-2.0

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


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

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

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


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

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

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


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

lib/node_modules/@stdlib/math/base/special/heaviside/benchmark/c/Makefile

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


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

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

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


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

lib/node_modules/@stdlib/math/base/special/heaviside/docs/types/test.ts

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


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

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

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


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

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

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

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

	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!

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

Are you sure you want to change the base?

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

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!

Reviewers

Assignees

Labels

Projects

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

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

sahil20021008 commented Apr 26, 2025 •

edited

Loading

stdlib-bot commented Apr 26, 2025 •

edited

Loading

sahil20021008 commented May 4, 2025 •

edited

Loading