1 /* Copyright (c) 2007-2023. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_MC_UDPOR_EVENT_SET_HPP
7 #define SIMGRID_MC_UDPOR_EVENT_SET_HPP
9 #include "src/mc/explo/udpor/udpor_forward.hpp"
13 #include <initializer_list>
14 #include <unordered_set>
16 #include <xbt/asserts.h>
18 namespace simgrid::mc::udpor {
22 std::unordered_set<const UnfoldingEvent*> events_;
26 EventSet(const EventSet&) = default;
27 EventSet& operator=(const EventSet&) = default;
28 EventSet& operator=(EventSet&&) = default;
29 EventSet(EventSet&&) = default;
30 explicit EventSet(Configuration&& config);
31 explicit EventSet(std::vector<const UnfoldingEvent*>&& raw_events) : events_(raw_events.begin(), raw_events.end())
33 xbt_assert(std::none_of(events_.begin(), events_.end(), [](const auto* e) { return e == nullptr; }), "Oh no");
35 explicit EventSet(std::unordered_set<const UnfoldingEvent*>&& raw_events) : events_(raw_events)
37 xbt_assert(std::none_of(events_.begin(), events_.end(), [](const auto* e) { return e == nullptr; }), "Oh no");
39 explicit EventSet(std::initializer_list<const UnfoldingEvent*> event_list) : events_(std::move(event_list))
41 xbt_assert(std::none_of(events_.begin(), events_.end(), [](const auto* e) { return e == nullptr; }), "Oh no");
44 auto begin() const { return this->events_.begin(); }
45 auto end() const { return this->events_.end(); }
46 auto cbegin() const { return this->events_.cbegin(); }
47 auto cend() const { return this->events_.cend(); }
49 void remove(const UnfoldingEvent*);
50 void subtract(const EventSet&);
51 void subtract(const Configuration&);
52 EventSet subtracting(const UnfoldingEvent*) const;
53 EventSet subtracting(const EventSet&) const;
54 EventSet subtracting(const Configuration&) const;
56 void insert(const UnfoldingEvent*);
57 void form_union(const EventSet&);
58 void form_union(const Configuration&);
59 EventSet make_union(const UnfoldingEvent*) const;
60 EventSet make_union(const EventSet&) const;
61 EventSet make_union(const Configuration&) const;
62 EventSet get_local_config() const;
66 bool contains(const UnfoldingEvent*) const;
67 bool contains(const History&) const;
68 bool intersects(const History&) const;
69 bool is_subset_of(const EventSet&) const;
71 bool operator==(const EventSet& other) const { return this->events_ == other.events_; }
72 bool operator!=(const EventSet& other) const { return this->events_ != other.events_; }
73 std::string to_string() const;
76 * @brief Whether or not this set of events could
77 * represent a configuration
79 bool is_valid_configuration() const;
82 * @brief Whether or not this set of events is
83 * a *maximal event set*, i.e. whether each element
84 * of the set causes none of the others
86 * A set of events `E` is said to be _maximal_ if
87 * it is causally-free. Formally,
89 * 1. For each event `e` in `E`, there is no event
90 * `e'` in `E` such that `e < e'`
92 bool is_maximal() const;
95 * @brief Whether or not this set of events is
98 * A set of events `E` is said to be _conflict free_
101 * 1. For each event `e` in `E`, there is no event
102 * `e'` in `E` such that `e # e'` where `#` is the
103 * conflict relation over the unfolding from
104 * which the events `E` are derived
106 * @note: This method makes use only of the causality
107 * tree of the events in the set; i.e. it determines conflicts
108 * based solely on the unfolding and the definition of
109 * conflict in an unfolding. Some clever techniques
110 * exist for computing conflicts with specialized transition
111 * types (only mutexes if I remember correctly) that was
112 * referenced in The Anh Pham's thesis. This would require
113 * keeping track of information *outside* of any given
114 * set and probably doesn't work for all types of transitions
117 bool is_conflict_free() const;
120 * @brief Produces the largest subset of this
121 * set of events which is maximal
123 EventSet get_largest_maximal_subset() const;
126 * @brief Orders the events of the set such that
127 * "more recent" events (i.e. those that are farther down in
128 * the event structure's dependency chain) come after those
129 * that appeared "farther in the past"
131 * @returns a vector `V` with the following property:
133 * 1. Let i(e) := C -> I map events to their indices in `V`.
134 * For every pair of events e, e' in C, if e < e' then i(e) < i(e')
136 * Intuitively, events that are closer to the "bottom" of the event
137 * structure appear farther along in the list than those that appear
138 * closer to the "top"
140 std::vector<const UnfoldingEvent*> get_topological_ordering() const;
143 * @brief Orders the events of set such that
144 * "more recent" events (i.e. those that are farther down in
145 * the event structure's dependency chain) come before those
146 * that appear "farther in the past"
148 * @note The events of the event structure are arranged such that
149 * e < e' implies a directed edge from e to e'. However, it is
150 * also useful to be able to traverse the *reverse* graph (for
151 * example when computing the compatibility graph of a configuration),
152 * hence the distinction between "reversed" and the method
153 * "EventSet::get_topological_ordering()"
155 * @returns a vector `V` with the following property:
157 * 1. Let i(e) := C -> I map events to their indices in `V`.
158 * For every pair of events e, e' in C, if e < e' then i(e) > i(e')
160 * Intuitively, events that are closer to the "top" of the event
161 * structure appear farther along in the list than those that appear
162 * closer to the "bottom"
164 std::vector<const UnfoldingEvent*> get_topological_ordering_of_reverse_graph() const;
167 * @brief Moves the event set into a list
169 std::vector<const UnfoldingEvent*> move_into_vector() const&&;
171 using iterator = decltype(events_)::iterator;
172 using const_iterator = decltype(events_)::const_iterator;
173 using value_type = decltype(events_)::value_type;
176 } // namespace simgrid::mc::udpor