Merge pull request #4010 from JuliaReach/schillic/convert_sspz

Move `convert` method to `SimpleSparsePolynomialZonotopeModule`

Author: schillic

docs/src/lib/conversion.md

@@ -39,7 +39,6 @@ convert(::Type{MinkowskiSumArray}, ::MinkowskiSum{N, ST, MinkowskiSumArray{N, ST
 convert(::Type{STAR}, ::AbstractPolyhedron{N}) where {N}
 convert(::Type{STAR}, ::Star)
 convert(::Type{SimpleSparsePolynomialZonotope}, ::AbstractZonotope)
-convert(::Type{SimpleSparsePolynomialZonotope}, ::AbstractSparsePolynomialZonotope)
 convert(::Type{SparsePolynomialZonotope}, ::AbstractZonotope{N}) where {N}
 convert(::Type{SparsePolynomialZonotope}, ::SimpleSparsePolynomialZonotope{N}) where {N}
 ```

docs/src/lib/sets/SimpleSparsePolynomialZonotope.md

@@ -8,8 +8,10 @@ CurrentModule = LazySets.SimpleSparsePolynomialZonotopeModule
 SimpleSparsePolynomialZonotope
 ```
 
-```@meta
-CurrentModule = LazySets
+## Conversion
+
+```julia
+convert(::Type{SimpleSparsePolynomialZonotope}, ::AbstractSparsePolynomialZonotope)
 ```
 
 ## Operations

src/Convert/SimpleSparsePolynomialZonotope.jl

@@ -16,36 +16,10 @@ A simple sparse polynomial zonotope.
 
 This method implements [KochdumperA21; Proposition 3](@citet).
 """
-function Base.convert(::Type{SimpleSparsePolynomialZonotope}, Z::AbstractZonotope)
+function convert(::Type{SimpleSparsePolynomialZonotope}, Z::AbstractZonotope)
     c = center(Z)
     G = genmat(Z)
     n = ngens(Z)
     E = Matrix(1 * I, n, n)
     return SimpleSparsePolynomialZonotope(c, G, E)
 end
-
-"""
-    convert(::Type{SimpleSparsePolynomialZonotope}, SPZ::AbstractSparsePolynomialZonotope)
-
-Convert a sparse polynomial zonotope to simple sparse polynomial zonotope.
-
-### Input
-
-- `SimpleSparsePolynomialZonotope` -- target type
-- `SPZ`                            -- sparse polynomial zonotope
-
-### Output
-
-A simple sparse polynomial zonotope.
-
-### Algorithm
-
-The method implements [Kochdumper21a; Proposition 3.1.4](@citet).
-"""
-function Base.convert(::Type{SimpleSparsePolynomialZonotope}, SPZ::AbstractSparsePolynomialZonotope)
-    c = center(SPZ)
-    G = hcat(genmat_dep(SPZ), genmat_indep(SPZ))
-    n = ngens_indep(SPZ)
-    E = cat(expmat(SPZ), Matrix(1 * I, n, n); dims=(1, 2))
-    return SimpleSparsePolynomialZonotope(c, G, E)
-end

src/Sets/SimpleSparsePolynomialZonotope/SimpleSparsePolynomialZonotopeModule.jl

@@ -4,7 +4,7 @@ using Reexport
 
 using ..LazySets: AbstractSparsePolynomialZonotope, ngens_dep, nparams,
                   _remove_redundant_generators_polyzono, @validate
-using LinearAlgebra: dot
+using LinearAlgebra: dot, I
 using Random: AbstractRNG, GLOBAL_RNG
 using ReachabilityBase.Distribution: reseed!
 using ReachabilityBase.Comparison: isapproxzero
@@ -15,6 +15,7 @@ using ReachabilityBase.Comparison: isapproxzero
 @reexport import ..LazySets: expmat, genmat, genmat_dep, genmat_indep, ngens,
                              ngens_indep, polynomial_order,
                              remove_redundant_generators
+import Base: convert
 @reexport using ..API
 
 export SimpleSparsePolynomialZonotope,
@@ -46,4 +47,6 @@ include("remove_redundant_generators.jl")
 include("expmat.jl")
 include("quadratic_map.jl")
 
+include("convert.jl")
+
 end  # module

src/Sets/SimpleSparsePolynomialZonotope/convert.jl

@@ -0,0 +1,25 @@
+"""
+    convert(::Type{SimpleSparsePolynomialZonotope}, SPZ::AbstractSparsePolynomialZonotope)
+
+Convert a sparse polynomial zonotope to simple sparse polynomial zonotope.
+
+### Input
+
+- `SimpleSparsePolynomialZonotope` -- target type
+- `SPZ`                            -- sparse polynomial zonotope
+
+### Output
+
+A simple sparse polynomial zonotope.
+
+### Algorithm
+
+The method implements [Kochdumper21a; Proposition 3.1.4](@citet).
+"""
+function Base.convert(::Type{SimpleSparsePolynomialZonotope}, SPZ::AbstractSparsePolynomialZonotope)
+    c = center(SPZ)
+    G = hcat(genmat_dep(SPZ), genmat_indep(SPZ))
+    n = ngens_indep(SPZ)
+    E = cat(expmat(SPZ), Matrix(1 * I, n, n); dims=(1, 2))
+    return SimpleSparsePolynomialZonotope(c, G, E)
+end

test/Sets/SimpleSparsePolynomialZonotope.jl

@@ -149,6 +149,13 @@ for N in @tN([Float64, Float32, Rational{Int}])
     P2 = copy(P)
     translate!(P2, N[1, 2])
     @test P2 == TPZ
+
+    # convert
+    SPZ = SparsePolynomialZonotope(N[4, 4], N[2 1 2; 0 2 2], hcat(N[1; 0]), [1 0 3; 0 1 1])
+    SSPZ = convert(SimpleSparsePolynomialZonotope, SPZ)
+    @test center(SSPZ) == center(SPZ)
+    @test genmat(SSPZ) == hcat(SPZ.G, SPZ.GI)
+    @test expmat(SSPZ) == [1 0 3 0; 0 1 1 0; 0 0 0 1]
 end
 
 for N in @tN([Float64, Float32])
@@ -162,11 +169,3 @@ for Z in [rand(Zonotope), rand(Hyperrectangle)]
     @test genmat(ZS) == genmat(Z)
     @test expmat(ZS) == I
 end
-
-let
-    SPZ = SparsePolynomialZonotope([4.0, 4], [2.0 1 2; 0 2 2], hcat([1.0; 0]), [1 0 3; 0 1 1])
-    SSPZ = convert(SimpleSparsePolynomialZonotope, SPZ)
-    @test center(SSPZ) == center(SPZ)
-    @test genmat(SSPZ) == hcat(SPZ.G, SPZ.GI)
-    @test expmat(SSPZ) == [1 0 3 0; 0 1 1 0; 0 0 0 1]
-end