Document the relation between "abelian invariants" and "elementary divisors"#4888
Merged
fingolfin merged 2 commits intooscar-system:masterfrom May 26, 2025
Merged
Conversation
- rename the conversion functions between the `Vector` formats
returned by `abelian_invariants` and `elementary_divisors` for groups:
call them `abelian_invariants` and `elementary_divisors`
- document these conversion functions
- make their signatures more restrictive:
request a `Vector{T} where T <: IntegerUnion` instead of just a `Vector`.
(Thus one can no longer enter `[]` as an argument, for the invariants of
the trivial group, `Int[]` or so is needed.)
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #4888 +/- ##
==========================================
+ Coverage 84.88% 84.92% +0.03%
==========================================
Files 681 685 +4
Lines 91621 92183 +562
==========================================
+ Hits 77772 78282 +510
- Misses 13849 13901 +52
🚀 New features to boost your workflow:
|
fingolfin
reviewed
May 19, 2025
fingolfin
reviewed
May 19, 2025
fingolfin
approved these changes
May 26, 2025
Member
|
@ThomasBreuer @fingolfin could you please add appropriate release notes labels to this PR? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
rename the conversion functions between the
Vectorformats returned byabelian_invariantsandelementary_divisorsfor groups: call themabelian_invariantsandelementary_divisorsdocument these conversion functions
make their signatures more restrictive: request a
Vector{T} where T <: IntegerUnioninstead of just aVector. (Thus one can no longer enter[]as an argument, for the invariants of the trivial group,Int[]or so is needed.)This addresses issue #2968.
Alternatively, we could move the definition of
abelian_invariants(forFinGenAbGroup) to Hecke.jl, add cross-references betweenabelian_invariantsandelementary_divisorsthere, and then extend the two functions toGAPGroupin Oscar.jl.One ugly detail in the current pull request is that referencing
abelian_invariants(::Vector)from the docstring ofabelian_invariants(G::Union{GAPGroup, FinGenAbGroup})apparently needs the full signatureabelian_invariants(::Vector{S}) where S <: Oscar.IntegerUnion, otherwise I get a wrong circular cross-reference to the docstring itself.(Referencing
elementary_divisors(::Vector)is not a problem, perhaps becauseelementary_divisorsfor groups is defined in Hecke.jl.)