Improve documentation for the "Matrix groups" section #4556
+422
−42
Conversation
This file contains 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
- add introductory text and examples for matrix groups (analogous to the recent changes in the documentation for f.p. groups) - improve the documentation for sesquilinear forms - change/fix docstrings, add examples to docstrings - export `invariant_bilinear_form`, `invariant_quadratic_form`, `invariant_sesquilinear_form` (alternatively, we could remove their documentation from the manual)
ThomasBreuer
added
documentation
fingolfin
reviewed
Feb 6, 2025
src/Groups/matrices/form_group.jl
Outdated
| @@ -184,7 +184,7 @@ An exception is thrown if `base_ring(G)` is not a finite field with even degree | |||
| over its prime subfield. | |||
|
|
|||
| !!! warning "Note:" | |||
| At the moment, elements of the generating set are returned of type `mat_elem_type(G)`. | |||
| At the moment, elements of the generating set are returned of type `mat_elem_type(typeof(G))`. | |||
There was a problem hiding this comment.
For other similar *_type function we actually make sure that one can also pass in instances, for convenience. Maybe a good idea to do that here, too? E.g. we do this in AA:
elem_type(x) = elem_type(typeof(x))
elem_type(T::DataType) = throw(MethodError(elem_type, (T,)))There was a problem hiding this comment.
I found mat_elem_type a bit irritating: It is not documented at all, but it appears essentially in these warnings in the documentation.
Now I think that the function is useful. Thus I will document mat_elem_type and ring_elem_type, and then it makes sense to admit also the group as an argument instead of its type.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4556 +/- ##
==========================================
- Coverage 84.43% 84.43% -0.01%
==========================================
Files 673 673
Lines 89624 89624
==========================================
- Hits 75676 75671 -5
- Misses 13948 13953 +5
|
- document `ring_elem_type`, `mat_elem_type`, admit a matrix group as argument - add examples for `corresponding_bilinear_form`, `corresponding_quadratic_form` - changed `show` for forms to avoid trailing whitespace
The matrices returned by `corresponding_bilinear_form` and `corresponding_quadratic_form` are determined at most up to scalars, thus `jldoctest` cannot be used.
|
Some tests fail: Aqua's "persistent tasks" complains. |
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.
invariant_bilinear_form,invariant_quadratic_form,invariant_sesquilinear_form(alternatively, we could remove their documentation from the manual)