From f320e537a6023e36cb55eb009503e963a8cf11f4 Mon Sep 17 00:00:00 2001 From: schillic Date: Tue, 2 Jul 2024 07:15:43 +0200 Subject: [PATCH] update docs page for Ball1 --- docs/src/lib/sets/Ball1.md | 80 +++++++++++++++++++++++++++++++------- 1 file changed, 65 insertions(+), 15 deletions(-) diff --git a/docs/src/lib/sets/Ball1.md b/docs/src/lib/sets/Ball1.md index 2c66bd4efe..f8e45e8884 100644 --- a/docs/src/lib/sets/Ball1.md +++ b/docs/src/lib/sets/Ball1.md @@ -12,37 +12,87 @@ Ball1 ```@docs center(::Ball1) -σ(::AbstractVector, ::Ball1) -ρ(::AbstractVector, ::Ball1) -∈(::AbstractVector, ::Ball1, ::Bool=false) -vertices_list(::Ball1) -rand(::Type{Ball1}) constraints_list(::Ball1) -translate!(::Ball1, ::AbstractVector) +rand(::Type{Ball1}) reflect(::Ball1) +vertices_list(::Ball1) +∈(::AbstractVector, ::Ball1, ::Bool=false) +ρ(::AbstractVector, ::Ball1) +σ(::AbstractVector, ::Ball1) +translate!(::Ball1, ::AbstractVector) +``` + +```@meta +CurrentModule = LazySets.API +``` + +Undocumented implementations: +* [`high`](@ref high(::LazySet)) +* [`high`](@ref high(::LazySet, ::Int)) +* [`isoperationtype`](@ref isoperationtype(::Type{LazySet})) +* [`low`](@ref low(::LazySet)) +* [`low`](@ref low(::LazySet, ::Int)) +* [`project`](@ref project(::LazySet, ::AbstractVector{Int})) +* [`scale`](@ref scale(::Real, ::LazySet)) +* [`translate`](@ref translate(::LazySet, ::AbstractVector)) +* [`minkowski_sum`](@ref minkowski_sum(::LazySet, ::LazySet)) +```@meta +CurrentModule = LazySets ``` +* [`ball_norm`](@ref ball_norm(::LazySet)) +* [`radius_ball`](@ref radius_ball(::LazySet)) Inherited from [`LazySet`](@ref): -* [`norm`](@ref norm(::LazySet, ::Real)) -* [`radius`](@ref radius(::LazySet, ::Real)) -* [`diameter`](@ref diameter(::LazySet, ::Real)) * [`area`](@ref area(::LazySet)) -* [`singleton_list`](@ref singleton_list(::LazySet)) +* [`complement`](@ref complement(::LazySet)) +* [`concretize`](@ref concretize(::LazySet)) +* [`constraints`](@ref constraints(::LazySet)) +* [`convex_hull`](@ref convex_hull(::LazySet)) +* [`diameter`](@ref diameter(::LazySet, ::Real)) +* [`eltype`](@ref eltype(::Type{<:LazySet})) +* [`eltype`](@ref eltype(::LazySet)) * [`rectify`](@ref rectify(::LazySet)) -* [`low`](@ref low(::LazySet)) -* [`high`](@ref high(::LazySet)) +* [`singleton_list`](@ref singleton_list(::LazySet)) +* [`surface`](@ref surface(::LazySet)) +* [`vertices`](@ref vertices(::LazySet)) +* [`affine_map`](@ref affine_map(::AbstractMatrix, ::LazySet, ::AbstractVector)) +* [`exponential_map`](@ref exponential_map(::AbstractMatrix, ::LazySet)) +* [`is_interior_point`](@ref is_interior_point(::AbstractVector, ::LazySet)) * [`linear_map`](@ref linear_map(::AbstractMatrix, ::LazySet) +* [`norm`](@ref norm(::LazySet, ::Real)) +* [`radius`](@ref radius(::LazySet, ::Real)) * [`translate`](@ref translate(::LazySet, ::AbstractVector)) +* [`cartesian_product`](@ref cartesian_product(::LazySet, ::LazySet)) +* [`≈`](@ref ≈(::LazySet, ::LazySet)) +* [`==`](@ref ==(::LazySet, ::LazySet)) +* [`isequivalent`](@ref isequivalent(::LazySet, ::LazySet)) +* [`⊂`](@ref ⊂(::LazySet, ::LazySet)) +* [`minkowski_difference`](@ref minkowski_difference(::LazySet, ::LazySet)) + +Inherited from [`AbstractPolyhedron`](@ref): +* [`is_polyhedral`](@ref is_polyhedral(::AbstractPolyhedron)) +* [`intersection`](@ref intersection(::AbstractPolyhedron, ::AbstractPolyhedron)) +* [`isdisjoint`](@ref isdisjoint(::AbstractPolyhedron, ::AbstractPolyhedron)) +* [`⊆`](@ref ⊆(::AbstractPolyhedron, ::AbstractPolyhedron)) Inherited from [`AbstractPolytope`](@ref): * [`isbounded`](@ref isbounded(::AbstractPolytope)) +```@meta +CurrentModule = LazySets.API +``` +* [`isboundedtype`](@ref isboundedtype(::Type{LazySet})) +* [`isconvextype`](@ref isconvextype(::Type{LazySet})) +```@meta +CurrentModule = LazySets +``` +* [`isoperation`](@ref isoperation(::AbstractPolytope)) * [`volume`](@ref volume(::AbstractPolytope)) Inherited from [`AbstractCentrallySymmetricPolytope`](@ref): -* [`dim`](@ref dim(::AbstractCentrallySymmetricPolytope)) -* [`isempty`](@ref isempty(::AbstractCentrallySymmetricPolytope)) * [`an_element`](@ref an_element(::AbstractCentrallySymmetricPolytope)) -* [`isuniversal`](@ref isuniversal(::AbstractCentrallySymmetricPolytope{N}, ::Bool=false) where {N}) * [`center`](@ref center(::AbstractCentrallySymmetricPolytope, ::Int)) +* [`dim`](@ref dim(::AbstractCentrallySymmetricPolytope)) * [`extrema`](@ref extrema(::AbstractCentrallySymmetricPolytope)) * [`extrema`](@ref extrema(::AbstractCentrallySymmetricPolytope, ::Int)) +* [`isempty`](@ref isempty(::AbstractCentrallySymmetricPolytope)) +* [`isuniversal`](@ref isuniversal(::AbstractCentrallySymmetricPolytope{N}, ::Bool=false) where {N})