randomltl.hh 11 KB
Newer Older
1
// -*- coding: utf-8 -*-
2 3
// Copyright (C) 2010, 2011, 2012, 2013, 2014 Laboratoire de Recherche
// et Développement de l'Epita (LRDE).
4
// Copyright (C) 2005  Laboratoire d'Informatique de Paris 6 (LIP6),
5
// département Systèmes Répartis Coopératifs (SRC), Université Pierre
6 7 8 9 10 11
// et Marie Curie.
//
// 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
12
// the Free Software Foundation; either version 3 of the License, or
13 14 15 16 17 18 19 20
// (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
21
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
22 23 24 25 26 27 28

#ifndef SPOT_LTLVISIT_RANDOMLTL_HH
# define SPOT_LTLVISIT_RANDOMLTL_HH

#include "apcollect.hh"
#include <iosfwd>

29 30 31 32 33 34 35 36 37 38 39
#include <unordered_set>
#include "misc/optionmap.hh"
#include "misc/hash.hh"
#include "simplify.hh"

#define OUTPUTBOOL 1
#define OUTPUTLTL 2
#define OUTPUTSERE 3
#define OUTPUTPSL 4
#define MAX_TRIALS 100000

40 41 42 43 44 45
namespace spot
{
  namespace ltl
  {

    /// \ingroup ltl_io
46
    /// \brief Base class for random formula generators
47
    class SPOT_API random_formula
48 49
    {
    public:
50 51 52 53 54 55
      random_formula(unsigned proba_size,
		     const atomic_prop_set* ap):
	proba_size_(proba_size), proba_(new op_proba[proba_size_]), ap_(ap)
      {
      }

56
      virtual ~random_formula()
57
      {
58
	delete[] proba_;
59 60 61 62 63 64 65 66
      }

      /// Return the set of atomic proposition used to build formulae.
      const atomic_prop_set*
      ap() const
      {
	return ap_;
      }
67 68 69 70 71 72 73

      /// \brief Generate a formula of size \a n.
      ///
      /// It is possible to obtain formulae that are smaller than \a
      /// n, because some simple simplifications are performed by the
      /// AST.  (For instance the formula <code>a | a</code> is
      /// automatically reduced to <code>a</code> by spot::ltl::multop.)
74
      const formula* generate(int n) const;
75 76 77 78 79

      /// \brief Print the priorities of each operator, constants,
      /// and atomic propositions.
      std::ostream& dump_priorities(std::ostream& os) const;

80
      /// \brief Update the priorities used to generate the formulae.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
      ///
      /// \a options should be comma-separated list of KEY=VALUE
      /// assignments, using keys from the above list.
      /// For instance <code>"xor=0, F=3"</code> will prevent \c xor
      /// from being used, and will raise the relative probability of
      /// occurrences of the \c F operator.
      const char* parse_options(char* options);

    protected:
      void update_sums();

      struct op_proba
      {
	const char* name;
	int min_n;
	double proba;
97
	typedef const formula* (*builder)(const random_formula* rl, int n);
98 99 100
	builder build;
	void setup(const char* name, int min_n, builder build);
      };
101
      unsigned proba_size_;
102 103 104 105
      op_proba* proba_;
      double total_1_;
      op_proba* proba_2_;
      double total_2_;
106
      op_proba* proba_2_or_more_;
107 108 109
      double total_2_and_more_;
      const atomic_prop_set* ap_;
    };
110 111 112


    /// \ingroup ltl_io
113
    /// \brief Generate random LTL formulae.
114
    ///
115 116 117 118
    /// This class recursively constructs LTL formulae of a given
    /// size.  The formulae will use the use atomic propositions from
    /// the set of propositions passed to the constructor, in addition
    /// to the constant and all LTL operators supported by Spot.
119 120 121 122 123
    ///
    /// By default each operator has equal chance to be selected.
    /// Also, each atomic proposition has as much chance as each
    /// constant (i.e., true and false) to be picked.  This can be
    /// tuned using parse_options().
124
    class SPOT_API random_ltl: public random_formula
125 126 127 128 129 130
    {
    public:
      /// Create a random LTL generator using atomic propositions from \a ap.
      ///
      /// The default priorities are defined as follows:
      ///
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
      /** \verbatim
          ap      n
          false   1
          true    1
          not     1
          F       1
          G       1
          X       1
          equiv   1
          implies 1
          xor     1
          R       1
          U       1
          W       1
          M       1
          and     1
          or      1
          \endverbatim */
149 150 151 152 153 154 155 156 157 158
      ///
      /// Where \c n is the number of atomic propositions in the
      /// set passed to the constructor.
      ///
      /// This means that each operator has equal chance to be
      /// selected.  Also, each atomic proposition has as much chance
      /// as each constant (i.e., true and false) to be picked.
      ///
      /// These priorities can be changed use the parse_options method.
      random_ltl(const atomic_prop_set* ap);
159 160 161 162 163 164 165

    protected:
      void setup_proba_();
      random_ltl(int size, const atomic_prop_set* ap);
    };

    /// \ingroup ltl_io
166
    /// \brief Generate random Boolean formulae.
167 168 169 170 171 172 173
    ///
    /// This class recursively constructs Boolean formulae of a given size.
    /// The formulae will use the use atomic propositions from the
    /// set of propositions passed to the constructor, in addition to the
    /// constant and all Boolean operators supported by Spot.
    ///
    /// By default each operator has equal chance to be selected.
174
    class SPOT_API random_boolean: public random_formula
175 176 177 178 179 180 181
    {
    public:
      /// Create a random Boolean formula generator using atomic
      /// propositions from \a ap.
      ///
      /// The default priorities are defined as follows:
      ///
182 183 184 185 186 187 188 189 190 191 192
      /** \verbatim
          ap      n
          false   1
          true    1
          not     1
          equiv   1
          implies 1
          xor     1
          and     1
          or      1
          \endverbatim */
193 194 195 196 197 198 199 200 201 202 203 204 205
      ///
      /// Where \c n is the number of atomic propositions in the
      /// set passed to the constructor.
      ///
      /// This means that each operator has equal chance to be
      /// selected.  Also, each atomic proposition has as much chance
      /// as each constant (i.e., true and false) to be picked.
      ///
      /// These priorities can be changed use the parse_options method.
      random_boolean(const atomic_prop_set* ap);
    };

    /// \ingroup ltl_io
206
    /// \brief Generate random SERE.
207 208 209 210 211 212 213
    ///
    /// This class recursively constructs SERE of a given size.
    /// The formulae will use the use atomic propositions from the
    /// set of propositions passed to the constructor, in addition to the
    /// constant and all SERE operators supported by Spot.
    ///
    /// By default each operator has equal chance to be selected.
214
    class SPOT_API random_sere: public random_formula
215 216 217 218 219 220
    {
    public:
      /// Create a random SERE genere using atomic propositions from \a ap.
      ///
      /// The default priorities are defined as follows:
      ///
221 222 223 224 225 226 227 228 229 230 231 232 233
      /** \verbatim
          eword    1
          boolform 1
          star     1
          star_b   1
          equal_b  1
          goto_b   1
          and      1
          andNLM   1
          or       1
          concat   1
          fusion   1
          \endverbatim */
234 235 236 237 238 239 240 241 242 243 244 245
      ///
      /// Where "boolfrom" designates a Boolean formula generated
      /// by random_boolean.
      ///
      /// These priorities can be changed use the parse_options method.
      ///
      /// In addition, you can set the properties of the Boolean
      /// formula generator used to build Boolean subformulae using
      /// the parse_options method of the \c rb attribute.
      random_sere(const atomic_prop_set* ap);

      random_boolean rb;
246
    };
247 248

    /// \ingroup ltl_io
249
    /// \brief Generate random PSL formulae.
250 251 252 253 254
    ///
    /// This class recursively constructs PSL formulae of a given size.
    /// The formulae will use the use atomic propositions from the
    /// set of propositions passed to the constructor, in addition to the
    /// constant and all PSL operators supported by Spot.
255
    class SPOT_API random_psl: public random_ltl
256 257 258 259 260 261 262 263 264 265
    {
    public:
      /// Create a random PSL generator using atomic propositions from \a ap.
      ///
      /// PSL formulae are built by combining LTL operators, plus
      /// three operators (EConcat, UConcat, Closure) taking a SERE
      /// as parameter.
      ///
      /// The default priorities are defined as follows:
      ///
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
      /** \verbatim
          ap      n
          false   1
          true    1
          not     1
          F       1
          G       1
          X       1
          Closure 1
          equiv   1
          implies 1
          xor     1
          R       1
          U       1
          W       1
          M       1
          and     1
          or      1
          EConcat 1
          UConcat 1
          \endverbatim */
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
      ///
      /// Where \c n is the number of atomic propositions in the
      /// set passed to the constructor.
      ///
      /// This means that each operator has equal chance to be
      /// selected.  Also, each atomic proposition has as much chance
      /// as each constant (i.e., true and false) to be picked.
      ///
      /// These priorities can be changed use the parse_options method.
      ///
      /// In addition, you can set the properties of the SERE generator
      /// used to build SERE subformulae using the parse_options method
      /// of the \c rs attribute.
      random_psl(const atomic_prop_set* ap);

      /// The SERE generator used to generate SERE subformulae.
      random_sere rs;
    };

306 307 308 309 310 311
    class SPOT_API randltlgenerator
    {
      typedef
      std::unordered_set<const spot::ltl::formula*,
      const spot::ptr_hash<const spot::ltl::formula>> fset_t;

312

313 314 315 316 317
      public:
      randltlgenerator(int aprops_n, option_map& opts,
                       char* opt_pL = nullptr,
                       char* opt_pS = nullptr,
                       char* opt_pB = nullptr);
318

319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
      randltlgenerator(atomic_prop_set aprops, option_map& opts,
                       char* opt_pL = nullptr,
                       char* opt_pS = nullptr,
                       char* opt_pB = nullptr);

      void construct(atomic_prop_set aprops, option_map& opts,
                       char* opt_pL, char* opt_pS,
                       char* opt_pB);

      ~randltlgenerator();

      const spot::ltl::formula* next();

      void dump_ltl_priorities(std::ostream& os);

      void dump_bool_priorities(std::ostream& os);
335

336
      void dump_psl_priorities(std::ostream& os);
337

338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
      void dump_sere_priorities(std::ostream& os);

      void dump_sere_bool_priorities(std::ostream& os);

      void remove_some_props(atomic_prop_set& s);

      const formula* GF_n();

      private:
      fset_t unique_set_;
      atomic_prop_set aprops_;

      int opt_seed_;
      int opt_tree_size_min_;
      int opt_tree_size_max_;
      bool opt_unique_;
      bool opt_wf_;
      int opt_simpl_level_;
      ltl_simplifier simpl_;

      int output_;

      random_formula* rf_ = 0;
      random_psl* rp_ = 0;
      random_sere* rs_ = 0;
    };
  }
}
366
#endif // SPOT_LTLVIST_RANDOMLTL_HH