Struct SolverStep 

#[non_exhaustive]
pub struct SolverStep<S: State> {
    pub state: S,
    pub completed: bool,
    pub termination: Option<Termination<S::Float>>,
}

Progress published by one solver step. Completion and termination are independent: a finished step can also be the step that stops the run. A continuing partial step publishes progress without an iteration callback.

Construct steps with Self::new or the named constructors. Fields remain public for reading, moving, and assignment; destructuring must include ... Future optional metadata must default to behavior compatible with existing constructors.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

state: S

Coherent progress published by this step.

completed: bool

Whether the executor should increment the completed-iteration count.

termination: Option<Termination<S::Float>>

An optional stopping decision, independent of iteration completion.

Implementations

impl<S: State> SolverStep<S>

pub fn new( state: S, completed: bool, termination: Option<Termination<S::Float>>, ) -> Self

Publish a step with explicit completion and termination decisions.

Use this when forwarding decisions from another solver. Completion and termination remain independent.

pub fn completed(state: S) -> Self

Publish a completed iteration and continue.

pub fn partial(state: S) -> Self

Publish progress and continue without completing an iteration.

The executor publishes counts and incumbent updates without incrementing the completed-iteration count or firing iteration observers.

pub fn stopped(state: S, termination: Termination<S::Float>) -> Self

Publish a partial step and its stopping explanation.

pub fn completed_with_termination( state: S, termination: Termination<S::Float>, ) -> Self

Publish a completed iteration and its stopping explanation.

pub fn into_parts(self) -> (S, bool, Option<Termination<S::Float>>)

Extract the published state, completion flag, and stopping decision.

Callers driving iterations manually must account for completed before consuming this value. This tuple retains only these three core fields; any future optional metadata is discarded.

Trait Implementations

impl<S: Debug + State> Debug for SolverStep<S>

where S::Float: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: State> From<(S, Option<Termination<<S as State>::Float>>)> for SolverStep<S>

fn from((state, termination): (S, Option<Termination<S::Float>>)) -> Self

Converts to this type from the input type.