scc.hh

Go to the documentation of this file.

#pragma once

#include <iterator> // std::rbegin
#include <limits>
#include <stack>

#include <boost/range/rbegin.hpp>
#include <boost/range/rend.hpp>

#include <vcsn/algos/copy.hh> // make_fresh_automaton
#include <vcsn/algos/filter.hh>
#include <vcsn/algos/tags.hh>
#include <vcsn/algos/transpose.hh>
#include <vcsn/core/partition-automaton.hh>
#include <vcsn/dyn/automaton.hh>
#include <vcsn/dyn/fwd.hh>
#include <vcsn/misc/builtins.hh>
#include <vcsn/misc/getargs.hh>
#include <vcsn/misc/unordered_map.hh>
#include <vcsn/misc/unordered_set.hh>
#include <vcsn/misc/vector.hh> // has

namespace vcsn
{
  namespace detail
  {

    /*--------------------------------.
    | strongly connected component.   |
    `--------------------------------*/

    template <Automaton Aut>
    using component_t = std::unordered_set<state_t_of<Aut>>;

    template <Automaton Aut>
    using components_t = std::vector<component_t<Aut>>;


    /*---------------------.
    | reverse_postorder.   |
    `---------------------*/

    template <Automaton Aut>
    class reverse_postorder_impl
    {
    public:
      using state_t = state_t_of<Aut>;

      reverse_postorder_impl(const Aut& aut)
        : aut_{aut}
      {
        // FIXME: wrong!  Should be states_size.  Or better yet: a
        // dedicated state-map type.
        rvp_.reserve(aut->num_all_states());
        for (auto s : aut->states())
          if (!has(marked_, s))
            dfs(s);
      }

      // FIXME: Wrong.  Should be const, or by value, and use
      // std::move.
      std::vector<state_t>& reverse_post()
      {
        return rvp_;
      }

    private:
      void dfs(state_t s)
      {
        marked_.emplace(s);
        for (auto t : out(aut_, s))
          {
            auto dst = aut_->dst_of(t);
            if (!has(marked_, dst))
              dfs(dst);
          }
        rvp_.emplace_back(s);
      }

      Aut aut_;
      std::vector<state_t> rvp_;
      std::unordered_set<state_t> marked_;
    };
  }

  template <Automaton Aut>
  std::vector<state_t_of<Aut>>
  reverse_postorder(const Aut& aut)
  {
    auto dv = detail::reverse_postorder_impl<Aut>(aut);
    return dv.reverse_post();
  }


  namespace detail
  {
    template <Automaton Aut, typename Tag = auto_tag>
    class scc_impl;

    /*------------.
    | dijkstra.   |
    `------------*/

    template <Automaton Aut>
    class scc_impl<Aut, dijkstra_tag>
    {
    public:
      using state_t = state_t_of<Aut>;
      using component_t = detail::component_t<Aut>;
      using components_t = detail::components_t<Aut>;

      scc_impl(const Aut& aut)
        : aut_{aut}
      {}

      const components_t& components()
      {
        for (auto s : aut_->states())
          if (!has(component_, s))
            dfs(s);
        return components_;
      }

    private:
      void dfs(state_t s)
      {
        preorder_[s] = count_;
        ++count_;
        unassigned_.push(s);
        uncertain_.push(s);
        for (auto t: out(aut_, s))
          {
            state_t dst = aut_->dst_of(t);
            if (!has(preorder_, dst))
              dfs(dst);
            else if (!has(component_, dst))
              {
                size_t dstpo = preorder_[dst];
                while (dstpo < preorder_[uncertain_.top()])
                  uncertain_.pop();
              }
          }
        if (s == uncertain_.top())
          {
            uncertain_.pop();
            auto scc_num = components_.size();
            components_.emplace_back();
            component_t& scc = components_.back();
            for (state_t r = unassigned_.top();
                 !unassigned_.empty();
                 unassigned_.pop(), r = unassigned_.top())
              {
                component_[r] = scc_num;
                scc.insert(r);
                if (r == s)
                  break;
              }
          }
      }

      Aut aut_;
      std::stack<state_t> unassigned_;
      std::stack<state_t> uncertain_;
      std::size_t count_ = 0;

      std::unordered_map<state_t, size_t> component_;

      std::unordered_map<state_t, size_t> preorder_;
      components_t components_;
    };
  }

  /*------------.
  | kosaraju.   |
  `------------*/

  struct kosaraju_tag {};

  namespace detail
  {
    template <Automaton Aut>
    class scc_impl<Aut, kosaraju_tag>
    {
    public:
      using state_t = state_t_of<Aut>;
      using component_t = detail::component_t<Aut>;
      using components_t = detail::components_t<Aut>;

      scc_impl(const Aut& aut)
        : aut_{aut}
      {
        auto trans = ::vcsn::transpose(aut);
        auto todo = ::vcsn::reverse_postorder(trans);
        while (!todo.empty())
          {
            auto s = todo.back();
            todo.pop_back();
            if (!has(marked_, s))
              {
                dfs(s);
                ++num_;
              }
          }
      }

      const components_t& components() const
      {
        return components_;
      }

    private:
      void dfs(state_t s)
      {
        marked_.emplace(s);
        if (num_ == components_.size())
          components_.emplace_back(component_t{s});
        else
          components_[num_].emplace(s);

        for (auto t : out(aut_, s))
          {
            auto dst = aut_->dst_of(t);
            if (!has(marked_, dst))
              dfs(dst);
          }
      }

      Aut aut_;
      std::size_t num_ = 0;
      components_t components_;
      std::unordered_set<state_t> marked_;
    };
  }

  /*---------------------.
  | tarjan, iterative.   |
  `---------------------*/

  struct tarjan_iterative_tag {};

  namespace detail
  {
    template <Automaton Aut>
    class scc_impl<Aut, tarjan_iterative_tag>
    {
    public:
      using state_t = state_t_of<Aut>;
      using transition_t = transition_t_of<Aut>;

      using component_t = detail::component_t<Aut>;
      using components_t = detail::components_t<Aut>;

      scc_impl(const Aut& aut)
        : aut_{aut}
      {
        for (auto s : aut_->states())
          if (!has(number_, s))
            dfs(s);
      }

      const components_t& components() const
      {
        return components_;
      }

    private:
      void dfs(state_t s)
      {
        number_[s] = low_[s] = curr_state_num_++;
        dfs_stack_.emplace_back(s, out(aut_, s).begin(), out(aut_, s).end());
        stack_.push_back(s);
        while (!dfs_stack_.empty())
          {
            auto& st = dfs_stack_.back();
            auto src = st.state;
            if (st.pos != st.end)
              {
                auto dst = aut_->dst_of(*st.pos);
                ++st.pos;
                if (!has(number_, dst))
                  {
                    number_[dst] = low_[dst] = curr_state_num_++;
                    const auto& ts = out(aut_, dst);
                    dfs_stack_.emplace_back(dst, ts.begin(), ts.end());
                    stack_.push_back(dst);
                  }
                else if (low_[dst] < low_[src])
                  low_[src] = low_[dst];
              }
            else
              {
                if (low_[src] == number_[src])
                  {
                    components_.emplace_back();
                    auto& com = components_.back();
                    state_t w;
                    do
                      {
                        w = stack_.back();
                        stack_.pop_back();
                        com.emplace(w);
                        low_[w] = low_max_;
                      }
                    while (w != src);
                  }
                dfs_stack_.pop_back();
                if (!dfs_stack_.empty())
                  {
                    auto& parent = dfs_stack_.back();
                    if (low_[src] < low_[parent.state])
                      low_[parent.state] = low_[src];
                  }
              }
          }
      }

      Aut aut_;

      struct step_t;
      std::vector<step_t> dfs_stack_;

      std::size_t curr_state_num_ = 0;
      std::unordered_map<state_t, std::size_t> number_;
      std::unordered_map<state_t, std::size_t> low_;
      std::size_t low_max_ = std::numeric_limits<unsigned int>::max();

      std::vector<state_t> stack_;
      components_t components_;

      using iterator_t = decltype(out(aut_, state_t{}).begin());

      struct step_t
      {
        step_t(state_t s, iterator_t p, iterator_t e)
          : state{s}, pos{p}, end{e} {}
        state_t state;
        iterator_t pos;
        iterator_t end;
      };
    };
  }

  /*--------------------.
  | tarjan_recursive.   |
  `--------------------*/

  struct tarjan_recursive_tag {};

  namespace detail
  {
    template <Automaton Aut>
    class scc_impl<Aut, tarjan_recursive_tag>
    {
    public:
      using state_t = state_t_of<Aut>;
      using component_t = detail::component_t<Aut>;
      using components_t = detail::components_t<Aut>;

      scc_impl(const Aut& aut)
        : aut_{aut}
      {
        for (auto s : aut_->states())
          if (!has(marked_, s))
            dfs(s);
      }

      const components_t& components() const
      {
        return components_;
      }

    private:
      void dfs(state_t s)
      {
        std::size_t min = curr_state_num_++;
        low_.emplace(s, min);
        marked_.emplace(s);
        stack_.push_back(s);

        for (auto t : out(aut_, s))
          {
            auto dst = aut_->dst_of(t);
            if (!has(marked_, dst))
              dfs(dst);
            if (low_[dst] < min)
              min = low_[dst];
          }
        if (min < low_[s])
          {
            low_[s] = min;
            return;
          }

        components_.emplace_back();
        auto& com = components_.back();
        state_t w;
        do
          {
            w = stack_.back();
            stack_.pop_back();
            com.emplace(w);
            // This state belong only one component
            // so remove it by update low value to max size.
            low_[w] = std::numeric_limits<size_t>::max();
          }
        while (w != s);
      }

      Aut aut_;
      std::size_t curr_state_num_ = 0;
      components_t components_;
      std::unordered_set<state_t> marked_;
      std::unordered_map<state_t, std::size_t> low_;
      std::vector<state_t> stack_;
    };
  }

  /*--------.
  | auto.   |
  `--------*/

  namespace detail
  {
    template <Automaton Aut>
    class scc_impl<Aut, auto_tag>
      : public scc_impl<Aut, tarjan_iterative_tag>
    {
      using super_t = scc_impl<Aut, tarjan_iterative_tag>;
      using super_t::super_t;
    };
  }


  /*-------.
  | scc.   |
  `-------*/

  enum class scc_algo_t
  {
    auto_,
    dijkstra,
    tarjan_iterative,
    tarjan_recursive,
    kosaraju
  };

  inline scc_algo_t scc_algo(const std::string& algo)
  {
    static const auto map = getarg<scc_algo_t>
      {
        "strongly connected components algorithm",
        {
          {"auto",             scc_algo_t::auto_},
          {"dijkstra",         scc_algo_t::dijkstra},
          {"kosaraju",         scc_algo_t::kosaraju},
          {"tarjan",           "tarjan,iterative"},
          {"tarjan,iterative", scc_algo_t::tarjan_iterative},
          {"tarjan,recursive", scc_algo_t::tarjan_recursive},
          {"tarjan_iterative", "tarjan,iterative"},
          {"tarjan_recursive", "tarjan,recursive"},
        }
      };
    return map[algo];
  }

  template <Automaton Aut, typename Tag = auto_tag>
  const detail::components_t<Aut>
  strong_components(const Aut& aut, Tag = {})
  {
    return detail::scc_impl<Aut, Tag>{aut}.components();
  }

  template <Automaton Aut>
  const detail::components_t<Aut>
  strong_components(const Aut& aut,
                    scc_algo_t algo = scc_algo_t::tarjan_iterative)
  {
    switch (algo)
      {
      case scc_algo_t::auto_:
        return strong_components(aut, auto_tag{});
      case scc_algo_t::dijkstra:
        return strong_components(aut, dijkstra_tag{});
      case scc_algo_t::kosaraju:
        return strong_components(aut, kosaraju_tag{});
      case scc_algo_t::tarjan_recursive:
        return strong_components(aut, tarjan_recursive_tag{});
      case scc_algo_t::tarjan_iterative:
        return strong_components(aut, tarjan_iterative_tag{});
      }
    BUILTIN_UNREACHABLE();
  }

  template <Automaton Aut>
  fresh_automaton_t_of<Aut>
  aut_of_component(const detail::component_t<Aut>& com, const Aut& aut)
  {
    auto res = make_fresh_automaton(aut);
    using res_t = decltype(res);
    auto map = std::unordered_map<state_t_of<Aut>, state_t_of<res_t>>{};
    auto s0 = *com.begin();
    map[s0] = res->new_state();
    res->set_initial(map[s0]);
    for (auto s : com)
      {
        if (!has(map, s))
          map[s] = res->new_state();
        for (auto t : out(aut, s))
          {
            auto dst = aut->dst_of(t);
            if (!has(com, dst))
              continue;
            if (!has(map, dst))
              map[dst] = res->new_state();
            res->new_transition(map[s], map[dst], aut->label_of(t));
          }
      }
    return res;
  }

  /*-----------------.
  | scc_automaton.   |
  `-----------------*/

  namespace detail
  {
    template <Automaton Aut>
    class scc_automaton_impl
      : public automaton_decorator<Aut>
    {
    public:
      using automaton_t = Aut;
      using super_t = automaton_decorator<automaton_t>;
      using state_t = state_t_of<Aut>;
      using components_t = detail::components_t<Aut>;
      using component_t = detail::component_t<Aut>;

      scc_automaton_impl(const automaton_t& input, scc_algo_t algo)
        : super_t(input)
      {
        // Components are numbered by ordered of discovery.  Reverse
        // this, so that components are roughly numbered as the
        // condensation state numbers would be (0 as an initial
        // state).
        const auto& cs = vcsn::strong_components(aut_, algo);
        // FIXME: std::rbegin/rend does not work with libstdc++.
        components_.assign(boost::rbegin(cs), boost::rend(cs));
        size_t num_sccs = components_.size();
        for (size_t i = 0; i < num_sccs; ++i)
          for (auto s : components_[i])
            component_[s] = i;
      }

      static symbol sname()
      {
        static auto res = symbol{"scc_automaton<"
                                 + automaton_t::element_type::sname() + '>'};
        return res;
      }

      std::ostream& print_set(std::ostream& o, format fmt = {}) const
      {
        o << "scc_automaton<";
        aut_->print_set(o, fmt);
        return o << '>';
      }

      bool state_has_name(state_t) const
      {
        return true;
      }

      std::ostream& print_state_name(state_t s, std::ostream& o,
                                     format fmt = {},
                                     bool = false) const
      {
        o << component_.at(s) << '.';
        aut_->print_state_name(s, o, fmt, true);
        return o;
      }

      const component_t& component(unsigned num) const
      {
        VCSN_REQUIRE(num < components_.size(),
                     "component: invalid component number: ",
                     num, ": there are ", components_.size(), " components");
        return components_[num];
      }

      const components_t& components() const
      {
        return components_;
      }

      size_t num_components() const
      {
        return components_.size();
      }

    private:
      using super_t::aut_;
      std::map<state_t, size_t> component_;
      components_t components_;
    };
  }

  template <Automaton Aut>
  using scc_automaton = std::shared_ptr<detail::scc_automaton_impl<Aut>>;

  template <Automaton Aut>
  scc_automaton<Aut>
  scc(const Aut& aut, const std::string& algo = "auto")
  {
    return make_shared_ptr<scc_automaton<Aut>>(aut, scc_algo(algo));
  }

  namespace dyn
  {
    namespace detail
    {
      template <Automaton Aut, typename String>
      automaton scc(const automaton& aut, const std::string& algo)
      {
        const auto& a = aut->as<Aut>();
        return ::vcsn::scc(a, algo);
      }
    }
  }

  /*----------------.
  | num_components. |
  `----------------*/

  template <Automaton Aut>
  std::size_t num_components(const scc_automaton<Aut>& aut)
  {
    return aut->num_components();
  }

  template <Automaton Aut>
  std::size_t num_components(const Aut&)
  {
    raise("num_components: requires an scc_automaton");
  }

  namespace dyn
  {
    namespace detail
    {
      template <Automaton Aut>
      std::size_t num_components(const automaton& aut)
      {
        const auto& a = aut->as<Aut>();
        return ::vcsn::num_components(a);
      }
    }
  }


  /*-----------.
  | component. |
  `-----------*/

  template <Automaton Aut>
  filter_automaton<scc_automaton<Aut>>
  component(const scc_automaton<Aut>& aut, unsigned num)
  {
    return vcsn::filter(aut, aut->component(num));
  }

  template <Automaton Aut>
  void
  component(const Aut&, unsigned)
  {
    raise("component: requires an scc_automaton");
  }

  namespace dyn
  {
    namespace detail
    {
      template <Automaton Aut, typename Unsigned>
      automaton component(const automaton& aut, unsigned num)
      {
        const auto& a = aut->as<Aut>();
        return ::vcsn::component(a, num);
      }
    }
  }


  /*----------.
  | condense. |
  `----------*/

  template <Automaton Aut>
  partition_automaton<scc_automaton<Aut>>
  condense(const scc_automaton<Aut>& aut)
  {
    auto res = make_shared_ptr<partition_automaton<scc_automaton<Aut>>>(aut);
    using state_t = state_t_of<Aut>;

    // State of aut -> state(component) of new automaton.
    auto map = std::unordered_map<state_t, state_t>
      {
        {aut->pre(), res->pre()},
        {aut->post(), res->post()},
      };

    // Add states to new automaton.
    for (const auto& com : aut->components())
      {
        state_t new_state = res->new_state(com);
        for (auto s : com)
          map[s] = new_state;
      }

    // Add transitions to new automaton.
    for (auto t: all_transitions(aut))
      {
        auto s = map[aut->src_of(t)];
        auto d = map[aut->dst_of(t)];
        if (s != d)
          res->add_transition(s, d, aut->label_of(t), aut->weight_of(t));
      }
    return res;
  }

  template <Automaton Aut>
  partition_automaton<Aut>
  condense(const Aut&)
  {
    raise("condense: requires an scc_automaton");
  }

  namespace dyn
  {
    namespace detail
    {
      template <Automaton Aut>
      automaton condense(const automaton& aut)
      {
        const auto& a = aut->as<Aut>();
        return ::vcsn::condense(a);
      }
    }
  }
}