pub struct Checkpointing<'a, Eqn, Method>where
Method: OdeSolverMethod<'a, Eqn>,
Eqn: OdeEquations,{ /* private fields */ }Expand description
Checkpointing system for adjoint sensitivity analysis.
This struct manages checkpoints of an ODE solution for use in adjoint sensitivity computation. It stores solution states at discrete checkpoints and uses Hermite interpolation between them to provide solution values at arbitrary time points during the backward adjoint solve.
The checkpointing system uses a two-level interpolation strategy:
- Checkpoints: Discrete saved states of the ODE solution
- Segments: Hermite interpolators that densely sample between adjacent checkpoints
When interpolating at a time point, the system first checks if it’s in the current segment. If not, it re-solves the ODE between the appropriate checkpoints to create a new segment, then interpolates within that segment.
§Type Parameters
Eqn: The ODE equations type (inferred from the solver)Method: The forward solver method type (inferred from the solver)
Implementations§
Source§impl<'a, Eqn, Method> Checkpointing<'a, Eqn, Method>where
Method: OdeSolverMethod<'a, Eqn>,
Eqn: OdeEquations,
impl<'a, Eqn, Method> Checkpointing<'a, Eqn, Method>where
Method: OdeSolverMethod<'a, Eqn>,
Eqn: OdeEquations,
Sourcepub fn new(
solver: Method,
start_idx: usize,
checkpoints: Vec<Method::State>,
segment: Option<HermiteInterpolator<Eqn::V>>,
) -> Self
pub fn new( solver: Method, start_idx: usize, checkpoints: Vec<Method::State>, segment: Option<HermiteInterpolator<Eqn::V>>, ) -> Self
Create a new checkpointing system.
§Arguments
solver: The forward solver to use for re-solving segmentsstart_idx: Index of the checkpoint to start from (must be < checkpoints.len() - 1)checkpoints: Vector of saved solution states (must have at least 2 elements)segment: Optional pre-computed Hermite interpolator for the initial segment given bystart_idx. IfNone, the segment betweencheckpoints[start_idx]andcheckpoints[start_idx+1]will be computed automatically.
§Panics
Panics if checkpoints.len() < 2 or if start_idx >= checkpoints.len() - 1.
Sourcepub fn last_h(&self) -> Option<Eqn::T>
pub fn last_h(&self) -> Option<Eqn::T>
Get the last time step size in the current segment.
§Returns
The difference between the last two time points in the current segment,
or None if the segment has fewer than two points.
Sourcepub fn problem(&self) -> &'a OdeSolverProblem<Eqn>
pub fn problem(&self) -> &'a OdeSolverProblem<Eqn>
Get a reference to the ODE problem associated with this checkpointing system.
§Returns
A reference to the OdeSolverProblem that defines the ODE equations,
tolerances, and other solver parameters.
Sourcepub fn interpolate(&self, t: Eqn::T, y: &mut Eqn::V) -> Result<(), DiffsolError>
pub fn interpolate(&self, t: Eqn::T, y: &mut Eqn::V) -> Result<(), DiffsolError>
Interpolate the solution at a given time point.
This method provides the forward solution value at time t for use during
the backward adjoint solve. It first checks if t is within the current
or previous segment. If not, it identifies the appropriate checkpoint interval,
re-solves the ODE between those checkpoints to create a new segment, and then
interpolates within that segment.
§Arguments
t: The time at which to interpolate the solutiony: Output vector to store the interpolated solution
§Returns
Ok(())if interpolation succeededErr(...)iftis outside the range of checkpoints (beyond roundoff tolerance) or if re-solving the ODE fails
§Notes
Small deviations from the checkpoint range (within roundoff error) are automatically snapped to the nearest checkpoint boundary.
Trait Implementations§
Source§impl<'a, Eqn, Method> Clone for Checkpointing<'a, Eqn, Method>where
Method: OdeSolverMethod<'a, Eqn>,
Eqn: OdeEquations,
impl<'a, Eqn, Method> Clone for Checkpointing<'a, Eqn, Method>where
Method: OdeSolverMethod<'a, Eqn>,
Eqn: OdeEquations,
Auto Trait Implementations§
impl<'a, Eqn, Method> !Freeze for Checkpointing<'a, Eqn, Method>
impl<'a, Eqn, Method> !RefUnwindSafe for Checkpointing<'a, Eqn, Method>
impl<'a, Eqn, Method> Send for Checkpointing<'a, Eqn, Method>
impl<'a, Eqn, Method> !Sync for Checkpointing<'a, Eqn, Method>
impl<'a, Eqn, Method> Unpin for Checkpointing<'a, Eqn, Method>
impl<'a, Eqn, Method> UnwindSafe for Checkpointing<'a, Eqn, Method>where
Method: UnwindSafe,
<Method as OdeSolverMethod<'a, Eqn>>::State: UnwindSafe,
<Eqn as Op>::V: UnwindSafe,
<Eqn as Op>::T: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.