epsilon-remover-separate.hh

Go to the documentation of this file.

#pragma once

#include <stdexcept>
#include <type_traits>
#include <unordered_map>
#include <unordered_set>
#include <utility>
#include <vector>

#include <boost/heap/fibonacci_heap.hpp>

#include <vcsn/algos/copy.hh>
#include <vcsn/algos/dot.hh>
#include <vcsn/algos/fwd.hh>
#include <vcsn/algos/is-eps-acyclic.hh>
#include <vcsn/algos/is-proper.hh>
#include <vcsn/algos/is-valid.hh>
#include <vcsn/core/kind.hh>
#include <vcsn/misc/attributes.hh>
#include <vcsn/misc/debug-level.hh>
#include <vcsn/misc/direction.hh>
#include <vcsn/misc/epsilon-profile.hh>
#include <vcsn/misc/vector.hh> // make_vector

#define STATS

namespace vcsn
{
  namespace detail
  {
    template <Automaton Aut,
              bool has_one = labelset_t_of<Aut>::has_one()>
    class epsilon_remover_separate
    {
      using automaton_t = std::remove_cv_t<Aut>;
      using weightset_t = weightset_t_of<automaton_t>;
      using weight_t = typename weightset_t::value_t;
      using labelset_t = labelset_t_of<automaton_t>;

      using dirty_ctx_t = context<vcsn::oneset, weightset_t>;
      using aut_dirty_t = mutable_automaton<dirty_ctx_t>;
      using state_dirty_t = state_t_of<aut_dirty_t>;

      using proper_ctx_t = detail::proper_context<context_t_of<Aut>>;
      using aut_proper_t = fresh_automaton_t_of<Aut, proper_ctx_t>;
      using state_proper_t = state_t_of<aut_proper_t>;
      using label_proper_t = label_t_of<aut_proper_t>;

    public:
      epsilon_remover_separate(const automaton_t& aut, bool prune = true)
        : debug_(debug_level())
        , ws_(*aut->weightset())
        , prune_(prune)
        , d2p_(aut->all_states().back() + 1,
               aut_proper_t::element_type::null_state())
        , p2d_(aut->all_states().back() + 1,
               aut_dirty_t::element_type::null_state())
      {
        auto dirty_ctx = dirty_ctx_t{{}, ws_};
        auto proper_ctx = make_proper_context(aut->context());
        aut_dirty_ = make_shared_ptr<aut_dirty_t>(dirty_ctx);
        aut_proper_ = make_shared_ptr<aut_proper_t>(proper_ctx);

        auto pcopier = make_copier(aut, aut_proper_);
        auto dcopier = make_copier(aut, aut_dirty_);

        using state_t = state_t_of<automaton_t>;
        using transition_t = transition_t_of<automaton_t>;
        pcopier([](state_t) { return true; },
                [&aut](transition_t t) {
                  return !aut->labelset()->is_one(aut->label_of(t));
                }
        );
        dcopier([&aut](state_t s) {
                  return (!in(aut, s, aut->labelset()->one()).empty()
                          || !out(aut, s, aut->labelset()->one()).empty());
                },
                [&aut](transition_t t) {
                  return aut->labelset()->is_one(aut->label_of(t));
                }
        );

        const auto& dorigins = dcopier.state_map();
        const auto& porigins = pcopier.state_map();
        for (const auto& dp : dorigins)
          {
            auto pp = porigins.find(dp.first);
            assert(pp != porigins.end());
            d2p_[dp.second] = pp->second;
            p2d_[pp->second] = dp.second;
          }
      }

    private:
      using profile_t = epsilon_profile<state_proper_t>;

      void update_profile_(state_proper_t proper_s)
      {
        auto dirty_s = p2d_[proper_s];
        if (auto p = profile_(proper_s))
          {
            auto in_dirty = in(aut_dirty_, dirty_s).size();
            auto in_proper = in(aut_proper_, proper_s).size();
            auto out_dirty = out(aut_dirty_, dirty_s).size();
            auto out_proper = all_out(aut_proper_, proper_s).size();

            p->update(in_dirty, in_proper + in_dirty,
                      out_dirty, out_proper + out_dirty);
          }
      }

      void build_heap_()
      {
        for (auto s: aut_dirty_->states())
          // We don't care about states without incoming spontaneous
          // transitions.
          if (in(aut_dirty_, s).size())
            {
              auto proper_s = d2p_[s];
              auto h = todo_.emplace(profile_t{proper_s, 0, 0, 0, 0});
              handles_.emplace(proper_s, h);
              update_profile_(proper_s);
            }
      }

      void show_heap_() const
      {
        const char* sep = "";
        for (auto i = todo_.ordered_begin(), end = todo_.ordered_end();
             i != end; ++i)
          {
            std::cerr << sep << *i;
            sep = " > ";
          }
      }

      void update_heap_(state_proper_t s)
      {
        if (3 < debug_)
          {
            std::cerr << "update heap (" << s << " : ";
            show_heap_();
          }
        auto i = handles_.find(s);
        if (i != handles_.end())
          todo_.update(i->second);
        if (3 < debug_)
          {
            std::cerr << ") => ";
            show_heap_();
            std::cerr << std::endl;
          }
      }

#ifdef STATS
      unsigned added_ = 0;
      unsigned removed_ = 0;
#endif

      profile_t* profile_(state_proper_t s) const
      {
        auto i = handles_.find(s);
        if (i == handles_.end())
          return nullptr;
        else
          return &*i->second;
      }

      void remover_on(state_proper_t proper_s, state_dirty_t dirty_s)
      {
        // The star of the weight of the loop on 's' (1 if no loop).
        weight_t star = ws_.one();
        using state_weight_t = std::pair<state_dirty_t, weight_t>;
        auto closure = std::vector<state_weight_t>{};

#ifdef STATS
        // Number of transitions that will be removed.
        auto removed = in(aut_dirty_, dirty_s).size();
#endif
        // Iterate on a copy: we remove these transitions in the loop.
        for (auto t : make_vector(in(aut_dirty_, dirty_s)))
          {
            weight_t weight = aut_dirty_->weight_of(t);
            auto src = aut_dirty_->src_of(t);
            if (src == dirty_s)  //loop
              star = ws_.star(weight);
            else
              closure.emplace_back(src, weight);
            // Delete incoming epsilon transitions.
            aut_dirty_->del_transition(t);
          }

        /*
          For each transition (t : s -- label|weight --> dst),
          for each former
          epsilon transition closure->first -- e|closure->second --> s
          a transition
          (closure->first -- label | closure->second*weight --> dst)
          is added to the automaton (add, not set !!)

          If (s) is final with weight (weight),
          for each former
          epsilon transition closure->first -- e|closure->second --> s
          pair-second * weight is added to the final weight
          of closure->first
        */


        // TODO: factoring with lambda
        for (auto t: out(aut_dirty_, dirty_s))
          {
            weight_t blow = ws_.mul(star, aut_dirty_->weight_of(t));
            aut_dirty_->set_weight(t, blow);

            auto dst = aut_dirty_->dst_of(t);
            for (auto pair: closure)
              {
                auto src = pair.first;
                weight_t w = ws_.mul(pair.second, blow);
                aut_dirty_->add_transition(src, dst, {}, w);
              }
          }

        for (auto t: all_out(aut_proper_, proper_s))
          {
            weight_t blow = ws_.mul(star, aut_proper_->weight_of(t));
            aut_proper_->set_weight(t, blow);

            label_proper_t label = aut_proper_->label_of(t);
            auto dst = aut_proper_->dst_of(t);
            for (auto pair: closure)
              {
                auto src = pair.first;
                weight_t w = ws_.mul(pair.second, blow);
                aut_proper_->add_transition(d2p_[src], dst, label, w);
              }
          }
#ifdef STATS
        // Number of transition that have been added.
        auto added = (all_out(aut_proper_, proper_s).size()
                      + out(aut_dirty_, dirty_s).size()) * closure.size();
#endif
        if (prune_
            && in(aut_dirty_, dirty_s).empty()
            && all_in(aut_proper_, proper_s).empty())
          {
#ifdef STATS
            removed += (all_out(aut_proper_, proper_s).size()
                        + out(aut_dirty_, dirty_s).size());
#endif
            aut_proper_->del_state(proper_s);
            aut_dirty_->del_state(dirty_s);
          }
#ifdef STATS
        added_ += added;
        removed_ += removed;
        if (1 < debug_)
          std::cerr << " -" << removed << "+" << added
                    << " (-" << removed_ << "+" << added_ << ")";
#endif
      }

    public:
      bool state_has_spontaneous_in(state_proper_t proper_s) const
      {
        state_dirty_t dirty_s = p2d_[proper_s];
        if (dirty_s == aut_dirty_->null_state())
          return false;
        else
          return !in(aut_dirty_, dirty_s).empty();
      }

      void remover_on(state_proper_t proper_s)
      {
        state_dirty_t dirty_s = p2d_[proper_s];
        if (dirty_s != aut_dirty_->null_state())
          remover_on(proper_s, dirty_s);
      }

      aut_proper_t operator()()
      {
        if (4 < debug_)
          {
            dot(aut_proper_, std::cerr) << std::endl;
            dot(aut_dirty_, std::cerr) << std::endl;
          }
        build_heap_();
        /* For each state (s), for each incoming epsilon-transitions
           (t), if (t) is a loop, the star of its weight is computed,
           otherwise, (t) is stored into the closure list.  Then (t)
           is removed.  */

        // The neighbors of s: their profiles need to be updated after
        // s was processed.
        auto neighbors = std::unordered_set<state_proper_t>{};
        while (!todo_.empty())
          {
            if (2 < debug_)
              {
                std::cerr << "Before: ";
                show_heap_();
                std::cerr << std::endl;
              }
            auto p = todo_.top();
            todo_.pop();
            if (1 < debug_)
              std::cerr << "Remove: " << p;

            state_proper_t proper_s = p.state;
            auto dirty_s = p2d_[proper_s];
            handles_.erase(proper_s);

            // Adjacent states.
            neighbors.clear();
            for (auto t: in(aut_proper_, proper_s))
              if (aut_proper_->src_of(t) != proper_s)
                neighbors.emplace(aut_proper_->src_of(t));
            for (auto t: out(aut_proper_, proper_s))
              if (aut_proper_->dst_of(t) != proper_s)
                neighbors.emplace(aut_proper_->dst_of(t));

            if (dirty_s != aut_dirty_->null_state())
              {
                state_dirty_t n;
                for (auto t: in(aut_dirty_, dirty_s))
                  if ((n = aut_dirty_->src_of(t)) != dirty_s)
                    neighbors.emplace(d2p_[n]);
                for (auto t: out(aut_dirty_, dirty_s))
                  if ((n = aut_dirty_->dst_of(t)) != dirty_s)
                    neighbors.emplace(d2p_[n]);

                remover_on(proper_s, dirty_s);
              }

            // Update all neighbors and then the heap.
            for (auto n: neighbors)
              update_profile_(n);
            for (auto n: neighbors)
              update_heap_(n);
            if (1 < debug_)
              std::cerr << " #tr: "
                        << transitions(aut_dirty_).size()
                        << "/" << (transitions(aut_dirty_).size()
                                   + transitions(aut_proper_).size())
                        << std::endl;
            if (2 < debug_)
              {
                std::cerr << "After:  ";
                show_heap_();
                std::cerr << std::endl;
              }
            if (4 < debug_)
              {
                dot(aut_proper_, std::cerr) << std::endl;
                dot(aut_dirty_, std::cerr) << std::endl;
              }
            if (2 < debug_)
              std::cerr << std::endl;
          }
#ifdef STATS
        if (0 < debug_)
          std::cerr << "Total transitions -" << removed_
                    << "+" << added_ << std::endl;
#endif

        return aut_proper_;
      }

      aut_proper_t get_proper()
      {
        return aut_proper_;
      }

    private:
      int debug_;

      aut_proper_t aut_proper_;

      aut_dirty_t aut_dirty_;

      const weightset_t& ws_;

      using heap_t = boost::heap::fibonacci_heap<profile_t>;
      heap_t todo_;
      std::unordered_map<state_proper_t, typename heap_t::handle_type> handles_;

      bool prune_;

      std::vector<state_proper_t> d2p_; // dirty states -> proper states
      std::vector<state_dirty_t> p2d_; // proper states -> dirty states
    };

    template <Automaton Aut>
    class epsilon_remover_separate<Aut, false>
    {
      using automaton_t = std::remove_cv_t<Aut>;
      using aut_proper_t = fresh_automaton_t_of<automaton_t>;
    public:
      epsilon_remover_separate(const automaton_t& aut, bool)
        : aut_(aut)
      {}

      aut_proper_t operator()()
      {
        return copy(aut_);
      }

      aut_proper_t get_proper()
      {
        return aut_;
      }

    private:
      automaton_t aut_;
    };
  }
} // namespace vcsn