proper.hh

Go to the documentation of this file.

#pragma once

#include <stdexcept>
#include <type_traits>
#include <utility>

#include <vcsn/algos/copy.hh>
#include <vcsn/algos/epsilon-remover-distance.hh>
#include <vcsn/algos/epsilon-remover-lazy.hh>
#include <vcsn/algos/epsilon-remover-separate.hh>
#include <vcsn/algos/epsilon-remover.hh>
#include <vcsn/algos/fwd.hh>
#include <vcsn/algos/is-proper.hh>
#include <vcsn/algos/is-valid.hh>
#include <vcsn/core/kind.hh>
#include <vcsn/misc/builtins.hh>
#include <vcsn/misc/direction.hh>
#include <vcsn/misc/getargs.hh>
#include <vcsn/misc/star-status.hh>

namespace vcsn
{
  namespace detail
  {
    template <Automaton Aut>
    class properer
    {
      using automaton_t = std::remove_cv_t<Aut>;
      using self_t = properer;
      using weightset_t = weightset_t_of<automaton_t>;
      using labelset_t = labelset_t_of<automaton_t>;
      using aut_proper_t = fresh_automaton_t_of<automaton_t,
                            detail::proper_context<context_t_of<automaton_t>>>;

    public:
      properer(automaton_t aut,
               bool prune = true,
               const std::string& algo = "auto")
        : aut_(aut)
        , prune_(prune)
        , algo_(algo)
      {}

      aut_proper_t operator()() const
      {
        return proper_star_<weightset_t::star_status()>();
      }

      void here()
      {
        proper_star_here_<weightset_t::star_status()>();
      }

    private:

      /*-----------------.
      | Separate proper. |
      `-----------------*/

      aut_proper_t remover_() const
      {
        static const auto map
          = getarg<std::function<aut_proper_t(const self_t&)>>
          {
            "proper algorithm",
            {
              {"auto",    "inplace"},
              {"default", "inplace"},
              {"distance", [](const self_t& s) {
                  auto r =
                    detail::epsilon_remover_distance<automaton_t>{s.aut_,
                                                                  s.prune_};
                  return r();
                }},
              {"inplace", [](const self_t& s) {
                  auto a = copy(s.aut_); // in place
                  auto r = detail::epsilon_remover<decltype(a)>{a, s.prune_};
                  return r();
                }},
              {"separate", [](const self_t& s) {
                  auto r =
                    detail::epsilon_remover_separate<automaton_t>{s.aut_,
                                                                  s.prune_};
                  return r();
                }},
            },
          };
        return map[algo_](*this);
      }

      template <star_status_t Status>
      std::enable_if_t<Status == star_status_t::ABSVAL, aut_proper_t>
      proper_star_() const
      {
        require(is_valid(aut_), "proper: invalid automaton");
        return remover_();
      }

      template <star_status_t Status>
      std::enable_if_t<Status == star_status_t::NON_STARRABLE, aut_proper_t>
      proper_star_() const
      {
        require(is_valid(aut_), "proper: invalid automaton");
        return remover_();
      }

      template <star_status_t Status>
      std::enable_if_t<Status == star_status_t::STARRABLE, aut_proper_t>
      proper_star_() const
      {
        return remover_();
      }

      template <star_status_t Status>
      std::enable_if_t<Status == star_status_t::TOPS, aut_proper_t>
      proper_star_() const
      {
        try
          {
            return remover_();
          }
        catch (const std::runtime_error&)
          {
            raise("proper: invalid automaton");
          }
      }


      /*-----------------.
      | In place proper. |
      `-----------------*/

      void remover_here_()
      {
        if (algo_ == "auto" || algo_ == "default" || algo_ == "inplace")
          {
            detail::epsilon_remover<automaton_t> r(aut_, prune_);
            r.in_situ_remover();
          }
        else if (algo_ == "separate" || algo_ == "distance")
          raise("proper: algorithm ", algo_, " cannot be used in place");
        else
          raise("proper: invalid algorithm: ", algo_);
      }

      template <star_status_t Status>
      std::enable_if_t<Status == star_status_t::ABSVAL>
      proper_star_here_()
      {
        require(is_valid(aut_), "proper: invalid automaton");
        remover_here_();
      }

      template <star_status_t Status>
      std::enable_if_t<Status == star_status_t::NON_STARRABLE>
      proper_star_here_()
      {
        require(is_valid(aut_), "proper: invalid automaton");
        remover_here_();
      }

      template <star_status_t Status>
      std::enable_if_t<Status == star_status_t::STARRABLE>
      proper_star_here_()
      {
        remover_here_();
      }

      template <star_status_t Status>
      std::enable_if_t<Status == star_status_t::TOPS>
      proper_star_here_()
      {
        try
          {
            remover_here_();
          }
        catch (const std::runtime_error&)
          {
            raise("proper: invalid automaton");
          }
      }

      automaton_t aut_;
      bool prune_;
      const std::string& algo_;
    };

    template <Automaton Aut>
    auto make_properer(Aut aut,
                       bool prune = true,
                       const std::string& algo = "auto")
    {
      return properer<Aut>(aut, prune, algo);
    }
  }

  /*---------.
  | proper.  |
  `---------*/

  template <Automaton Aut>
  auto
  proper(const Aut& aut, direction dir = direction::backward,
         bool prune = true, const std::string& algo = "auto")
    -> fresh_automaton_t_of<Aut, detail::proper_context<context_t_of<Aut>>>
  {
    switch (dir)
      {
      case direction::backward:
        return detail::make_properer(aut, prune, algo)();
      case direction::forward:
        return transpose(proper(transpose(aut),
                                direction::backward, prune, algo));
      }
    BUILTIN_UNREACHABLE();
  }

  template <Automaton Aut>
  auto
  proper_lazy(const Aut& aut, direction dir = direction::backward,
              bool prune = true)
    -> lazy_proper_automaton<Aut>
  {
    require(dir == direction::backward,
            "backward direction for lazy proper is not implemented");
    return make_shared_ptr<lazy_proper_automaton<Aut>>(aut, prune);
  }

  template <Automaton Aut>
  inline
  void proper_here(Aut& aut, direction dir = direction::backward,
                   bool prune = true, const std::string& algo = "auto")
  {
    switch (dir)
      {
      case direction::backward:
        detail::make_properer(aut, prune, algo).here();
        return;
      case direction::forward:
        auto tr_aut = transpose(aut);
        detail::make_properer(tr_aut, prune, algo).here();
        return;
      }
  }

  namespace dyn
  {
    namespace detail
    {
      template <Automaton Aut, typename Dir, typename Bool, typename String>
      automaton proper(const automaton& aut, direction dir, bool prune,
                       const std::string& algo)
      {
        const auto& a = aut->as<Aut>();
        if (algo == "lazy")
          return make_automaton(proper_lazy(a, dir, prune));
        else
          return make_automaton(::vcsn::proper(a, dir, prune, algo));
      }
    }
  }
} // namespace vcsn