Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use small images in docs #146

Merged
merged 2 commits into from
Oct 16, 2023
Merged

Use small images in docs #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15c013f
use latest supported version of IntervalArithmetic in docs
schillic Oct 15, 2023
ed8132d
use png images in docs
schillic Oct 15, 2023
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
2 changes: 1 addition & 1 deletion docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"

[compat]
Documenter = "1"
IntervalArithmetic = "=0.20" # new versions require updates and are incompatible with dependencies
IntervalArithmetic = "=0.20.9" # new versions require updates and are incompatible with dependencies
IntervalOptimisation = "0.4"
Plots = "1"
6 changes: 6 additions & 0 deletions docs/src/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,11 @@ plot(xlabel="x", ylabel="f(x)", legendfontsize=12, tickfontsize=12,
plot!(IntervalBox(D, R), label="natural enclosure")
plot!(IntervalBox(D, Rbb), label="branch and bound", alpha=1)
plot!(f, -10, 10, lw=2, c=:black, label="f")
savefig("tutorial-2d.png"); nothing # hide
```

![](tutorial-2d.png)

### Tuning parameters

Some solvers have parameters that can be tuned. For example, looking at the [`BranchAndBoundEnclosure`](@ref) documentation, we can see that it has two parameters, `tol` and `maxdepth`.
Expand Down Expand Up @@ -155,4 +158,7 @@ plot(legend=:none, size=(800, 800), xlabel="x", ylabel="y", zlabel="h(x,y)",
surface!(x, y, [inf(Rh) for _ in x, _ in y], α=0.4)
surface!(x, y, f.(x', y), zlims=(-4, 4))
surface!(x, y, [sup(Rh) for _ in x, _ in y], α=0.4)
savefig("tutorial-3d.png"); nothing # hide
```

![](tutorial-3d.png)