spot/spot/twaalgos/game.hh
Alexandre Duret-Lutz 8b93b6967d rename pg_print() as print_pg() and add it to to_str()
* NEWS: Mention those change.
* spot/twaalgos/game.hh (print_pg): New function.
(pg_print): Mark as deprecated.
* spot/twaalgos/game.cc (pg_print): Redirect to print_pg().
(print_pg): Update to output state names.
* python/spot/__init__.py: Teach to_str() about print_pg().
* bin/ltlsynt.cc: Adjust to call print_pg().
* tests/python/games.ipynb: Add an example.
* tests/core/ltlsynt.test: Adjust to remove the "INIT" note.
2022-07-23 21:38:23 +02:00

218 lines
6.9 KiB
C++

// -*- coding: utf-8 -*-
// Copyright (C) 2017-2022 Laboratoire de Recherche et Développement
// de l'Epita (LRDE).
//
// This file is part of Spot, a model checking library.
//
// Spot is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// Spot is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
// License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
#pragma once
#include <algorithm>
#include <memory>
#include <ostream>
#include <unordered_map>
#include <vector>
#include <optional>
#include <bddx.h>
#include <spot/misc/optionmap.hh>
#include <spot/twa/twagraph.hh>
#include <spot/twaalgos/parity.hh>
namespace spot
{
/// \addtogroup games Functions related to game solving
/// \ingroup twa_algorithms
/// \ingroup games
/// \brief Transform an automaton into a parity game by propagating
/// players
///
/// This propagate state players, assuming the initial state belong
/// to \a first_player, and alternating players on each transitions.
/// If an odd cycle is detected, a runtime_exception is raised.
///
/// If \a complete0 is set, ensure that states of player 0 are
/// complete.
SPOT_API
void alternate_players(spot::twa_graph_ptr& arena,
bool first_player = false,
bool complete0 = true);
// false -> env, true -> player
typedef std::vector<bool> region_t;
// state idx -> global edge number
typedef std::vector<unsigned> strategy_t;
/// \ingroup games
/// \brief solve a parity-game
///
/// The arena is a deterministic max odd parity automaton with a
/// "state-player" property.
///
/// Player 1 tries to satisfy the acceptance condition, while player
/// 0 tries to prevent that.
///
/// This computes the winning strategy and winning region using
/// Zielonka's recursive algorithm. \cite zielonka.98.tcs
///
/// Also includes some inspiration from Oink.
/// \cite vandijk.18.tacas
///
/// Returns the player winning in the initial state, and sets
/// the state-winner and strategy named properties.
SPOT_API
bool solve_parity_game(const twa_graph_ptr& arena);
/// \ingroup games
/// \brief Solve a safety game.
///
/// The arena should be represented by an automaton with true
/// acceptance.
///
/// Player 1 tries to satisfy the acceptance condition, while player
/// 0 tries to prevent that. The only way for player 0 to win is
/// to find a way to move the play toward a state without successor.
/// If there no state without successors, then the game is necessarily
/// winning for player 1.
///
/// Returns the player winning in the initial state, and sets
/// the state-winner and strategy named properties.
SPOT_API
bool solve_safety_game(const twa_graph_ptr& game);
/// \ingroup games
/// \brief Generic interface for game solving
///
/// Dispatch to solve_safety_game() if the acceptance condition is
/// t, or to solve_parity_game() if it is a parity acceptance. Note that
/// parity acceptance include Büchi, co-Büchi, Rabin 1, and Streett 1.
///
/// Currently unable to solve game with other acceptance conditions
/// that are not parity.
///
/// Return the winning player for the initial state, and sets
/// the state-winner and strategy named properties.
SPOT_API bool
solve_game(const twa_graph_ptr& arena);
/// \ingroup games
/// \brief Print a parity game using PG-solver syntax
///
/// The input automaton should have parity acceptance and should
/// define state owner. Since the PG solver format want player 1 to
/// solve a max odd condition, the acceptance condition will be
/// adapted to max odd if necessary.
///
/// The output will list the initial state as first state (because
/// that is the convention of our parser), and list only reachable
/// states.
///
/// If states are named, the names will be output as well.
/// @{
SPOT_API
std::ostream& print_pg(std::ostream& os, const const_twa_graph_ptr& arena);
SPOT_DEPRECATED("use print_pg() instead")
SPOT_API
void pg_print(std::ostream& os, const const_twa_graph_ptr& arena);
/// @}
/// \ingroup games
/// \brief Highlight the edges of a strategy on an automaton.
///
/// Pass a negative color to not display the corresponding strategy.
SPOT_API
twa_graph_ptr highlight_strategy(twa_graph_ptr& arena,
int player0_color = 5,
int player1_color = 4);
/// \ingroup games
/// \brief Set the owner for all the states.
/// @{
SPOT_API
void set_state_players(twa_graph_ptr arena, const region_t& owners);
SPOT_API
void set_state_players(twa_graph_ptr arena, region_t&& owners);
/// @}
/// \ingroup games
/// \brief Set the owner of a state.
SPOT_API
void set_state_player(twa_graph_ptr arena, unsigned state, bool owner);
/// \ingroup games
/// \brief Get the owner of a state.
SPOT_API
bool get_state_player(const_twa_graph_ptr arena, unsigned state);
/// \ingroup games
/// \brief Get the owner of all states
SPOT_API
const region_t& get_state_players(const_twa_graph_ptr arena);
/// \ingroup games
/// \brief Get or set the strategy
/// @{
SPOT_API
const strategy_t& get_strategy(const_twa_graph_ptr arena);
SPOT_API
void set_strategy(twa_graph_ptr arena, const strategy_t& strat);
SPOT_API
void set_strategy(twa_graph_ptr arena, strategy_t&& strat);
/// @}
/// \ingroup games
/// \brief Set all synthesis outputs as a conjunction
SPOT_API
void set_synthesis_outputs(const twa_graph_ptr& arena, const bdd& outs);
/// \ingroup games
/// \brief Get all synthesis outputs as a conjunction
SPOT_API
bdd get_synthesis_outputs(const const_twa_graph_ptr& arena);
/// \brief Get the vector with the names of the output propositions
SPOT_API
std::vector<std::string>
get_synthesis_output_aps(const const_twa_graph_ptr& arena);
/// \ingroup games
/// \brief Set the winner for all the states.
/// @{
SPOT_API
void set_state_winners(twa_graph_ptr arena, const region_t& winners);
SPOT_API
void set_state_winners(twa_graph_ptr arena, region_t&& winners);
/// @}
/// \ingroup games
/// \brief Set the winner of a state.
SPOT_API
void set_state_winner(twa_graph_ptr arena, unsigned state, bool winner);
/// \ingroup games
/// \brief Get the winner of a state.
SPOT_API
bool get_state_winner(const_twa_graph_ptr arena, unsigned state);
/// \ingroup games
/// \brief Get the winner of all states
SPOT_API
const region_t& get_state_winners(const_twa_graph_ptr arena);
}