feat: add C implementation for `math/base/special/gammainc` #7408

anandkaranubc · 2025-06-19T07:21:36Z

Progresses #649

Description

What is the purpose of this pull request?

This pull request:

Adds the complete C implementation of gammainc, along with updated benchmarks and examples.

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

anandkaranubc · 2025-06-19T07:22:34Z

/stdlib update-copyright-years

stdlib-bot · 2025-06-19T07:23:56Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/gammainc	$\color{red}1526/1755$ $\color{green}+86.95\%$	$\color{red}106/140$ $\color{green}+75.71\%$	$\color{red}20/24$ $\color{green}+83.33\%$	$\color{red}1526/1755$ $\color{green}+86.95\%$

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

anandkaranubc · 2025-06-21T07:00:07Z

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

+// TODO: Add this to `test.js` once the JS implementation matches the latest Boost C++ implementation.
+var largeXLargeS = require( './fixtures/cpp/large_x_large_s.json' );


The CI is failing because of this.

The JS implementation needs to be updated first in order to properly account for all the expected values in this fixture.

New test coverage is 89.34%

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

Planeshifter

Looks all good to me (pending resolution of the CI failures for the native add-on tests, which I cannot reproduce locally).

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

anandkaranubc · 2025-06-27T21:59:38Z

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

@@ -447,8 +447,8 @@ tape( 'the function correctly evaluates the unregularized lower incomplete gamma
 			t.strictEqual( isSameValue( actual, PINF ), true, 'returns expected value' );
 			continue;
 		}
-		// NOTE: The difference is high because some of the expected values are very large.
-		t.strictEqual( ulpdiff( actual, expected[ i ] ) <= 534, true, 'returns expected value within 534 ulp' );
+		// NOTE: The difference is high because some of the expected values are very large and the compiler optimizations have been disabled.


Adding a note for future reference: this was done because the workflows build the native addons with the CFLAGS="-ffp-contract=off" flag. If this flag is not set, the tests pass with the ULP difference observed in the previous commit.

Planeshifter

Let's get it in. 🚀

Any potential further needed changes can be made in follow-up PR(s).

Thanks, @anandkaranubc! Been waiting for this one for a long time. 🙏

stdlib-bot · 2025-06-27T22:23:49Z

PR Commit Message

feat: add C implementation for `math/base/special/gammainc`

PR-URL: https://github.com/stdlib-js/stdlib/pull/7408
Ref: https://github.com/stdlib-js/stdlib/issues/649

Co-authored-by: stdlib-bot <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>

Please review the above commit message and make any necessary adjustments.

⚠️ Action Required: This PR references tracking issues. Please update the PR description to replace any "Closes", "Fixes", or "Resolves" keywords with "Ref" when referencing these issues.

anandkaranubc added 6 commits May 11, 2025 12:45

feat: temp commit

d24f74f

Merge branch 'develop' into feat/gammainc

b55983d

feat: temp commit

a225e46

Merge branch 'develop' into feat/gammainc

c263025

Merge branch 'develop' into feat/gammainc

dcbd012

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

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

chore: update copyright years

02b8dd1

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

anandkaranubc added C Issue involves or relates to C. GSoC Google Summer of Code. gsoc: 2025 Google Summer of Code (2025). labels Jun 19, 2025

anandkaranubc added 3 commits June 19, 2025 00:28

Merge branch 'develop' into feat/gammainc-c

0265fb5

Planeshifter self-requested a review June 20, 2025 20:03

anandkaranubc added 4 commits June 20, 2025 17:49

test: add more tests

d79211e

Merge branch 'develop' into feat/gammainc-c

e1c5923

Merge branch 'develop' into feat/gammainc-c

ce37e13

anandkaranubc force-pushed the feat/gammainc-c branch from ac2f429 to ce37e13 Compare June 21, 2025 04:46

anandkaranubc added 4 commits June 20, 2025 21:47

anandkaranubc commented Jun 21, 2025

View reviewed changes

Planeshifter previously approved these changes Jun 27, 2025

View reviewed changes

anandkaranubc dismissed Planeshifter’s stale review via dbb1de6 June 27, 2025 21:39

anandkaranubc commented Jun 27, 2025

View reviewed changes

Planeshifter approved these changes Jun 27, 2025

View reviewed changes

Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Jun 27, 2025

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

Planeshifter merged commit 84c97ba into stdlib-js:develop Jun 27, 2025
29 checks passed

anandkaranubc deleted the feat/gammainc-c branch June 28, 2025 14:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: add C implementation for `math/base/special/gammainc` #7408

feat: add C implementation for `math/base/special/gammainc` #7408

Uh oh!

anandkaranubc commented Jun 19, 2025

Uh oh!

anandkaranubc commented Jun 19, 2025

Uh oh!

stdlib-bot commented Jun 19, 2025 •

edited

Loading

Uh oh!

anandkaranubc Jun 21, 2025

Uh oh!

anandkaranubc Jun 21, 2025

Uh oh!

anandkaranubc Jun 21, 2025

Uh oh!

Planeshifter left a comment •

edited

Loading

Uh oh!

anandkaranubc Jun 27, 2025

Uh oh!

Planeshifter left a comment

Uh oh!

stdlib-bot commented Jun 27, 2025

Uh oh!

Uh oh!

Uh oh!

		// TODO: Add this to `test.js` once the JS implementation matches the latest Boost C++ implementation.
		var largeXLargeS = require( './fixtures/cpp/large_x_large_s.json' );

Uh oh!

feat: add C implementation for math/base/special/gammainc #7408

feat: add C implementation for math/base/special/gammainc #7408

Uh oh!

Conversation

anandkaranubc commented Jun 19, 2025

Description

Related Issues

Questions

Other

Checklist

Uh oh!

anandkaranubc commented Jun 19, 2025

Uh oh!

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

Uh oh!

Coverage Report

Uh oh!

anandkaranubc Jun 21, 2025

Choose a reason for hiding this comment

Uh oh!

anandkaranubc Jun 21, 2025

Choose a reason for hiding this comment

Uh oh!

anandkaranubc Jun 21, 2025

Choose a reason for hiding this comment

Uh oh!

Planeshifter left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anandkaranubc Jun 27, 2025

Choose a reason for hiding this comment

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

stdlib-bot commented Jun 27, 2025

PR Commit Message

Uh oh!

Uh oh!

Uh oh!

feat: add C implementation for `math/base/special/gammainc` #7408

feat: add C implementation for `math/base/special/gammainc` #7408

stdlib-bot commented Jun 19, 2025 •

edited

Loading

Planeshifter left a comment •

edited

Loading