Skip to content

New version: MinkowskiReduction v3.0.0#154765

Merged
JuliaTagBot merged 1 commit intomasterfrom
registrator-minkowskireduction-d617d09d-v3.0.0-266cf8b58e
May 5, 2026
Merged

New version: MinkowskiReduction v3.0.0#154765
JuliaTagBot merged 1 commit intomasterfrom
registrator-minkowskireduction-d617d09d-v3.0.0-266cf8b58e

Conversation

@JuliaRegistrator
Copy link
Copy Markdown
Contributor

@JuliaRegistrator JuliaRegistrator commented May 5, 2026

## Breaking changes
  This release renames every public function from camelCase / PascalCase to snake_case. All v2.x callers will need to update.
                                                                                                                                                                          
  | Old name              | New name                |                                                                                                                     
  | --------------------- | ----------------------- |                                                                                                                     
  | `minkReduce`          | `mink_reduce`           |                                                                                                                     
  | `GaussReduce`         | `gauss_reduce`          |                                                                                                                     
  | `isMinkReduced`       | `is_mink_reduced`       |                                                                                                                     
  | `orthogonalityDefect` | `orthogonality_defect`  |                                                                                                                     
  | `RandUnimodMat2`      | `rand_unimod_mat2`      |                                                                                                                     
  | `RandUnimodMat3`      | `rand_unimod_mat3`      |                                                                                                                     
  | `DeviousMat`          | `devious_mat`           |                                                                                                                     
  | `isPermutationMatrix` | `is_permutation_matrix` |                                                                                                                     
                                                                                                                                                                          
  `RandLowerTri` is also un-exported in this release; access it as `MinkowskiReduction.rand_lower_tri` if needed.                                                         
                                                                                                                                                                          
  ## Other changes                                                                                                                                                        
  - Library functions no longer `println` to stdout: `is_mink_reduced` now logs `@debug` messages when conditions fail. Set `ENV["JULIA_DEBUG"] = MinkowskiReduction` to
  see them.                                                                                                                                                               
  - Argument errors now throw specific exception types (`ArgumentError`, `DomainError`, `DimensionMismatch`, `OverflowError`) rather than generic `ErrorException`.
  - Matrix-form wrappers (`mink_reduce(M)`, `is_mink_reduced(M)`, `orthogonality_defect(M)`) now validate that `M` is exactly 3×3 and throw `DimensionMismatch` otherwise.
  - Internal cleanup: `@views` on the matrix wrappers, `Int64` → `Int`, dropped `using Random` from the source.

JuliaRegistrator referenced this pull request in glwhart/MinkowskiReduction.jl May 5, 2026
This is a breaking change from v2.0.x. Every public function has
been renamed from camelCase / PascalCase to snake_case:

  minkReduce          → mink_reduce
  GaussReduce         → gauss_reduce
  isMinkReduced       → is_mink_reduced
  orthogonalityDefect → orthogonality_defect
  RandUnimodMat2      → rand_unimod_mat2
  RandUnimodMat3      → rand_unimod_mat3
  DeviousMat          → devious_mat
  isPermutationMatrix → is_permutation_matrix

Internal helpers also renamed (visible to anyone who used qualified
access via `MinkowskiReduction.X`):

  shortenW_in_UVW  → shorten_w_in_uvw
  FibonacciMat     → fibonacci_mat
  RandLowerTri     → rand_lower_tri  (also un-exported in this release)

Migration guide and full file-by-file change list in
`dev-notes/snake_case_migration.md`.

The original plan was to ship v2.1 with `@deprecate` shims first and
then v3.0 to remove them. We are skipping the v2.1 step: this is a
small specialty package, the only known downstream consumer
(Spacey.jl) is maintained alongside this one and will be updated in
lockstep, and the deprecation cycle would have been mostly ceremony.
External users on v2.0.3 will need to either pin their `[compat]` or
do a one-shot rename per the migration guide.

Bundled into this release:
- snake_case rename across src, tests, README, docs, CLAUDE.md
  (commit 2b9439b)
- julianic idiom cleanup: println → @debug in is_mink_reduced;
  specific exception types (ArgumentError / DomainError /
  DimensionMismatch / OverflowError) replacing generic ErrorException;
  shape validation in matrix-form wrappers; Int64 → Int; ÷ for
  exact integer division; @views; consistent error-message prefixes;
  is_permutation_matrix shadowing fixes (commit 5683172)
- [deps] cleanup: Random and Test moved to [extras] (commit c8b858d)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of AutoMerge guidelines. If all these guidelines are met, this pull request will be merged automatically, completing your registration. It is strongly recommended to follow the guidelines, since otherwise the pull request needs to be manually reviewed and merged by a human.

1. AutoMerge Guidelines are all met! ✅

Your new version registration met all of the guidelines for auto-merging and is scheduled to be merged in the next round (~20 minutes).

2. To pause or stop registration

If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text [noblock] in your comment.

Tip: You can edit blocking comments to add [noblock] in order to unblock auto-merging.

UUID: d617d09d-b3c0-43f1-8886-30d89b900f25
Repo: https://github.com/glwhart/MinkowskiReduction.jl.git
Tree: 78d955214bbb320f8ae9f2fbec5ac8bdbc079f60

Registrator tree SHA: 50f504d641745716a5b3eabaf681d3a4937d2ae3
@JuliaRegistrator JuliaRegistrator force-pushed the registrator-minkowskireduction-d617d09d-v3.0.0-266cf8b58e branch from 4f91dd2 to 4b99687 Compare May 5, 2026 21:26
@JuliaTagBot JuliaTagBot merged commit 92f7515 into master May 5, 2026
13 checks passed
@JuliaTagBot JuliaTagBot deleted the registrator-minkowskireduction-d617d09d-v3.0.0-266cf8b58e branch May 5, 2026 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants