Skip to content
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.

Sign up for GitHub

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

Jump to bottom

test: add tests for C99 edge cases #6389

Merged
merged 4 commits into from
Apr 2, 2025
Merged

test: add tests for C99 edge cases #6389

merged 4 commits into from
Apr 2, 2025
+96 −9

Conversation

anandkaranubc
Copy link
Contributor

Resolves None

Description

What is the purpose of this pull request?

This pull request:

  • Completes the TODO on confirming the alignment of math/base/special/cabs with C99 conventions

Related Issues

Does this pull request have any related issues?

This pull request:

  • resolves None

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.

@stdlib-js/reviewers

@anandkaranubc
chore: improve implementation and tests
daa14d9 
---
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: passed
  - 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
---
@stdlib-bot stdlib-bot added Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review. labels Mar 26, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Mar 26, 2025 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
math/base/special/cabs $\color{green}138/138$
$\color{green}+100.00\%$ 		$\color{green}5/5$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}138/138$
$\color{green}+100.00\%$

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

@anandkaranubc
Copy link
Contributor Author

anandkaranubc commented Mar 26, 2025 •
edited
Loading

Also, based on the TODO comment referring to SciPy's implementation, I am still not sure why they perform an infinity check before a NaN check. They also specify that it's according to the C99 rules. However, testing with those values shows something different—if any of the arguments is NaN, the result is NaN.

Test results

No special comment has been made in the reference C99 documentation, and I couldn’t find anything in the ISO/IEC 9899:1999 that justifies this either.

cc: @kgryte

@kgryte
Copy link
Member

kgryte commented Apr 1, 2025 •
edited
Loading

@anandkaranubc See also https://data-apis.org/array-api/latest/API_specification/generated/array_api.abs.html#array_api.abs. The rule to check for infinity before NaN can be found in C99 hypot: https://en.cppreference.com/w/c/numeric/math/hypot.

@kgryte
Copy link
Member

kgryte commented Apr 1, 2025

It's also possible that our hypot is not IEEE 754 compliant. We should double check, as our hypot does not match C99 atm.

@kgryte kgryte added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Apr 2, 2025
anandkaranubc and others added 3 commits April 2, 2025 01:33
@anandkaranubc
Merge branch 'stdlib-js:develop' into fix/cabs
0f68b5c
@anandkaranubc
fix: update implementation to follow the C99 standard
ae3c95d 
---
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: passed
  - 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
---
@anandkaranubc
chore: remove extra linebreak
cc1f448 
---
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
---
@anandkaranubc anandkaranubc changed the title chore: improve implementation and tests fix: update cabs to follow the C99 rules Apr 2, 2025
@anandkaranubc anandkaranubc changed the title fix: update cabs to follow the C99 rules fix: update cabs to use C99 rules Apr 2, 2025
@anandkaranubc anandkaranubc changed the title fix: update cabs to use C99 rules test: add tests for C99 edge cases Apr 2, 2025
@anandkaranubc anandkaranubc requested a review from kgryte April 2, 2025 08:52
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Apr 2, 2025
@kgryte kgryte removed the Needs Changes Pull request which needs changes before being merged. label Apr 2, 2025
kgryte
kgryte approved these changes Apr 2, 2025
View reviewed changes
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks, @anandkaranubc!

@kgryte kgryte removed the Needs Review A pull request which needs code review. label Apr 2, 2025
@kgryte kgryte merged commit 1aa6c6d into stdlib-js:develop Apr 2, 2025
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kgryte kgryte kgryte approved these changes

Assignees
No one assigned
Labels
Math Issue or pull request specific to math functionality.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@anandkaranubc @stdlib-bot @kgryte