#[cfg(test)]
#[path = "../../../tests/unit/construction/heuristics/evaluators_test.rs"]
mod evaluators_test;
use std::sync::Arc;
use crate::construction::constraints::{ActivityConstraintViolation, ConstraintPipeline};
use crate::construction::heuristics::*;
use crate::models::common::Cost;
use crate::models::problem::{Job, Multi, Single};
use crate::models::solution::{Activity, Place};
use crate::utils::{unwrap_from_result, Either};
use std::iter::repeat;
#[derive(Copy, Clone)]
pub enum InsertionPosition {
Any,
Concrete(usize),
Last,
}
pub fn evaluate_job_insertion_in_route(
ctx: &InsertionContext,
route_ctx: &RouteContext,
job: &Job,
position: InsertionPosition,
alternative: InsertionResult,
result_selector: &(dyn ResultSelector + Send + Sync),
) -> InsertionResult {
match (route_ctx.is_stale(), ctx.solution.unassigned.get(job)) {
(false, Some(code)) if *code > 0 => return alternative,
_ => {}
}
let constraint = &ctx.problem.constraint;
if let Some(violation) = constraint.evaluate_hard_route(&ctx.solution, &route_ctx, job) {
return result_selector.select_insertion(
ctx,
alternative,
InsertionResult::make_failure_with_code(violation.code, true, Some(job.clone())),
);
}
let route_costs = constraint.evaluate_soft_route(&ctx.solution, &route_ctx, &job);
let best_known_cost = match &alternative {
InsertionResult::Success(success) => Some(success.cost),
_ => None,
};
if let Some(best_known_cost) = best_known_cost {
if best_known_cost < route_costs {
return alternative;
}
}
result_selector.select_insertion(
ctx,
alternative,
evaluate_job_constraint_in_route(
job,
constraint,
&route_ctx,
position,
route_costs,
best_known_cost,
result_selector,
),
)
}
pub fn evaluate_job_constraint_in_route(
job: &Job,
constraint: &ConstraintPipeline,
route_ctx: &RouteContext,
position: InsertionPosition,
route_costs: Cost,
best_known_cost: Option<Cost>,
r_selector: &(dyn ResultSelector + Send + Sync),
) -> InsertionResult {
match job {
Job::Single(single) => {
evaluate_single(job, single, constraint, &route_ctx, position, route_costs, best_known_cost, r_selector)
}
Job::Multi(multi) => {
evaluate_multi(job, multi, constraint, &route_ctx, position, route_costs, best_known_cost, r_selector)
}
}
}
#[allow(clippy::too_many_arguments)]
fn evaluate_single(
job: &Job,
single: &Arc<Single>,
constraint: &ConstraintPipeline,
route_ctx: &RouteContext,
position: InsertionPosition,
route_costs: Cost,
best_known_cost: Option<Cost>,
result_selector: &(dyn ResultSelector + Send + Sync),
) -> InsertionResult {
let insertion_idx = get_insertion_index(route_ctx, position);
let mut activity = Activity::new_with_job(single.clone());
let result = analyze_insertion_in_route(
constraint,
route_ctx,
insertion_idx,
single,
&mut activity,
SingleContext::new(best_known_cost, 0),
result_selector,
);
if result.is_success() {
activity.place = result.place.unwrap();
let activities = vec![(activity, result.index)];
InsertionResult::make_success(result.cost.unwrap() + route_costs, job.clone(), activities, route_ctx.clone())
} else {
let (code, stopped) = result.violation.map_or((0, false), |v| (v.code, v.stopped));
InsertionResult::make_failure_with_code(code, stopped, Some(job.clone()))
}
}
#[allow(clippy::too_many_arguments)]
fn evaluate_multi(
job: &Job,
multi: &Arc<Multi>,
constraint: &ConstraintPipeline,
route_ctx: &RouteContext,
position: InsertionPosition,
route_costs: Cost,
best_known_cost: Option<Cost>,
result_selector: &(dyn ResultSelector + Send + Sync),
) -> InsertionResult {
let insertion_idx = get_insertion_index(route_ctx, position).unwrap_or(0);
let result = unwrap_from_result(multi.permutations().into_iter().try_fold(
MultiContext::new(best_known_cost, insertion_idx),
|acc_res, services| {
let mut shadow = ShadowContext::new(constraint, &route_ctx);
let perm_res = unwrap_from_result(repeat(0).try_fold(MultiContext::new(None, insertion_idx), |out, _| {
if out.is_failure(route_ctx.route.tour.activity_count()) {
return Result::Err(out);
}
shadow.restore(route_ctx);
let sq_res = unwrap_from_result(services.iter().try_fold(out.next(), |in1, service| {
if in1.violation.is_some() {
return Result::Err(in1);
}
let mut activity = Activity::new_with_job(service.clone());
let srv_res = analyze_insertion_in_route(
&constraint,
&shadow.ctx,
None,
service,
&mut activity,
SingleContext::new(None, in1.next_index),
result_selector,
);
if srv_res.is_success() {
activity.place = srv_res.place.unwrap();
let activity = shadow.insert(activity, srv_res.index);
let activities = concat_activities(in1.activities, (activity, srv_res.index));
return MultiContext::success(in1.cost.unwrap_or(0.) + srv_res.cost.unwrap(), activities);
}
MultiContext::fail(srv_res, in1)
}));
MultiContext::promote(sq_res, out)
}));
MultiContext::promote(perm_res, acc_res)
},
));
if result.is_success() {
let activities = result.activities.unwrap();
InsertionResult::make_success(result.cost.unwrap() + route_costs, job.clone(), activities, route_ctx.clone())
} else {
let (code, stopped) = result.violation.map_or((0, false), |v| (v.code, v.stopped));
InsertionResult::make_failure_with_code(code, stopped, Some(job.clone()))
}
}
fn analyze_insertion_in_route(
constraint: &ConstraintPipeline,
route_ctx: &RouteContext,
insertion_idx: Option<usize>,
single: &Single,
target: &mut Activity,
init: SingleContext,
result_selector: &(dyn ResultSelector + Send + Sync),
) -> SingleContext {
unwrap_from_result(match insertion_idx {
Some(idx) => {
if let Some(leg) = route_ctx.route.tour.legs().nth(idx) {
analyze_insertion_in_route_leg(constraint, route_ctx, leg, single, target, init, result_selector)
} else {
Ok(init)
}
}
None => route_ctx.route.tour.legs().skip(init.index).try_fold(init, |out, leg| {
analyze_insertion_in_route_leg(constraint, route_ctx, leg, single, target, out, result_selector)
}),
})
}
fn analyze_insertion_in_route_leg<'a>(
constraint: &ConstraintPipeline,
route_ctx: &RouteContext,
leg: (&'a [Activity], usize),
single: &Single,
target: &mut Activity,
out: SingleContext,
result_selector: &(dyn ResultSelector + Send + Sync),
) -> Result<SingleContext, SingleContext> {
let (items, index) = leg;
let (prev, next) = match items {
[prev] => (prev, None),
[prev, next] => (prev, Some(next)),
_ => panic!("Unexpected route leg configuration."),
};
let start_time = route_ctx.route.tour.start().unwrap().schedule.departure;
single.places.iter().try_fold(out, |in1, detail| {
detail.times.iter().try_fold(in1, |in2, time| {
target.place = Place {
location: detail.location.unwrap_or(prev.place.location),
duration: detail.duration,
time: time.to_time_window(start_time),
};
let activity_ctx = ActivityContext { index, prev, target: &target, next };
if let Some(violation) = constraint.evaluate_hard_activity(route_ctx, &activity_ctx) {
return SingleContext::fail(violation, in2);
}
let costs = constraint.evaluate_soft_activity(route_ctx, &activity_ctx);
let other_costs = in2.cost.unwrap_or(f64::MAX);
match result_selector.select_cost(route_ctx, costs, other_costs) {
Either::Left => SingleContext::success(activity_ctx.index, costs, target.place.clone()),
Either::Right => SingleContext::skip(in2),
}
})
})
}
fn get_insertion_index(route_ctx: &RouteContext, position: InsertionPosition) -> Option<usize> {
match position {
InsertionPosition::Any => None,
InsertionPosition::Concrete(idx) => Some(idx),
InsertionPosition::Last => Some(route_ctx.route.tour.legs().count().max(1) - 1),
}
}
#[derive(Debug)]
struct SingleContext {
pub violation: Option<ActivityConstraintViolation>,
pub index: usize,
pub cost: Option<Cost>,
pub place: Option<Place>,
}
impl SingleContext {
fn new(cost: Option<Cost>, index: usize) -> Self {
Self { violation: None, index, cost, place: None }
}
fn fail(violation: ActivityConstraintViolation, other: SingleContext) -> Result<Self, Self> {
let stopped = violation.stopped;
let ctx = Self { violation: Some(violation), index: other.index, cost: other.cost, place: other.place };
if stopped {
Result::Err(ctx)
} else {
Result::Ok(ctx)
}
}
#[allow(clippy::unnecessary_wraps)]
fn success(index: usize, cost: Cost, place: Place) -> Result<Self, Self> {
Result::Ok(Self { violation: None, index, cost: Some(cost), place: Some(place) })
}
#[allow(clippy::unnecessary_wraps)]
fn skip(other: SingleContext) -> Result<Self, Self> {
Result::Ok(other)
}
fn is_success(&self) -> bool {
self.place.is_some()
}
}
struct MultiContext {
pub violation: Option<ActivityConstraintViolation>,
pub start_index: usize,
pub next_index: usize,
pub cost: Option<Cost>,
pub activities: Option<Vec<(Activity, usize)>>,
}
impl MultiContext {
fn new(cost: Option<Cost>, index: usize) -> Self {
Self { violation: None, start_index: index, next_index: index, cost, activities: None }
}
fn promote(left: Self, right: Self) -> Result<Self, Self> {
let index = left.start_index.max(right.start_index) + 1;
let best = match (left.cost, right.cost) {
(Some(left_cost), Some(right_cost)) => {
if left_cost < right_cost {
left
} else {
right
}
}
(Some(_), None) => left,
(None, Some(_)) => right,
_ => {
if left.violation.is_some() {
left
} else {
right
}
}
};
let result = Self {
violation: best.violation,
start_index: index,
next_index: index,
cost: best.cost,
activities: best.activities,
};
if result.violation.as_ref().map_or_else(|| false, |v| v.stopped) {
Result::Err(result)
} else {
Result::Ok(result)
}
}
fn fail(err_ctx: SingleContext, other_ctx: MultiContext) -> Result<Self, Self> {
let (code, stopped) =
err_ctx.violation.map_or((0, false), |v| (v.code, v.stopped && other_ctx.activities.is_none()));
Result::Err(Self {
violation: Some(ActivityConstraintViolation { code, stopped }),
start_index: other_ctx.start_index,
next_index: other_ctx.start_index,
cost: None,
activities: None,
})
}
#[allow(clippy::unnecessary_wraps)]
fn success(cost: Cost, activities: Vec<(Activity, usize)>) -> Result<Self, Self> {
Result::Ok(Self {
violation: None,
start_index: activities.first().unwrap().1,
next_index: activities.last().unwrap().1 + 1,
cost: Some(cost),
activities: Some(activities),
})
}
fn next(&self) -> Self {
Self {
violation: None,
start_index: self.start_index,
next_index: self.start_index,
cost: None,
activities: None,
}
}
fn is_success(&self) -> bool {
self.violation.is_none() && self.cost.is_some() && self.activities.is_some()
}
fn is_failure(&self, index: usize) -> bool {
self.violation.as_ref().map_or(false, |v| v.stopped) || (self.start_index > index)
}
}
struct ShadowContext<'a> {
is_mutated: bool,
is_dirty: bool,
constraint: &'a ConstraintPipeline,
ctx: RouteContext,
}
impl<'a> ShadowContext<'a> {
fn new(constraint: &'a ConstraintPipeline, ctx: &RouteContext) -> Self {
Self { is_mutated: false, is_dirty: false, constraint, ctx: ctx.clone() }
}
fn insert(&mut self, activity: Activity, index: usize) -> Activity {
if !self.is_mutated {
self.ctx = self.ctx.deep_copy();
self.is_mutated = true;
}
self.ctx.route_mut().tour.insert_at(activity.deep_copy(), index + 1);
self.constraint.accept_route_state(&mut self.ctx);
self.is_dirty = true;
activity
}
fn restore(&mut self, original: &RouteContext) {
if self.is_dirty {
self.ctx = original.clone();
self.is_mutated = false;
self.is_dirty = false;
}
}
}
fn concat_activities(
activities: Option<Vec<(Activity, usize)>>,
activity: (Activity, usize),
) -> Vec<(Activity, usize)> {
let mut activities = activities.unwrap_or_else(Vec::new);
activities.push((activity.0, activity.1));
activities
}