synthesis.hh

// -*- coding: utf-8 -*-
// Copyright (C) by the Spot authors, see the AUTHORS file for details.
//
// 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 <spot/twa/twagraph.hh>
#include <spot/twaalgos/game.hh>
#include <spot/twaalgos/relabel.hh>
#include <bddx.h>
 
namespace spot
{
 
  struct SPOT_API synthesis_info
  {
    enum class algo
    {
      DET_SPLIT = 0,
      SPLIT_DET,
      DPA_SPLIT,
      LAR,
      LAR_OLD,
      ACD,
    };
 
    enum class splittype
    {
      AUTO = 0,  // Uses a heuristic to choose
      EXPL,  // Explicit enumerations of inputs
      SEMISYM,  // Works on one bdd per env state
      FULLYSYM  // Works on a fully symbolic version of the automaton
    };
 
    // These statistics are recorded by various steps of the synthesis
    // process.
    struct bench_var
    {
      // Number of sub-specifications resulting from the decomposition.
      // Updated by ltlsynt.
      unsigned sub_specs = 0;
      // Total time needed for the synthesis.  Computed by ltlsynt.
      double total_time = 0.0;
      // Time needed to transform the LTL formula(s) into automata, summed
      // over all subspecs.   The type of automaton constructed depends on
      // the "algo" parameter.
      double sum_trans_time = 0.0;
      // Time needed to split the automata into separate
      // environment/controller steps.  Summed over all subspecs.
      // Splitting may occur before or after paritization depending on
      // the "algo" parameter.
      double sum_split_time = 0.0;
      // Time needed to convert the automaton to deterministic parity
      // automata.  Summed over all subspecs.  Paritization may occur
      // before or after splitting depending on the "algo" parameter.
      double sum_paritize_time = 0.0;
      // Time needed to solve the game.  Summed over all subspecs.
      double sum_solve_time = 0.0;
      // Time needed to convert the winning strategy into an
      // automaton.  Summed over all subspecs.
      double sum_strat2aut_time = 0.0;
      // Time needed to simplify the winning strategy.  Summed over
      // all subspecs.
      double sum_simplify_strat_time = 0.0;
      // Time needed to encode all the strategies into one AIG.
      double aig_time = 0.0;
      // Size of the automaton resulting from the main translation.
      // If multiple subspecifications are used, only the largest
      // (states,edges,colors,aps) triplet is kept.
      unsigned max_trans_states = 0;
      unsigned max_trans_edges = 0;
      unsigned max_trans_colors = 0;
      unsigned max_trans_ap = 0;
      // Size of the game that should be solved.  If multiple
      // subspecifications are used, only the maximum states and
      // colors are kept (those are compared independently).
      unsigned max_game_states = 0;
      unsigned max_game_colors = 0;
      // Size of the strategy extracted from the game.  If multiple
      // subspecifications are used, only the maximum pair (states,
      // edges) is kept.
      unsigned max_strat_states = 0;
      unsigned max_strat_edges = 0;
      // Size of the strategy extracted from the game, summed over all
      // subspecifications.
      unsigned sum_strat_states = 0;
      unsigned sum_strat_edges = 0;
      // Size of the strategy after simplification game.  If multiple
      // subspecifications are used, only the maximum pair (states,
      // edges) is kept.
      unsigned max_simpl_strat_states = 0;
      unsigned max_simpl_strat_edges = 0;
      // Size of the strategy after simplification, summed over all
      // subspecifications.
      unsigned sum_simpl_strat_states = 0;
      unsigned sum_simpl_strat_edges = 0;
      // Size of the AIG
      unsigned aig_latches = 0;
      unsigned aig_gates = 0;
      // Whether the (global) specification is realizable.  Updated by
      // ltlsynt.
      bool realizable = false;
    };
 
    synthesis_info()
        : force_sbacc{false},
          s{algo::LAR},
          minimize_lvl{2},
          sp{splittype::AUTO},
          bv{},
          verbose_stream{nullptr},
          dict(make_bdd_dict())
    {
    }
 
    bool force_sbacc;
    algo s;
    int minimize_lvl;
    splittype sp;
    std::optional<bench_var> bv;
    std::ostream* verbose_stream;
    option_map opt;
    bdd_dict_ptr dict;
  };
 
 
  SPOT_API twa_graph_ptr
  split_2step(const const_twa_graph_ptr& aut,
              const bdd& output_bdd, bool complete_env = true,
              synthesis_info::splittype sp
                = synthesis_info::splittype::AUTO);
 
  SPOT_API twa_graph_ptr
  split_2step(const const_twa_graph_ptr& aut, bool complete_env = true,
              synthesis_info::splittype sp
                            = synthesis_info::splittype::AUTO);
 
  SPOT_API twa_graph_ptr
  split_2step(const const_twa_graph_ptr& aut,
              synthesis_info& gi);
 
 
  SPOT_API twa_graph_ptr
  unsplit_2step(const const_twa_graph_ptr& aut);
 
  SPOT_API std::ostream&
  operator<<(std::ostream& os, synthesis_info::algo s);
 
  SPOT_API std::ostream &
  operator<<(std::ostream &os, const synthesis_info &gi);
 
 
  SPOT_API twa_graph_ptr
  ltl_to_game(const formula& f,
              const std::vector<std::string>& all_outs,
              synthesis_info& gi);
  SPOT_API twa_graph_ptr
  ltl_to_game(const formula& f,
              const std::vector<std::string>& all_outs);
  SPOT_API twa_graph_ptr
  ltl_to_game(const std::string& f,
              const std::vector<std::string>& all_outs,
              synthesis_info& gi);
  SPOT_API twa_graph_ptr
  ltl_to_game(const std::string& f,
              const std::vector<std::string>& all_outs);
 
  SPOT_API twa_graph_ptr
  solved_game_to_mealy(twa_graph_ptr arena, synthesis_info& gi);
  SPOT_API twa_graph_ptr
  solved_game_to_mealy(twa_graph_ptr arena);
  SPOT_API twa_graph_ptr
  solved_game_to_separated_mealy(twa_graph_ptr arena, synthesis_info& gi);
  SPOT_API twa_graph_ptr
  solved_game_to_separated_mealy(twa_graph_ptr arena);
  SPOT_API twa_graph_ptr
  solved_game_to_split_mealy(twa_graph_ptr arena, synthesis_info& gi);
  SPOT_API twa_graph_ptr
  solved_game_to_split_mealy(twa_graph_ptr arena);
 
  struct SPOT_API mealy_like
  {
    enum class realizability_code
    {
      UNREALIZABLE,
      UNKNOWN,
      REALIZABLE_REGULAR,
      // strat is DTGBA and a glob_cond
      REALIZABLE_DTGBA
    };
 
    realizability_code success;
    twa_graph_ptr mealy_like;
    bdd glob_cond;
  };
 
  SPOT_API std::pair<std::vector<formula>, std::vector<std::set<formula>>>
  split_independent_formulas(formula f, const std::vector<std::string>& outs);
 
  SPOT_API std::pair<std::vector<formula>, std::vector<std::set<formula>>>
  split_independent_formulas(const std::string& f,
                             const std::vector<std::string>& outs);
 
  SPOT_API mealy_like
  try_create_direct_strategy(formula f,
                             const std::vector<std::string>& output_aps,
                             synthesis_info& gi, bool want_strategy = false);
 
  SPOT_API bool
  solve_game(twa_graph_ptr arena, synthesis_info& gi);
 
  struct SPOT_API game_relabeling_map
  {
    relabeling_map env_map;
    relabeling_map player_map;
  };
 
  SPOT_API game_relabeling_map
  partitioned_game_relabel_here(twa_graph_ptr& arena,
                                bool relabel_env,
                                bool relabel_play,
                                bool split_env = false,
                                bool split_play = false,
                                unsigned max_letter = -1u,
                                unsigned max_letter_mult = -1u);
 
  SPOT_API void
  relabel_game_here(twa_graph_ptr& arena,
                    game_relabeling_map& rel_maps);
 
}