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

chore: improve implementation and tests #6389

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

chore: improve implementation and tests #6389

wants to merge 1 commit into from

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
anandkaranubc
anandkaranubc commented Mar 26, 2025
View reviewed changes
lib/node_modules/@stdlib/math/base/special/cabs/lib/main.js
Comment on lines +46 to +51
if ( isnan( real( z ) ) || isnan( imag( z ) ) ) {
return NaN;
}
if ( isInfinite( real( z ) ) || isInfinite( imag( z ) ) ) {
return PINF;
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This essentially is not "explicitly" needed, as all this is also being checked by hypot

@stdlib-bot
Copy link
Contributor

Coverage Report

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

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

anandkaranubc
anandkaranubc commented Mar 26, 2025
View reviewed changes
lib/node_modules/@stdlib/math/base/special/cabs/test/test.native.js
t.end();
});

tape( 'if either the real or imaginary component is `+Infinity`, the function returns `+Infinity`', opts, function test( t ) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

However, these tests could help improve the test coverage.

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review.
Projects
None yet
Milestone
No milestone
Development

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