StatisticsCollector

Struct StatisticsCollector 

Source
pub struct StatisticsCollector<Sc: Score> { /* private fields */ }
Expand description

Thread-safe collector for solver statistics.

Use this to record statistics during solving. After solving, call into_statistics() to get the final SolverStatistics.

Implementations§

Source§

impl<Sc: Score> StatisticsCollector<Sc>

Source

pub fn new() -> Self

Creates a new statistics collector.

The start time is recorded when this is called.

Source

pub fn record_move_evaluated(&self)

Records a move evaluation.

Call this each time a move is evaluated, regardless of whether it was accepted.

Source

pub fn record_move_accepted(&self)

Records an accepted move.

Call this when a move is accepted (in addition to record_move_evaluated).

Source

pub fn record_move(&self, accepted: bool)

Records both evaluation and acceptance for a move.

Convenience method when you know the move was accepted.

Source

pub fn record_step(&self)

Records a step completion.

Source

pub fn record_score_calculation(&self)

Records a score calculation.

Source

pub fn record_improvement(&self, score: Sc)

Records a score improvement.

Call this when a new best score is found.

Source

pub fn start_phase(&self, phase_type: impl Into<String>) -> usize

Starts a new phase and returns its index.

Call this at the beginning of each phase.

Source

pub fn end_phase( &self, phase_index: usize, duration: Duration, step_count: u64, moves_evaluated: u64, moves_accepted: u64, starting_score: Option<Sc>, ending_score: Option<Sc>, )

Ends the current phase with the given statistics.

Call this at the end of each phase.

Source

pub fn elapsed(&self) -> Duration

Returns the elapsed time since solving started.

Source

pub fn current_step_count(&self) -> u64

Returns the current step count.

Source

pub fn current_moves_evaluated(&self) -> u64

Returns the current moves evaluated count.

Source

pub fn current_moves_accepted(&self) -> u64

Returns the current moves accepted count.

Source

pub fn current_score_calculations(&self) -> u64

Returns the current score calculation count.

Source

pub fn into_statistics(self) -> SolverStatistics<Sc>

Converts this collector into final statistics.

This consumes the collector and returns the complete statistics.

Source

pub fn snapshot(&self) -> SolverStatistics<Sc>

Takes a snapshot of current statistics without consuming the collector.

Trait Implementations§

Source§

impl<Sc: Score> Default for StatisticsCollector<Sc>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<Sc> !Freeze for StatisticsCollector<Sc>

§

impl<Sc> RefUnwindSafe for StatisticsCollector<Sc>

§

impl<Sc> Send for StatisticsCollector<Sc>

§

impl<Sc> Sync for StatisticsCollector<Sc>

§

impl<Sc> Unpin for StatisticsCollector<Sc>
where Sc: Unpin,

§

impl<Sc> UnwindSafe for StatisticsCollector<Sc>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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