SolverScope

Struct SolverScope 

Source
pub struct SolverScope<'t, S: PlanningSolution, D: ScoreDirector<S>> { /* private fields */ }
Expand description

Top-level scope for the entire solving process.

Holds the working solution, score director, and tracks the best solution found.

§Type Parameters

  • 't - Lifetime of the termination flag reference
  • S - The planning solution type
  • D - The score director type

Implementations§

Source§

impl<'t, S: PlanningSolution, D: ScoreDirector<S>> SolverScope<'t, S, D>

Source

pub fn new(score_director: D) -> Self

Creates a new solver scope with the given score director.

Source

pub fn with_terminate( score_director: D, terminate: Option<&'t AtomicBool>, ) -> Self

Creates a solver scope with a termination flag.

Source

pub fn with_seed(score_director: D, seed: u64) -> Self

Creates a solver scope with a specific random seed.

Source

pub fn start_solving(&mut self)

Marks the start of solving.

Source

pub fn elapsed(&self) -> Option<Duration>

Returns the elapsed time since solving started.

Source

pub fn score_director(&self) -> &D

Returns a reference to the score director.

Source

pub fn score_director_mut(&mut self) -> &mut D

Returns a mutable reference to the score director.

Source

pub fn working_solution(&self) -> &S

Returns a reference to the working solution.

Source

pub fn working_solution_mut(&mut self) -> &mut S

Returns a mutable reference to the working solution.

Source

pub fn calculate_score(&mut self) -> S::Score

Calculates and returns the current score.

Source

pub fn best_solution(&self) -> Option<&S>

Returns the best solution found so far.

Source

pub fn best_score(&self) -> Option<&S::Score>

Returns the best score found so far.

Source

pub fn update_best_solution(&mut self)

Updates the best solution if the current solution is better.

Source

pub fn set_best_solution(&mut self, solution: S, score: S::Score)

Forces an update of the best solution regardless of score comparison.

Source

pub fn rng(&mut self) -> &mut StdRng

Returns a reference to the RNG.

Source

pub fn increment_step_count(&mut self) -> u64

Increments and returns the total step count.

Source

pub fn total_step_count(&self) -> u64

Returns the total step count.

Source

pub fn take_best_solution(self) -> Option<S>

Extracts the best solution, consuming this scope.

Source

pub fn take_best_or_working_solution(self) -> S

Returns the best solution or the current working solution if no best was set.

Source

pub fn is_terminate_early(&self) -> bool

Checks if early termination was requested (external flag only).

Source

pub fn set_time_limit(&mut self, limit: Duration)

Sets the time limit for solving.

Source

pub fn should_terminate(&self) -> bool

Checks if solving should terminate (external flag OR time limit).

Source

pub fn stats(&self) -> &SolverStats

Returns a reference to the solver statistics.

Source

pub fn stats_mut(&mut self) -> &mut SolverStats

Returns a mutable reference to the solver statistics.

Auto Trait Implementations§

§

impl<'t, S, D> Freeze for SolverScope<'t, S, D>
where D: Freeze, S: Freeze, <S as PlanningSolution>::Score: Freeze,

§

impl<'t, S, D> RefUnwindSafe for SolverScope<'t, S, D>

§

impl<'t, S, D> Send for SolverScope<'t, S, D>

§

impl<'t, S, D> Sync for SolverScope<'t, S, D>
where D: Sync,

§

impl<'t, S, D> Unpin for SolverScope<'t, S, D>
where D: Unpin, S: Unpin, <S as PlanningSolution>::Score: Unpin,

§

impl<'t, S, D> UnwindSafe for SolverScope<'t, S, D>

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