Formatted and fixed doctests

Author: alecarraro

docs/src/lib/sets/ZonotopeMD.md

@@ -2,19 +2,17 @@
 CurrentModule = LazySets.ZonotopeModule
 ```
 
-# [Zonotope](@id def_ZonotopeMD)
+# [ZonotopeMD](@id def_ZonotopeMD)
 
 ```@docs
 ZonotopeMD
 ```
 
 ## Operations
+
 ```@docs
 genmat(::ZonotopeMD)
-cartesian_product(Z1::ZonotopeMD, Z2::ZonotopeMD)
-```
-
-Undocumented implementations:
-
-* [`center`](@ref center(::LazySet))
-* [`ngens`](@ref ngens(::AbstractZonotope))
+cartesian_product(::ZonotopeMD, ::ZonotopeMD)
+center(::ZonotopeMD)
+ngens(::ZonotopeMD)
+```

src/Sets/Zonotope/ZonotopeMD/ZonotopeMD.jl

@@ -30,24 +30,27 @@ Constructing a zonotope in normal form from a center, general generator matrix `
 
 ```jldoctest zonotopemd_label
 julia> c = [0.0, 0.0];
+
 julia> M = [1.0 2.0; 3.0 1.0];
+
 julia> d = [0.1, 0.2];
+
 julia> Z = ZonotopeMD(c, M, d)
-ZonotopeMD{Float64, Vector{Float64}, Matrix{Float64}, Vector{Float64}}([0.0, 0.0], [1.0 0.0; 0.0 1.0], [0.1, 0.2])
+ZonotopeMD{Float64, Vector{Float64}, Matrix{Float64}, Vector{Float64}}([0.0, 0.0], [1.0 2.0; 3.0 1.0], [0.1, 0.2])
 
 julia> center(Z)
 2-element Vector{Float64}:
  0.0
  0.0
 
 julia> genmat(Z)
-2×4 Matrix{Float64}:
- 1.0  2.0  0.1  0.0
- 3.0  1.0  0.0  0.2
+2×4 SparseArrays.SparseMatrixCSC{Float64, Int64} with 6 stored entries:
+ 1.0  2.0  0.1   ⋅ 
+ 3.0  1.0   ⋅   0.1
 ```
 
 The generator matrix returned by `genmat` is the concatenation `[M D]`, where `D` is the diagonal matrix formed from `d`.
-
+THe resulting matrix is stored as a sparse matrix.
 Constructing the same zonotope by passing the full generator matrix `[M D]` directly:
 
 ```jldoctest zonotopemd_label
@@ -64,32 +67,34 @@ You can also convert back to a standard `Zonotope` if needed:
 
 ```jldoctest zonotopemd_label
 julia> Zstd = Zonotope(Z)
-Zonotope{Float64, Vector{Float64}, Matrix{Float64}}([0.0, 0.0], [1.0 2.0 0.1 0.0; 3.0 1.0 0.0 0.2])
+Zonotope{Float64, Vector{Float64}, SparseArrays.SparseMatrixCSC{Float64, Int64}}([0.0, 0.0], sparse([1, 2, 1, 2, 1, 2], [1, 1, 2, 2, 3, 4], [1.0, 3.0, 2.0, 1.0, 0.1, 0.2], 2, 4))
 ```
 
 """
-struct ZonotopeMD{N,VN<: AbstractVector{N}, MN<:AbstractMatrix{N},DN<:AbstractVector{N}} <: AbstractZonotope{N}
+struct ZonotopeMD{N,VN<:AbstractVector{N},MN<:AbstractMatrix{N},DN<:AbstractVector{N}} <:
+       AbstractZonotope{N}
     center::VN
     M::MN
     d::DN
 
-    function ZonotopeMD(center::VN, M::MN, d::DN) where {N,
-                                             VN<:AbstractVector{N},
-                                             MN<:AbstractMatrix{N},
-                                             DN<:AbstractVector{N}}
+    function ZonotopeMD(center::VN, M::MN,
+                        d::DN) where {N,
+                                      VN<:AbstractVector{N},
+                                      MN<:AbstractMatrix{N},
+                                      DN<:AbstractVector{N}}
         @assert length(center) == size(M, 1) == length(d) "Dimensions must match"
         return new{N,VN,MN,DN}(center, M, d)
     end
 end
 
 # constructor from generator matrix
-function ZonotopeMD(center::VN, G::AbstractMatrix{N}) where {N, VN<:AbstractVector{N}}
+function ZonotopeMD(center::VN, G::AbstractMatrix{N}) where {N,VN<:AbstractVector{N}}
     n, p = size(G)
     @assert p % n == 0 "The generator matrix must contain a multiple of n columns"
     @assert p >= 2n "Expected at least order 2 zonotope"
 
     M = G[:, 1:(p - n)]
-    D = G[:, end - n + 1:end]
+    D = G[:, (end - n + 1):end]
 
     @assert isdiag(D) "The last n columns of the generator matrix must be diagonal"
     d = diag(D)

src/Sets/Zonotope/ZonotopeMD/cartesian_product.jl

@@ -17,4 +17,4 @@ function cartesian_product(Z1::ZonotopeMD, Z2::ZonotopeMD)
     d = vcat(Z1.d, Z2.d)
     M = blockdiag(sparse(Z1.M), sparse(Z2.M))
     return ZonotopeMD(c, M, d)
-end
+end

src/Sets/Zonotope/ZonotopeMD/center.jl

@@ -1,3 +1,3 @@
 function center(Z::ZonotopeMD)
     return Z.center
-end
+end

src/Sets/Zonotope/ZonotopeMD/convert.jl

@@ -1 +1 @@
-Zonotope(Z::ZonotopeMD) = convert(Zonotope, Z)
+Zonotope(Z::ZonotopeMD) = convert(Zonotope, Z)

src/Sets/Zonotope/ZonotopeMD/genmat.jl

@@ -14,4 +14,4 @@ A matrix where each column represents one generator of the zonotope `Z`.
 function genmat(Z::ZonotopeMD)
     D = spdiagm(0 => Z.d)
     return hcat(Z.M, D)
-end
+end

src/Sets/Zonotope/ZonotopeMD/ngens.jl

@@ -1 +1 @@
-ngens(Z::ZonotopeMD) = size(Z.M, 2) + length(Z.d)
+ngens(Z::ZonotopeMD) = size(Z.M, 2) + length(Z.d)

test/runtests.jl

@@ -150,6 +150,9 @@ if test_suite_basic
     @testset "LazySets.Zonotope" begin
         include("Sets/Zonotope.jl")
     end
+    @testset "LazySets.ZonotopeMD" begin
+        include("Sets/ZonotopeMD.jl")
+    end
     @testset "LazySets.ZeroSet" begin
         include("Sets/ZeroSet.jl")
     end