behaviorsim-rs 0.7.0

Domain-agnostic specification for modeling individual psychology and social dynamics
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

//! Interaction pattern metadata for relationships.
//!
//! Captures how consistently entities interact.

/// Interaction pattern for a relationship.
#[derive(Debug, Clone, PartialEq)]
pub struct InteractionPattern {
    /// Regularity of interactions (0 = erratic, 1 = consistent).
    pub consistency: f32,
}

impl Default for InteractionPattern {
    fn default() -> Self {
        InteractionPattern { consistency: 0.0 }
    }
}

impl InteractionPattern {
    /// Creates a new InteractionPattern with empty defaults.
    #[must_use]
    pub fn new() -> Self {
        InteractionPattern::default()
    }

    /// Sets the interaction consistency.
    #[must_use]
    pub fn with_consistency(mut self, consistency: f32) -> Self {
        self.consistency = consistency.clamp(0.0, 1.0);
        self
    }
}

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

    #[test]
    fn interaction_pattern_defaults_empty() {
        let pattern = InteractionPattern::default();
        assert!((pattern.consistency - 0.0).abs() < f32::EPSILON);
    }

    #[test]
    fn interaction_pattern_builder_sets_values() {
        let pattern = InteractionPattern::new().with_consistency(0.8);

        assert!((pattern.consistency - 0.8).abs() < f32::EPSILON);
    }

    #[test]
    fn interaction_pattern_consistency_clamped() {
        let pattern = InteractionPattern::new().with_consistency(-0.2);
        assert!((pattern.consistency - 0.0).abs() < f32::EPSILON);

        let pattern2 = InteractionPattern::new().with_consistency(1.5);
        assert!((pattern2.consistency - 1.0).abs() < f32::EPSILON);
    }
}