In [1]:
import spot
spot.setup()

Acceptance conditions

The acceptance condition of an automaton specifies which of its paths are accepting.

The way acceptance conditions are stored in Spot is derived from the way acceptance conditions are specified in the HOA format. In HOA, acceptance conditions are given as a line of the form:

Acceptance: 3 (Inf(0)&Fin(1))|Inf(2)

The number 3 gives the number of acceptance sets used (numbered from 0 to 2 in that case), while the rest of the line is a positive Boolean formula over terms of the form:

  • Inf(n), that is true if and only if the set n is seen infinitely often,
  • Fin(n), that is true if and only if the set n should be seen finitely often,
  • t, always true,
  • f, always false.

The HOA specifications additionally allows terms of the form Inf(!n) or Fin(!n) but Spot automatically rewrites those away when reading an HOA file.

Note that the number of sets given can be larger than what is actually needed by the acceptance formula.

Transitions in automata can be tagged as being part of some member sets, and a path in the automaton is accepting if the set of acceptance sets visited along this path satisfy the acceptance condition.

Defining acceptance conditions in Spot involves three different types of C++ objects:

  • spot::acc_cond is used to represent an acceptance condition, that is: a number of sets and a formula.
  • spot::acc_cond::acc_code, is used to represent Boolean formula for the acceptance condition using a kind of byte code (hence the name)
  • spot::acc_cond::mark_t, is a type of bit-vector used to represent membership to acceptance sets.

In because Swig's support for nested class is limited, these types are available respectively as spot.acc_cond, spot.acc_code, and spot.mark_t in Python.

mark_t

Let's start with the simpler of these three objects. mark_t is a type of bit vector. Its main constructor takes a sequence of set numbers.

In [2]:
print(spot.mark_t())

{}
In [3]:
print(spot.mark_t([0, 2, 3])) # works with lists

{0,2,3}
In [4]:
print(spot.mark_t((0, 2, 3))) # works with tuples

{0,2,3}

As seen above, the sequence of set numbers can be specified using a list or a tuple. While from the Python language point of view, using a tuple is faster than using a list, the overhead to converting all the arguments from Python to C++ and then converting the resulting back from C++ to Python makes this difference completely negligible. In the following, we opted to use lists, because brackets are more readable than nested parentheses.

In [5]:
x = spot.mark_t([0, 2, 3])
y = spot.mark_t([0, 4])
print(x | y)
print(x & y)
print(x - y)

{0,2,3,4}
{0}
{2,3}

The bits can be set, cleared, and tested using the set(), clear(), and has() methods:

In [6]:
x.set(5)
print(x)

{0,2,3,5}
In [7]:
x.clear(3)
print(x)

{0,2,5}
In [8]:
print(x.has(2))
print(x.has(3))

True
False

Left-shifting will increment all set numbers. This operation is useful when building the product of two automata: all the set number of one automaton have to be shift by the number of sets used in the other automaton.

In [9]:
print(x << 2)

{2,4,7}

The different sets can be iterated over with the sets() method, that returns a tuple with the index of all bits set.

In [10]:
print(x)
print(list(x.sets()))
for s in x.sets():
    print(s)

{0,2,5}
[0, 2, 5]
0
2
5

count() return the number of sets in a mark_t:

In [11]:
x.count()
Out[11]:
3

lowest() returns a mark_t containing only the lowest set number. This provides another way to iterate overs all set numbers in cases where you need the result as a mark_t.

In [12]:
spot.mark_t([1,3,5]).lowest()
Out[12]:
spot.mark_t([1])
In [13]:
v = spot.mark_t([1, 3, 5])
while v:               # this stops once v is empty
    b = v.lowest()
    v -= b
    print(b)

{1}
{3}
{5}

max_set() returns the number of the highest set plus one. This is usually used to figure out how many sets we need to declare on the Acceptance: line of the HOA format:

In [14]:
spot.mark_t([1, 3, 5]).max_set()
Out[14]:
6

acc_code

acc_code encodes the formula of the acceptance condition using a kind of bytecode that basically corresponds to an encoding in reverse Polish notation in which conjunctions of Inf(n) terms, and disjunctions of Fin(n) terms are grouped. In particular, the frequently-used generalized-Büchi acceptance conditions (like Inf(0)&Inf(1)&Inf(2)) are always encoded as a single term (like Inf({0,1,2})).

The simplest way to construct an acc_code by passing a string that represent the formula to build.

In [15]:
acc = spot.acc_code('(Inf(0)&Fin(1))|Inf(2)')
print(acc)   # shows just the formula
acc          # shows the acc_code object

(Inf(0) & Fin(1)) | Inf(2)
Out[15]:
spot.acc_code("(Inf(0) & Fin(1)) | Inf(2)")

You may also use a named acceptance condition:

In [16]:
spot.acc_code('Rabin 2')
Out[16]:
spot.acc_code("(Fin(0) & Inf(1)) | (Fin(2) & Inf(3))")

The recognized names are the valid values for acc-name: in the HOA format. Additionally, numbers may be replaced by ranges of the form n..m, in which case a random number is selected in that range.

In [17]:
print(spot.acc_code('Streett 2..4'))
print(spot.acc_code('Streett 2..4'))

(Fin(0) | Inf(1)) & (Fin(2) | Inf(3)) & (Fin(4) | Inf(5)) & (Fin(6) | Inf(7))
(Fin(0) | Inf(1)) & (Fin(2) | Inf(3))

It may also be convenient to generate a random acceptance condition. Below we require between 3 and 5 acceptance sets:

In [18]:
spot.acc_code('random 3..5')
Out[18]:
spot.acc_code("(Fin(3) | Inf(1)) & Inf(4) & (Fin(0)|Fin(2))")

The to_cnf() and to_dnf() functions can be used to rewrite the formula into Conjunctive or Disjunctive normal forms. This functions will simplify the resulting formulas to make them irredundant.

In [19]:
a = spot.acc_code('parity min odd 5')
a
Out[19]:
spot.acc_code("Fin(0) & (Inf(1) | (Fin(2) & (Inf(3) | Fin(4))))")
In [20]:
a.to_cnf()
Out[20]:
spot.acc_code("Fin(0) & (Inf(1) | Fin(2)) & (Inf(1) | Inf(3) | Fin(4))")
In [21]:
a.to_dnf()
Out[21]:
spot.acc_code("(Fin(0) & Inf(1)) | (Fin(0) & Fin(2) & Inf(3)) | (Fin(0) & Fin(2) & Fin(4))")

The manipulation of acc_code objects is quite rudimentary at the moment: they are easy to build, but are harder take appart. In fact we won't attempt to disassemble an acc_code object in Python: those things are better done in C++.

Operators |, |=, &, &=, <<, and <<= can be used with their obvious semantics. Whenever possible, the inplace versions (|=, &=, <<=) should be prefered, because they create less temporary acceptance conditions.

In [22]:
x = spot.acc_code('Rabin 2')
y = spot.acc_code('Rabin 2') << 4
print(x)
print(y)

(Fin(0) & Inf(1)) | (Fin(2) & Inf(3))
(Fin(4) & Inf(5)) | (Fin(6) & Inf(7))
In [23]:
print(x | y)
print(x & y)

(Fin(4) & Inf(5)) | (Fin(6) & Inf(7)) | (Fin(0) & Inf(1)) | (Fin(2) & Inf(3))
((Fin(4) & Inf(5)) | (Fin(6) & Inf(7))) & ((Fin(0) & Inf(1)) | (Fin(2) & Inf(3)))

The complement() method returns the complemented acceptance condition:

In [24]:
print(x)
print(x.complement())

(Fin(0) & Inf(1)) | (Fin(2) & Inf(3))
(Inf(0) | Fin(1)) & (Inf(2) | Fin(3))

Instead of using acc_code('string'), it is also possible to build an acceptance formula from atoms like Inf({...}), Fin({...}), t, or f.

Remember that in our encoding for the formula, terms like Inf(1)&Inf(2) and Fin(3)|Fin(4)|Fin(5) are actually stored as Inf({1,2}) and Fin({3,4,5}), where {1,2} and {3,4,5} are instance of mark_t. These terms can be generated with the functions spot.acc_code.inf(mark) and spot.acc_code.fin(mark).

Inf({}) is equivalent to t, and Fin({}) is equivalent to f, but it's better to use the functions spot.acc_code.t() or spot.acc_code.f() directly.

In [25]:
spot.acc_code.inf([1,2]) & spot.acc_code.fin([3,4,5])
Out[25]:
spot.acc_code("(Fin(3)|Fin(4)|Fin(5)) & (Inf(1)&Inf(2))")
In [26]:
spot.acc_code.inf([])
Out[26]:
spot.acc_code("t")
In [27]:
spot.acc_code.t()
Out[27]:
spot.acc_code("t")
In [28]:
spot.acc_code.fin([])
Out[28]:
spot.acc_code("f")
In [29]:
spot.acc_code.f()
Out[29]:
spot.acc_code("f")

To evaluate an acceptance condition formula on a run, build a mark_t containing all the acceptance sets that are seen infinitely often along this run, and call the accepting() method.

In [30]:
acc = spot.acc_code('Fin(0) & Inf(1) | Inf(2)')
print("acc =", acc)
for x in ([0, 1, 2], [1, 2], [0, 1], [0, 2], [0], [1], [2], []):
    print(f"acc.accepting({x}) = {acc.accepting(x)}")

acc = (Fin(0) & Inf(1)) | Inf(2)
acc.accepting([0, 1, 2]) = True
acc.accepting([1, 2]) = True
acc.accepting([0, 1]) = False
acc.accepting([0, 2]) = True
acc.accepting([0]) = False
acc.accepting([1]) = True
acc.accepting([2]) = True
acc.accepting([]) = False

Finally the method used_sets() returns a mark_t with all the sets appearing in the formula:

In [31]:
acc = spot.acc_code('Fin(0) & Inf(2)')
print(acc)
print(acc.used_sets())
print(acc.used_sets().max_set())

Fin(0) & Inf(2)
{0,2}
3

The used_inf_fin_sets() returns a pair of marks instead, the first one with all sets occurring in Inf, and the second one with all sets appearing in Fin.

In [32]:
acc.used_inf_fin_sets()
Out[32]:
(spot.mark_t([2]), spot.mark_t([0]))

If the top-level operators is a conjunct or disjunct, the following methods returns lists of clauses.

In [33]:
c = spot.acc_code('Fin(0)|(Inf(1)&Fin(2))|Fin(3)')
print(repr(c))
print(c.top_disjuncts())
c = spot.acc_code('Inf(0)&Inf(1)&(Fin(2)|Fin(3))')
print(repr(c))
print(c.top_conjuncts())
# Nothing to split here as the top operator is not a disjunction
print(c.top_disjuncts())

spot.acc_code("(Fin(0)|Fin(3)) | (Inf(1) & Fin(2))")
(spot.acc_code("Fin(0)"), spot.acc_code("Fin(3)"), spot.acc_code("Inf(1) & Fin(2)"))
spot.acc_code("(Inf(0)&Inf(1)) & (Fin(2)|Fin(3))")
(spot.acc_code("Inf(0)"), spot.acc_code("Inf(1)"), spot.acc_code("Fin(2)|Fin(3)"))
(spot.acc_code("(Inf(0)&Inf(1)) & (Fin(2)|Fin(3))"),)

acc_cond

Automata store their acceptance condition as an instance of the acc_cond class. This class can be thought of as a pair (n, code), where n is an integer that tells how many acceptance sets are used, while the code is an instance of acc_code and encodes the formula over a subset of these acceptance sets. We usually have n == code.used_sets().max_set()), but n can be larger.

It is OK if an automaton declares that is uses 3 sets, even if the acceptance condition formula only uses set number 1. The extra two sets will have no impact on the language, even if they are used in the automaton.

The acc_cond objects are usually not created by hand: automata have dedicated methods for that. But for the purpose of this notebook, let's do it:

In [34]:
acc = spot.acc_cond(4, spot.acc_code('Rabin 2'))
acc
Out[34]:
spot.acc_cond(4, "(Fin(0) & Inf(1)) | (Fin(2) & Inf(3))")

For convenience, you can pass the string directly:

In [35]:
acc = spot.acc_cond(4, 'Rabin 2')
acc
Out[35]:
spot.acc_cond(4, "(Fin(0) & Inf(1)) | (Fin(2) & Inf(3))")
In [36]:
acc.num_sets()
Out[36]:
4
In [37]:
acc.get_acceptance()
Out[37]:
spot.acc_code("(Fin(0) & Inf(1)) | (Fin(2) & Inf(3))")

The acc_cond object can also be constructed using only a number of sets. In that case, the acceptance condition defaults to t, and it can be changed to something else later (using set_acceptance()). The number of acceptance sets can also be augmented with add_sets().

In [38]:
acc = spot.acc_cond(4)
acc
Out[38]:
spot.acc_cond(4, "t")
In [39]:
acc.add_sets(2)
acc
Out[39]:
spot.acc_cond(6, "t")
In [40]:
acc.set_acceptance('Streett 2')
acc
Out[40]:
spot.acc_cond(6, "(Fin(0) | Inf(1)) & (Fin(2) | Inf(3))")

Calling the constructor of acc_cond by passing just an instance of acc_code (or a string that will be passed to the acc_code constructor) will automatically set the number of acceptance sets to the minimum needed by the formula:

In [41]:
acc = spot.acc_cond('Streett 2')
acc
Out[41]:
spot.acc_cond(4, "(Fin(0) | Inf(1)) & (Fin(2) | Inf(3))")

The above is in fact just syntactic sugar for:

In [42]:
code = spot.acc_code('Streett 2')
acc = spot.acc_cond(code.used_sets().max_set(), code)
acc
Out[42]:
spot.acc_cond(4, "(Fin(0) | Inf(1)) & (Fin(2) | Inf(3))")

The common scenario of setting generalized Büchi acceptance can be achieved more efficiently by first setting the number of acceptance sets, and then requiring generalized Büchi acceptance:

In [43]:
acc = spot.acc_cond(4)
acc.set_generalized_buchi()
acc
Out[43]:
spot.acc_cond(4, "Inf(0)&Inf(1)&Inf(2)&Inf(3)")

The acc_cond class has several methods for detecting acceptance conditions that match the named acceptance conditions of the HOA format. Note that in the HOA format, Inf(0)&Inf(1)&Inf(2)&Inf(3) is only called generalized Büchi if exactly 4 acceptance sets are used. So the following behavior should not be surprising:

In [44]:
print(acc)
print(acc.is_generalized_buchi())
acc.add_sets(1)
print(acc)
print(acc.is_generalized_buchi())

(4, Inf(0)&Inf(1)&Inf(2)&Inf(3))
True
(5, Inf(0)&Inf(1)&Inf(2)&Inf(3))
False

Similar methods like is_t(), is_f(), is_buchi(), is_co_buchi(), is_generalized_co_buchi() all return a Boolean.

The is_rabin() and is_streett() methods, however, return a number of pairs. The number of pairs is always num_sets()/2 on success, or -1 on failure.

In [45]:
acc = spot.acc_cond('Rabin 2')
print(acc)
print(acc.is_rabin())
print(acc.is_streett())

(4, (Fin(0) & Inf(1)) | (Fin(2) & Inf(3)))
2
-1

The check for parity acceptance returns three Boolean in a list of the form [matched, max?, odd?]. If matched is False, the other values should be ignored.

In [46]:
acc = spot.acc_cond('parity min odd 4')
print(acc)
print(acc.is_parity())
acc.set_generalized_buchi()
print(acc)
print(acc.is_parity())

(4, Fin(0) & (Inf(1) | (Fin(2) & Inf(3))))
[True, False, True]
(4, Inf(0)&Inf(1)&Inf(2)&Inf(3))
[False, False, False]

If the acceptance condition has some known name, it can be retrieved using the name() method. By default the name given is a human-readable string close that used in the HOA format, but with proper accents, and support for name like Streett-like or Rabin-like. The argument arg can specify a different style using the same syntax as in --format='%[arg]g' when using the command-line tools.

In [47]:
print(acc.name())
print(acc.name("d"))  # <- Style used by print_dot(aut, "a")
print(acc.name("0"))  # <- no parameters

generalized-Büchi 4
gen. Büchi 4
generalized-Buchi

acc_cond contains a few functions for manipulating mark_t instances, these are typically functions that require known the total number of accepting sets declared.

For instance complementing a mark_t:

In [48]:
m = spot.mark_t([1, 3])
print(acc.comp(m))

{0,2}

all_sets() returns a mark_t listing all the declared sets:

In [49]:
acc.all_sets()
Out[49]:
spot.mark_t([0, 1, 2, 3])

For convenience, the accepting() method of acc_cond delegates to that of the acc_code.
Any set passed to accepting() that is not used by the acceptance formula has no influence.

In [50]:
print("acc =", acc)
for x in ([0, 1, 2, 3, 10], [1, 2]):
    print(f"acc.accepting({x}) = {acc.accepting(x)}")

acc = (4, Inf(0)&Inf(1)&Inf(2)&Inf(3))
acc.accepting([0, 1, 2, 3, 10]) = True
acc.accepting([1, 2]) = False

Finally the unsat_mark() method of acc_cond computes an instance of mark_t that is unaccepting (i.e., passing this value to acc.accepting(...) will return False when such a value exist. Not all acceptance conditions have an satisfiable mark. Obviously the t acceptance is always satisfiable, and so are all equivalent acceptances (for instance Fin(1)|Inf(1)).

For this reason, unsat_mark() actually returns a pair: (bool, mark_t) where the Boolean is False iff the acceptance is always satisfiable. When the Boolean is True, then the second element of the pair gives a non-accepting mark.

In [51]:
print(acc)
print(acc.unsat_mark())

(4, Inf(0)&Inf(1)&Inf(2)&Inf(3))
(True, spot.mark_t([]))
In [52]:
acc = spot.acc_cond(0)   # use 0 acceptance sets, and the default formula (t)
print(acc)
print(acc.unsat_mark())

(0, t)
(False, spot.mark_t([]))
In [53]:
acc = spot.acc_cond('Streett 2')
print(acc)
print(acc.unsat_mark())

(4, (Fin(0) | Inf(1)) & (Fin(2) | Inf(3)))
(True, spot.mark_t([2]))

top_conjuncts and top_disjuncts also work on acc_cond. In this case they return tuple of acc_cond with the same number of sets.

In [54]:
print(acc.top_disjuncts())
print(acc.top_conjuncts())

(spot.acc_cond(4, "(Fin(0) | Inf(1)) & (Fin(2) | Inf(3))"),)
(spot.acc_cond(4, "Fin(0) | Inf(1)"), spot.acc_cond(4, "Fin(2) | Inf(3)"))

fin_one() return the number of one color x that appears as Fin(x) in the formula, or -1 if the formula is Fin-less.

The variant fin_one_extract() consider the acceptance condition as a disjunction (if the top-level operator is not a disjunction, we just assume the formula is a disjunction with only one disjunct), and return a pair (x,c) where c is the disjunction of all disjuncts of the original formula where Fin(x) used to appear but where Fin(x) have been replaced by true, and Inf(x) by false. Also this function tries to choose an x such that one of the disjunct has the form ...&Fin(x)&... if possible: this is visible in the third example, where 5 is preferred to 2.

In [55]:
print(acc)
print(acc.fin_one())
print(acc.fin_one_extract())

(4, (Fin(0) | Inf(1)) & (Fin(2) | Inf(3)))
0
(0, spot.acc_cond(4, "Fin(2) | Inf(3)"))
In [56]:
acc2 = spot.acc_cond('Rabin 3')
print(acc2)
print(acc2.fin_one())
print(acc2.fin_one_extract())

(6, (Fin(0) & Inf(1)) | (Fin(2) & Inf(3)) | (Fin(4) & Inf(5)))
0
(0, spot.acc_cond(6, "Inf(1)"))
In [57]:
acc3 = spot.acc_cond('Inf(0)&(Fin(2)|Inf(3)) | Inf(4)&Fin(5) | Inf(0)&Inf(5)&(Fin(5)|Fin(0))')
print(acc3)
print(acc3.fin_one())
print(acc3.fin_one_extract())

(6, (Inf(0) & (Fin(2) | Inf(3))) | (Inf(4) & Fin(5)) | ((Inf(0)&Inf(5)) & (Fin(0)|Fin(5))))
2
(5, spot.acc_cond(6, "Inf(4)"))
In [58]:
acc4 = spot.acc_cond('Fin(1)&Inf(2)|Inf(3)&Inf(4)|Inf(5)&(Fin(1)|Fin(7))')
print(acc4)
print(acc4.fin_one())
print(acc4.fin_one_extract())

(8, (Fin(1) & Inf(2)) | (Inf(3)&Inf(4)) | (Inf(5) & (Fin(1)|Fin(7))))
1
(1, spot.acc_cond(8, "Inf(2) | Inf(5)"))
In [ ]: