Skip to main content

SolverEvent

Enum SolverEvent 

Source
pub enum SolverEvent {
    SolveRequested {
        algorithm: Algorithm,
        matrix_rows: usize,
        matrix_nnz: usize,
        lane: ComputeLane,
    },
    IterationCompleted {
        iteration: usize,
        residual: f64,
        elapsed: Duration,
    },
    SolveConverged {
        algorithm: Algorithm,
        iterations: usize,
        residual: f64,
        wall_time: Duration,
    },
    AlgorithmFallback {
        from: Algorithm,
        to: Algorithm,
        reason: String,
    },
    BudgetExhausted {
        algorithm: Algorithm,
        limit: BudgetLimit,
        elapsed: Duration,
    },
}
Expand description

Events emitted during a solver invocation.

Events are tagged with #[serde(tag = "type")] so they serialise as { "type": "SolveRequested", ... } for easy ingestion into event stores.

Variants§

§

SolveRequested

A solve request was received and is about to begin.

Fields

§algorithm: Algorithm

Algorithm that will be attempted first.

§matrix_rows: usize

Matrix dimension (number of rows).

§matrix_nnz: usize

Number of non-zeros.

§lane: ComputeLane

Compute lane.

§

IterationCompleted

One iteration of the solver completed.

Fields

§iteration: usize

Iteration number (0-indexed).

§residual: f64

Current residual norm.

§elapsed: Duration

Wall time elapsed since the solve began.

§

SolveConverged

The solver converged successfully.

Fields

§algorithm: Algorithm

Algorithm that produced the result.

§iterations: usize

Total iterations executed.

§residual: f64

Final residual norm.

§wall_time: Duration

Total wall time.

§

AlgorithmFallback

The solver fell back from one algorithm to another (e.g. Neumann series spectral radius too high, falling back to CG).

Fields

§from: Algorithm

Algorithm that failed or was deemed unsuitable.

§to: Algorithm

Algorithm that will be tried next.

§reason: String

Human-readable reason for the fallback.

§

BudgetExhausted

The compute budget was exhausted before convergence.

Fields

§algorithm: Algorithm

Algorithm that was running when the budget was hit.

§limit: BudgetLimit

Which budget limit was hit.

§elapsed: Duration

Wall time elapsed.

Trait Implementations§

Source§

impl Clone for SolverEvent

Source§

fn clone(&self) -> SolverEvent

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 Debug for SolverEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SolverEvent

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for SolverEvent

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,