solverforge_solver/manager/
solution_manager.rs

1//! Stateless score analysis for planning solutions.
2
3use solverforge_core::domain::PlanningSolution;
4use solverforge_core::score::Score;
5
6/// Analysis of a single constraint's contribution to the score.
7#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
8#[serde(rename_all = "camelCase")]
9pub struct ConstraintAnalysis<Sc> {
10    /// Name of the constraint.
11    pub name: String,
12    /// Weight of the constraint.
13    pub weight: Sc,
14    /// Score contribution from this constraint.
15    pub score: Sc,
16    /// Number of matches (violations or rewards).
17    pub match_count: usize,
18}
19
20/// Result of analyzing a solution's constraints.
21#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
22#[serde(rename_all = "camelCase")]
23pub struct ScoreAnalysis<Sc> {
24    /// The total score.
25    pub score: Sc,
26    /// Analysis of each constraint.
27    pub constraints: Vec<ConstraintAnalysis<Sc>>,
28}
29
30/// Trait for solutions that can be analyzed for constraint violations.
31///
32/// This trait is implemented by the `#[planning_solution]` macro when
33/// `constraints` is specified. It provides constraint analysis without
34/// knowing the concrete solution type.
35///
36/// # Example
37///
38/// ```
39/// use solverforge_core::domain::PlanningSolution;
40/// use solverforge_core::score::SoftScore;
41/// use solverforge_solver::manager::{Analyzable, ScoreAnalysis, ConstraintAnalysis};
42///
43/// #[derive(Clone)]
44/// struct Schedule {
45///     score: Option<SoftScore>,
46/// }
47///
48/// impl PlanningSolution for Schedule {
49///     type Score = SoftScore;
50///     fn score(&self) -> Option<Self::Score> { self.score }
51///     fn set_score(&mut self, score: Option<Self::Score>) { self.score = score; }
52/// }
53///
54/// impl Analyzable for Schedule {
55///     fn analyze(&self) -> ScoreAnalysis<SoftScore> {
56///         ScoreAnalysis {
57///             score: SoftScore::of(0),
58///             constraints: vec![],
59///         }
60///     }
61/// }
62///
63/// let schedule = Schedule { score: Some(SoftScore::of(0)) };
64/// let analysis = schedule.analyze();
65/// assert_eq!(analysis.score, SoftScore::of(0));
66/// ```
67pub trait Analyzable: PlanningSolution + Clone + Send + 'static {
68    /// Analyzes the solution and returns constraint breakdowns.
69    fn analyze(&self) -> ScoreAnalysis<Self::Score>;
70}
71
72/// Analyzes a solution for constraint violations.
73///
74/// Returns a breakdown of each constraint's contribution to the score.
75///
76/// # Example
77///
78/// ```
79/// use solverforge_core::domain::PlanningSolution;
80/// use solverforge_core::score::SoftScore;
81/// use solverforge_solver::manager::{analyze, Analyzable, ScoreAnalysis};
82///
83/// #[derive(Clone)]
84/// struct Schedule { score: Option<SoftScore> }
85///
86/// impl PlanningSolution for Schedule {
87///     type Score = SoftScore;
88///     fn score(&self) -> Option<Self::Score> { self.score }
89///     fn set_score(&mut self, score: Option<Self::Score>) { self.score = score; }
90/// }
91///
92/// impl Analyzable for Schedule {
93///     fn analyze(&self) -> ScoreAnalysis<SoftScore> {
94///         ScoreAnalysis { score: SoftScore::of(0), constraints: vec![] }
95///     }
96/// }
97///
98/// let schedule = Schedule { score: Some(SoftScore::of(0)) };
99/// let result = analyze(&schedule);
100/// assert_eq!(result.score, SoftScore::of(0));
101/// ```
102pub fn analyze<S>(solution: &S) -> ScoreAnalysis<S::Score>
103where
104    S: Analyzable,
105    S::Score: Score,
106{
107    solution.analyze()
108}
solverforge_solver/manager/solution_manager.rs

solverforge_solver/manager/
solution_manager.rs
