solverforge-solver 0.8.5

Solver engine for SolverForge
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

// Score-based termination conditions.

use std::fmt::Debug;

use solverforge_core::domain::PlanningSolution;
use solverforge_core::score::Score;
use solverforge_scoring::Director;

use super::Termination;
use crate::scope::ProgressCallback;
use crate::scope::SolverScope;

/* Terminates when the best score reaches or exceeds a target score.

This is useful when you know what score you're aiming for (e.g., a perfect
score of 0 for constraint satisfaction problems).

# Example

```
use solverforge_solver::termination::BestScoreTermination;
use solverforge_core::score::SoftScore;

// Terminate when score reaches 0 (no constraint violations)
let term: BestScoreTermination<SoftScore> = BestScoreTermination::new(SoftScore::of(0));
```
*/
#[derive(Debug, Clone)]
pub struct BestScoreTermination<Sc: Score> {
    target_score: Sc,
}

impl<Sc: Score> BestScoreTermination<Sc> {
    pub fn new(target_score: Sc) -> Self {
        Self { target_score }
    }
}

impl<S, D, BestCb, Sc> Termination<S, D, BestCb> for BestScoreTermination<Sc>
where
    S: PlanningSolution<Score = Sc>,
    D: Director<S>,
    BestCb: ProgressCallback<S>,
    Sc: Score,
{
    fn is_terminated(&self, solver_scope: &SolverScope<S, D, BestCb>) -> bool {
        solver_scope
            .best_score()
            .map(|score| *score >= self.target_score)
            .unwrap_or(false)
    }
}

/// Terminates when the best score becomes feasible.
///
/// A score is considered feasible when it meets a feasibility check defined
/// by a user-provided function. For HardSoftScore, this typically means
/// hard score >= 0 (no hard constraint violations).
///
/// # Zero-Erasure Design
///
/// The feasibility check function `F` is stored as a concrete generic type
/// parameter, eliminating virtual dispatch overhead when checking termination.
pub struct BestScoreFeasibleTermination<S, F>
where
    S: PlanningSolution,
    F: Fn(&S::Score) -> bool + Send + Sync,
{
    feasibility_check: F,
    _phantom: std::marker::PhantomData<fn() -> S>,
}

impl<S, F> Debug for BestScoreFeasibleTermination<S, F>
where
    S: PlanningSolution,
    F: Fn(&S::Score) -> bool + Send + Sync,
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("BestScoreFeasibleTermination").finish()
    }
}

impl<S, F> BestScoreFeasibleTermination<S, F>
where
    S: PlanningSolution,
    F: Fn(&S::Score) -> bool + Send + Sync,
{
    pub fn new(feasibility_check: F) -> Self {
        Self {
            feasibility_check,
            _phantom: std::marker::PhantomData,
        }
    }
}

impl<S: PlanningSolution> BestScoreFeasibleTermination<S, fn(&S::Score) -> bool> {
    /// Creates a termination that checks if score >= zero.
    ///
    /// This is the typical feasibility check for most score types.
    pub fn score_at_least_zero() -> Self {
        Self::new(|score| *score >= S::Score::zero())
    }
}

impl<S, D, BestCb, F> Termination<S, D, BestCb> for BestScoreFeasibleTermination<S, F>
where
    S: PlanningSolution,
    D: Director<S>,
    BestCb: ProgressCallback<S>,
    F: Fn(&S::Score) -> bool + Send + Sync,
{
    fn is_terminated(&self, solver_scope: &SolverScope<S, D, BestCb>) -> bool {
        solver_scope
            .best_score()
            .map(|score| (self.feasibility_check)(score))
            .unwrap_or(false)
    }
}