solverforge-scoring 0.7.0

Incremental constraint scoring 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
119
120
121

// Unit tests for IncrementalTriConstraint.

use crate::api::constraint_set::IncrementalConstraint;
use crate::constraint::IncrementalTriConstraint;
use solverforge_core::score::SoftScore;
use solverforge_core::{ConstraintRef, ImpactType};

#[derive(Clone, Debug, Hash, PartialEq, Eq)]
struct Task {
    team: u32,
}

#[derive(Clone)]
struct Solution {
    tasks: Vec<Task>,
}

fn tasks(s: &Solution) -> &[Task] {
    s.tasks.as_slice()
}

#[test]
fn test_tri_constraint_evaluate() {
    let constraint = IncrementalTriConstraint::new(
        ConstraintRef::new("", "Cluster"),
        ImpactType::Penalty,
        tasks,
        |_s: &Solution, t: &Task, _idx: usize| t.team,
        |_s: &Solution, _a: &Task, _b: &Task, _c: &Task| true,
        |_s: &Solution, _a_idx: usize, _b_idx: usize, _c_idx: usize| SoftScore::of(1),
        false,
    );

    let solution = Solution {
        tasks: vec![
            Task { team: 1 },
            Task { team: 1 },
            Task { team: 1 },
            Task { team: 2 },
        ],
    };

    // One triple on team 1: (0, 1, 2) = -1 penalty
    assert_eq!(constraint.evaluate(&solution), SoftScore::of(-1));
}

#[test]
fn test_tri_constraint_multiple_triples() {
    let constraint = IncrementalTriConstraint::new(
        ConstraintRef::new("", "Cluster"),
        ImpactType::Penalty,
        tasks,
        |_s: &Solution, t: &Task, _idx: usize| t.team,
        |_s: &Solution, _a: &Task, _b: &Task, _c: &Task| true,
        |_s: &Solution, _a_idx: usize, _b_idx: usize, _c_idx: usize| SoftScore::of(1),
        false,
    );

    let solution = Solution {
        tasks: vec![
            Task { team: 1 },
            Task { team: 1 },
            Task { team: 1 },
            Task { team: 1 },
        ],
    };

    // Four tasks on same team = C(4,3) = 4 triples
    assert_eq!(constraint.evaluate(&solution), SoftScore::of(-4));
}

#[test]
fn test_tri_constraint_incremental() {
    let mut constraint = IncrementalTriConstraint::new(
        ConstraintRef::new("", "Cluster"),
        ImpactType::Penalty,
        tasks,
        |_s: &Solution, t: &Task, _idx: usize| t.team,
        |_s: &Solution, _a: &Task, _b: &Task, _c: &Task| true,
        |_s: &Solution, _a_idx: usize, _b_idx: usize, _c_idx: usize| SoftScore::of(1),
        false,
    );

    let solution = Solution {
        tasks: vec![Task { team: 1 }, Task { team: 1 }, Task { team: 1 }],
    };

    // Initialize with 3 tasks on same team = 1 triple
    let total = constraint.initialize(&solution);
    assert_eq!(total, SoftScore::of(-1));

    // Retract one task
    let delta = constraint.on_retract(&solution, 0, 0);
    // Removes the triple = +1
    assert_eq!(delta, SoftScore::of(1));

    // Re-insert the task
    let delta = constraint.on_insert(&solution, 0, 0);
    // Re-adds the triple = -1
    assert_eq!(delta, SoftScore::of(-1));
}

#[test]
fn test_tri_constraint_reward() {
    let constraint = IncrementalTriConstraint::new(
        ConstraintRef::new("", "Team bonus"),
        ImpactType::Reward,
        tasks,
        |_s: &Solution, t: &Task, _idx: usize| t.team,
        |_s: &Solution, _a: &Task, _b: &Task, _c: &Task| true,
        |_s: &Solution, _a_idx: usize, _b_idx: usize, _c_idx: usize| SoftScore::of(5),
        false,
    );

    let solution = Solution {
        tasks: vec![Task { team: 1 }, Task { team: 1 }, Task { team: 1 }],
    };

    // One triple = +5 reward
    assert_eq!(constraint.evaluate(&solution), SoftScore::of(5));
}