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

solverforge_scoring/stream/
mod.rs
