Skip to content

Commit

Permalink
Fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
blegat committed May 2, 2024
1 parent d56925e commit f3be67a
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 6 deletions.
7 changes: 6 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,12 @@ makedocs(
"Substitution" => "substitution.md",
"Differentiation" => "differentiation.md",
"Division" => "division.md",
]
"Internal" => "internal.md",
],

# The following ensures that we only include the docstrings from
# this module for functions define in Base that we overwrite.
modules = [MultivariatePolynomials],
)

deploydocs(
Expand Down
4 changes: 1 addition & 3 deletions docs/src/division.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ Given a polynomial ``p`` and divisors ``d_1, \ldots, d_n``, one can find ``r`` a
You can obtain the vector ``[q_1, \ldots, q_n]`` using `div(p, d)` where ``d = [d_1, \ldots, d_n]`` and ``r`` using the `rem` function with the same arguments.
The `divrem` function returns ``(q, r)``.
```@docs
divrem
div
rem
divides
div_multiple
```
Expand All @@ -32,6 +29,7 @@ obtained for integers respectively with the `gcd` and `lcm` functions.
The same functions can be used with monomials and polynomials:
```@docs
gcd
lcm
AbstractUnivariateGCDAlgorithm
GeneralizedEuclideanAlgorithm
SubresultantAlgorithm
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ The following packages extend the interface and/or implement algorithms using th

## Contents
```@contents
Pages = ["types.md", "substitution.md", "differentiation.md", "division.md"]
Pages = ["types.md", "substitution.md", "differentiation.md", "division.md", "internal.md"]
Depth = 3
```
9 changes: 9 additions & 0 deletions docs/src/internal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Internal

Internal utilities:
```@docs
pair_zip
vec
print_maybe_multiplication_sign
LazyMap
```
1 change: 1 addition & 0 deletions docs/src/substitution.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ However, if some variables only are replaced by `Int` then the return type shoul

```@docs
subs
substitute
```
1 change: 1 addition & 0 deletions docs/src/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ extdegree
leading_term
leading_coefficient
leading_monomial
deg_num_leading_terms
remove_leading_term
remove_monomials
filter_terms
Expand Down
2 changes: 1 addition & 1 deletion src/division.jl
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ end
"""
rem_or_pseudo_rem(f::_APL, g::_APL, algo)
If the coefficient type is a field, return `rem`, otherwise, return [`pseudo_rem`](ref).
If the coefficient type is a field, return `rem`, otherwise, return [`pseudo_rem`](@ref).
"""
function rem_or_pseudo_rem(f::_APL, g::_APL, algo)
return MA.operate!!(rem_or_pseudo_rem, MA.mutable_copy(f), g, algo)
Expand Down

0 comments on commit f3be67a

Please sign in to comment.