* src/tgba/bdddict.hh, src/tgba/state.hh, src/tgba/statebdd.hh,
src/tgba/succiter.hh, src/tgba/succiterconcrete.hh, src/tgba/tgba.hh, src/tgba/tgbabddconcrete.hh, src/tgba/tgbabddconcreteproduct.hh, src/tgba/tgbaexplicit.hh, src/tgba/tgbaproduct.hh, src/tgba/tgbareduc.hh, src/tgba/tgbatba.hh, src/tgbaalgos/emptiness.hh, src/tgbaalgos/magic.hh, src/tgbaalgos/replayrun.hh, src/tgbaalgos/gtec/gtec.hh, iface/gspn/ssp.hh: Introduce Doxygen groups in the documentation. Presently this only covers the tgba/ directory, and the emptiness-check algorithms. * doc/Doxyfile.in (EXCLUDE_PATTERNS): Skip Bison-generated files in src/evtgbaparse/.
This commit is contained in:
parent
cac85dbcca
commit
2cd298e4b0
19 changed files with 182 additions and 70 deletions
|
|
@ -34,6 +34,7 @@ namespace spot
|
|||
{
|
||||
|
||||
/// Map BDD variables to formulae.
|
||||
/// \ingroup tgba_essentials
|
||||
class bdd_dict: public bdd_allocator
|
||||
{
|
||||
public:
|
||||
|
|
|
|||
|
|
@ -31,6 +31,7 @@ namespace spot
|
|||
{
|
||||
|
||||
/// \brief Abstract class for states.
|
||||
/// \ingroup tgba_essentials
|
||||
class state
|
||||
{
|
||||
public:
|
||||
|
|
@ -76,6 +77,7 @@ namespace spot
|
|||
};
|
||||
|
||||
/// \brief Strict Weak Ordering for \c state*.
|
||||
/// \ingroup tgba_essentials
|
||||
///
|
||||
/// This is meant to be used as a comparison functor for
|
||||
/// STL \c map whose key are of type \c state*.
|
||||
|
|
@ -98,6 +100,7 @@ namespace spot
|
|||
};
|
||||
|
||||
/// \brief An Equivalence Relation for \c state*.
|
||||
/// \ingroup tgba_essentials
|
||||
///
|
||||
/// This is meant to be used as a comparison functor for
|
||||
/// Sgi \c hash_map whose key are of type \c state*.
|
||||
|
|
@ -121,6 +124,7 @@ namespace spot
|
|||
};
|
||||
|
||||
/// \brief Hash Function for \c state*.
|
||||
/// \ingroup tgba_essentials
|
||||
///
|
||||
/// This is meant to be used as a hash functor for
|
||||
/// Sgi's \c hash_map whose key are of type \c state*.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
// Copyright (C) 2003 Laboratoire d'Informatique de Paris 6 (LIP6),
|
||||
// Copyright (C) 2003, 2004 Laboratoire d'Informatique de Paris 6 (LIP6),
|
||||
// département Systèmes Répartis Coopératifs (SRC), Université Pierre
|
||||
// et Marie Curie.
|
||||
//
|
||||
|
|
@ -28,6 +28,7 @@
|
|||
namespace spot
|
||||
{
|
||||
/// A state whose representation is a BDD.
|
||||
/// \ingroup tgba_representation
|
||||
class state_bdd: public state
|
||||
{
|
||||
public:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
// Copyright (C) 2003 Laboratoire d'Informatique de Paris 6 (LIP6),
|
||||
// Copyright (C) 2003, 2004 Laboratoire d'Informatique de Paris 6 (LIP6),
|
||||
// département Systèmes Répartis Coopératifs (SRC), Université Pierre
|
||||
// et Marie Curie.
|
||||
//
|
||||
|
|
@ -26,8 +26,8 @@
|
|||
|
||||
namespace spot
|
||||
{
|
||||
|
||||
/// \brief Iterate over the successors of a state.
|
||||
/// \ingroup tgba_essentials
|
||||
///
|
||||
/// This class provides the basic functionalities required to
|
||||
/// iterate over the successors of a state, as well as querying
|
||||
|
|
@ -96,7 +96,6 @@ namespace spot
|
|||
|
||||
//@}
|
||||
};
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
// Copyright (C) 2003 Laboratoire d'Informatique de Paris 6 (LIP6),
|
||||
// Copyright (C) 2003, 2004 Laboratoire d'Informatique de Paris 6 (LIP6),
|
||||
// département Systèmes Répartis Coopératifs (SRC), Université Pierre
|
||||
// et Marie Curie.
|
||||
//
|
||||
|
|
@ -29,6 +29,7 @@
|
|||
namespace spot
|
||||
{
|
||||
/// A concrete iterator over successors of a TGBA state.
|
||||
/// \ingroup tgba_representation
|
||||
class tgba_succ_iterator_concrete: public tgba_succ_iterator
|
||||
{
|
||||
public:
|
||||
|
|
|
|||
|
|
@ -28,7 +28,21 @@
|
|||
|
||||
namespace spot
|
||||
{
|
||||
/// \defgroup tgba TGBA (Transition-based Genealized Büchi Automaton)
|
||||
///
|
||||
/// Spot is centered around the spot::tgba type. This type and its
|
||||
/// cousins are listed \ref tgba_essentials "here". This is an
|
||||
/// abstract interface. Its implementations are either \ref
|
||||
/// tgba_representation "concrete representations", or \ref
|
||||
/// tgba_on_the_fly_algorithms "on-the-fly algorithms". Other
|
||||
/// algorithms that work on spot::tgba are \ref tgba_algorithms
|
||||
/// "listed separately".
|
||||
|
||||
/// \addtogroup tgba_essentials Essential TGBA types
|
||||
/// \ingroup tgba
|
||||
|
||||
/// \brief A Transition-based Generalized Büchi Automaton.
|
||||
/// \ingroup tgba_essentials
|
||||
///
|
||||
/// The acronym TGBA (Transition-based Generalized Büchi Automaton)
|
||||
/// was coined by Dimitra Giannakopoulou and Flavio Lerda
|
||||
|
|
@ -201,6 +215,14 @@ namespace spot
|
|||
mutable int num_acc_;
|
||||
};
|
||||
|
||||
/// \addtogroup tgba_representation TGBA representations
|
||||
/// \ingroup tgba
|
||||
|
||||
/// \addtogroup tgba_on_the_fly_algorithms TGBA on-the-fly algorithms
|
||||
/// \ingroup tgba
|
||||
|
||||
/// \addtogroup tgba_algorithms TGBA algorithms
|
||||
/// \ingroup tgba
|
||||
}
|
||||
|
||||
#endif // SPOT_TGBA_TGBA_HH
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
// Copyright (C) 2003 Laboratoire d'Informatique de Paris 6 (LIP6),
|
||||
// Copyright (C) 2003, 2004 Laboratoire d'Informatique de Paris 6 (LIP6),
|
||||
// département Systèmes Répartis Coopératifs (SRC), Université Pierre
|
||||
// et Marie Curie.
|
||||
//
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
namespace spot
|
||||
{
|
||||
/// \brief A concrete spot::tgba implemented using BDDs.
|
||||
///
|
||||
/// \ingroup tgba_representation
|
||||
class tgba_bdd_concrete: public tgba
|
||||
{
|
||||
public:
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
// Copyright (C) 2003 Laboratoire d'Informatique de Paris 6 (LIP6),
|
||||
// Copyright (C) 2003, 2004 Laboratoire d'Informatique de Paris 6 (LIP6),
|
||||
// département Systèmes Répartis Coopératifs (SRC), Université Pierre
|
||||
// et Marie Curie.
|
||||
//
|
||||
|
|
@ -26,10 +26,11 @@
|
|||
|
||||
namespace spot
|
||||
{
|
||||
/// \brief Multiplies two tgba::tgba_bdd_concrete automata.
|
||||
/// \brief Multiplies two spot::tgba_bdd_concrete automata.
|
||||
/// \ingroup tgba_algorithms
|
||||
///
|
||||
/// This function build the resulting product, as another
|
||||
/// tgba::tgba_bdd_concrete automaton.
|
||||
/// This function builds the resulting product as another
|
||||
/// spot::tgba_bdd_concrete automaton.
|
||||
tgba_bdd_concrete*
|
||||
product(const tgba_bdd_concrete* left, const tgba_bdd_concrete* right);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -34,6 +34,7 @@ namespace spot
|
|||
class tgba_explicit_succ_iterator;
|
||||
|
||||
/// Explicit representation of a spot::tgba.
|
||||
/// \ingroup tgba_representation
|
||||
class tgba_explicit: public tgba
|
||||
{
|
||||
public:
|
||||
|
|
@ -116,6 +117,7 @@ namespace spot
|
|||
|
||||
|
||||
/// States used by spot::tgba_explicit.
|
||||
/// \ingroup tgba_representation
|
||||
class state_explicit : public spot::state
|
||||
{
|
||||
public:
|
||||
|
|
@ -139,6 +141,7 @@ namespace spot
|
|||
|
||||
|
||||
/// Successor iterators used by spot::tgba_explicit.
|
||||
/// \ingroup tgba_representation
|
||||
class tgba_explicit_succ_iterator: public tgba_succ_iterator
|
||||
{
|
||||
public:
|
||||
|
|
|
|||
|
|
@ -29,6 +29,7 @@ namespace spot
|
|||
{
|
||||
|
||||
/// \brief A state for spot::tgba_product.
|
||||
/// \ingroup tgba_on_the_fly_algorithms
|
||||
///
|
||||
/// This state is in fact a pair of state: the state from the left
|
||||
/// automaton and that of the right.
|
||||
|
|
|
|||
|
|
@ -47,8 +47,10 @@ namespace spot
|
|||
};
|
||||
|
||||
|
||||
class tgba_reduc: public tgba_explicit,
|
||||
public tgba_reachable_iterator_breadth_first
|
||||
/// Explicit automata used in reductions.
|
||||
/// \ingroup tgba_representation
|
||||
class tgba_reduc:
|
||||
public tgba_explicit, public tgba_reachable_iterator_breadth_first
|
||||
{
|
||||
public:
|
||||
tgba_reduc(const tgba* a,
|
||||
|
|
|
|||
|
|
@ -30,6 +30,7 @@ namespace spot
|
|||
{
|
||||
|
||||
/// \brief Degeneralize a spot::tgba on the fly, producing a TBA.
|
||||
/// \ingroup tgba_on_the_fly_algorithms
|
||||
///
|
||||
/// This class acts as a proxy in front of a spot::tgba, that should
|
||||
/// be degeneralized on the fly. The result is still a spot::tgba,
|
||||
|
|
@ -87,6 +88,7 @@ namespace spot
|
|||
};
|
||||
|
||||
/// \brief Degeneralize a spot::tgba on the fly, producing an SBA.
|
||||
/// \ingroup tgba_on_the_fly_algorithms
|
||||
///
|
||||
/// This class acts as a proxy in front of a spot::tgba, that should
|
||||
/// be degeneralized on the fly.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue