solverforge 0.6.0

SolverForge - A constraint solver in Rust
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

/* SolverForge - A Constraint Solver in Rust

SolverForge is a high-performance constraint satisfaction/optimization solver.
It helps you optimize planning and scheduling problems.

# Quick Start

```
use solverforge::prelude::*;

#[problem_fact]
pub struct Employee {
#[planning_id]
pub id: i64,
pub name: String,
}

#[planning_entity]
pub struct Shift {
#[planning_id]
pub id: i64,
#[planning_variable]
pub employee: Option<i64>,
}

#[planning_solution]
pub struct Schedule {
#[problem_fact_collection]
pub employees: Vec<Employee>,
#[planning_entity_collection]
pub shifts: Vec<Shift>,
#[planning_score]
pub score: Option<HardSoftScore>,
}
```
*/

/* ============================================================================
Attribute Macros
============================================================================
*/

pub use solverforge_macros::{planning_entity, planning_solution, problem_fact};

// Derive macros (used by attribute macros, must be at root level)
pub use solverforge_macros::{PlanningEntityImpl, PlanningSolutionImpl, ProblemFactImpl};

/* ============================================================================
Score Types
============================================================================
*/

pub use solverforge_core::score::{
    BendableScore, HardMediumSoftScore, HardSoftDecimalScore, HardSoftScore, Score, SoftScore,
};

/* ============================================================================
Constraint API
============================================================================
*/

pub use solverforge_scoring::{
    ConstraintSet, IncrementalBiConstraint, IncrementalConstraint, IncrementalUniConstraint,
};

/// Fluent constraint stream API.
pub mod stream {
    pub use solverforge_scoring::stream::collection_extract::vec;
    pub use solverforge_scoring::stream::collection_extract::{CollectionExtract, VecExtract};
    pub use solverforge_scoring::stream::{joiner, ConstraintFactory};
}

/* ============================================================================
Score Director
============================================================================
*/

pub use solverforge_scoring::{Director, ScoreDirector};

/* ============================================================================
Solver
============================================================================
*/

pub use solverforge_solver::heuristic::selector::DefaultDistanceMeter;
pub use solverforge_solver::CrossEntityDistanceMeter;
pub use solverforge_solver::{
    analyze, run_solver, Analyzable, BasicSpec, ConstraintAnalysis, ListSpec, ScoreAnalysis,
    Solvable, SolverManager, SolverStatus,
};

/* ============================================================================
CVRP domain helpers
============================================================================
*/

pub mod cvrp {
    pub use solverforge_cvrp::{
        capacity, depot_for_cw, depot_for_entity, distance, element_load, get_route,
        is_kopt_feasible, is_time_feasible, replace_route, MatrixDistanceMeter,
        MatrixIntraDistanceMeter, ProblemData, VrpSolution,
    };
}

/* ============================================================================
Console Output (feature-gated)
============================================================================
*/

#[cfg(feature = "console")]
pub use solverforge_console as console;

/* ============================================================================
Prelude
============================================================================
*/

pub mod prelude {
    pub use crate::stream::{joiner, ConstraintFactory};
    pub use crate::{
        planning_entity, planning_solution, problem_fact, BendableScore, ConstraintSet, Director,
        HardMediumSoftScore, HardSoftDecimalScore, HardSoftScore, Score, ScoreDirector, SoftScore,
    };
}

/* ============================================================================
Internal API for Macros
============================================================================
*/

// Internal module for macro-generated code. Not part of public API.
#[doc(hidden)]
pub mod __internal {
    // Initializes console output if the feature is enabled.
    #[inline]
    pub fn init_console() {
        #[cfg(feature = "console")]
        solverforge_console::init();
    }

    // Derive macros
    pub use solverforge_macros::{PlanningEntityImpl, PlanningSolutionImpl, ProblemFactImpl};

    // Domain types
    pub use solverforge_core::domain::{
        EntityDescriptor, PlanningEntity, PlanningId, PlanningSolution, ProblemFact,
        ProblemFactDescriptor, ShadowVariableKind, SolutionDescriptor, TypedEntityExtractor,
        VariableDescriptor,
    };

    // Scoring
    pub use solverforge_scoring::{
        Director, ScoreDirector, ShadowVariableSupport, SolvableSolution,
    };

    // Solver infrastructure
    pub use solverforge_solver::heuristic::selector::{
        DefaultDistanceMeter, FromSolutionEntitySelector,
    };
    pub use solverforge_solver::manager::{
        KOptPhaseBuilder, ListConstructionPhaseBuilder, PhaseFactory, SolverFactory,
    };
    pub use solverforge_solver::{BasicSpec, ListSpec};

    // Config
    pub use solverforge_config::SolverConfig;

    // Stream types needed for macro-generated extension traits
    pub use solverforge_scoring::stream::filter::{
        AndUniFilter, FnUniFilter, TrueFilter, UniFilter,
    };
    pub use solverforge_scoring::stream::{UniConstraintBuilder, UniConstraintStream};
}