From fbed4573fbb9e4f95abd428fe400a0e932576256 Mon Sep 17 00:00:00 2001 From: schillic Date: Tue, 31 Dec 2024 09:01:02 +0100 Subject: [PATCH] ConvexSet: revise docs entries --- docs/src/lib/interfaces/ConvexSet.md | 67 ++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) diff --git a/docs/src/lib/interfaces/ConvexSet.md b/docs/src/lib/interfaces/ConvexSet.md index 6096cc3bf6..c4f901504c 100644 --- a/docs/src/lib/interfaces/ConvexSet.md +++ b/docs/src/lib/interfaces/ConvexSet.md @@ -14,3 +14,70 @@ Every convex set in this library implements this interface. ```@docs ConvexSet ``` + +This interface defines the following functions (undocumented): + +```@meta +CurrentModule = LazySets.API +``` + +* [`isconvextype`](@ref isconvextype(::Type{LazySet})) +* [`linear_combination`](@ref linear_combination(::LazySet, ::LazySet)) + +```@meta +CurrentModule = LazySets +``` + +Inherited from [`LazySet`](@ref): +* [`an_element`](@ref an_element(::LazySet)) +* [`area`](@ref area(::LazySet)) +* [`center`](@ref center(::LazySet)) +* [`chebyshev_center_radius`](@ref chebyshev_center_radius(::LazySet)) +* [`complement`](@ref complement(::LazySet)) +* [`concretize`](@ref concretize(::LazySet)) +* [`constraints`](@ref constraints(::LazySet)) +* [`convex_hull`](@ref convex_hull(::LazySet)) +* `copy(::Type{LazySet})` +* [`diameter`](@ref diameter(::LazySet, ::Real=Inf)) +* [`eltype`](@ref eltype(::Type{<:LazySet})) +* [`eltype`](@ref eltype(::LazySet)) +* [`extrema`](@ref extrema(::LazySet)) +* [`extrema`](@ref extrema(::LazySet, ::Int)) +* [`high`](@ref high(::LazySet)) +* [`high`](@ref high(::LazySet, ::Int)) +* [`isbounded`](@ref isbounded(::LazySet)) +* [`isboundedtype`](@ref isboundedtype(::Type{LazySet})) +* [`isempty`](@ref isempty(::LazySet)) +* [`isoperation`](@ref isoperation(::LazySet)) +* [`ispolyhedral`](@ref ispolyhedral(::LazySet)) +* [`low`](@ref low(::LazySet)) +* [`low`](@ref low(::LazySet, ::Int)) +* [`norm`](@ref norm(::LazySet, ::Real=Inf)) +* [`radius`](@ref radius(::LazySet, ::Real=Inf)) +* [`rationalize`](@ref rationalize(::LazySet)) +* [`rectify`](@ref rectify(::LazySet)) +* [`reflect`](@ref reflect(::LazySet)) +* [`singleton_list`](@ref singleton_list(::LazySet)) +* [`surface`](@ref surface(::LazySet)) +* [`triangulate`](@ref triangulate(::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)) +* [`project`](@ref project(::LazySet, ::AbstractVector{Int})) +* [`sample`](@ref sample(::LazySet, ::Int=1)) +* [`scale`](@ref scale(::Real, ::LazySet)) +* [`ρ`](@ref ρ(::AbstractVector, ::LazySet)) +* [`translate`](@ref translate(::LazySet, ::AbstractVector)) +* [`cartesian_product`](@ref cartesian_product(::LazySet, ::LazySet)) +* [`convex_hull`](@ref convex_hull(::LazySet, ::LazySet)) +* [`exact_sum`](@ref exact_sum(::LazySet, ::LazySet)) +* [`≈`](@ref ≈(::LazySet, ::LazySet)) +* [`isdisjoint`](@ref isdisjoint(::LazySet, ::LazySet)) +* [`==`](@ref ==(::LazySet, ::LazySet)) +* [`isequivalent`](@ref isequivalent(::LazySet, ::LazySet)) +* [`⊂`](@ref ⊂(::LazySet, ::LazySet)) +* [`⊆`](@ref ⊆(::LazySet, ::LazySet)) +* [`minkowski_difference`](@ref minkowski_difference(::LazySet, ::LazySet)) +* [`minkowski_sum`](@ref minkowski_sum(::LazySet, ::LazySet))