alphabets_base.hh

Go to the documentation of this file.

// alphabets_base.hh: this file is part of the Vaucanson project.
//
// Vaucanson, a generic library for finite state machines.
//
// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The
// Vaucanson Group.
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// The complete GNU General Public Licence Notice can be found as the
// `COPYING' file in the root directory.
//
// The Vaucanson Group consists of people listed in the `AUTHORS' file.
//
#ifndef VCSN_ALGEBRA_CONCEPT_ALPHABETS_BASE_HH
# define VCSN_ALGEBRA_CONCEPT_ALPHABETS_BASE_HH

# include <vaucanson/design_pattern/design_pattern.hh>
# include <vaucanson/misc/container_ops.hh>
# include <vaucanson/algebra/concept/letter.hh>

namespace vcsn {

  namespace algebra {

    /*----------------------.
    | AlphabetSetBase<Self> |
    `----------------------*/

    template<class S>
    struct AlphabetSetBase
      : Structure<S>
    {
    protected:


      AlphabetSetBase();
      AlphabetSetBase(const AlphabetSetBase& other);
    };

    /*----------------.
    | alphabet_traits |
    `----------------*/

    template<typename S, typename T>
    struct alphabet_traits
    {
      typedef undefined_type    letter_t;

      typedef undefined_type    first_projection_t;

      typedef undefined_type    second_projection_t;

      static const bool dynamic_data = false;
    };

  } // algebra

  /*---------------.
  | dynamic_traits |
  `---------------*/

  template<typename S>
  struct dynamic_traits<algebra::AlphabetSetBase<S> >
    : dynamic_traits<Structure<S> >
  { };

  /*--------------.
  | virtual_types |
  `--------------*/

  template<typename S>
  struct virtual_types<algebra::AlphabetSetBase<S> >
    : virtual_types<Structure<S> >
  { };


  /*--------------------------------------.
  | MetaElement<AlphabetSetBase<Self>, T> |
  `--------------------------------------*/

  template<class S, typename T>
  struct MetaElement<algebra::AlphabetSetBase<S>, T>
    : MetaElement<Structure<S>, T>
  {

    typedef typename algebra::alphabet_traits<S, T>::letter_t letter_t;

    typedef typename op_begin_traits<S, T>::const_ret_t const_iterator;

    typedef typename op_begin_traits<S, T>::ret_t iterator;

    void insert(const letter_t& l);

    void insert(const std::string& lit);

    letter_t choose() const;

    letter_t random_letter() const;

    size_t size() const;

    size_t max_size() const;

    bool letter_equality(letter_t, letter_t) const;

    bool contains(const letter_t& l) const;

    bool is_finite() const;


    iterator begin();
    const_iterator begin() const;


    iterator end();
    const_iterator end() const;

  protected:

    MetaElement();
    MetaElement(const MetaElement& other);
  };

  namespace algebra
  {
    template <typename S, typename L>
    L op_parse(const AlphabetSetBase<S>& s,
               const std::string&,
               size_t&);

    template <typename S, typename St, typename T>
    St& op_rout(const AlphabetSetBase<S>& s, St& st, const T& a);

    template <typename S, typename T, typename L>
    bool op_letter_equality(const AlphabetSetBase<S>& s,
                            const T& a,
                            L lhs,
                            L rhs);
  } // ! algebra

  template <typename S, typename T>
  std::pair<bool, typename Element<S, T>::letter_t>
  parse_letter(const Element<S, T>& alphabet,
               const std::string& s);

} // vcsn

# if !defined VCSN_USE_INTERFACE_ONLY || defined VCSN_USE_LIB
#  include <vaucanson/algebra/concept/alphabets_base.hxx>
# endif // VCSN_USE_INTERFACE_ONLY

#endif // ! VCSN_ALGEBRA_CONCEPT_ALPHABETS_BASE_HH