trie_policy.hpp

Go to the documentation of this file.

// -*- C++ -*-

// Copyright (C) 2005-2013 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library.  This library 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 3, or (at your option) any later
// version.

// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.

// Under Section 7 of GPL version 3, you are granted additional
// permissions described in the GCC Runtime Library Exception, version
// 3.1, as published by the Free Software Foundation.

// You should have received a copy of the GNU General Public License and
// a copy of the GCC Runtime Library Exception along with this program;
// see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
// <http://www.gnu.org/licenses/>.

// Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.

// Permission to use, copy, modify, sell, and distribute this software
// is hereby granted without fee, provided that the above copyright
// notice appears in all copies, and that both that copyright notice
// and this permission notice appear in supporting documentation. None
// of the above authors, nor IBM Haifa Research Laboratories, make any
// representation about the suitability of this software for any
// purpose. It is provided "as is" without express or implied
// warranty.

#ifndef PB_DS_TRIE_POLICY_HPP
#define PB_DS_TRIE_POLICY_HPP

#include <bits/c++config.h>
#include <string>
#include <ext/pb_ds/detail/type_utils.hpp>
#include <ext/pb_ds/detail/trie_policy/trie_policy_base.hpp>

namespace __gnu_pbds
{
#define PB_DS_CLASS_T_DEC \
  template<typename String, typename String::value_type Min_E_Val, \
       typename String::value_type Max_E_Val, bool Reverse, \
       typename _Alloc>

#define PB_DS_CLASS_C_DEC \
  trie_string_access_traits<String, Min_E_Val,Max_E_Val,Reverse,_Alloc>

  template<typename String = std::string,
       typename String::value_type Min_E_Val = detail::__numeric_traits<typename String::value_type>::__min,
       typename String::value_type Max_E_Val = detail::__numeric_traits<typename String::value_type>::__max,
       bool Reverse = false,
       typename _Alloc = std::allocator<char> >
  struct trie_string_access_traits
  {
  public:
    typedef typename _Alloc::size_type            size_type;
    typedef String                    key_type;
    typedef typename _Alloc::template rebind<key_type>    __rebind_k;
    typedef typename __rebind_k::other::const_reference   key_const_reference;

    enum
      {
    reverse = Reverse
      };

    typedef typename detail::__conditional_type<Reverse, \
               typename String::const_reverse_iterator, \
               typename String::const_iterator>::__type const_iterator;

    typedef typename std::iterator_traits<const_iterator>::value_type e_type;

    enum
      {
    min_e_val = Min_E_Val,
    max_e_val = Max_E_Val,
    max_size = max_e_val - min_e_val + 1
      };
    PB_DS_STATIC_ASSERT(min_max_size, max_size >= 2);

    inline static const_iterator
    begin(key_const_reference);

    inline static const_iterator
    end(key_const_reference);

    inline static size_type
    e_pos(e_type e);

  private:
    inline static const_iterator
    begin_imp(key_const_reference, detail::false_type);

    inline static const_iterator
    begin_imp(key_const_reference, detail::true_type);

    inline static const_iterator
    end_imp(key_const_reference, detail::false_type);

    inline static const_iterator
    end_imp(key_const_reference, detail::true_type);

    static detail::integral_constant<int, Reverse> s_rev_ind;
  };

#include <ext/pb_ds/detail/trie_policy/trie_string_access_traits_imp.hpp>

#undef PB_DS_CLASS_T_DEC
#undef PB_DS_CLASS_C_DEC

#define PB_DS_CLASS_T_DEC \
  template<typename Node_CItr,typename Node_Itr, \
       typename _ATraits, typename _Alloc>

#define PB_DS_CLASS_C_DEC \
  trie_prefix_search_node_update<Node_CItr, Node_Itr, \
                 _ATraits,_Alloc>

#define PB_DS_TRIE_POLICY_BASE \
  detail::trie_policy_base<Node_CItr,Node_Itr,_ATraits, _Alloc>

  template<typename Node_CItr,
       typename Node_Itr,
       typename _ATraits,
       typename _Alloc>
  class trie_prefix_search_node_update : private PB_DS_TRIE_POLICY_BASE
  {
  private:
    typedef PB_DS_TRIE_POLICY_BASE              base_type;

  public:
    typedef typename base_type::key_type        key_type;
    typedef typename base_type::key_const_reference     key_const_reference;

    typedef _ATraits                access_traits;

    typedef typename access_traits::const_iterator  a_const_iterator;

    typedef _Alloc                      allocator_type;

    typedef typename allocator_type::size_type      size_type;
    typedef null_type                   metadata_type;
    typedef Node_Itr                    node_iterator;
    typedef Node_CItr                   node_const_iterator;
    typedef typename node_iterator::value_type      iterator;
    typedef typename node_const_iterator::value_type    const_iterator;

    std::pair<const_iterator, const_iterator>
    prefix_range(key_const_reference) const;

    std::pair<iterator, iterator>
    prefix_range(key_const_reference);

    std::pair<const_iterator, const_iterator>
    prefix_range(a_const_iterator, a_const_iterator) const;

    std::pair<iterator, iterator>
    prefix_range(a_const_iterator, a_const_iterator);

  protected:
    inline void
    operator()(node_iterator node_it, node_const_iterator end_nd_it) const;

  private:
    node_iterator
    next_child(node_iterator, a_const_iterator, a_const_iterator,
           node_iterator, const access_traits&);

    virtual const_iterator
    end() const = 0;

    virtual iterator
    end() = 0;

    virtual node_const_iterator
    node_begin() const = 0;

    virtual node_iterator
    node_begin() = 0;

    virtual node_const_iterator
    node_end() const = 0;

    virtual node_iterator
    node_end() = 0;

    virtual const access_traits&
    get_access_traits() const = 0;
  };

#include <ext/pb_ds/detail/trie_policy/prefix_search_node_update_imp.hpp>

#undef PB_DS_CLASS_C_DEC

#define PB_DS_CLASS_C_DEC \
  trie_order_statistics_node_update<Node_CItr, Node_Itr, \
                    _ATraits, _Alloc>

  template<typename Node_CItr,
       typename Node_Itr,
       typename _ATraits,
       typename _Alloc>
  class trie_order_statistics_node_update : private PB_DS_TRIE_POLICY_BASE
  {
  private:
    typedef PB_DS_TRIE_POLICY_BASE              base_type;

  public:
    typedef _ATraits                access_traits;
    typedef typename access_traits::const_iterator  a_const_iterator;
    typedef _Alloc                  allocator_type;
    typedef typename allocator_type::size_type      size_type;
    typedef typename base_type::key_type        key_type;
    typedef typename base_type::key_const_reference     key_const_reference;

    typedef size_type                   metadata_type;
    typedef Node_CItr                   node_const_iterator;
    typedef Node_Itr                    node_iterator;
    typedef typename node_const_iterator::value_type    const_iterator;
    typedef typename node_iterator::value_type      iterator;

    inline const_iterator
    find_by_order(size_type) const;

    inline iterator
    find_by_order(size_type);

    inline size_type
    order_of_key(key_const_reference) const;

    inline size_type
    order_of_prefix(a_const_iterator, a_const_iterator) const;

  protected:
    inline void
    operator()(node_iterator, node_const_iterator) const;

  private:
    typedef typename base_type::const_reference     const_reference;
    typedef typename base_type::const_pointer       const_pointer;

    typedef typename _Alloc::template rebind<metadata_type> __rebind_m;
    typedef typename __rebind_m::other          __rebind_ma;
    typedef typename __rebind_ma::const_reference      metadata_const_reference;
    typedef typename __rebind_ma::reference         metadata_reference;

    virtual bool
    empty() const = 0;

    virtual iterator
    begin() = 0;

    virtual iterator
    end() = 0;

    virtual node_const_iterator
    node_begin() const = 0;

    virtual node_iterator
    node_begin() = 0;

    virtual node_const_iterator
    node_end() const = 0;

    virtual node_iterator
    node_end() = 0;

    virtual access_traits&
    get_access_traits() = 0;
  };

#include <ext/pb_ds/detail/trie_policy/order_statistics_imp.hpp>

#undef PB_DS_CLASS_T_DEC
#undef PB_DS_CLASS_C_DEC
#undef PB_DS_TRIE_POLICY_BASE

} // namespace __gnu_pbds

#endif