ixa 1.0.0

A framework for building agent-based models
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

use std::any::TypeId;

use crate::people::{ContextPeopleExt, PeoplePlugin};
use crate::{Context, ContextBase, IxaError, PersonId};

#[cfg_attr(not(feature = "web_api"), allow(dead_code))]
pub(crate) trait ContextPeopleExtCrate: ContextBase + ContextPeopleExt {
    // Note: We can't do a default implementation here because
    // it uses callbacks that take a &Context
    fn get_person_property_by_name(
        &self,
        name: &str,
        person_id: PersonId,
    ) -> Result<String, IxaError>;

    fn tabulate_person_properties_by_name<F>(
        &self,
        properties: Vec<String>,
        print_fn: F,
    ) -> Result<(), IxaError>
    where
        F: Fn(&Context, &[String], usize),
    {
        let data_container = self.get_data(PeoplePlugin);
        let people_types = data_container.people_types.borrow();

        let mut query = Vec::new();
        for name in properties {
            let type_id = people_types
                .get(&name.to_string())
                .ok_or(IxaError::IxaError(format!("No property '{name}'")))?;

            query.push((*type_id, name.to_string()));
        }

        self.tabulate_person_properties(&query, print_fn);
        Ok(())
    }

    fn index_property_by_id(&self, type_id: TypeId) {
        let data_container = self.get_data(PeoplePlugin);

        let mut index = data_container.get_index_ref_mut(type_id).unwrap();
        if !index.is_indexed() {
            index.set_indexed(true);
        }
    }

    fn get_person_property_names(&self) -> Vec<String> {
        let data_container = self.get_data(PeoplePlugin);
        let people_types = data_container.people_types.borrow();

        people_types
            .keys()
            .map(std::string::ToString::to_string)
            .collect()
    }
}
impl ContextPeopleExtCrate for Context {
    fn get_person_property_by_name(
        &self,
        name: &str,
        person_id: PersonId,
    ) -> Result<String, IxaError> {
        let data_container = self.get_data(PeoplePlugin);
        let type_id = *data_container
            .people_types
            .borrow()
            .get(name)
            .ok_or(IxaError::IxaError(format!("No property '{name}'")))?;
        let methods = data_container.get_methods(type_id);
        Ok((methods.get_display)(self, person_id))
    }
}

#[cfg(test)]
mod test {
    use std::cell::RefCell;

    use super::ContextPeopleExtCrate;
    use crate::people::{define_person_property, ContextPeopleExt};
    use crate::{
        define_person_property_with_default, Context, ContextRandomExt, HashSet, HashSetExt,
    };

    define_person_property!(Age, u8);

    #[test]
    fn get_property_string() {
        let mut context = Context::new();
        context.init_random(42);

        let person1 = context.add_person((Age, 10)).unwrap();
        let age = context.get_person_property_by_name("Age", person1).unwrap();
        assert_eq!(age, "10");
    }

    #[test]
    fn get_unknown_property_string() {
        let mut context = Context::new();
        context.init_random(42);

        let person1 = context.add_person((Age, 10)).unwrap();
        let age = context.get_person_property_by_name("Unknown", person1);
        assert!(age.is_err());
    }

    define_person_property_with_default!(IsRunner, bool, false);
    define_person_property_with_default!(IsSwimmer, bool, false);

    fn tabulate_properties_test_setup(
        tabulator: Vec<String>,
        setup: impl FnOnce(&mut Context),
        expected_values: &HashSet<(Vec<String>, usize)>,
    ) {
        let mut context = Context::new();
        setup(&mut context);

        let results: RefCell<HashSet<(Vec<String>, usize)>> = RefCell::new(HashSet::new());
        context
            .tabulate_person_properties_by_name(tabulator, |_context, values, count| {
                results.borrow_mut().insert((values.to_vec(), count));
            })
            .unwrap();

        let results = &*results.borrow();
        assert_eq!(results, expected_values);
    }

    #[test]
    fn test_get_counts_multi_by_name() {
        let tabulator = vec![String::from("IsRunner"), String::from("IsSwimmer")];
        let mut expected = HashSet::new();
        expected.insert((vec!["false".to_string(), "false".to_string()], 3));
        expected.insert((vec!["false".to_string(), "true".to_string()], 1));
        expected.insert((vec!["true".to_string(), "false".to_string()], 1));
        expected.insert((vec!["true".to_string(), "true".to_string()], 1));

        tabulate_properties_test_setup(
            tabulator,
            |context| {
                context.add_person(()).unwrap();
                context.add_person(()).unwrap();
                context.add_person(()).unwrap();
                let bob = context.add_person(()).unwrap();
                let anne = context.add_person(()).unwrap();
                let charlie = context.add_person(()).unwrap();

                context.set_person_property(bob, IsRunner, true);
                context.set_person_property(charlie, IsRunner, true);
                context.set_person_property(anne, IsSwimmer, true);
                context.set_person_property(charlie, IsSwimmer, true);
            },
            &expected,
        );
    }
}