Document ideal interface #2113
Document ideal interface #2113
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2113 +/- ##
==========================================
- Coverage 88.35% 87.95% -0.40%
==========================================
Files 126 127 +1
Lines 31674 31791 +117
==========================================
- Hits 27984 27961 -23
- Misses 3690 3830 +140 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
I am not too happy with the change. The function should not call In general, we are not really advertising |
Ok, if the previous code was as desired, then I'll remove the edit. I was a bit confused as it didn't work in AA, but I suppose it makes sense for its use beyond. |
| ``` | ||
| ```julia | ||
| issubset(I::NewIdeal, J::NewIdeal) | ||
| ``` | ||
| ```julia | ||
| iszero(I::NewIdeal) | ||
| ``` | ||
| ```julia | ||
| +(I::T, J::T) where {T <: NewIdeal} | ||
| ``` | ||
| ```julia | ||
| *(I::T, J::T) where {T <: NewIdeal} | ||
| ``` | ||
| ```julia | ||
| intersect(I::T, J::T) where {T <: NewIdeal} | ||
| ``` | ||
| ```julia | ||
| ==(I::T, J::T) where {T <: NewIdeal} | ||
| ``` |
There was a problem hiding this comment.
Of course all of these will get default implementations with my PR #2108 -- but we can update this later, once that PR is merged.
Co-authored-by: Max Horn <max@quendi.de>
docs/src/ideal_interface.md
Outdated
| The generic ideals have type `Generic.Ideal{T}` where `T` is the type of | ||
| elements of the ring the ideals belong to. Internally they consist of a Julia | ||
| array of generators and some additional fields for a parent object, etc. See | ||
| the file `src/generic/GenericTypes.jl` for details. | ||
|
|
||
| Parent objects of ideals have type `Generic.IdealSet{T}`. | ||
|
|
Co-authored-by: Max Horn <max@quendi.de>
4 participants
Add a documentation page for the ideal interface.
This is addressing #1733 and comments in #2108. I plan to extend this slightly later
@fingolfin