Outsource DensePolynomialZonotope to its own module

docs/src/lib/sets/DensePolynomialZonotope.md

@@ -1,11 +1,16 @@
 ```@meta
-CurrentModule = LazySets
+CurrentModule = LazySets.DensePolynomialZonotopeModule
 ```
 
 # [Polynomial zonotope (DensePolynomialZonotope)](@id def_DensePolynomialZonotope)
 
 ```@docs
 DensePolynomialZonotope
+```
+
+## Operations
+
+```@docs
 center(::DensePolynomialZonotope)
 ngens_dep(::DensePolynomialZonotope)
 ngens_indep(::DensePolynomialZonotope)
@@ -14,6 +19,10 @@ linear_map(::AbstractMatrix, ::DensePolynomialZonotope)
 scale!(::Real, ::DensePolynomialZonotope)
 ```
 
+```@meta
+CurrentModule = LazySets
+```
+
 Inherited from [`AbstractPolynomialZonotope`](@ref):
 * [`dim`](@ref dim(::AbstractPolynomialZonotope))
 * [`order`](@ref dim(::AbstractPolynomialZonotope))

src/LazySets.jl

@@ -114,7 +114,9 @@ include("Sets/Ballp/BallpModule.jl")
 include("Sets/Ellipsoid/EllipsoidModule.jl")
 @reexport using ..EllipsoidModule: Ellipsoid, shape_matrix
 
-include("Sets/DensePolynomialZonotope.jl")
+include("Sets/DensePolynomialZonotope/DensePolynomialZonotopeModule.jl")
+@reexport using ..DensePolynomialZonotopeModule: DensePolynomialZonotope
+
 include("Sets/HParallelotope.jl")
 include("Sets/HPolygon.jl")
 include("Sets/HPolygonOpt.jl")

src/Sets/DensePolynomialZonotope.jl → src/Sets/DensePolynomialZonotope/DensePolynomialZonotope.jl

@@ -1,5 +1,3 @@
-export DensePolynomialZonotope
-
 """
     DensePolynomialZonotope{N, VT, VMT, MT} <: AbstractPolynomialZonotope{N}
 
@@ -83,123 +81,3 @@ struct DensePolynomialZonotope{N,VT,VMT,MT} <: AbstractPolynomialZonotope{N}
         return new{N,VT,VMT,MT}(c, E, F, G)
     end
 end
-
-isoperationtype(::Type{<:DensePolynomialZonotope}) = false
-
-"""
-    center(P::DensePolynomialZonotope)
-
-Return the center of a polynomial zonotope.
-
-### Input
-
-- `P` -- polynomial zonotope
-
-### Output
-
-The center of `P`.
-"""
-center(P::DensePolynomialZonotope) = P.c
-
-"""
-    polynomial_order(P::DensePolynomialZonotope)
-
-Polynomial order of a polynomial zonotope.
-
-### Input
-
-- `P` -- polynomial zonotope
-
-## Output
-
-The polynomial order, defined as the maximal power of the scale factors ``β_i``.
-It is usually denoted ``η``.
-"""
-polynomial_order(P::DensePolynomialZonotope) = length(P.E)
-
-"""
-    ngens_indep(P::DensePolynomialZonotope)
-
-Return the number of independent generators of a polynomial zonotope.
-
-### Input
-
-- `P` -- polynomial zonotope
-
-### Output
-
-The number of independent generators of `P`.
-"""
-ngens_indep(P::DensePolynomialZonotope) = size(P.G, 2)
-
-"""
-    ngens_dep(P::DensePolynomialZonotope)
-
-Return the number of dependent generators of a polynomial zonotope.
-
-### Input
-
-- `P` -- polynomial zonotope
-
-### Output
-
-The number of dependent generators of `P`.
-"""
-function ngens_dep(P::DensePolynomialZonotope)
-    η = polynomial_order(P)  # polynomial order
-    p = size(P.E[1], 2)  # number of dependent factors
-    return sum(i -> binomial(p + i - 1, i), 1:η)
-end
-
-"""
-    linear_map(M::AbstractMatrix, P::DensePolynomialZonotope)
-
-Return the linear map of a polynomial zonotope.
-
-### Input
-
-- `M` -- matrix
-- `P` -- polynomial zonotope
-
-## Output
-
-A polynomial zonotope.
-
-### Algorithm
-
-The result's starting point and generators are those of `P` multiplied by the
-matrix `M`.
-"""
-function linear_map(M::AbstractMatrix, P::DensePolynomialZonotope)
-    c = M * P.c
-    E = [M * Ei for Ei in P.E]
-    F = [M * Fi for Fi in P.F]
-    G = M * P.G
-    return DensePolynomialZonotope(c, E, F, G)
-end
-
-"""
-    scale!(α::Real, P::DensePolynomialZonotope)
-
-Scale a polynomial zonotope modified by a scale factor in-place.
-
-### Input
-
-- `α` -- scaling factor
-- `P` -- polynomial zonotope
-
-## Output
-
-The modified polynomial zonotope.
-
-### Algorithm
-
-The center and generators are scaled by ``α``.
-"""
-function scale!(α::Real, P::DensePolynomialZonotope)
-    P.c .*= α
-    P.E .*= α
-    P.F .*= α
-    P.G .*= α
-    return P
-end

src/Sets/DensePolynomialZonotope/DensePolynomialZonotopeModule.jl

@@ -0,0 +1,24 @@
+module DensePolynomialZonotopeModule
+
+using Reexport
+
+using ..LazySets: AbstractPolynomialZonotope
+
+@reexport import ..API: center, isoperationtype, linear_map, scale!
+@reexport import ..LazySets: ngens_dep, ngens_indep, polynomial_order
+@reexport using ..API
+
+export DensePolynomialZonotope
+
+include("DensePolynomialZonotope.jl")
+
+include("center.jl")
+include("isoperationtype.jl")
+include("linear_map.jl")
+include("scale.jl")
+
+include("ngens_dep.jl")
+include("ngens_indep.jl")
+include("polynomial_order.jl")
+
+end  # module

src/Sets/DensePolynomialZonotope/center.jl

@@ -0,0 +1,14 @@
+"""
+    center(P::DensePolynomialZonotope)
+
+Return the center of a polynomial zonotope.
+
+### Input
+
+- `P` -- polynomial zonotope
+
+### Output
+
+The center of `P`.
+"""
+center(P::DensePolynomialZonotope) = P.c

src/Sets/DensePolynomialZonotope/isoperationtype.jl

@@ -0,0 +1 @@
+isoperationtype(::Type{<:DensePolynomialZonotope}) = false

src/Sets/DensePolynomialZonotope/linear_map.jl

@@ -0,0 +1,26 @@
+"""
+    linear_map(M::AbstractMatrix, P::DensePolynomialZonotope)
+
+Return the linear map of a polynomial zonotope.
+
+### Input
+
+- `M` -- matrix
+- `P` -- polynomial zonotope
+
+## Output
+
+A polynomial zonotope.
+
+### Algorithm
+
+The result's starting point and generators are those of `P` multiplied by the
+matrix `M`.
+"""
+function linear_map(M::AbstractMatrix, P::DensePolynomialZonotope)
+    c = M * P.c
+    E = [M * Ei for Ei in P.E]
+    F = [M * Fi for Fi in P.F]
+    G = M * P.G
+    return DensePolynomialZonotope(c, E, F, G)
+end

src/Sets/DensePolynomialZonotope/ngens_dep.jl

@@ -0,0 +1,18 @@
+"""
+    ngens_dep(P::DensePolynomialZonotope)
+
+Return the number of dependent generators of a polynomial zonotope.
+
+### Input
+
+- `P` -- polynomial zonotope
+
+### Output
+
+The number of dependent generators of `P`.
+"""
+function ngens_dep(P::DensePolynomialZonotope)
+    η = polynomial_order(P)  # polynomial order
+    p = size(P.E[1], 2)  # number of dependent factors
+    return sum(i -> binomial(p + i - 1, i), 1:η)
+end

src/Sets/DensePolynomialZonotope/ngens_indep.jl

@@ -0,0 +1,14 @@
+"""
+    ngens_indep(P::DensePolynomialZonotope)
+
+Return the number of independent generators of a polynomial zonotope.
+
+### Input
+
+- `P` -- polynomial zonotope
+
+### Output
+
+The number of independent generators of `P`.
+"""
+ngens_indep(P::DensePolynomialZonotope) = size(P.G, 2)

src/Sets/DensePolynomialZonotope/polynomial_order.jl

@@ -0,0 +1,15 @@
+"""
+    polynomial_order(P::DensePolynomialZonotope)
+
+Polynomial order of a polynomial zonotope.
+
+### Input
+
+- `P` -- polynomial zonotope
+
+## Output
+
+The polynomial order, defined as the maximal power of the scale factors ``β_i``.
+It is usually denoted ``η``.
+"""
+polynomial_order(P::DensePolynomialZonotope) = length(P.E)

src/Sets/DensePolynomialZonotope/scale.jl

@@ -0,0 +1,25 @@
+"""
+    scale!(α::Real, P::DensePolynomialZonotope)
+
+Scale a polynomial zonotope modified by a scale factor in-place.
+
+### Input
+
+- `α` -- scaling factor
+- `P` -- polynomial zonotope
+
+## Output
+
+The modified polynomial zonotope.
+
+### Algorithm
+
+The center and generators are scaled by ``α``.
+"""
+function scale!(α::Real, P::DensePolynomialZonotope)
+    P.c .*= α
+    P.E .*= α
+    P.F .*= α
+    P.G .*= α
+    return P
+end

test/Sets/DensePolynomialZonotope.jl

@@ -25,4 +25,7 @@ for N in [Float64, Float32, Rational{Int}]
     z = Zonotope(N[1.0, 2.0], Matrix(N(1)I, 2, 2))
     minkowski_sum(P, z)
     minkowski_sum(z, P)
+
+    # isoperationtype
+    @test !isoperationtype(DensePolynomialZonotope)
 end