Document ideal interface #2113
Document ideal interface #2113
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2113 +/- ##
==========================================
- Coverage 88.35% 88.00% -0.35%
==========================================
Files 126 126
Lines 31674 31654 -20
==========================================
- Hits 27984 27856 -128
- Misses 3690 3798 +108 ☔ 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. |
|
|
||
| Currently AbstractAlgebra.jl provides ideals of a Euclidean domain (assuming the existence of a `gcdx` function) | ||
| or of a univariate or multivariate polynomial ring over the integers. | ||
| Univariate and multivariate polynomial rings over other | ||
| domains (other than fields) are not supported at this time. |
There was a problem hiding this comment.
This text doesn't seem to belong here? It seems to be about the Genric.Ideal type?
| Currently AbstractAlgebra.jl provides ideals of a Euclidean domain (assuming the existence of a `gcdx` function) | |
| or of a univariate or multivariate polynomial ring over the integers. | |
| Univariate and multivariate polynomial rings over other | |
| domains (other than fields) are not supported at this time. |
There was a problem hiding this comment.
I though it might be useful to briefly describe the existing functionality in order to give some context to people, who want to expand on this.
| ``` | ||
| ```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 <[email protected]>
Add a documentation page for the ideal interface.
This is addressing #1733 and comments in #2108. I plan to extend this slightly later
@fingolfin