Skip to main content

Stepper

Struct Stepper 

Source
pub struct Stepper<P, S, So> { /* private fields */ }
Expand description

Drive a solver one iteration at a time.

Owns the problem, state, solver and termination criteria, runs solver.init exactly once on construction, and exposes step / run_to_end so callers can interleave their own work between iterations — recording trajectories, animating from a UI, pausing on a button press, evaluating a custom budget, etc.

Executor::run is self.into_stepper().run_to_end(); the stepper is the building block, the executor is the convenience wrapper.

§Example

let mut stepper = Executor::new(problem, solver, state)
    .max_iter(100)
    .terminate_on(GradientTolerance(1e-6))
    .into_stepper();

let reason = loop {
    match stepper.step() {
        StepOutcome::Continue => { /* observe `stepper.state()` */ }
        StepOutcome::Stopped(reason) => break reason,
    }
};

Implementations§

Source§

impl<P, S, So> Stepper<P, S, So>
where S: State, So: Solver<P, S>,

Source

pub fn state(&self) -> &S

Read-only access to the current state, between steps.

Source

pub fn finished(&self) -> Option<&TerminationReason>

Termination reason if the stepper has stopped, else None.

Source

pub fn iter(&self) -> u64

Total iterations that have completed so far. Convenience read equivalent to self.state().iter().

Source

pub fn step(&mut self) -> StepOutcome

Advance one iteration. Once a Stopped outcome has been returned the stepper is sticky: subsequent calls keep returning the same Stopped(reason) without touching the state or solver.

Source

pub fn run_to_end(self) -> OptimizationResult<S>

Drive step to completion and return an OptimizationResult.

Source

pub fn into_state(self) -> S

Consume the stepper and return the final state.

Auto Trait Implementations§

§

impl<P, S, So> Freeze for Stepper<P, S, So>
where P: Freeze, So: Freeze, S: Freeze,

§

impl<P, S, So> !RefUnwindSafe for Stepper<P, S, So>

§

impl<P, S, So> !Send for Stepper<P, S, So>

§

impl<P, S, So> !Sync for Stepper<P, S, So>

§

impl<P, S, So> Unpin for Stepper<P, S, So>
where P: Unpin, So: Unpin, S: Unpin,

§

impl<P, S, So> UnsafeUnpin for Stepper<P, S, So>

§

impl<P, S, So> !UnwindSafe for Stepper<P, S, So>

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> 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, 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,