Merge pull request #3683 from JuliaReach/schillic/docs

Revise some docs entries
JuliaReach · Dec 20, 2024 · 1fa0049 · 1fa0049
2 parents b194b8b + b73a110
commit 1fa0049
Show file tree

Hide file tree

Showing 7 changed files with 65 additions and 21 deletions.
diff --git a/docs/src/lib/interfaces/AbstractCentrallySymmetric.md b/docs/src/lib/interfaces/AbstractCentrallySymmetric.md
@@ -25,7 +25,6 @@ CurrentModule = LazySets.API
 ```
 ```@docs; canonical=false
 center(::LazySet)
-center(::LazySet, ::Int)
 ```
 ```@meta
 CurrentModule = LazySets

diff --git a/docs/src/lib/sets/BallInf.md b/docs/src/lib/sets/BallInf.md
@@ -141,38 +141,48 @@ Inherited from [`AbstractPolyhedron`](@ref):
 
 Inherited from [`AbstractPolytope`](@ref):
 * [`isbounded`](@ref isbounded(::AbstractPolytope))
-* [`isboundedtype`](@ref isboundedtype(::Type{AbstractPolytope}))
+```@meta
+CurrentModule = LazySets.API
+```
+* [`isboundedtype`](@ref isboundedtype(::Type{LazySet}))
+```@meta
+CurrentModule = LazySets
+```
 
 Inherited from [`AbstractCentrallySymmetricPolytope`](@ref):
 * [`an_element`](@ref an_element(::AbstractCentrallySymmetricPolytope))
-* [`center`](@ref center(::LazySet, ::Int))
+* [`center`](@ref center(::AbstractCentrallySymmetricPolytope, ::Int))
 * [`dim`](@ref dim(::AbstractCentrallySymmetricPolytope))
 * [`isempty`](@ref isempty(::AbstractCentrallySymmetricPolytope))
-* [`isuniversal`](@ref isuniversal(::AbstractPolytope, ::Bool=false))
+* [`isuniversal`](@ref isuniversal(::AbstractCentrallySymmetricPolytope, ::Bool=false))
 
 Inherited from [`AbstractZonotope`](@ref):
 * [`order`](@ref order(::AbstractZonotope))
+* [`remove_redundant_generators`](@ref remove_redundant_generators(::AbstractZonotope))
 * [`togrep`](@ref togrep(::AbstractZonotope))
 * [`linear_map`](@ref linear_map(::AbstractMatrix, ::AbstractZonotope))
+* [`reduce_order`](@ref reduce_order(::AbstractZonotope, ::Real, ::AbstractReductionMethod=GIR05()))
+* [`split`](@ref split(::AbstractZonotope, ::Int))
+* [`split`](@ref split(::AbstractZonotope, ::AbstractVector{Int}, ::AbstractVector{Int}))
 
 Inherited from [`AbstractHyperrectangle`](@ref):
+* [`constraints_list`](@ref constraints_list(::AbstractHyperrectangle))
+* [`extrema`](@ref extrema(::AbstractHyperrectangle))
+* [`extrema`](@ref extrema(::AbstractHyperrectangle, ::Int))
+* [`generators`](@ref generators(::AbstractHyperrectangle))
+* [`genmat`](@ref genmat(::AbstractHyperrectangle))
 ```@meta
 CurrentModule = LazySets.API
 ```
-* [`cartesian_product`](@ref cartesian_product(::LazySet, ::LazySet))
+* [`isconvextype`](@ref isconvextype(::Type{LazySet}))
 ```@meta
 CurrentModule = LazySets
 ```
-* [`constraints_list`](@ref constraints_list(::AbstractHyperrectangle))
-* [`extrema`](@ref extrema(::AbstractHyperrectangle))
-* [`extrema`](@ref extrema(::AbstractHyperrectangle, ::Int))
-* [`generators`](@ref generators(::AbstractHyperrectangle))
-* [`genmat`](@ref genmat(::AbstractHyperrectangle))
-* [`isboundedtype`](@ref isboundedtype(::Type{AbstractHyperrectangle}))
 * [`norm`](@ref norm(::AbstractHyperrectangle, ::Real))
 * [`rectify`](@ref rectify(::AbstractHyperrectangle))
 * [`vertices_list`](@ref vertices_list(::AbstractHyperrectangle))
 * [`∈`](@ref ∈(::AbstractVector, ::AbstractHyperrectangle))
+* [`cartesian_product`](@ref cartesian_product(::AbstractHyperrectangle, ::AbstractHyperrectangle))
 * [`difference`](@ref difference(::AbstractHyperrectangle, ::AbstractHyperrectangle))
 * [`distance`](@ref distance(::AbstractHyperrectangle, ::AbstractHyperrectangle))
 * [`intersection`](@ref intersection(::AbstractHyperrectangle, ::AbstractHyperrectangle))

diff --git a/docs/src/lib/sets/LineSegment.md b/docs/src/lib/sets/LineSegment.md
@@ -127,7 +127,6 @@ Inherited from [`LazySet`](@ref):
 * [`low`](@ref low(::LazySet))
 * [`norm`](@ref norm(::LazySet, ::Real))
 * [`radius`](@ref radius(::LazySet, ::Real))
-* [`reflect`](@ref reflect(::LazySet))
 * [`singleton_list`](@ref singleton_list(::LazySet))
 * [`surface`](@ref surface(::LazySet))
 * [`vertices`](@ref vertices(::LazySet))
@@ -151,8 +150,14 @@ Inherited from [`AbstractPolyhedron`](@ref):
 
 Inherited from [`AbstractPolytope`](@ref):
 * [`isbounded`](@ref isbounded(::AbstractPolytope))
-* [`isboundedtype`](@ref isboundedtype(::Type{AbstractPolytope}))
-* [`isconvextype`](@ref isconvextype(::Type{AbstractPolytope}))
+```@meta
+CurrentModule = LazySets.API
+```
+* [`isboundedtype`](@ref isboundedtype(::Type{LazySet}))
+* [`isconvextype`](@ref isconvextype(::Type{LazySet}))
+```@meta
+CurrentModule = LazySets
+```
 * [`volume`](@ref volume(::AbstractPolytope))
 
 Inherited from [`AbstractCentrallySymmetricPolytope`](@ref):
@@ -164,8 +169,12 @@ Inherited from [`AbstractCentrallySymmetricPolytope`](@ref):
 Inherited from [`AbstractZonotope`](@ref):
 * [`order`](@ref order(::AbstractZonotope))
 * [`reflect`](@ref reflect(::AbstractZonotope))
+* [`remove_redundant_generators`](@ref remove_redundant_generators(::AbstractZonotope))
 * [`togrep`](@ref togrep(::AbstractZonotope))
 * [`linear_map`](@ref linear_map(::AbstractMatrix, ::AbstractZonotope))
+* [`reduce_order`](@ref reduce_order(::AbstractZonotope, ::Real, ::AbstractReductionMethod=GIR05()))
+* [`split`](@ref split(::AbstractZonotope, ::Int))
+* [`split`](@ref split(::AbstractZonotope, ::AbstractVector{Int}, ::AbstractVector{Int}))
 * [`cartesian_product`](@ref cartesian_product(::AbstractZonotope, ::AbstractZonotope))
 * [`minkowski_difference`](@ref minkowski_difference(::AbstractZonotope, ::AbstractZonotope))
 * [`minkowski_sum`](@ref minkowski_sum(::AbstractZonotope, ::AbstractZonotope))
diff --git a/docs/src/lib/sets/Singleton.md b/docs/src/lib/sets/Singleton.md
@@ -95,7 +95,13 @@ Inherited from [`AbstractPolyhedron`](@ref):
 
 Inherited from [`AbstractPolytope`](@ref):
 * [`isbounded`](@ref isbounded(::AbstractPolytope))
-* [`isboundedtype`](@ref isboundedtype(::Type{AbstractPolytope}))
+```@meta
+CurrentModule = LazySets.API
+```
+* [`isboundedtype`](@ref isboundedtype(::Type{LazySet}))
+```@meta
+CurrentModule = LazySets
+```
 
 Inherited from [`AbstractCentrallySymmetricPolytope`](@ref):
 * [`an_element`](@ref an_element(::AbstractCentrallySymmetricPolytope))
@@ -105,12 +111,17 @@ Inherited from [`AbstractCentrallySymmetricPolytope`](@ref):
 
 Inherited from [`AbstractZonotope`](@ref):
 * [`order`](@ref order(::AbstractZonotope))
+* [`remove_redundant_generators`](@ref remove_redundant_generators(::AbstractZonotope))
 * [`togrep`](@ref togrep(::AbstractZonotope))
+* [`reduce_order`](@ref reduce_order(::AbstractZonotope, ::Real, ::AbstractReductionMethod=GIR05()))
+* [`split`](@ref split(::AbstractZonotope, ::Int))
+* [`split`](@ref split(::AbstractZonotope, ::AbstractVector{Int}, ::AbstractVector{Int}))
 
 Inherited from [`AbstractHyperrectangle`](@ref):
 * [`area`](@ref area(::AbstractHyperrectangle))
 * [`extrema`](@ref extrema(::AbstractHyperrectangle))
 * [`extrema`](@ref extrema(::AbstractHyperrectangle, ::Int))
+* [`isflat`](@ref isflat(::AbstractHyperrectangle))
 * [`norm`](@ref norm(::AbstractHyperrectangle, ::Real))
 * [`radius`](@ref radius(::AbstractHyperrectangle, ::Real))
 * [`volume`](@ref volume(::AbstractHyperrectangle))
@@ -124,7 +135,13 @@ Inherited from [`AbstractSingleton`](@ref):
 * [`genmat`](@ref genmat(::AbstractSingleton))
 * [`high`](@ref high(::AbstractSingleton))
 * [`high`](@ref high(::AbstractSingleton, ::Int))
-* [`isboundedtype`](@ref isboundedtype(::Type{AbstractSingleton}))
+```@meta
+CurrentModule = LazySets.API
+```
+* [`isconvextype`](@ref isconvextype(::Type{LazySet}))
+```@meta
+CurrentModule = LazySets
+```
 * [`low`](@ref low(::AbstractSingleton))
 * [`low`](@ref low(::AbstractSingleton, ::Int))
 * [`ngens`](@ref ngens(::AbstractSingleton))

diff --git a/docs/src/lib/sets/Tetrahedron.md b/docs/src/lib/sets/Tetrahedron.md
@@ -101,8 +101,14 @@ Inherited from [`AbstractPolyhedron`](@ref):
 
 Inherited from [`AbstractPolytope`](@ref):
 * [`isbounded`](@ref isbounded(::AbstractPolytope))
-* [`isboundedtype`](@ref isboundedtype(::Type{AbstractPolytope}))
-* [`isconvextype`](@ref isconvextype(::Type{AbstractPolytope}))
+```@meta
+CurrentModule = LazySets.API
+```
+* [`isboundedtype`](@ref isboundedtype(::Type{LazySet}))
+* [`isconvextype`](@ref isconvextype(::Type{LazySet}))
+```@meta
+CurrentModule = LazySets
+```
 * [`isempty`](@ref isempty(::AbstractPolytope))
 * [`ispolyhedral`](@ref ispolyhedral(::AbstractPolytope))
 * [`isuniversal`](@ref isuniversal(::AbstractPolytope, ::Bool=false))

diff --git a/docs/src/lib/sets/ZeroSet.md b/docs/src/lib/sets/ZeroSet.md
@@ -84,12 +84,17 @@ Inherited from [`AbstractCentrallySymmetricPolytope`](@ref):
 
 Inherited from [`AbstractZonotope`](@ref):
 * [`order`](@ref order(::AbstractZonotope))
+* [`remove_redundant_generators`](@ref remove_redundant_generators(::AbstractZonotope))
 * [`togrep`](@ref togrep(::AbstractZonotope))
+* [`reduce_order`](@ref reduce_order(::AbstractZonotope, ::Real, ::AbstractReductionMethod=GIR05()))
+* [`split`](@ref split(::AbstractZonotope, ::Int))
+* [`split`](@ref split(::AbstractZonotope, ::AbstractVector{Int}, ::AbstractVector{Int}))
 
 Inherited from [`AbstractHyperrectangle`](@ref):
 * [`area`](@ref area(::AbstractHyperrectangle))
 * [`extrema`](@ref extrema(::AbstractHyperrectangle))
 * [`extrema`](@ref extrema(::AbstractHyperrectangle, ::Int))
+* [`isflat`](@ref isflat(::AbstractHyperrectangle))
 * [`norm`](@ref norm(::AbstractHyperrectangle, ::Real))
 * [`radius`](@ref radius(::AbstractHyperrectangle, ::Real))
 * [`volume`](@ref volume(::AbstractHyperrectangle))

diff --git a/src/Interfaces/AbstractCentrallySymmetric.jl b/src/Interfaces/AbstractCentrallySymmetric.jl
@@ -7,11 +7,9 @@ Abstract type for centrally symmetric compact convex sets.
 
 ### Notes
 
-Every concrete `AbstractCentrallySymmetric` must define the following functions:
+Every concrete `AbstractCentrallySymmetric` must define the following function:
 
 - `center(::AbstractCentrallySymmetric)` -- return the center point
-- `center(::AbstractCentrallySymmetric, i::Int)` -- return the center point at
-                                                    index `i`
 
 The subtypes of `AbstractCentrallySymmetric`: