solverforge_scoring/stream/
mod.rs

1/* Fluent constraint stream API for zero-erasure constraint programming.
2
3This module provides an ergonomic builder pattern for defining constraints
4that compile to fully monomorphized, monomorphized constraint implementations.
5
6# Overview
7
8The stream API transforms verbose constraint definitions into concise,
9fluent declarations while preserving full type information through the
10entire evaluation pipeline.
11
12# Example
13
14```
15use solverforge_scoring::stream::ConstraintFactory;
16use solverforge_scoring::api::constraint_set::{ConstraintSet, IncrementalConstraint};
17use solverforge_core::score::SoftScore;
18
19#[derive(Clone)]
20struct Schedule {
21shifts: Vec<Shift>,
22}
23
24#[derive(Clone, Debug)]
25struct Shift {
26employee_idx: Option<usize>,
27required_skill: String,
28}
29
30// Define constraints using the fluent API
31let unassigned = ConstraintFactory::<Schedule, SoftScore>::new()
32.for_each(|s: &Schedule| &s.shifts)
33.filter(|shift: &Shift| shift.employee_idx.is_none())
34.penalize(SoftScore::of(1))
35.named("Unassigned shift");
36
37// Use the constraint
38let schedule = Schedule {
39shifts: vec![
40Shift { employee_idx: Some(0), required_skill: "A".into() },
41Shift { employee_idx: None, required_skill: "B".into() },
42],
43};
44
45assert_eq!(unassigned.evaluate(&schedule), SoftScore::of(-1));
46```
47
48# Architecture
49
50The stream builders produce existing constraint types at definition time:
51
52```text
53ConstraintFactory::new()
54.for_each(extractor)     -> UniConstraintStream<S, A, Sc>
55.filter(predicate)            -> UniConstraintStream (accumulates filters)
56.penalize(weight)             -> UniConstraintBuilder<S, A, Sc>
57.named(name)                  -> IncrementalUniConstraint<S, A, Sc>
58```
59
60The final `IncrementalUniConstraint` is fully monomorphized with no
61virtual dispatch in the hot path.
62*/
63
64#[macro_use]
65mod arity_stream_macros;
66mod balance_stream;
67mod bi_stream;
68pub mod collection_extract;
69pub mod collector;
70mod complemented_stream;
71mod cross_bi_stream;
72mod existence_stream;
73mod existence_target;
74mod factory;
75pub mod filter;
76mod flattened_bi_stream;
77mod grouped_stream;
78pub mod join_target;
79pub mod joiner;
80pub mod key_extract;
81mod penta_stream;
82mod projected_stream;
83mod quad_stream;
84mod tri_stream;
85mod unassigned;
86mod uni_stream;
87mod weighting_support;
88
89#[cfg(test)]
90mod tests;
91
92pub use balance_stream::{BalanceConstraintBuilder, BalanceConstraintStream};
93pub use bi_stream::{BiConstraintBuilder, BiConstraintStream};
94pub use collection_extract::{
95    source, ChangeSource, CollectionExtract, FlattenExtract, SourceExtract, VecExtract,
96};
97pub use complemented_stream::{ComplementedConstraintBuilder, ComplementedConstraintStream};
98pub use cross_bi_stream::{
99    CrossBiConstraintBuilder, CrossBiConstraintStream, CrossComplementedGroupedConstraintBuilder,
100    CrossComplementedGroupedConstraintStream, CrossGroupedConstraintBuilder,
101    CrossGroupedConstraintStream,
102};
103pub use existence_stream::{ExistenceMode, ExistsConstraintBuilder, ExistsConstraintStream};
104pub use existence_target::{ExistenceTarget, FlattenedCollectionTarget};
105pub use factory::ConstraintFactory;
106pub use flattened_bi_stream::{FlattenedBiConstraintBuilder, FlattenedBiConstraintStream};
107pub use grouped_stream::{GroupedConstraintBuilder, GroupedConstraintStream};
108pub use join_target::JoinTarget;
109pub use key_extract::{EntityKeyAdapter, KeyExtract};
110pub use penta_stream::{PentaConstraintBuilder, PentaConstraintStream};
111pub use projected_stream::{
112    JoinedProjectedSource, ProjectedBiConstraintBuilder, ProjectedBiConstraintStream,
113    ProjectedComplementedGroupedConstraintBuilder, ProjectedComplementedGroupedConstraintStream,
114    ProjectedConstraintBuilder, ProjectedConstraintStream, ProjectedGroupedConstraintBuilder,
115    ProjectedGroupedConstraintStream, ProjectedRowCoordinate, ProjectedRowOwner, ProjectedSource,
116    Projection, ProjectionSink,
117};
118pub use quad_stream::{QuadConstraintBuilder, QuadConstraintStream};
119pub use tri_stream::{TriConstraintBuilder, TriConstraintStream};
120#[doc(hidden)]
121pub use unassigned::UnassignedEntity;
122pub use uni_stream::{UniConstraintBuilder, UniConstraintStream};
123#[doc(hidden)]
124pub use weighting_support::ConstraintWeight;
125pub use weighting_support::{fixed_weight, hard_weight, FixedWeight, HardWeight};
solverforge_scoring/stream/mod.rs

solverforge_scoring/stream/
mod.rs
