Skip to content

test: migrate math/base/special/ellipj to ULP-based assertions - #15264

Merged
kgryte merged 1 commit into
stdlib-js:developfrom
Devansh-18155:devansh/ulp-ellipj-test
Sep 23, 2026
Merged

kgryte merged 1 commit into
stdlib-js:developfrom
Devansh-18155:devansh/ulp-ellipj-test

Conversation

@Devansh-18155

Copy link
Copy Markdown
Contributor

Resolves a part of #11352

Description

What is the purpose of this pull request?

This pull request:

  • Migrates tests for @stdlib/math/base/special/ellipj from relative tolerance testing to ULP difference testing using @stdlib/assert/is-almost-same-value.

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

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.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

I used AI assistance to calculate minimum required ULP values.


@stdlib-js/reviewers

@Devansh-18155
Devansh-18155 requested a review from a team September 16, 2026 12:08
@stdlib-bot stdlib-bot added Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review. Good First PR A pull request resolving a Good First Issue. labels Sep 16, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
math/base/special/ellipj $\\color{red}701/713$
$\\color{green}+98.32\\%$
$\\color{red}32/34$
$\\color{green}+94.12\\%$
$\\color{green}7/7$
$\\color{green}+100.00\\%$
$\\color{red}701/713$
$\\color{green}+98.32\\%$

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

@kgryte kgryte added difficulty: 1 Low degree of difficulty. Should be straightforward to implement and/or resolve. Tests Pull requests specifically adding tests. review: 5 and removed Needs Review A pull request which needs code review. labels Sep 21, 2026
tol = 40.0 * EPS;
t.strictEqual( delta <= tol, true, 'within tolerance. u: '+u[i]+'. m: '+m[i]+', dn: '+dn+'. E: '+dnExpected[i]+'. Δ: '+delta+'. tol: '+tol+'.' );
}
t.strictEqual( isAlmostSameValue( sn, snExpected[ i ], 4750 ), true, 'returns expected value' );

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@Devansh-18155 How did you derive these ULP diffs? Given the previous deltas (e.g., 18*EPS), I am surprised by these large ULP differences.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This same comment applies to several other test assertions.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@kgryte ,Large ULP diffs because the previous test checks difference (18 * EPS), while isAlmostSameValue checks ULP, As an deltas of 2.3 * EPS which makes approx 4750 ULP.
I derived it by checking max ULP diff across dataset and we can keep this limits!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This still doesn't seem right. 1 unit of epsilon is roughly equal to 1 ULP, so, again, this large divergence is surprising. Can you provide exact test values demonstrating the large ULP difference?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@kgryte ,

Taken a test case from medium_positive_modulus.json :

  • u : 5.006645997054875
  • m : 0.8826190324290656
  • Computed sn : -0.000761851982413601
  • Expected sn : -0.000761851982414116
  • Difference : 5.15 e-16 ( approx 2.3 EPS)

The value is small (0.0007), 1 ULP is 1.08e-19. So difference is 2.3 * EPS in terms, it takes 4750 ULPs.

1 ULP =1 EPS but, if the numbers are closer to zero the ULP shrinks as well.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Oh, I see. The tolerances were previously computed incorrectly. They should have been scaled by the expected value.

@kgryte kgryte left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Left initial comments.

@kgryte kgryte added Needs Changes Pull request which needs changes before being merged. review: 3 and removed review: 5 labels Sep 21, 2026

@kgryte kgryte left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@kgryte
kgryte merged commit 8a518c5 into stdlib-js:develop Sep 23, 2026
146 checks passed
@kgryte kgryte added review: 5 and removed Needs Changes Pull request which needs changes before being merged. review: 3 labels Sep 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

difficulty: 1 Low degree of difficulty. Should be straightforward to implement and/or resolve. Good First PR A pull request resolving a Good First Issue. Math Issue or pull request specific to math functionality. review: 5 Tests Pull requests specifically adding tests.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants