Trait PlanningSolution

Source

pub trait PlanningSolution:
    Send
    + Sync
    + Clone {
    type Score: Score;

    // Required methods
    fn domain_model() -> DomainModel;
    fn constraints() -> ConstraintSet;
    fn score(&self) -> Option<Self::Score>;
    fn set_score(&mut self, score: Self::Score);
    fn to_json(&self) -> SolverForgeResult<String>;
    fn from_json(json: &str) -> SolverForgeResult<Self>
       where Self: Sized;
}

Expand description

Marker trait for types that can be used as planning solutions.

A planning solution contains:

Problem facts: immutable data that constraints can reference
Planning entities: objects that can be changed during solving
A score: represents the quality of the solution

§Requirements

Must have at least one planning entity collection
Must have a score field
Must provide a constraint provider function

§Derive Macro

This trait is typically implemented via #[derive(PlanningSolution)]:

#[derive(PlanningSolution)]
#[constraint_provider = "define_constraints"]
struct Timetable {
    #[problem_fact_collection]
    #[value_range_provider(id = "timeslots")]
    timeslots: Vec<Timeslot>,
    #[planning_entity_collection]
    lessons: Vec<Lesson>,
    #[planning_score]
    score: Option<HardSoftScore>,
}