diff --git a/docs/make.jl b/docs/make.jl index b8b051e9..b0613311 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -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( diff --git a/docs/src/division.md b/docs/src/division.md index d126550b..fe11e597 100644 --- a/docs/src/division.md +++ b/docs/src/division.md @@ -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 ``` @@ -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 diff --git a/docs/src/index.md b/docs/src/index.md index 5daba16f..95da3624 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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 ``` diff --git a/docs/src/internal.md b/docs/src/internal.md new file mode 100644 index 00000000..43c463b7 --- /dev/null +++ b/docs/src/internal.md @@ -0,0 +1,9 @@ +# Internal + +Internal utilities: +```@docs +pair_zip +vec +print_maybe_multiplication_sign +LazyMap +``` diff --git a/docs/src/substitution.md b/docs/src/substitution.md index f5c9c381..fafb0d81 100644 --- a/docs/src/substitution.md +++ b/docs/src/substitution.md @@ -12,4 +12,5 @@ However, if some variables only are replaced by `Int` then the return type shoul ```@docs subs +substitute ``` diff --git a/docs/src/types.md b/docs/src/types.md index fdbe53fe..3bbeb8d0 100644 --- a/docs/src/types.md +++ b/docs/src/types.md @@ -90,6 +90,7 @@ extdegree leading_term leading_coefficient leading_monomial +deg_num_leading_terms remove_leading_term remove_monomials filter_terms diff --git a/src/division.jl b/src/division.jl index 889064b9..7ca299c4 100644 --- a/src/division.jl +++ b/src/division.jl @@ -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)