Struct StepScope

Source

pub struct StepScope<'t, 'a, 'b, S: PlanningSolution, D: ScoreDirector<S>> { /* private fields */ }

Expand description

Scope for a single step within a phase.

§Type Parameters

't - Lifetime of the termination flag
'a - Lifetime of the phase scope reference
'b - Lifetime of the solver scope reference
S - The planning solution type
D - The score director type

Implementations§

Source §

impl<'t, 'a, 'b, S: PlanningSolution, D: ScoreDirector<S>> StepScope<'t, 'a, 'b, S, D>

Source

pub fn new(phase_scope: &'a mut PhaseScope<'t, 'b, S, D>) -> Self

Creates a new step scope.

Source

pub fn step_index(&self) -> u64

Returns the step index within the phase.

Source

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

Returns the step score.

Source

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

Sets the step score.

Source

pub fn complete(&mut self)

Marks this step as complete and increments counters.

Source

pub fn phase_scope(&self) -> &PhaseScope<'t, 'b, S, D>

Returns a reference to the phase scope.

Source

pub fn phase_scope_mut(&mut self) -> &mut PhaseScope<'t, 'b, S, D>

Returns a mutable reference to the phase scope.

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 calculate_score(&mut self) -> S::Score

Calculates the current score.

Auto Trait Implementations§

§

impl<'t, 'a, 'b, S, D> Freeze for StepScope<'t, 'a, 'b, S, D>
where <S as PlanningSolution>::Score: Freeze,

§

impl<'t, 'a, 'b, S, D> RefUnwindSafe for StepScope<'t, 'a, 'b, S, D>
where <S as PlanningSolution>::Score: RefUnwindSafe, D: RefUnwindSafe, S: RefUnwindSafe,

§

impl<'t, 'a, 'b, S, D> Send for StepScope<'t, 'a, 'b, S, D>

§

impl<'t, 'a, 'b, S, D> Sync for StepScope<'t, 'a, 'b, S, D>
where D: Sync,

§

impl<'t, 'a, 'b, S, D> Unpin for StepScope<'t, 'a, 'b, S, D>
where <S as PlanningSolution>::Score: Unpin,

§

impl<'t, 'a, 'b, S, D> !UnwindSafe for StepScope<'t, 'a, 'b, 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 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 §