kcl-ezpz 0.2.2

A constraint solver for KCL and Zoo Design Studio
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

use crate::Constraint;

/// A constraint that EZPZ should solve for.
#[derive(Debug, Clone, Copy)]
#[cfg_attr(feature = "fuzz", derive(arbitrary::Arbitrary))]
pub struct ConstraintRequest {
    /// The constraint itself.
    pub constraint: Constraint,
    /// The constraint's priority.
    /// 0 is highest priority.
    /// Larger numbers are lower priority.
    pub priority: u32,
}

impl ConstraintRequest {
    /// Create a new constraint request.
    pub fn new(constraint: Constraint, priority: u32) -> Self {
        Self {
            constraint,
            priority,
        }
    }

    /// Create a new constraint request with the highest priority.
    pub fn highest_priority(constraint: Constraint) -> Self {
        Self::new(constraint, 0)
    }
}

impl From<ConstraintRequest> for Constraint {
    fn from(value: ConstraintRequest) -> Self {
        value.constraint
    }
}

impl AsRef<Constraint> for ConstraintRequest {
    fn as_ref(&self) -> &Constraint {
        &self.constraint
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn demo_constraint() -> Constraint {
        Constraint::Fixed(42, 3.1)
    }

    #[test]
    fn builds_with_expected_priorities() {
        let constraint = demo_constraint();
        let custom = ConstraintRequest::new(constraint, 5);
        assert_eq!(custom.priority, 5);

        let highest = ConstraintRequest::highest_priority(custom.constraint);
        let lower = ConstraintRequest::new(custom.constraint, 40);
        assert!(highest.priority < lower.priority);
    }

    #[test]
    fn converts_back_to_constraint() {
        let constraint = demo_constraint();
        let req = ConstraintRequest::new(constraint, 1);

        let Constraint::Fixed(id, value) = Constraint::from(req) else {
            panic!();
        };
        assert_eq!(id, 42);
        assert_eq!(value, 3.1);

        let req = ConstraintRequest::new(constraint, 1);
        assert!(matches!(req.as_ref(), Constraint::Fixed(_, _)));
    }
}