Skip to content

API modernization: v1.0.1#20

Merged
kdw503 merged 8 commits into
masterfrom
dwk/mng
May 15, 2026
Merged

API modernization: v1.0.1#20
kdw503 merged 8 commits into
masterfrom
dwk/mng

Conversation

@kdw503
Copy link
Copy Markdown
Member

@kdw503 kdw503 commented May 15, 2026

Summary

  • Breaking: pat_rotation renamed to principalaxes_rotation — aligns naming with the companion principalaxes function
  • Breaking: qfit 4-argument positional form removed; keyword-only form is now the sole public interface
  • Non-breaking: added uclamp and mms2fit non-mutating counterparts
  • Non-breaking: qfit accepts solver_kwargs forwarded to nlsolve
  • Non-breaking: qbuild type annotations widened (Vector/MatrixAbstractVector/AbstractMatrix); maxshift annotated as Union{AbstractVector,Tuple} across qbuild, uisvalid, uclamp!

Test plan

  • All 74 tests pass (Pkg.test())
  • Test.detect_ambiguities(RegisterFit) = 0 (baseline was 0)
  • Aqua full check passes (11/11)
  • ExplicitImports passes (7/7)
  • @test_throws MethodError guards on both breaking removals

🤖 Generated with Claude Code

kdw503 and others added 8 commits May 15, 2026 12:45
…tMatrix

Allows callers to pass SVector/SMatrix results from mms2fit! directly into
qbuild without an intermediate copy or conversion.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
… uclamp!

Surfaces misuse (e.g. scalar maxshift) as a MethodError at the call site
rather than a confusing indexing error inside the function body.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
uclamp(u, maxshift) copies u and delegates to uclamp!, following the
sort/sort! convention. Exported and documented with a cross-reference
to uclamp!.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Uses deepcopy rather than copy because interpolate_mm! writes B-spline
coefficients into each MismatchArray's .data in-place (InPlace BSpline),
so a shallow copy would alias the original's storage.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Adds a solver_kwargs = (;) keyword to qfit that is splatted into the
NLsolve.nlsolve call, letting callers tune ftol, xtol, iterations, etc.
without the package having to enumerate nlsolve's full option set.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The internal qfit(mm, thresh, maxsep, opt::Bool) form, which leaked an
implementation detail into the public API, is renamed to _qfit. The
sole public interface is now qfit(mm, thresh; maxsep, opt, solver_kwargs).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The abbreviation "pat" (principal axes transform) is opaque and
inconsistent with the companion function principalaxes. The new name
makes the pipeline principalaxes → principalaxes_rotation self-evident.
No deprecation shim per stated values. Docs and README updated.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@codecov
Copy link
Copy Markdown

codecov Bot commented May 15, 2026

Codecov Report

❌ Patch coverage is 91.66667% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 75.60%. Comparing base (eff67b1) to head (e3c0011).
⚠️ Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
src/RegisterFit.jl 91.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master      #20      +/-   ##
==========================================
+ Coverage   75.46%   75.60%   +0.14%     
==========================================
  Files           1        1              
  Lines         326      328       +2     
==========================================
+ Hits          246      248       +2     
  Misses         80       80              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kdw503 kdw503 merged commit 13c3172 into master May 15, 2026
5 checks passed
@kdw503 kdw503 deleted the dwk/mng branch May 15, 2026 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant