converge-optimization 3.2.1

Optimization algorithms for converge.zone - Rust reimplementation of OR-Tools subset
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

//! Invariants for Shipping Choice pack

use super::types::ShippingChoiceOutput;
use crate::gate::Violation;
use crate::packs::{InvariantDef, InvariantResult};

/// Get invariant definitions
pub fn get_invariants() -> Vec<InvariantDef> {
    vec![
        InvariantDef::critical(
            "carrier_selected",
            "A carrier must be selected for valid orders",
        ),
        InvariantDef::critical(
            "cost_positive",
            "Shipping cost must be positive when carrier selected",
        ),
        InvariantDef::advisory(
            "meets_sla",
            "Selected carrier should meet the SLA requirement",
        ),
        InvariantDef::advisory(
            "cost_reasonable",
            "Shipping cost should be reasonable relative to alternatives",
        ),
    ]
}

/// Invariant definitions constant
pub const INVARIANTS: &[InvariantDef] = &[];

/// Check all invariants
pub fn check_all_invariants(output: &ShippingChoiceOutput) -> Vec<InvariantResult> {
    vec![
        check_carrier_selected(output),
        check_cost_positive(output),
        check_meets_sla(output),
        check_cost_reasonable(output),
    ]
}

fn check_carrier_selected(output: &ShippingChoiceOutput) -> InvariantResult {
    let invariant = "carrier_selected";

    if output.selected_carrier.is_some() {
        InvariantResult::pass(invariant)
    } else {
        let violation = Violation::new(
            invariant,
            1.0,
            format!("No carrier selected: {}", output.selection_reason),
        );
        InvariantResult::fail(invariant, violation)
    }
}

fn check_cost_positive(output: &ShippingChoiceOutput) -> InvariantResult {
    let invariant = "cost_positive";

    if output.selected_carrier.is_none() {
        return InvariantResult::pass(invariant);
    }

    if output.cost > 0.0 {
        InvariantResult::pass(invariant)
    } else {
        let violation = Violation::new(
            invariant,
            1.0,
            format!("Invalid shipping cost: {}", output.cost),
        );
        InvariantResult::fail(invariant, violation)
    }
}

fn check_meets_sla(output: &ShippingChoiceOutput) -> InvariantResult {
    let invariant = "meets_sla";

    if output.selected_carrier.is_none() {
        return InvariantResult::pass(invariant);
    }

    if output.meets_sla {
        InvariantResult::pass(invariant)
    } else {
        let violation = Violation::new(
            invariant,
            0.5,
            format!(
                "Selected carrier does not meet SLA ({} days)",
                output.estimated_days
            ),
        );
        InvariantResult::fail(invariant, violation)
    }
}

fn check_cost_reasonable(output: &ShippingChoiceOutput) -> InvariantResult {
    let invariant = "cost_reasonable";

    if output.selected_carrier.is_none() || output.alternatives.is_empty() {
        return InvariantResult::pass(invariant);
    }

    // Check if selected cost is not significantly higher than cheapest alternative
    let min_alt_cost = output
        .alternatives
        .iter()
        .map(|a| a.cost)
        .fold(f64::INFINITY, f64::min);

    if output.cost <= min_alt_cost * 1.5 {
        InvariantResult::pass(invariant)
    } else {
        let violation = Violation::new(
            invariant,
            0.3,
            format!(
                "Selected cost ${:.2} is significantly higher than alternative ${:.2}",
                output.cost, min_alt_cost
            ),
        );
        InvariantResult::fail(invariant, violation)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::packs::shipping_choice::types::*;

    fn create_valid_output() -> ShippingChoiceOutput {
        ShippingChoiceOutput {
            selected_carrier: Some("ups".to_string()),
            selected_service: Some("ground".to_string()),
            cost: 8.99,
            estimated_days: 5,
            meets_sla: true,
            selection_reason: "Lowest cost".to_string(),
            alternatives: vec![AlternativeCarrier {
                carrier_id: "fedex".to_string(),
                service_level: "express".to_string(),
                cost: 15.99,
                reason_not_selected: "Higher cost".to_string(),
            }],
        }
    }

    #[test]
    fn test_all_pass_valid_output() {
        let output = create_valid_output();
        let results = check_all_invariants(&output);

        for result in &results {
            assert!(result.passed, "Invariant {} failed", result.invariant);
        }
    }

    #[test]
    fn test_no_carrier_fails() {
        let output = ShippingChoiceOutput::no_carrier("No carriers available");
        let results = check_all_invariants(&output);

        let carrier_result = results
            .iter()
            .find(|r| r.invariant == "carrier_selected")
            .unwrap();
        assert!(!carrier_result.passed);
    }

    #[test]
    fn test_sla_not_met() {
        let mut output = create_valid_output();
        output.meets_sla = false;

        let result = check_meets_sla(&output);
        assert!(!result.passed);
        assert!(result.violation.as_ref().unwrap().severity < 1.0); // Advisory
    }
}