Trait vrp_core::construction::constraints::ConstraintModule

source · [−]

pub trait ConstraintModule {
    fn accept_insertion(
        &self, 
        solution_ctx: &mut SolutionContext, 
        route_index: usize, 
        job: &Job
    );
    fn accept_route_state(&self, ctx: &mut RouteContext);
    fn accept_solution_state(&self, ctx: &mut SolutionContext);
    fn merge(&self, source: Job, candidate: Job) -> Result<Job, i32>;
    fn state_keys(&self) -> Iter<'_, i32>;
    fn get_constraints(&self) -> Iter<'_, ConstraintVariant>;
}

Expand description

Represents a constraint module which can be added to constraint pipeline.

Required Methods

source

fn accept_insertion(
    &self,
    solution_ctx: &mut SolutionContext,
    route_index: usize,
    job: &Job
)

Accept insertion of specific job into the route. Called once job has been inserted into solution represented via solution_ctx. Target route is defined by route_index which refers to routes collection in solution context. Inserted job is job. This method should call accept_route_state internally. This method should NOT modify amount of job activities in the tour.

source

fn accept_route_state(&self, ctx: &mut RouteContext)

Accept route and updates its state to allow more efficient constraint checks. This method should NOT modify amount of job activities in the tour.

source

fn accept_solution_state(&self, ctx: &mut SolutionContext)

Accepts insertion solution context allowing to update job insertion data. This method called twice: before insertion of all jobs starts and when it ends. Please note, that it is important to update only stale routes as this allows to avoid updating non changed route states.

source

fn merge(&self, source: Job, candidate: Job) -> Result<Job, i32>

Tries to merge two jobs taking into account common constraints. Returns a new job, if it is possible to merge them together having theoretically assignable job. Otherwise returns violation error code.

source