Merge pull request #3590 from JuliaReach/schillic/Hyperplane

Outsource `Hyperplane` to its own module
JuliaReach · Jul 17, 2024 · b9ec396 · b9ec396
2 parents d709a6e + fe62218
commit b9ec396
Show file tree

Hide file tree

Showing 30 changed files with 890 additions and 822 deletions.
diff --git a/docs/src/lib/sets/Hyperplane.md b/docs/src/lib/sets/Hyperplane.md
@@ -1,34 +1,44 @@
 ```@meta
-CurrentModule = LazySets
+CurrentModule = LazySets.HyperplaneModule
 ```
 
 # [Hyperplane](@id def_Hyperplane)
 
 ```@docs
 Hyperplane
-dim(::Hyperplane)
-ρ(::AbstractVector, ::Hyperplane)
-σ(::AbstractVector, ::Hyperplane)
-∈(::AbstractVector, ::Hyperplane)
+```
+
+## Operations
+
+```@docs
 an_element(::Hyperplane)
-rand(::Type{Hyperplane})
-isbounded(::Hyperplane)
-isuniversal(::Hyperplane, ::Bool=false)
-isempty(::Hyperplane)
 constrained_dimensions(::Hyperplane)
 constraints_list(::Hyperplane)
-translate(::Hyperplane, ::AbstractVector)
+dim(::Hyperplane)
+isbounded(::Hyperplane)
+isempty(::Hyperplane)
+isuniversal(::Hyperplane, ::Bool=false)
 normalize(::Hyperplane{N}, p::Real=N(2)) where {N}
+rand(::Type{Hyperplane})
 distance(::AbstractVector, ::Hyperplane{N}) where {N}
-reflect(::AbstractVector, ::Hyperplane)
+∈(::AbstractVector, ::Hyperplane)
 project(::AbstractVector, ::Hyperplane)
+reflect(::AbstractVector, ::Hyperplane)
+ρ(::AbstractVector, ::Hyperplane)
+σ(::AbstractVector, ::Hyperplane)
+translate(::Hyperplane, ::AbstractVector)
+```
+
+```@meta
+CurrentModule = LazySets
 ```
+
 Inherited from [`LazySet`](@ref):
+* [`diameter`](@ref diameter(::LazySet, ::Real))
 * [`high`](@ref high(::LazySet))
 * [`low`](@ref low(::LazySet))
 * [`norm`](@ref norm(::LazySet, ::Real))
 * [`radius`](@ref radius(::LazySet, ::Real))
-* [`diameter`](@ref diameter(::LazySet, ::Real))
 * [`reflect`](@ref reflect(::LazySet))
 
 Inherited from [`AbstractPolyhedron`](@ref):

diff --git a/src/Initialization/init_SymEngine.jl b/src/Initialization/init_SymEngine.jl
@@ -80,5 +80,4 @@ function free_symbols(expr::Expr)
     end
 end
 
-eval(load_symengine_hyperplane())
 eval(load_symengine_halfspace())
diff --git a/src/Initialization/init_Symbolics.jl b/src/Initialization/init_Symbolics.jl
@@ -17,5 +17,4 @@ function _get_variables(expr::Vector{<:Num})
     return unique(reduce(vcat, _get_variables(ex) for ex in expr))
 end
 
-eval(load_symbolics_hyperplane())
 eval(load_symbolics_halfspace())
diff --git a/src/LazySets.jl b/src/LazySets.jl
@@ -137,7 +137,12 @@ include("Sets/HParallelotope/HParallelotopeModule.jl")
                                         extremal_vertices,
                                         offset
 
-include("Sets/Hyperplane.jl")
+include("Sets/Hyperplane/HyperplaneModule.jl")
+@reexport using ..HyperplaneModule: Hyperplane
+using ..HyperplaneModule: _an_element_helper_hyperplane,
+                          _constraints_list_hyperplane,
+                          _reflect_point_hyperplane,
+                          _σ_hyperplane_halfspace
 
 include("Sets/Hyperrectangle/HyperrectangleModule.jl")
 @reexport using ..HyperrectangleModule: Hyperrectangle
-Original file line number
+Diff line change
@@ Expand Up / @@ -80,5 +80,4 @@ function free_symbols(expr::Expr) @@
         end
     end
-    eval(load_symengine_hyperplane())
     eval(load_symengine_halfspace())