Skip to content

test: migrate stats/incr/nanmrss to ULP-based assertions - #15166

Merged
kgryte merged 1 commit into
developfrom
kgryte/ulp-nanmrss
Sep 11, 2026
Merged

test: migrate stats/incr/nanmrss to ULP-based assertions#15166
kgryte merged 1 commit into
developfrom
kgryte/ulp-nanmrss

Conversation

@kgryte

@kgryte kgryte commented Sep 11, 2026

Copy link
Copy Markdown
Member

Resolves a part of #11352.

Description

What is the purpose of this pull request?

This pull request:

  • migrates the tests for stats/incr/nanmrss from a computed relative-tolerance comparison (delta = abs( expected - actual ) / tol = 1.0 * EPS * abs( expected ), asserted via t.equal( delta <= tol, ... )) to a ULP-difference assertion using @stdlib/assert/is-almost-same-value.
  • applies the migration to the single tolerance-based assertion site in test/test.js. The package has no test/test.native.js. The remaining assertions in the file are exact comparisons against null, thrown TypeErrors, function types, and the exactly representable value 145.0, which are correct as-is and are left unchanged.
  • removes the now-unused @stdlib/math/base/special/abs and @stdlib/constants/float64/eps requires, along with the delta and tol variable declarations.
  • collapses the if ( actual === expected[i] ) { ... } else { ... } branch in the moving-residual-sum-of-squares test into a single ULP assertion, matching the migrated idiom.

Only a test file is changed; no implementation, fixture, or documentation changes are included.

ULP bounds

Assertion Previous tolerance ULP bound
moving residual sum of squares computed incrementally (9 values) 1.0 * EPS * abs( expected ) 0

This is the minimum integer bound N such that isAlmostSameValue( actual, expected[ i ], N ) holds at the assertion site, and it is the floor of the scale — no tighter bound exists. It was measured independently of the test harness by computing ulpDifference( actual, expected[ i ] ) directly at every element, starting from a high bound (64, which passes) and tightening.

The per-element ULP differences are 0, 0, 0, 0, 0, 0, 0, 0, 0: the accumulator reproduces every expected value (1, 1, 1, 17, 26, 89, 89, 82, 154) bit-for-bit. These are small integers well within the exactly representable range, and the incremental algorithm accumulates only sums of products of small integer-valued inputs, so no rounding occurs at any step. The original test anticipated this by branching on actual === expected[i] and taking the exact-comparison path first; the pre-existing relative tolerance was never actually exercised on this platform. At N = 0, isAlmostSameValue delegates to isSameValue, so the migrated assertion preserves that exact-comparison behavior rather than loosening it.

make test TESTS_FILTER=".*/stats/incr/nanmrss/.*" was run twice at the final bound with identical results: 25/25 passing on both runs, no failures, ruling out FMA/architecture-dependent flakiness on this platform. make eslint-tests TESTS_FILTER=".*/stats/incr/nanmrss/.*" is clean.

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?

The migrated bound is 0 rather than 1. Since every value in this fixture is exact, 0 is the minimum required bound as the tracking issue asks for, and it preserves the exact comparison the original test already performed via its actual === expected[i] branch. A bound of 1 would be strictly weaker than the assertion being replaced. Flagging in case a reviewer would prefer 1 for consistency with sibling packages whose fixtures are genuinely inexact; 0 is used elsewhere in the migrated set, so this follows existing precedent.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

The resulting diff mirrors the already-merged migrations for the sibling accumulator packages stats/incr/nanmhmean (#15125), stats/incr/mmape (#15150), and stats/incr/mda (#15142), which share the same test structure.

One environment note, which did not affect verification: make install-node-modules initially failed with ETARGET for es-object-atoms@^1.1.2. As previously observed in #15116 and #15125, this is a stale local npm packument cache rather than a repository or registry problem; refetching with npm_config_prefer_online=true succeeded, after which make init and the full toolchain were available for this PR.

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

This PR was written primarily by Claude Code, running as an unattended scheduled task. It selected the package, studied previously migrated packages in the same family to match the established idiom, performed the migration, and determined the minimum passing ULP bound empirically at the assertion site.


@stdlib-js/reviewers

🤖 Generated with Claude Code

https://claude.ai/code/session_014muLqDv12CgWqs2cpTH9vW


Generated by Claude Code

Migrate the tolerance-based assertion in `stats/incr/nanmrss` tests from
a computed relative tolerance to a ULP-difference assertion using
`@stdlib/assert/is-almost-same-value`.

Ref: #11352

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014muLqDv12CgWqs2cpTH9vW

---
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: skipped
  - task: lint_markdown_pkg_readmes
    status: na
  - task: lint_markdown_docs
    status: na
  - 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: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. Good First PR A pull request resolving a Good First Issue. labels Sep 11, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/incr/nanmrss $\\color{green}155/155$
$\\color{green}+100.00\\%$
$\\color{green}8/8$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}155/155$
$\\color{green}+100.00\\%$

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

@kgryte kgryte added the Tests Pull requests specifically adding tests. label Sep 11, 2026
@kgryte
kgryte marked this pull request as ready for review September 11, 2026 17:23
@kgryte
kgryte requested a review from a team September 11, 2026 17:23
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Sep 11, 2026
@kgryte
kgryte merged commit cc3767c into develop Sep 11, 2026
82 checks passed
@kgryte
kgryte deleted the kgryte/ulp-nanmrss branch September 11, 2026 17:24
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Sep 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Good First PR A pull request resolving a Good First Issue. Statistics Issue or pull request related to statistical functionality. Tests Pull requests specifically adding tests.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants