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

use std::collections::VecDeque;

use crate::{
    Activity, Attribute, HasActivityKey,
    ebi_objects::{
        event_log_csv::EventLogCsv, event_log_ocel::EventLogOcel, event_log_xes::EventLogXes,
    },
};
use intmap::IntMap;

/// An iterator over traces, where the traces do not exist in memory until they are necessary.
pub enum TraceIterator<'a> {
    Csv(TraceIteratorCsv<'a>),
    Xes(TraceIteratorXes<'a>),
    Ocel(TraceIteratorOcel<'a>),
}

impl<'a> Iterator for TraceIterator<'a> {
    type Item = Vec<Activity>;

    fn next(&mut self) -> Option<Self::Item> {
        match self {
            TraceIterator::Csv(it) => it.next(),
            TraceIterator::Xes(it) => it.next(),
            TraceIterator::Ocel(it) => it.next(),
        }
    }
}

// === CSV ===

pub struct TraceIteratorCsv<'a> {
    log: &'a EventLogCsv,
    it: std::slice::Iter<'a, (String, Vec<IntMap<Attribute, String>>)>,
}

impl<'a> Iterator for TraceIteratorCsv<'a> {
    type Item = Vec<Activity>;

    fn next(&mut self) -> Option<Self::Item> {
        let (_, trace) = self.it.next()?;
        let mut result = Vec::with_capacity(trace.len());
        for event in trace.iter() {
            let empty = String::new();
            let activity_label = event
                .get(self.log.activity_attribute)
                .unwrap_or_else(|| &empty);
            let activity = self
                .log
                .activity_key
                .process_activity_attempt(activity_label)?;
            result.push(activity);
        }
        Some(result)
    }
}

impl<'a> From<&'a EventLogCsv> for TraceIteratorCsv<'a> {
    fn from(value: &'a EventLogCsv) -> Self {
        Self {
            log: value,
            it: value.traces.iter(),
        }
    }
}

// === XES ===

pub struct TraceIteratorXes<'a> {
    log: &'a EventLogXes,
    next: usize,
}

impl<'a> Iterator for TraceIteratorXes<'a> {
    type Item = Vec<Activity>;

    fn next(&mut self) -> Option<Self::Item> {
        let trace = self.log.rust4pm_log.traces.get(self.next)?;
        let mut result = Vec::with_capacity(trace.events.len());
        for event in trace.events.iter() {
            let activity = self
                .log
                .activity_key
                .process_activity_attempt(&self.log.classifier.get_class_identity(event))?;
            result.push(activity);
        }
        self.next += 1;
        Some(result)
    }
}

impl<'a> From<&'a EventLogXes> for TraceIteratorXes<'a> {
    fn from(value: &'a EventLogXes) -> Self {
        Self {
            log: value,
            next: 0,
        }
    }
}

// === OCEL ===

pub struct TraceIteratorOcel<'a> {
    log: &'a EventLogOcel,
    objects: VecDeque<String>,
}

impl<'a> Iterator for TraceIteratorOcel<'a> {
    type Item = Vec<Activity>;

    fn next(&mut self) -> Option<Self::Item> {
        if let Some(object_id) = self.objects.pop_front() {
            //gather the relevant events
            Some(
                self.log
                    .rust4pm_log
                    .events
                    .iter()
                    .filter(|event| {
                        event
                            .relationships
                            .iter()
                            .any(|relation| relation.object_id == object_id)
                    })
                    .filter_map(|event| {
                        self.log
                            .activity_key()
                            .process_activity_attempt(&event.event_type)
                    })
                    .collect(),
            )
        } else {
            None
        }
    }
}

impl<'a> From<&'a EventLogOcel> for TraceIteratorOcel<'a> {
    fn from(value: &'a EventLogOcel) -> Self {
        let objects =
            EventLogOcel::get_relevant_objects(&value.rust4pm_log.objects, &value.case_object_type)
                .into_iter()
                .collect::<VecDeque<_>>();
        Self {
            log: value,
            objects,
        }
    }
}