Skip to content

fix: update math/base/special/cotd to match correct reference implementation #5813

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
Merged
merged 4 commits into from
Mar 7, 2025
Merged

fix: update math/base/special/cotd to match correct reference implementation #5813

merged 4 commits into from
Mar 7, 2025

Conversation

@anandkaranubc
Copy link
Contributor

@anandkaranubc anandkaranubc commented Mar 5, 2025

Resolves none.

Description

What is the purpose of this pull request?

This pull request:

  • Fixes the implementation of math/base/special/cotd to align with the correct reference implementation.
  • Adds improved test fixtures to enhance accuracy and ensure correctness.

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
fix: update JS implementation
cfc6ce7 
---
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: 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
test: add improved test fixtures
6dea92d 
---
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
---
@anandkaranubc
fix: update the function according to reference implementation
5739343 
---
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: passed
  - 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 5, 2025
@anandkaranubc
test: increase the tolerance
a686017 
---
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
---
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Mar 5, 2025

Coverage Report

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

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

anandkaranubc
anandkaranubc commented Mar 5, 2025
View reviewed changes
lib/node_modules/@stdlib/math/base/special/cotd/test/fixtures/julia/runner.jl
Comment on lines +65 to +69
x = range( -179.0, stop = 0.0, length = 1000 );
gen( x, "negative.json" );

# Generate fixture data for positive values:
x = range( 1.0, stop = 10.0, length = 1000 );
x = range( 0.0, stop = 179.0, length = 1000 );
Copy link
Contributor Author

@anandkaranubc anandkaranubc Mar 5, 2025

Choose a reason for hiding this comment

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

This is because cotd( 180.0 ) and cotd( 0.0 ) produce different results. Therefore, 180.0 and -180.0 are tested separately.

anandkaranubc
anandkaranubc commented Mar 5, 2025
View reviewed changes
lib/node_modules/@stdlib/math/base/special/cotd/test/test.js
Comment on lines +120 to +126
tape( 'if provided `180.0`, the function returns `-Infinity`', function test( t ) {
var v = cotd( 180.0 );
t.equal( v, NINF, 'returns expected value' );
t.end();
});

tape( 'if provided `-180.0`, the function returns `+Infinity`', function test( t ) {
Copy link
Contributor Author

@anandkaranubc anandkaranubc Mar 5, 2025

Choose a reason for hiding this comment

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

Over here 😄

anandkaranubc
anandkaranubc commented Mar 5, 2025
View reviewed changes
lib/node_modules/@stdlib/math/base/special/cotd/test/test.js

for ( i = 0; i < x.length; i++ ) {
y = cotd( x[i] );
if ( expected[ i ] === null ) {
Copy link
Contributor Author

@anandkaranubc anandkaranubc Mar 5, 2025

Choose a reason for hiding this comment

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

This check is included because cotd( 0.0 ) returns PINF, whereas Julia returns null.

Copy link
Member

@Planeshifter Planeshifter Mar 7, 2025

Choose a reason for hiding this comment

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

Julia does return +Inf as well, it's just getting transformed to null when serialized to JSON:

image

Planeshifter
Planeshifter approved these changes Mar 7, 2025
View reviewed changes
Copy link
Member

@Planeshifter Planeshifter left a comment

Choose a reason for hiding this comment

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

LGTM!

@Planeshifter Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Mar 7, 2025
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Mar 7, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Mar 7, 2025

PR Commit Message

fix: update `math/base/special/cotd` to match correct reference implementation

PR-URL: https://github.com/stdlib-js/stdlib/pull/5813

Co-authored-by: Karan Anand <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>

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

@Planeshifter Planeshifter merged commit 75941b9 into stdlib-js:develop Mar 7, 2025
27 checks passed
@anandkaranubc anandkaranubc deleted the fix/cotd branch March 7, 2025 04:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Planeshifter Planeshifter Planeshifter approved these changes

Assignees

No one assigned

Labels

Math Issue or pull request specific to math functionality. Ready To Merge A pull request which is ready to be merged.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@anandkaranubc @stdlib-bot @Planeshifter