Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Outsource Hyperplane to its own module #3590

Merged
merged 5 commits into from
Jul 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 22 additions & 12 deletions docs/src/lib/sets/Hyperplane.md
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
1 change: 0 additions & 1 deletion src/Initialization/init_SymEngine.jl
Original file line number Diff 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())
1 change: 0 additions & 1 deletion src/Initialization/init_Symbolics.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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())
7 changes: 6 additions & 1 deletion src/LazySets.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading