ListRuinMove

Struct ListRuinMove 

Source
pub struct ListRuinMove<S, V> { /* private fields */ }
Expand description

A move that removes elements from a list for Large Neighborhood Search.

Elements are removed by index and stored for reinsertion by a construction heuristic. This is the list-variable equivalent of RuinMove.

§Type Parameters

  • S - The planning solution type
  • V - The list element value type

§Example

use solverforge_solver::heuristic::r#move::ListRuinMove;
use solverforge_core::domain::PlanningSolution;
use solverforge_core::score::SimpleScore;

#[derive(Clone, Debug)]
struct Route { stops: Vec<i32>, score: Option<SimpleScore> }

impl PlanningSolution for Route {
    type Score = SimpleScore;
    fn score(&self) -> Option<Self::Score> { self.score }
    fn set_score(&mut self, score: Option<Self::Score>) { self.score = score; }
}

fn list_len(s: &Route, _: usize) -> usize { s.stops.len() }
fn list_remove(s: &mut Route, _: usize, idx: usize) -> i32 { s.stops.remove(idx) }
fn list_insert(s: &mut Route, _: usize, idx: usize, v: i32) { s.stops.insert(idx, v); }

// Remove elements at indices 1 and 3 from the route
let m = ListRuinMove::<Route, i32>::new(
    0,
    &[1, 3],
    list_len, list_remove, list_insert,
    "stops", 0,
);

Implementations§

Source§

impl<S, V> ListRuinMove<S, V>

Source

pub fn new( entity_index: usize, element_indices: &[usize], list_len: fn(&S, usize) -> usize, list_remove: fn(&mut S, usize, usize) -> V, list_insert: fn(&mut S, usize, usize, V), variable_name: &'static str, descriptor_index: usize, ) -> Self

Creates a new list ruin move with typed function pointers.

§Arguments
  • entity_index - Entity index
  • element_indices - Indices of elements to remove
  • list_len - Function to get list length
  • list_remove - Function to remove element at index
  • list_insert - Function to insert element at index
  • variable_name - Name of the list variable
  • descriptor_index - Entity descriptor index
§Note

Indices are sorted internally for correct removal order.

Source

pub fn entity_index(&self) -> usize

Returns the entity index.

Source

pub fn element_indices(&self) -> &[usize]

Returns the element indices being removed.

Source

pub fn ruin_count(&self) -> usize

Returns the number of elements being removed.

Trait Implementations§

Source§

impl<S, V> Clone for ListRuinMove<S, V>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<S, V: Debug> Debug for ListRuinMove<S, V>

Source§

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

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

impl<S, V> Move<S> for ListRuinMove<S, V>
where S: PlanningSolution, V: Clone + Send + Sync + Debug + 'static,

Source§

fn is_doable<D: ScoreDirector<S>>(&self, score_director: &D) -> bool

Returns true if this move can be executed in the current state. Read more
Source§

fn do_move<D: ScoreDirector<S>>(&self, score_director: &mut D)

Executes this move, modifying the working solution. Read more
Source§

fn descriptor_index(&self) -> usize

Returns the descriptor index of the entity type this move affects.
Source§

fn entity_indices(&self) -> &[usize]

Returns the entity indices involved in this move.
Source§

fn variable_name(&self) -> &str

Returns the variable name this move affects.
Source§

impl<S, V> MoveSelector<S, ListRuinMove<S, V>> for ListRuinMoveSelector<S, V>
where S: PlanningSolution, V: Clone + Send + Sync + Debug + 'static,

Source§

fn iter_moves<'a, D: ScoreDirector<S>>( &'a self, score_director: &'a D, ) -> Box<dyn Iterator<Item = ListRuinMove<S, V>> + 'a>

Returns an iterator over typed moves.
Source§

fn size<D: ScoreDirector<S>>(&self, score_director: &D) -> usize

Returns the approximate number of moves.
Source§

fn is_never_ending(&self) -> bool

Returns true if this selector may return the same move multiple times.

Auto Trait Implementations§

§

impl<S, V> Freeze for ListRuinMove<S, V>

§

impl<S, V> RefUnwindSafe for ListRuinMove<S, V>
where V: RefUnwindSafe,

§

impl<S, V> Send for ListRuinMove<S, V>
where V: Send,

§

impl<S, V> Sync for ListRuinMove<S, V>
where V: Sync,

§

impl<S, V> Unpin for ListRuinMove<S, V>
where V: Unpin,

§

impl<S, V> UnwindSafe for ListRuinMove<S, V>
where V: UnwindSafe,

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