Skip to content

Commit 924be0a

Browse files
Fix typos in PIDController docs
1 parent 2c538af commit 924be0a

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

diffrax/step_size_controller/adaptive.py

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -128,14 +128,14 @@ class PIDController(AbstractAdaptiveStepSizeController):
128128
129129
If you're not sure, then a good default for easy ("non-stiff") problems is
130130
often something like `rtol=1e-3`, `atol=1e-6`. When more accurate solutions
131-
are required then something like `rtol=1e-7`, `atol=`1e-9` are typical (along
131+
are required then something like `rtol=1e-7`, `atol=1e-9` are typical (along
132132
with using `float64` instead of `float32`).
133133
134134
(Note that technically speaking, the meaning of `rtol` and `atol` is entirely
135-
dependent on the choice of `solver`. In practice, however, most solvers tend to
136-
provide similar behaviour for similar values of `rtol`, `atol`, so it is common
137-
to refer to solving an equation to specificy tolerances, without necessarily
138-
stating about the solver used.)
135+
dependent on the choice of `solver`. In practice however, most solvers tend to
136+
provide similar behaviour for similar values of `rtol`, `atol`. As such it is
137+
common to refer to solving an equation to specific tolerances, without
138+
necessarily stating which solver was used.)
139139
140140
??? tip "Choosing PID coefficients"
141141
@@ -624,15 +624,12 @@ def _clip_jump_ts(self, t0: Scalar, t1: Scalar) -> Tuple[Scalar, Array[(), bool]
624624
error raised if the step size decreases below this, depending on `force_dtmin`.
625625
- `dtmax`: Maximum step size; the step size is clipped to this value.
626626
- `force_dtmin`: How to handle the step size hitting the minimum. If `True` then the
627-
step size is clipped to `dtmin`. If `False` then the step fails and the integration
628-
errors. (Which will in turn either set an error flag, or raise an exception,
629-
depending on the `throw` value for `diffeqsolve(..., throw=...).)
630-
- `step_ts`: Denotes *extra* times that must be stepped to. This can be used to help
631-
deal with a vector field that has a known derivative discontinuity, by stepping
632-
to exactly the derivative discontinuity.
633-
- `jump_ts`: Denotes times at which the vector field has a known discontinuity. This
634-
can be used to step exactly to the discontinuity. (And any other appropriate action
635-
taken, like FSAL algorithms re-evaluating the vector field.)
627+
step size is clipped to `dtmin`. If `False` then the differential equation solve
628+
halts with an error.
629+
- `step_ts`: Denotes extra times that must be stepped to.
630+
- `jump_ts`: Denotes extra times that must be stepped to, and at which the vector field
631+
has a known discontinuity. (This is used to force FSAL solvers so re-evaluate the
632+
vector field.)
636633
- `factormin`: Minimum amount a step size can be decreased relative to the previous
637634
step.
638635
- `factormax`: Maximum amount a step size can be increased relative to the previous

0 commit comments

Comments
 (0)