Skip to content
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
95 changes: 79 additions & 16 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,15 @@ makedocs(; sitename="LazySets.jl",
modules=[LazySets, Approximations, LazySets.Parallel],
format=Documenter.HTML(; prettyurls=get(ENV, "CI", nothing) == "true",
assets=["assets/aligned.css"],
size_threshold=nothing),
pages=["Home" => "index.md",
"Manual" => Any["Getting Started" => "man/getting_started.md",
size_threshold_warn=150 * 2^10),
doctest=false,
pagesonly=true,
pages=[
#
"Home" => "index.md",
"Manual" => Any[
#
"Getting Started" => "man/getting_started.md",
"Optional Features" => "man/optional_dependencies.md",
"A Tour of LazySets" => "man/tour.md",
"Introduction to Convex Sets" => "man/convex_sets.md",
Expand All @@ -20,14 +26,36 @@ makedocs(; sitename="LazySets.jl",
"Iterative Refinement" => "man/iterative_refinement.md",
"Interval Hulls" => "man/interval_hulls.md",
"Convex Hulls" => "man/convex_hulls.md",
"Operations on Sets" => "man/set_operations.md",
"Unary Operations on Sets" => "man/unary_set_operations.md",
"A Reachability Algorithm" => "man/reach_zonotopes.md",
"A Hybrid Reachability Algorithm" => "man/reach_zonotopes_hybrid.md",
"Concrete Polyhedra" => "man/concrete_polyhedra.md",
"Parallel Approximations" => "man/parallel_approximations.md",
"Lazy Intersections" => "man/lazy_intersections.md"],
"Library" => Any["Interfaces" => "lib/interfaces.md",
"Sets" => ["Ball1" => "lib/sets/Ball1.md",
"Lazy Intersections" => "man/lazy_intersections.md"
#
],
"Library" => Any["Set Interfaces" => [
#
"lib/interfaces/overview.md",
"lib/interfaces/LazySet.md",
"lib/interfaces/ConvexSet.md",
"lib/interfaces/AbstractCentrallySymmetric.md",
"lib/interfaces/AbstractPolyhedron.md",
"lib/interfaces/AbstractPolytope.md",
"lib/interfaces/AbstractPolygon.md",
"lib/interfaces/AbstractHPolygon.md",
"lib/interfaces/AbstractCentrallySymmetricPolytope.md",
"lib/interfaces/AbstractZonotope.md",
"lib/interfaces/AbstractHyperrectangle.md",
"lib/interfaces/AbstractSingleton.md",
"lib/interfaces/AbstractAffineMap.md",
"lib/interfaces/AbstractPolynomialZonotope.md",
"lib/interfaces/AbstractBallp.md"
#
],
"Sets" => [
#
"Ball1" => "lib/sets/Ball1.md",
"Ball2" => "lib/sets/Ball2.md",
"BallInf" => "lib/sets/BallInf.md",
"Ballp" => "lib/sets/Ballp.md",
Expand Down Expand Up @@ -57,8 +85,12 @@ makedocs(; sitename="LazySets.jl",
"VPolygon" => "lib/sets/VPolygon.md",
"VPolytope" => "lib/sets/VPolytope.md",
"ZeroSet" => "lib/sets/ZeroSet.md",
"Zonotope" => "lib/sets/Zonotope.md"],
"Lazy Operations" => ["AffineMap" => "lib/lazy_operations/AffineMap.md",
"Zonotope" => "lib/sets/Zonotope.md"
#
],
"Lazy Operations" => [
#
"AffineMap" => "lib/lazy_operations/AffineMap.md",
"Bloating" => "lib/lazy_operations/Bloating.md",
"CartesianProduct" => "lib/lazy_operations/CartesianProduct.md",
"Complement" => "lib/lazy_operations/Complement.md",
Expand All @@ -73,15 +105,46 @@ makedocs(; sitename="LazySets.jl",
"ResetMap" => "lib/lazy_operations/ResetMap.md",
"SymmetricIntervalHull" => "lib/lazy_operations/SymmetricIntervalHull.md",
"Translation" => "lib/lazy_operations/Translation.md",
"UnionSet" => "lib/lazy_operations/UnionSet.md"],
"Concrete Operations" => "lib/binary_functions.md",
"UnionSet" => "lib/lazy_operations/UnionSet.md"
#
],
"Concrete Binary Operations" => [
#
"lib/concrete_binary_operations/overview.md",
"lib/concrete_binary_operations/cartesian_product.md",
"lib/concrete_binary_operations/convex_hull.md",
"lib/concrete_binary_operations/difference.md",
"lib/concrete_binary_operations/distance.md",
"lib/concrete_binary_operations/exact_sum.md",
"lib/concrete_binary_operations/intersection.md",
"lib/concrete_binary_operations/linear_combination.md",
"lib/concrete_binary_operations/minkowski_sum.md",
"lib/concrete_binary_operations/minkowski_difference.md",
"lib/concrete_binary_operations/isdisjoint.md",
"lib/concrete_binary_operations/issubset.md"
#
],
"Conversions between set representations" => "lib/conversion.md",
"Approximations" => "lib/approximations.md",
"Approximations" => [
#
"lib/approximations/overview.md",
"lib/approximations/overapproximate.md",
"lib/approximations/box_approximation.md",
"lib/approximations/iterative_refinement.md",
"lib/approximations/template_directions.md",
"lib/approximations/underapproximate.md",
"lib/approximations/approximate.md",
"lib/approximations/decompose.md",
"lib/approximations/hausdorff_distance.md"
#
],
"Utilities" => "lib/utils.md",
"Parallel" => "lib/parallel.md"],
"About" => "about.md"],
doctest=false,
pagesonly=true)
"Parallel" => "lib/parallel.md"
#
],
"About" => "about.md"
#
])

deploydocs(; repo="github.com/JuliaReach/LazySets.jl.git",
push_preview=true)
91 changes: 0 additions & 91 deletions docs/src/lib/approximations.md

This file was deleted.

14 changes: 14 additions & 0 deletions docs/src/lib/approximations/approximate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```@contents
Pages = ["approximate.md"]
Depth = 3
```

```@meta
CurrentModule = LazySets.Approximations
```

# Approximation

```@docs
approximate
```
19 changes: 19 additions & 0 deletions docs/src/lib/approximations/box_approximation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
```@contents
Pages = ["box_approximation.md"]
Depth = 3
```

```@meta
CurrentModule = LazySets.Approximations
```

# Box Approximation

```@docs
box_approximation
interval_hull
□(::LazySet)
symmetric_interval_hull
box_approximation_symmetric
ballinf_approximation
```
14 changes: 14 additions & 0 deletions docs/src/lib/approximations/decompose.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```@contents
Pages = ["decompose.md"]
Depth = 3
```

```@meta
CurrentModule = LazySets.Approximations
```

# Cartesian Decomposition

```@docs
decompose
```
14 changes: 14 additions & 0 deletions docs/src/lib/approximations/hausdorff_distance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```@contents
Pages = ["hausdorff_distance.md"]
Depth = 3
```

```@meta
CurrentModule = LazySets.Approximations
```

# Hausdorff Distance

```@docs
hausdorff_distance
```
21 changes: 21 additions & 0 deletions docs/src/lib/approximations/iterative_refinement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
```@contents
Pages = ["iterative_refinement.md"]
Depth = 3
```

```@meta
CurrentModule = LazySets.Approximations
```

# Iterative refinement

```@docs
overapproximate_hausdorff
LocalApproximation
PolygonalOverapproximation
new_approx
addapproximation!
refine(::LocalApproximation, ::LazySet)
tohrep(::PolygonalOverapproximation)
convert(::Type{HalfSpace}, ::LocalApproximation)
```
16 changes: 16 additions & 0 deletions docs/src/lib/approximations/overapproximate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```@contents
Pages = ["overapproximate.md"]
Depth = 3
```

```@meta
CurrentModule = LazySets.Approximations
```

# Overapproximation

```@docs
overapproximate
LazySets.Approximations._overapproximate_zonotope_vrep
LazySets.Approximations._overapproximate_zonotope_cpa
```
17 changes: 17 additions & 0 deletions docs/src/lib/approximations/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
```@contents
Pages = ["overview.md"]
Depth = 3
```

```@meta
CurrentModule = LazySets.Approximations
```

# Overview

This section of the manual describes the Cartesian decomposition algorithms and
the approximation of high-dimensional convex sets using projections.

```@docs
Approximations
```
26 changes: 26 additions & 0 deletions docs/src/lib/approximations/template_directions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
```@contents
Pages = ["template_directions.md"]
Depth = 3
```

```@meta
CurrentModule = LazySets.Approximations
```

# Template directions

See also [`overapproximate(X::LazySet, dir::AbstractDirections)`](@ref).

```@docs
AbstractDirections
isbounding
isnormalized
project(::LazySet, ::AbstractVector{Int}, ::Type{<:AbstractDirections})
BoxDirections
DiagDirections
OctDirections
BoxDiagDirections
PolarDirections
SphericalDirections
CustomDirections
```
14 changes: 14 additions & 0 deletions docs/src/lib/approximations/underapproximate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```@contents
Pages = ["underapproximate.md"]
Depth = 3
```

```@meta
CurrentModule = LazySets.Approximations
```

# Underapproximation

```@docs
underapproximate
```
Loading