Skip to main content

ListClarkeWrightPhase

Struct ListClarkeWrightPhase 

Source
pub struct ListClarkeWrightPhase<S, E>
where S: PlanningSolution, E: Copy + Send + Sync + 'static,
{ /* private fields */ }
Expand description

List construction phase using Clarke-Wright savings algorithm.

Builds routes by computing a savings value for every pair of elements, then greedily merges singleton routes in descending savings order, subject to a capacity constraint. All domain knowledge is supplied by the caller via function pointers — no time-window feasibility or post-processing is performed inside the phase.

§Algorithm

1. For every pair (i, j) where i < j (depot excluded):
       savings(i, j) = dist(depot, i) + dist(depot, j) - dist(i, j)
2. Sort savings descending.
3. Start with each element in its own singleton route.
4. For each (i, j) in savings order:
       - Skip if i or j are in the same route.
       - Skip if merged load exceeds capacity.
       - Skip if i is not an endpoint of its route, or j is not.
       - Orient and merge the two routes.
5. Assign each non-empty route to an entity via assign_route.

§Example

use solverforge_solver::ListClarkeWrightPhase;
use solverforge_core::domain::PlanningSolution;
use solverforge_core::score::SoftScore;

#[derive(Clone)]
struct Vehicle { route: Vec<usize> }

#[derive(Clone)]
struct Plan {
    vehicles: Vec<Vehicle>,
    n_stops: usize,
    score: Option<SoftScore>,
}

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

let phase = ListClarkeWrightPhase::<Plan, usize>::new(
    |p| p.n_stops,
    |p| p.vehicles.iter().flat_map(|v| v.route.iter().copied()).collect(),
    |p| p.vehicles.len(),
    |p, entity_idx, route| {
        if let Some(v) = p.vehicles.get_mut(entity_idx) {
            v.route = route;
        }
    },
    |_p, idx| idx,
    |_p| 0,            // depot index
    |_p, i, j| (i as i64 - j as i64).abs(),  // distance fn
    |_p, _idx| 1,      // unit load per element
    |_p| 10,           // capacity per route
    None,              // merge_feasible_fn: no extra feasibility check
    0,
);

Implementations§

Source§

impl<S, E> ListClarkeWrightPhase<S, E>
where S: PlanningSolution, E: Copy + Send + Sync + 'static,

Source

pub fn new( element_count: fn(&S) -> usize, get_assigned: fn(&S) -> Vec<E>, entity_count: fn(&S) -> usize, assign_route: fn(&mut S, usize, Vec<E>), index_to_element: fn(&S, usize) -> E, depot_fn: fn(&S) -> usize, distance_fn: fn(&S, usize, usize) -> i64, element_load_fn: fn(&S, usize) -> i64, capacity_fn: fn(&S) -> i64, merge_feasible_fn: Option<fn(&S, &[usize]) -> bool>, descriptor_index: usize, ) -> Self

Creates a new Clarke-Wright savings construction phase.

§Arguments
  • element_count — Total number of elements (stops) to assign
  • get_assigned — Returns currently assigned elements
  • entity_count — Number of entities (vehicles/routes)
  • assign_route — Assigns a complete route Vec<E> to entity at index
  • index_to_element — Converts an element index to its domain value
  • depot_fn — Returns the depot element index (excluded from savings pairs)
  • distance_fn — Distance between two element indices
  • element_load_fn — Load contributed by element at given index
  • capacity_fn — Maximum load per route
  • merge_feasible_fn — Optional feasibility gate called after capacity and endpoint checks. Receives the solution and the candidate merged route (as element indices); return false to skip the merge.
  • descriptor_index — Entity descriptor index for change notification

Trait Implementations§

Source§

impl<S, E> Debug for ListClarkeWrightPhase<S, E>
where S: PlanningSolution, E: Copy + Send + Sync + 'static,

Source§

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

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

impl<S, E, D, BestCb> Phase<S, D, BestCb> for ListClarkeWrightPhase<S, E>
where S: PlanningSolution, E: Copy + Send + Sync + 'static, D: Director<S>, BestCb: BestSolutionCallback<S>,

Source§

fn solve(&mut self, solver_scope: &mut SolverScope<'_, S, D, BestCb>)

Executes this phase. Read more
Source§

fn phase_type_name(&self) -> &'static str

Returns the name of this phase type.

Auto Trait Implementations§

§

impl<S, E> Freeze for ListClarkeWrightPhase<S, E>

§

impl<S, E> RefUnwindSafe for ListClarkeWrightPhase<S, E>

§

impl<S, E> Send for ListClarkeWrightPhase<S, E>

§

impl<S, E> Sync for ListClarkeWrightPhase<S, E>

§

impl<S, E> Unpin for ListClarkeWrightPhase<S, E>

§

impl<S, E> UnsafeUnpin for ListClarkeWrightPhase<S, E>

§

impl<S, E> UnwindSafe for ListClarkeWrightPhase<S, E>

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