Skip to content

Commit

Permalink
Update the docs such that we don't recommend indexing with sol[t]
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanaelbosch committed Feb 4, 2024
1 parent 22d2d1c commit bdc4533
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions docs/src/tutorials/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,18 +128,12 @@ plot!(sol.t, zero(errors), ribbon=3error_estimates, label="error estimate",

The solution object returned by ProbNumDiffEq.jl mostly behaves just like any other `ODESolution` in DifferentialEquations.jl --
with some added uncertainties and related functionality on top.
The `ProbabilisticODESolution` can be indexed
The `ProbabilisticODESolution` can be indexed with

```@repl 1
sol[1]
sol[end]
```

and has fields `sol.t` and `sol.u` which store the time points and mean estimates:

```@repl 1
sol.t[end]
sol.u[1]
sol.u[end]
sol.t[end]
```


Expand Down

0 comments on commit bdc4533

Please sign in to comment.