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 cross_tri_stream;
73mod existence_stream;
74mod existence_target;
75mod factory;
76pub mod filter;
77mod flattened_bi_stream;
78mod grouped_stream;
79pub mod join_target;
80pub mod joiner;
81pub mod key_extract;
82mod penta_stream;
83mod projected_stream;
84mod quad_stream;
85mod tri_stream;
86mod unassigned;
87mod uni_stream;
88mod weighting_support;
89
90#[cfg(test)]
91mod tests;
92
93pub mod cross {
94    pub use super::cross_bi_stream::{
95        Bi, Builder, ComplementedGrouped, ComplementedGroupedBuilder, Grouped, GroupedBuilder,
96    };
97    pub use super::cross_tri_stream::Tri;
98}
99
100pub mod projected {
101    pub use super::projected_stream::{
102        Bi, BiBuilder, Builder, ComplementedGrouped, ComplementedGroupedBuilder, DirectedBi,
103        DirectedBiBuilder, Grouped, GroupedBuilder, JoinedSource, ProjectedJoinTarget, Projection,
104        ProjectionSink, RowCoordinate, RowOwner, Source, Stream,
105    };
106}
107
108pub use balance_stream::{BalanceConstraintBuilder, BalanceConstraintStream};
109pub use bi_stream::{BiConstraintBuilder, BiConstraintStream};
110pub use collection_extract::{
111    source, ChangeSource, CollectionExtract, FlattenExtract, SourceExtract, VecExtract,
112};
113pub use complemented_stream::{ComplementedConstraintBuilder, ComplementedConstraintStream};
114pub use existence_stream::{ExistenceMode, ExistsConstraintBuilder, ExistsConstraintStream};
115pub use existence_target::{ExistenceTarget, FlattenedCollectionTarget};
116pub use factory::ConstraintFactory;
117pub use flattened_bi_stream::{FlattenedBiConstraintBuilder, FlattenedBiConstraintStream};
118pub use grouped_stream::{GroupedConstraintBuilder, GroupedConstraintStream};
119pub use join_target::JoinTarget;
120pub use key_extract::{EntityKeyAdapter, KeyExtract};
121pub use penta_stream::{PentaConstraintBuilder, PentaConstraintStream};
122pub use projected_stream::{Projection, ProjectionSink};
123pub use quad_stream::{QuadConstraintBuilder, QuadConstraintStream};
124pub use tri_stream::{TriConstraintBuilder, TriConstraintStream};
125#[doc(hidden)]
126pub use unassigned::UnassignedEntity;
127pub use uni_stream::{UniConstraintBuilder, UniConstraintStream};
128#[doc(hidden)]
129pub use weighting_support::ConstraintWeight;
130pub use weighting_support::{fixed_weight, hard_weight, FixedWeight, HardWeight};
solverforge_scoring/stream/mod.rs

solverforge_scoring/stream/
mod.rs
