Checkpointing

Struct Checkpointing 

Source
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:

  1. Checkpoints: Discrete saved states of the ODE solution
  2. 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,

Source

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 segments
  • start_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 by start_idx. If None, the segment between checkpoints[start_idx] and checkpoints[start_idx+1] will be computed automatically.
§Panics

Panics if checkpoints.len() < 2 or if start_idx >= checkpoints.len() - 1.

Source

pub fn last_t(&self) -> Eqn::T

Get the last (most recent) time point in the current segment.

§Returns

The last time value in the current interpolation segment.

§Panics

Panics if the segment is empty (should never happen with valid construction).

Source

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.

Source

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.

Source

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 solution
  • y: Output vector to store the interpolated solution
§Returns
  • Ok(()) if interpolation succeeded
  • Err(...) if t is 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,

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

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>
where Method: Send, <Method as OdeSolverMethod<'a, Eqn>>::State: Send, <Eqn as Op>::V: Send,

§

impl<'a, Eqn, Method> !Sync for Checkpointing<'a, Eqn, Method>

§

impl<'a, Eqn, Method> Unpin for Checkpointing<'a, Eqn, Method>
where Method: Unpin, <Method as OdeSolverMethod<'a, Eqn>>::State: Unpin, <Eqn as Op>::V: Unpin, <Eqn as Op>::T: Unpin,

§

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V