ebi_objects 0.3.182

Objects for Ebi - a stochastic process mining utility
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
use crate::{
    ActivityKey, ActivityKeyTranslator, CompressedEventLog, CompressedEventLogTraceAttributes,
    CompressedEventLogXes, DirectlyFollowsGraph, EventLog, EventLogCsv, EventLogOcel,
    EventLogPython, EventLogTraceAttributes, EventLogXes, FiniteStochasticLanguage, HasActivityKey,
    NumberOfTraces, StochasticDeterministicFiniteAutomaton, StochasticDirectlyFollowsModel,
    StochasticNondeterministicFiniteAutomaton, StochasticProcessTree,
    ebi_objects::stochastic_process_tree::{
        execute_transition, get_enabled_transitions, get_initial_state,
        get_total_weight_of_enabled_transitions, get_transition_activity, get_transition_weight,
    },
};
use ebi_arithmetic::{Fraction, Signed, Zero};
use std::collections::{HashMap, VecDeque, hash_map::Entry};

impl From<FiniteStochasticLanguage> for StochasticNondeterministicFiniteAutomaton {
    fn from(value: FiniteStochasticLanguage) -> Self {
        log::info!("convert finite stochastic language to SNFA");

        let mut result = StochasticNondeterministicFiniteAutomaton::new();
        if value.number_of_traces().is_zero() {
            result.initial_state = None;
        } else {
            let mut final_states = HashMap::new();
            result.activity_key = value.activity_key;

            //create automaton
            for (trace, probability) in &value.traces {
                let mut state = result.initial_state.unwrap();
                for activity in trace {
                    state =
                        result.take_or_add_transition(state, Some(*activity), probability.clone());
                }

                match final_states.entry(state) {
                    Entry::Occupied(mut e) => *e.get_mut() += probability,
                    Entry::Vacant(e) => {
                        e.insert(probability.clone());
                    }
                }
            }

            //count
            let mut sums = final_states;
            for (source, _, _, probability) in &result {
                match sums.entry(*source) {
                    Entry::Occupied(mut e) => *e.get_mut() += probability,
                    Entry::Vacant(e) => {
                        e.insert(probability.clone());
                    }
                }
            }

            //normalise
            result.scale_outgoing_probabilities(sums);
        }
        result
    }
}

macro_rules! from_via_slang {
    ($t:ident) => {
        impl From<$t> for StochasticNondeterministicFiniteAutomaton {
            fn from(value: $t) -> Self {
                FiniteStochasticLanguage::from(value).into()
            }
        }
    };
}

from_via_slang!(EventLog);
from_via_slang!(EventLogTraceAttributes);
from_via_slang!(EventLogXes);
from_via_slang!(EventLogCsv);
from_via_slang!(EventLogOcel);
from_via_slang!(EventLogPython);
from_via_slang!(CompressedEventLogXes);
from_via_slang!(CompressedEventLog);
from_via_slang!(CompressedEventLogTraceAttributes);

impl From<StochasticDeterministicFiniteAutomaton> for StochasticNondeterministicFiniteAutomaton {
    fn from(value: StochasticDeterministicFiniteAutomaton) -> Self {
        let StochasticDeterministicFiniteAutomaton {
            activities,
            activity_key,
            initial_state,
            probabilities,
            sources,
            targets,
            terminating_probabilities,
            ..
        } = value;

        Self {
            activity_key,
            initial_state,
            sources,
            targets,
            activities: activities.into_iter().map(|a| Some(a)).collect(),
            probabilities,
            terminating_probabilities,
        }
    }
}

impl From<DirectlyFollowsGraph> for StochasticNondeterministicFiniteAutomaton {
    fn from(value: DirectlyFollowsGraph) -> Self {
        let mut result = Self::new();
        let initial_state = 0;

        //add states
        for _ in value.activity_key().get_activities() {
            result.add_state(); //we do not keep a map, as we can predict the numbers: 0 = initial state, 1..=n = activity states, n+1 = final state.
        }

        //start activities
        {
            let mut sum_of_start_activities = value
                .start_activities
                .iter()
                .map(|(_, f)| f)
                .sum::<Fraction>();
            sum_of_start_activities += &value.empty_traces_weight;
            for (activity, weight) in &value.start_activities {
                result
                    .add_transition(
                        initial_state,
                        Some(*activity),
                        activity.id + 1,
                        weight / &sum_of_start_activities,
                    )
                    .unwrap(); //by construction, outgoing probability cannot become lower than 0
            }

            //empty traces are implied
        }

        //edges
        {
            for activity in value.activity_key().get_activities() {
                //gather the outgoing sum
                let mut sum = Fraction::zero();
                {
                    let (_, mut i) =
                        value.binary_search(*activity, value.activity_key().get_activity_by_id(0));
                    while i < value.sources.len() && &value.sources[i] == activity {
                        if value.weights[i].is_positive() {
                            sum += &value.weights[i];
                        }
                        i += 1;
                    }

                    if let Some(w) = value.end_activities.get(activity)
                        && w.is_positive()
                    {
                        sum += w;
                    }
                }

                // add the edges
                let (_, mut i) =
                    value.binary_search(*activity, value.activity_key().get_activity_by_id(0));
                while i < value.sources.len() && &value.sources[i] == activity {
                    if value.weights[i].is_positive() {
                        result
                            .add_transition(
                                activity.id + 1,
                                Some(value.targets[i]),
                                value.targets[i].id + 1,
                                &value.weights[i] / &sum,
                            )
                            .unwrap(); //by construction, remaining outgoing probability cannot become negative
                    }
                    i += 1;
                }

                // termination is implied
            }
        }

        result.activity_key = value.activity_key;

        result
    }
}

impl From<StochasticDirectlyFollowsModel> for StochasticNondeterministicFiniteAutomaton {
    fn from(value: StochasticDirectlyFollowsModel) -> Self {
        let mut result = Self::new();

        if value.node_2_activity.is_empty() && !value.has_empty_traces() {
            //empty language
            result.initial_state = None;
            return result;
        }

        let initial_state = 0;
        result.initial_state = Some(initial_state);

        //add states
        for _ in 0..value.start_node_weights.len() {
            result.add_state(); //we do not keep a map, as we can predict the numbers: 0 = initial state, 1..=n = activity states.
        }

        //start activities
        {
            let mut sum_of_start_activities: Fraction = value.start_node_weights.iter().sum();
            sum_of_start_activities += &value.empty_traces_weight;
            for (node, weight) in value.start_node_weights.iter().enumerate() {
                if weight.is_positive() {
                    result
                        .add_transition(
                            initial_state,
                            Some(value.node_2_activity[node]),
                            node + 1,
                            weight / &sum_of_start_activities,
                        )
                        .unwrap(); //by construction, outgoing probability cannot become lower than 0
                }
            }

            //empty traces are captured by termination probability of initial state
        }

        //edges
        {
            for source in 0..value.start_node_weights.len() {
                //gather the outgoing sum
                let mut sum = Fraction::zero();
                {
                    let (_, mut i) = value.binary_search(source, 0);
                    while i < value.sources.len() && value.sources[i] == source {
                        if value.weights[i].is_positive() {
                            sum += &value.weights[i];
                        }
                        i += 1;
                    }

                    if value.end_node_weights[source].is_positive() {
                        sum += &value.end_node_weights[source];
                    }
                }

                // add the edges
                let (_, mut i) = value.binary_search(source, 0);
                while i < value.sources.len() && value.sources[i] == source {
                    if value.weights[i].is_positive() {
                        result
                            .add_transition(
                                source + 1,
                                Some(value.node_2_activity[value.targets[i]]),
                                value.targets[i] + 1,
                                &value.weights[i] / &sum,
                            )
                            .unwrap(); //by construction, remaining outgoing probability cannot become negative
                    }
                    i += 1;
                }

                // termination is implied
            }
        }

        result.activity_key = value.activity_key;

        result
    }
}

impl From<StochasticProcessTree> for StochasticNondeterministicFiniteAutomaton {
    fn from(tree: StochasticProcessTree) -> Self {
        log::info!("convert (stochastic) process tree to SNFA");

        let initial_marking = if let Some(marking) = get_initial_state(&tree) {
            marking
        } else {
            //empty language
            return Self {
                activity_key: ActivityKey::new(),
                initial_state: None,
                sources: vec![],
                targets: vec![],
                activities: vec![],
                probabilities: vec![],
                terminating_probabilities: vec![],
            };
        };

        let mut result = StochasticNondeterministicFiniteAutomaton::new();
        let translator = ActivityKeyTranslator::new(tree.activity_key(), result.activity_key_mut());

        let mut marking2node = HashMap::new();

        //initial state
        let source_node = result.initial_state.unwrap(); //exists by contract of new()
        marking2node.insert(initial_marking.clone(), source_node);

        let mut queue = VecDeque::new();
        queue.push_back(initial_marking);

        while let Some(marking) = queue.pop_front() {
            let node = marking2node[&marking];

            let sum_weight = get_total_weight_of_enabled_transitions(&tree, &marking);
            for transition in get_enabled_transitions(&tree, &marking) {
                let mut target_marking = marking.clone();
                execute_transition(&tree, &mut target_marking, transition).unwrap(); //by construction, transition is enabled

                //get the target node
                let target_node = marking2node
                    .entry(target_marking.clone())
                    .or_insert_with(|| {
                        queue.push_back(target_marking.clone());
                        result.add_state()
                    });

                //add the transition
                let probability = get_transition_weight(&tree, &marking, transition) / &sum_weight;
                if let Some(activity) = get_transition_activity(&tree, transition) {
                    //labelled transition
                    let new_activity = translator.translate_activity(&activity);
                    result
                        .add_transition(node, Some(new_activity), *target_node, probability)
                        .unwrap(); //by construction, sum outgoing weight cannot surpass 1
                } else {
                    //silent transition
                    result
                        .add_transition(node, None, *target_node, probability)
                        .unwrap(); //by construction, sum outgoing weight cannot surpass 1
                }
            }
        }

        result
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        DirectlyFollowsGraph, FiniteStochasticLanguage, HasActivityKey,
        StochasticDirectlyFollowsModel, StochasticNondeterministicFiniteAutomaton,
        StochasticProcessTree,
    };
    use ebi_arithmetic::{Fraction, One, Zero, f0, f1};
    use std::fs;

    #[test]
    fn dfg_to_snfa() {
        let fin1 = fs::read_to_string("testfiles/aa-ab-ba.dfg").unwrap();
        let mut dfg = fin1.parse::<DirectlyFollowsGraph>().unwrap();

        let a = dfg.activity_key_mut().process_activity("a");
        let b = dfg.activity_key_mut().process_activity("b");
        assert_eq!(dfg.start_activities[&a], Fraction::from((2, 5)));
        assert_eq!(dfg.start_activities[&b], Fraction::from((3, 5)));

        let snfa: StochasticNondeterministicFiniteAutomaton = dfg.into();
        assert_eq!(snfa.number_of_states(), 3);
        assert_eq!(snfa.number_of_transitions(), 5);
        assert_eq!(snfa.sources, [0, 0, 1, 1, 2]);
        assert_eq!(snfa.targets, [1, 2, 1, 2, 1]);
        assert_eq!(
            snfa.probabilities,
            [
                Fraction::from((2, 5)),
                Fraction::from((3, 5)),
                Fraction::from((1, 6)),
                Fraction::from((1, 6)),
                Fraction::from((3, 4))
            ]
        );
        assert_eq!(
            snfa.terminating_probabilities,
            [f0!(), Fraction::from((2, 3)), Fraction::from((1, 4))]
        );
    }

    #[test]
    fn log_to_sdfa() {
        let fin1 = fs::read_to_string("testfiles/acb-abc-ad-aded-adeded-adededed.slang").unwrap();
        let slang = fin1.parse::<FiniteStochasticLanguage>().unwrap();

        let sdfa = StochasticNondeterministicFiniteAutomaton::from(slang);

        assert!(
            sdfa.terminating_probabilities
                .contains(&Fraction::from((8, 15)))
        );
        assert!(
            sdfa.terminating_probabilities
                .contains(&Fraction::from((2, 3)))
        );
        assert!(
            sdfa.terminating_probabilities
                .contains(&Fraction::from((4, 7)))
        );
    }

    #[test]
    fn sptree_to_snfa() {
        let fin = fs::read_to_string("testfiles/seq(a-xor(b-c)).sptree").unwrap();
        let tree = fin.parse::<StochasticProcessTree>().unwrap();

        let snfa = StochasticNondeterministicFiniteAutomaton::from(tree);
        assert_eq!(snfa.sources, [0, 1, 1, 2]);
        assert_eq!(snfa.targets, [1, 2, 2, 3]);
        assert_eq!(
            snfa.probabilities,
            [f1!(), Fraction::from((1, 3)), Fraction::from((2, 3)), f1!()]
        );
        assert_eq!(snfa.terminating_probabilities, [f0!(), f0!(), f0!(), f1!()]);
    }

    #[test]
    fn sptree_to_snfa_all_operators() {
        let fin = fs::read_to_string("testfiles/all_operators.sptree").unwrap();
        let tree = fin.parse::<StochasticProcessTree>().unwrap();

        let _snfa = StochasticNondeterministicFiniteAutomaton::from(tree);
    }

    #[test]
    fn sdfm_to_snfa() {
        let fin = fs::read_to_string("testfiles/aa-ab-ba.sdfm").unwrap();
        let sdfm = fin.parse::<StochasticDirectlyFollowsModel>().unwrap();

        let snfa = StochasticNondeterministicFiniteAutomaton::from(sdfm);

        assert_eq!(snfa.sources, [0, 0, 1, 1, 2]);
        assert_eq!(snfa.targets, [1, 2, 1, 2, 1]);
        assert_eq!(
            snfa.probabilities,
            [
                Fraction::from((2, 5)),
                Fraction::from((3, 5)),
                Fraction::from((1, 6)),
                Fraction::from((1, 6)),
                Fraction::from((3, 4))
            ]
        );
        assert_eq!(
            snfa.terminating_probabilities,
            [
                Fraction::zero(),
                Fraction::from((2, 3)),
                Fraction::from((1, 4))
            ]
        );
    }
}