Skip to main content

StopReason

Enum StopReason 

Source
pub enum StopReason {
    Completed,
    Optimal,
    TargetReached,
    IterationLimit,
    NoImprovement,
    TimeLimit,
    Cancelled,
}
Expand description

Why a solve stopped – the same vocabulary every runner in u-metaheur reports, so a nesting run and any other search say it in one set of words. Each strategy here sets it where it stops; Completed is a fill that tried every piece, or a search that spent the budget it is given internally. Why a run stopped: the run’s own account of the solution it returns.

The names follow the termination statuses of mathematical-programming solvers (Gurobi OPTIMAL · ITERATION_LIMIT · TIME_LIMIT · USER_OBJ_LIMIT · INTERRUPTED) and MATLAB ga’s stall generations.

Variants§

§

Completed

The method ran to its own end: a schedule that cooled to its final temperature, a construction that tried every element.

§

Optimal

An exact method proved the solution optimal.

§

TargetReached

The solution met the target the caller set, so the search stopped there.

§

IterationLimit

The search spent its generation or iteration budget.

§

NoImprovement

The search went its stall budget without improving its best solution, and stopped there.

§

TimeLimit

The time limit ran out; the solution is the best found by then.

§

Cancelled

The caller cancelled the run; the solution is the best found by then.

Implementations§

Source§

impl StopReason

Source

pub const ALL: [StopReason; 7]

Every reason, in declaration order.

Source

pub fn name(self) -> &'static str

The wire name ("time_limit", "no_improvement", …).

Source

pub fn cut_short(self) -> bool

Whether the run ended on something other than its own course: the caller cancelled it or its time limit ran out.

Trait Implementations§

Source§

impl Clone for StopReason

Source§

fn clone(&self) -> StopReason

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for StopReason

Source§

impl Debug for StopReason

Source§

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

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

impl Eq for StopReason

Source§

impl Hash for StopReason

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for StopReason

Source§

fn eq(&self, other: &StopReason) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for StopReason

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, 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.