Skip to main content

HermiteInterpolator

Struct HermiteInterpolator 

Source
pub struct HermiteInterpolator<V>
where V: Vector,
{ /* private fields */ }
Expand description

Hermite interpolator for ODE solution trajectories.

This interpolator uses cubic Hermite interpolation based on solution values and derivatives at discrete time points. It provides smooth interpolation between checkpoints and is used internally by the checkpointing system for adjoint sensitivity analysis.

Implementations§

Source§

impl<V> HermiteInterpolator<V>
where V: Vector,

Source

pub fn new(ys: Vec<V>, ydots: Vec<V>, ts: Vec<V::T>) -> Self

Create a new Hermite interpolator with the given solution data.

§Arguments
  • ys: Vector of solution values at each time point
  • ydots: Vector of solution derivatives (dy/dt) at each time point
  • ts: Vector of time points (must be sorted)
§Notes

All three vectors must have the same length. The time points should be sorted in increasing or decreasing order for proper interpolation.

Source

pub fn last_t(&self) -> Option<V::T>

Get the last time point in the interpolator.

§Returns

The last time value, or None if the interpolator is empty.

Source

pub fn last_h(&self) -> Option<V::T>

Get the last time step size in the interpolator.

§Returns

The difference between the last two time points, or None if there are fewer than two time points.

Source

pub fn reset<'a, Eqn, Method, State>( &mut self, solver: &mut Method, state0: &State, state1: &State, ) -> Result<(), DiffsolError>
where Eqn: OdeEquations<V = V, T = V::T> + 'a, Method: OdeSolverMethod<'a, Eqn, State = State>, State: OdeSolverState<V>,

Reset the interpolator by solving the ODE between two checkpointed states.

This method clears the current interpolation data and re-solves the ODE from state0 to state1, storing all intermediate solution points.

§Arguments
  • solver: The ODE solver to use for integration
  • state0: The initial state (starting point)
  • state1: The final state (target point)
§Returns

Ok(()) on success, or an error if the solver fails.

Source

pub fn interpolate(&self, t: V::T, y: &mut V) -> Option<()>

Interpolate the solution at a given time point.

Uses cubic Hermite interpolation to compute the solution value at time t.

§Arguments
  • t: The time at which to interpolate
  • y: Output vector to store the interpolated solution
§Returns

Some(()) if the interpolation succeeded (t is within range), None if t is outside the range of stored time points.

Trait Implementations§

Source§

impl<V> Clone for HermiteInterpolator<V>
where V: Vector + Clone, V::T: Clone,

Source§

fn clone(&self) -> HermiteInterpolator<V>

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

impl<V> Default for HermiteInterpolator<V>
where V: Vector,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> Context for T
where T: Clone + Default,

Source§

fn vector_from_element<V: Vector<C = Self>>(&self, len: usize, value: V::T) -> V

Source§

fn vector_from_vec<V: Vector<C = Self>>(&self, vec: Vec<V::T>) -> V

Source§

fn vector_zeros<V: Vector<C = Self>>(&self, len: usize) -> V

Source§

fn dense_mat_zeros<V: Vector<C = Self> + DefaultDenseMatrix>( &self, rows: usize, cols: usize, ) -> <V as DefaultDenseMatrix>::M

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

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,