Merge pull request #126 from JuliaAlgebra/bl/effective_variables

Add effective_variables

Author: blegat

docs/Project.toml

@@ -3,4 +3,4 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 MultivariatePolynomials = "102ac46a-7ee4-5c85-9060-abc95bfdeaa3"
 
 [compat]
-Documenter = "^0.19.6"
+Documenter = "^0.24.3"

docs/make.jl

@@ -1,8 +1,15 @@
 using Documenter, MultivariatePolynomials
 
 makedocs(
-    format = :html,
     sitename = "MultivariatePolynomials",
+
+    format = Documenter.HTML(
+        # See https://github.com/JuliaDocs/Documenter.jl/issues/868
+        prettyurls = get(ENV, "CI", nothing) == "true"
+    ),
+    # See https://github.com/JuliaOpt/JuMP.jl/issues/1576
+    strict = true,
+
     pages = [
         "Introduction" => "index.md",
         "Types" => "types.md",
@@ -14,9 +21,4 @@ makedocs(
 
 deploydocs(
     repo   = "github.com/JuliaAlgebra/MultivariatePolynomials.jl.git",
-    target = "build",
-    osname = "linux",
-    julia  = "1.0",
-    deps   = nothing,
-    make   = nothing,
 )

docs/src/types.md

@@ -23,6 +23,7 @@ AbstractMonomialLike
 AbstractMonomial
 monomialtype
 variables
+effective_variables
 nvariables
 exponents
 degree
@@ -56,7 +57,7 @@ polynomialtype
 terms
 nterms
 coefficients
-coefficient(p::AbstractPolynomialLike, vars, m::AbstractMonomialLike)
+coefficient(p::AbstractPolynomialLike, m::AbstractMonomialLike, vars)
 monomials
 mindegree
 maxdegree

src/polynomial.jl

@@ -1,6 +1,6 @@
 export polynomial, polynomial!, polynomialtype, terms, nterms, coefficients, monomials
 export coefficienttype, monomialtype
-export mindegree, maxdegree, extdegree
+export mindegree, maxdegree, extdegree, effective_variables
 export leadingterm, leadingcoefficient, leadingmonomial
 export removeleadingterm, removemonomials, monic
 
@@ -258,6 +258,18 @@ function extdegree(p::Union{AbstractPolynomialLike, AbstractVector{<:AbstractTer
     (mindegree(p, args...), maxdegree(p, args...))
 end
 
+"""
+    effective_variables(p::AbstractPolynomialLike)
+
+Return a vector of `eltype` `variable_union_type(p)` (see [`variable_union_type`](@ref)),
+containing all the variables that has nonzero degree in at least one term.
+That is, return all the variables `v` such that `maxdegree(p, v)` is not zero.
+"""
+function effective_variables(p::AbstractPolynomialLike)
+    VT = variable_union_type(p)
+    return VT[v for v in variables(p) if !iszero(maxdegree(p, v))]
+end
+
 """
     leadingterm(p::AbstractPolynomialLike)
 

src/variable.jl

@@ -1,4 +1,4 @@
-export name, name_base_indices, similarvariable, @similarvariable
+export name, name_base_indices, similarvariable, @similarvariable, variable_union_type
 
 Base.copy(x::AbstractVariable) = x
 

test/monomial.jl

@@ -51,4 +51,19 @@ const MP = MultivariatePolynomials
     @test adjoint(x) == x
     @test transpose(x^2) == x^2
     @test adjoint(x^2) == x^2
+
+    @testset "Effective variables" begin
+        T = variable_union_type(x)
+        @test x isa T
+        @test y[2] isa T
+        @test T[x, y[2]] == @inferred effective_variables(x * y[2])
+        @test T[x, y[2]] == @inferred effective_variables(y[2] * x)
+        @test T[x] == @inferred effective_variables(x * y[2]^0)
+        @test T[x] == @inferred effective_variables(y[2]^0 * x)
+        @test T[y[2]] == @inferred effective_variables(x^0 * y[2])
+        @test T[y[2]] == @inferred effective_variables(y[2] * x^0)
+        @test T[x, y[2]] == @inferred effective_variables(y[3]^0 * x * y[2])
+        @test T[x, y[2]] == @inferred effective_variables(y[2] * y[3]^0 * x)
+        @test T[x, y[2]] == @inferred effective_variables(y[2] * x * y[3]^0)
+    end
 end

test/polynomial.jl

@@ -154,4 +154,16 @@ const MP = MultivariatePolynomials
         @test variables(v)[1] == x
         @test variables(v)[2] == y
     end
+
+    @testset "Effective variables" begin
+        Mod.@polyvar x y z
+        T = variable_union_type(x)
+        @test x isa T
+        @test y isa T
+        @test z isa T
+        @test T[x] == @inferred effective_variables(x + y - y)
+        @test T[x, y] == @inferred effective_variables(z + x + y - z)
+        @test T[y, z] == @inferred effective_variables(z + 0 * x + y)
+        @test T[z] == @inferred effective_variables(z + 0 * x + y^0)
+    end
 end

test/term.jl

@@ -48,4 +48,17 @@
 
     @test_throws InexactError push!([1], 2x)
     @test_throws ErrorException push!([x^2], 2x)
+
+
+    @testset "Effective variables" begin
+        T = variable_union_type(x)
+        @test x isa T
+        @test y isa T
+        @test T[x, y] == @inferred effective_variables(x * y)
+        @test T[x, y] == @inferred effective_variables(y * x)
+        @test T[x] == @inferred effective_variables(x * y^0)
+        @test T[x] == @inferred effective_variables(y^0 * x)
+        @test T[y] == @inferred effective_variables(x^0 * y)
+        @test T[y] == @inferred effective_variables(y * x^0)
+    end
 end

test/variable.jl

@@ -49,6 +49,11 @@ import MultivariatePolynomials: AbstractVariable, similarvariable, @similarvaria
                 end
             end
         end
+
+        @testset "Effective variables" begin
+            @test [x] == @inferred effective_variables(x)
+            @test [y] == @inferred effective_variables(y)
+        end
     end
     @testset "Create similar variable" begin
         Mod.@polyvar x y