solverforge-scoring 0.19.12

Incremental constraint scoring for SolverForge
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

use super::composite::{EqualityKeys, EqualityKind, EqualityPlan};
use super::{ExecutablePlan, IndexedPlan, PlannedCondition, Strategy};
use crate::stream::joiner::Joiner;
use crate::stream::relational::{index::HashIndex, RowHandle};
use std::borrow::Cow;

/// Extract indexed equality keys while preserving authored residual order.
pub struct EqualityWithResidual<E, P, const EQUALITY_FIRST: bool> {
    pub(super) equality: E,
    pub(super) residual: P,
}
impl<E: EqualityPlan, P, const FIRST: bool> EqualityPlan for EqualityWithResidual<E, P, FIRST> {
    type Key = E::Key;
}
impl<L, R, E: EqualityKeys<L, R>, P: Joiner<L, R>, const FIRST: bool> EqualityKeys<L, R>
    for EqualityWithResidual<E, P, FIRST>
{
    fn left_key(&self, row: &L) -> Self::Key {
        self.equality.left_key(row)
    }
    fn right_key(&self, row: &R) -> Self::Key {
        self.equality.right_key(row)
    }
    // Preserve authored short-circuit invocation order.
    #[allow(clippy::if_same_then_else)]
    fn residual_matches(&self, left: &L, right: &R) -> bool {
        if FIRST {
            self.equality.residual_matches(left, right) && self.residual.matches(left, right)
        } else {
            self.residual.matches(left, right) && self.equality.residual_matches(left, right)
        }
    }
}
impl<L, R, E: Joiner<L, R>, P: Joiner<L, R>, const FIRST: bool> Joiner<L, R>
    for EqualityWithResidual<E, P, FIRST>
{
    // Preserve authored short-circuit invocation order.
    #[allow(clippy::if_same_then_else)]
    fn matches(&self, left: &L, right: &R) -> bool {
        if FIRST {
            self.equality.matches(left, right) && self.residual.matches(left, right)
        } else {
            self.residual.matches(left, right) && self.equality.matches(left, right)
        }
    }
}
impl<L, R, E: Joiner<L, R>, P: Joiner<L, R>, const FIRST: bool> PlannedCondition<L, R>
    for EqualityWithResidual<E, P, FIRST>
{
    const STRATEGY: Strategy = Strategy::EquiHash;
    fn check(&self, left: &L, right: &R) -> bool {
        self.matches(left, right)
    }
}
/* Already a compiled mixed plan: composing it further is a no-op, so it is
its own compiled condition. This lets an equality+residual conjunction be the
condition a stream hands to `from_condition`. */
impl<E: EqualityPlan, P, const FIRST: bool> super::CompileCondition
    for EqualityWithResidual<E, P, FIRST>
{
    type Plan = Self;
    fn compile(self) -> Self {
        self
    }
}

impl<E: EqualityPlan, P, const FIRST: bool> IndexedPlan for EqualityWithResidual<E, P, FIRST> {
    type Kind = EqualityKind;
    type Indexes = (HashIndex<E::Key>, HashIndex<E::Key>);
    fn new_indexes(&self) -> Self::Indexes {
        (HashIndex::new(), HashIndex::new())
    }
    fn remove_left(&self, i: &mut Self::Indexes, h: RowHandle) {
        i.0.remove(h);
    }
    fn remove_right(&self, i: &mut Self::Indexes, h: RowHandle) {
        i.1.remove(h);
    }
}
impl<L, R, E, P, const FIRST: bool> ExecutablePlan<L, R> for EqualityWithResidual<E, P, FIRST>
where
    E: EqualityKeys<L, R> + Joiner<L, R>,
    P: Joiner<L, R>,
{
    fn candidate_matches(&self, left: &L, right: &R) -> bool {
        self.residual_matches(left, right)
    }
    fn insert_left(&self, i: &mut Self::Indexes, h: RowHandle, row: &L) {
        i.0.insert(h, self.left_key(row));
    }
    fn insert_right(&self, i: &mut Self::Indexes, h: RowHandle, row: &R) {
        i.1.insert(h, self.right_key(row));
    }
    fn insert_right_transient(&self, i: &mut Self::Indexes, h: RowHandle, row: &R) {
        i.1.insert_transient(h, self.right_key(row));
    }
    fn right_candidates<'i>(&self, i: &'i Self::Indexes, row: &L) -> Cow<'i, [RowHandle]> {
        Cow::Borrowed(i.1.lookup(&self.left_key(row)))
    }
    fn left_candidates<'i>(&self, i: &'i Self::Indexes, row: &R) -> Cow<'i, [RowHandle]> {
        Cow::Borrowed(i.0.lookup(&self.right_key(row)))
    }
}