Skip to content

Commit a3688bb

Browse files
Tweaked docstring for Solution
1 parent fc68478 commit a3688bb

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

diffrax/_solution.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,17 @@ class Solution(AbstractPath):
8383
- `ys`: The value of the solution at each of the times in `ts`. Might `None` if no
8484
values were saved.
8585
- `stats`: Statistics for the solve (number of steps etc.).
86-
- `result`: A [`diffrax.RESULT`][] specifying the success or cause of failure of the
87-
solve. A human-readable message is displayed if printed. No message means
86+
- `result`: A [`diffrax.RESULTS`][] specifying the success or cause of failure of
87+
the solve. A human-readable message is displayed if printed. No message means
8888
success!
8989
- `solver_state`: If saved, the final internal state of the numerical solver.
9090
- `controller_state`: If saved, the final internal state for the step size
9191
controller.
9292
- `made_jump`: If saved, the final internal state for the jump tracker.
93+
- `event_mask`: If using [events](../events), a boolean mask indicating which event
94+
triggered. This is a PyTree of bools, with the same PyTree stucture as the event
95+
condition functions. It will be all `False` if no events triggered; otherwise it
96+
will have precisely one `True`, corresponding to the event that triggered.
9397
9498
!!! note
9599

0 commit comments

Comments
 (0)