Trait PlanningSolution

Source

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

    // Required methods
    fn score(&self) -> Option<Self::Score>;
    fn set_score(&mut self, score: Option<Self::Score>);

    // Provided method
    fn is_initialized(&self) -> bool { ... }
}

Expand description

Marker trait for planning solutions.

A planning solution represents both the problem definition and the (potentially partial) solution. It contains:

Problem facts: Immutable input data
Planning entities: Things to be optimized
Score: The quality of the current solution

§Example

use solverforge_core::{PlanningSolution, score::SimpleScore};

#[derive(Clone)]
struct NQueens {
    n: usize,
    rows: Vec<Option<usize>>,
    score: Option<SimpleScore>,
}

impl PlanningSolution for NQueens {
    type Score = SimpleScore;

    fn score(&self) -> Option<Self::Score> {
        self.score
    }

    fn set_score(&mut self, score: Option<Self::Score>) {
        self.score = score;
    }
}