converge-ferrox-solver 0.7.2

Iron-forged OR-Tools and HiGHS solvers as Converge Suggestors
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

use serde::{Deserialize, Serialize};

use converge_pack::{ExecutionIdentity, FactPayload};

use crate::domain_types::NodeId;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum FlowSolveStatus {
    NotSolved,
    Optimal,
    Feasible,
    Infeasible,
    Unbalanced,
    BadResult,
    BadCostRange,
    BadCapacityRange,
    Error,
    Invalid,
}

impl FlowSolveStatus {
    pub fn is_successful(self) -> bool {
        matches!(self, Self::Optimal | Self::Feasible)
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "snake_case")]
pub enum FlowSolveMode {
    /// Requires total supply and demand to balance and all demand to be served.
    #[default]
    BalancedMinCost,
    /// Sends as much flow as possible, then minimizes cost for that flow value.
    MaxFlowMinCost,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct FlowArc {
    pub name: String,
    pub tail: NodeId,
    pub head: NodeId,
    pub capacity: i64,
    pub unit_cost: i64,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct NodeSupply {
    pub node: NodeId,
    pub supply: i64,
}

/// Seeded into `ContextKey::Seeds` with id prefix `"network-flow-request:"`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct MinCostFlowRequest {
    pub id: String,
    pub arcs: Vec<FlowArc>,
    pub supplies: Vec<NodeSupply>,
    #[serde(default)]
    pub mode: FlowSolveMode,
}

impl FactPayload for MinCostFlowRequest {
    const FAMILY: &'static str = "ferrox.network_flow.request";
    const VERSION: u16 = 1;
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct FlowArcPlan {
    pub name: String,
    pub tail: NodeId,
    pub head: NodeId,
    pub capacity: i64,
    pub unit_cost: i64,
    pub flow: i64,
}

/// Written to `ContextKey::Strategies` with id prefix `"network-flow-plan-ortools:"`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct MinCostFlowPlan {
    pub request_id: String,
    pub status: FlowSolveStatus,
    pub mode: FlowSolveMode,
    pub arcs: Vec<FlowArcPlan>,
    pub optimal_cost: i64,
    pub expected_flow: i64,
    pub fulfilled_flow: i64,
    pub fulfillment_ratio: f64,
    pub solver: String,
    pub execution_identity: ExecutionIdentity,
}

impl FactPayload for MinCostFlowPlan {
    const FAMILY: &'static str = "ferrox.network_flow.plan";
    const VERSION: u16 = 1;
}