Merge pull request #3559 from JuliaReach/schillic/docs

Update docs
JuliaReach · Jul 9, 2024 · 2fe39bd · 2fe39bd
2 parents f951c92 + 92be0b7
commit 2fe39bd
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 11 deletions.
diff --git a/docs/src/lib/sets/Ball1.md b/docs/src/lib/sets/Ball1.md
@@ -60,6 +60,7 @@ Inherited from [`LazySet`](@ref):
 * [`linear_map`](@ref linear_map(::AbstractMatrix, ::LazySet)
 * [`norm`](@ref norm(::LazySet, ::Real))
 * [`radius`](@ref radius(::LazySet, ::Real))
+* [`sample`](@ref sample(::LazySet, ::Int))
 * [`translate`](@ref translate(::LazySet, ::AbstractVector))
 * [`cartesian_product`](@ref cartesian_product(::LazySet, ::LazySet))
 * [`≈`](@ref ≈(::LazySet, ::LazySet))

diff --git a/docs/src/lib/sets/BallInf.md b/docs/src/lib/sets/BallInf.md
@@ -60,8 +60,8 @@ Inherited from [`LazySet`](@ref):
 * [`affine_map`](@ref affine_map(::AbstractMatrix, ::LazySet, ::AbstractVector))
 * [`exponential_map`](@ref exponential_map(::AbstractMatrix, ::LazySet))
 * [`is_interior_point`](@ref is_interior_point(::AbstractVector, ::LazySet))
-* [`translate`](@ref translate(::LazySet, ::AbstractVector))
 * [`sample`](@ref sample(::LazySet, ::Int))
+* [`translate`](@ref translate(::LazySet, ::AbstractVector))
 * [`≈`](@ref ≈(::LazySet, ::LazySet))
 * [`==`](@ref ==(::LazySet, ::LazySet))
 * [`isequivalent`](@ref isequivalent(::LazySet, ::LazySet))

diff --git a/docs/src/lib/sets/Interval.md b/docs/src/lib/sets/Interval.md
@@ -26,21 +26,21 @@ chebyshev_center_radius(::Interval)
 constraints_list(::Interval)
 diameter(::Interval, ::Real=Inf)
 dim(::Interval)
-∈(::AbstractVector, ::Interval)
 isflat(::Interval)
-linear_map(::AbstractMatrix, ::Interval)
 ngens(::Interval)
 radius_hyperrectangle(::Interval)
 radius_hyperrectangle(::Interval{N}, ::Int) where {N}
 rand(::Type{Interval})
 rectify(::Interval{N}) where {N}
 reflect(::Interval)
+vertices_list(::Interval)
+∈(::AbstractVector, ::Interval)
+linear_map(::AbstractMatrix, ::Interval)
 scale(::Real, ::Interval)
 split(::Interval, ::AbstractVector{Int})
 ρ(::AbstractVector, ::Interval)
 σ(::AbstractVector, ::Interval)
 translate(::Interval, ::AbstractVector)
-vertices_list(::Interval)
 difference(::Interval{N}, ::Interval) where {N}
 intersection(::Interval, ::Interval)
 isdisjoint(::Interval, ::Interval, ::Bool=false)
@@ -59,9 +59,7 @@ CurrentModule = LazySets.API
 ```
 
 Undocumented implementations:
-* [`affine_map`](@ref affine_map(::AbstractMatrix, ::LazySet, ::AbstractVector))
 * [`complement`](@ref complement(::LazySet))
-* [`exponential_map`](@ref exponential_map(::AbstractMatrix, ::LazySet))
 * [`extrema`](@ref extrema(::LazySet))
 * [`extrema`](@ref extrema(::LazySet, ::Int))
 * [`high`](@ref high(::LazySet, ::Int))
@@ -70,10 +68,12 @@ Undocumented implementations:
 * [`low`](@ref low(::LazySet, ::Int))
 * [`low`](@ref low(::LazySet))
 * [`norm`](@ref norm(::LazySet, ::Real))
-* [`permute`](@ref permute(::LazySet, ::AbstractVector{Int}))
-* [`project`](@ref project(::LazySet, ::AbstractVector{Int}))
 * [`radius`](@ref radius(::LazySet, ::Real))
 * [`volume`](@ref volume(::LazySet))
+* [`affine_map`](@ref affine_map(::AbstractMatrix, ::LazySet, ::AbstractVector))
+* [`exponential_map`](@ref exponential_map(::AbstractMatrix, ::LazySet))
+* [`permute`](@ref permute(::LazySet, ::AbstractVector{Int}))
+* [`project`](@ref project(::LazySet, ::AbstractVector{Int}))
 * [`convex_hull`](@ref convex_hull(::LazySet, ::LazySet))
 * [`distance`](@ref distance(::LazySet, ::LazySet))
 * [`≈`](@ref ≈(::LazySet, ::LazySet))
@@ -100,13 +100,10 @@ Inherited from [`AbstractPolyhedron`](@ref):
 * [`is_polyhedral`](@ref is_polyhedral(::AbstractPolyhedron))
 
 Inherited from [`ConvexSet`](@ref):
-
 ```@meta
 CurrentModule = LazySets.API
 ```
-
 * [`linear_combination`](@ref linear_combination(::LazySet, ::LazySet))
-
 ```@meta
 CurrentModule = LazySets
 ```