Skip to content

API modernization: argmin rename, ratio keyword arg, highpass! variants (v1.0.0)#26

Merged
kdw503 merged 15 commits intomasterfrom
dwk/mng
May 4, 2026
Merged

API modernization: argmin rename, ratio keyword arg, highpass! variants (v1.0.0)#26
kdw503 merged 15 commits intomasterfrom
dwk/mng

Conversation

@kdw503
Copy link
Copy Markdown
Member

@kdw503 kdw503 commented Apr 29, 2026

Summary

  • Breaking: rename indmin_mismatchargmin_mismatch, following Julia 1.0+ argmin/argmax convention (replaces deprecated indmin/indmax)
  • Non-breaking: move ratio fillval from positional to keyword argument (fillval=NaN); @deprecate shims preserve old 3-arg callers
  • Non-breaking: add highpass!(out, data, sigma) and highpass!(data, sigma) in-place variants to avoid allocation in hot loops
  • Internal consistency: docstring clarifications for ratio(Real,...) (thresh/fillval are ignored), highpass type-first calling convention, and ::AbstractArray annotation on trimmedview's first argument
  • Version bumped 0.2.51.0.0

🤖 Generated with Claude Code

kdw503 and others added 15 commits April 28, 2026 20:26
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Adds Aqua as a test dependency, fixes missing [compat] entries for
extras (ImageMetadata, Interpolations, Test), and adds Aqua badge to README.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Both `one(NumDenom)` (superseded by `oneunit`) and the non-broadcasting
`ratio(::AbstractArray, ...)` (superseded by `ratio.(...)`) had been
deprecated; all callers already use the replacements.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
No fields are mutated after construction; marking them const
makes the immutability explicit and allows the compiler to
optimize accordingly.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Add tests for: promote_rule(NumDenom, Number), identity convert,
MismatchArray vararg dims constructor, ColonFun constructor,
PreprocessSNF on SubArray, and pdindex error path.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Fixes MismatchArray docstring association (was stranded on constructor
method, now on the const alias so ?MismatchArray works in the REPL).
Adds ColonFun docstring. Documents all overloads of separate, ratio, and
indmin_mismatch (including the silent zero-index failure case). Corrects
stale Image.jl reference in highpass to ImageFiltering.jl. Expands
PreprocessSNF and NumDenom docs with Float32 conversion, sigmalp/sigmahp
length requirements, SubArray behavior, and all arithmetic operators.
Expands module docstring to list all exported symbols with @ref links.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add CI, stable-docs, and dev-docs badges to README; fix stable docs URL
- Bump Documenter compat from ~0.23 to 1; update make.jl for Documenter 1.x
- Add checkdocs=:exports to catch undocumented exports
- Add MismatchArray, ColonFun, PreprocessSNF to API reference page
- Add verified jldoctest example for NumDenom arithmetic
- Update CI action versions and Julia version matrix (1.10 LTS + 1 current)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Follows Julia 1.0+ convention of `argmin`/`argmax` over the deprecated
`indmin`/`indmax` naming.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
`fillval` is configuration, not data; keyword argument follows modern
Julia convention. Adds @deprecate shims for the old 3-positional-arg
forms. Also clarifies the Real-input docstring: thresh/fillval are
silently ignored for pre-computed ratio inputs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Provides highpass!(out, data, sigma) and highpass!(data, sigma) to
avoid allocation in hot loops. Output element type is taken from
eltype(out).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- ratio(Real, ...): clarify in docstring that thresh/fillval are ignored
- highpass: clarify type-first vs data-first calling conventions in docstring
- trimmedview: add ::AbstractArray annotation to Bpad argument

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Breaking change: indmin_mismatch renamed to argmin_mismatch.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Replace indmin_mismatch with argmin_mismatch in api.md (rename was already breaking)
- Add RegisterCore module docstring to api.md to satisfy checkdocs=:exports
- Remove unresolvable @ref cross-link to Base.copyto!

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@kdw503 kdw503 merged commit b241ba6 into master May 4, 2026
3 checks passed
@kdw503 kdw503 deleted the dwk/mng branch May 4, 2026 21:07
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