Skip to main content

AuditBuilder

Struct AuditBuilder 

Source
pub struct AuditBuilder { /* private fields */ }
Expand description

Convenience builder for SolverAuditEntry.

Start a timer at the beginning of a solve, then call [finish] with the result to produce a complete audit record.

§Example

let audit = AuditBuilder::start("req-42", &matrix, &rhs);
let result = solver.solve(&matrix, &rhs)?;
let entry = audit.finish(&result, tolerance);
tracing::info!(?entry, "solve completed");

Implementations§

Source§

impl AuditBuilder

Source

pub fn start( request_id: impl Into<String>, matrix: &CsrMatrix<f32>, rhs: &[f32], ) -> Self

Begin an audit trace for a new solve request.

Records the wall-clock start time and computes the input hash eagerly so that the hash is taken before any mutation.

Source

pub fn finish(self, result: &SolverResult, tolerance: f64) -> SolverAuditEntry

Finalize the audit entry after the solver returns.

tolerance is the target tolerance that was requested so that converged can be computed from the residual.

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> 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, 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