blob: bf2f42916dd8655a60c0979fed04880e3487839c [file] [log] [blame]
// -*- C++ -*-
// Copyright (C) 2005, 2006, 2007, 2009 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.
/**
* @file internal_node.hpp
* Contains an internal PB_DS_BASE_C_DEC for a patricia tree.
*/
#ifndef PB_DS_PAT_TRIE_INTERNAL_NODE_HPP
#define PB_DS_PAT_TRIE_INTERNAL_NODE_HPP
#include <debug/debug.h>
namespace __gnu_pbds
{
namespace detail
{
#define PB_DS_CLASS_T_DEC \
template<typename Type_Traits, typename E_Access_Traits, \
typename Metadata, typename Allocator>
#define PB_DS_CLASS_C_DEC \
pat_trie_internal_node<Type_Traits, E_Access_Traits, Metadata, Allocator>
#define PB_DS_BASE_C_DEC \
pat_trie_node_base<Type_Traits, E_Access_Traits, Metadata, Allocator>
#define PB_DS_LEAF_C_DEC \
pat_trie_leaf<Type_Traits, E_Access_Traits, Metadata, Allocator>
template<typename Type_Traits,
typename E_Access_Traits,
typename Metadata,
typename Allocator>
struct pat_trie_internal_node : public PB_DS_BASE_C_DEC
{
private:
typedef PB_DS_BASE_C_DEC base_type;
typedef Type_Traits type_traits;
typedef typename type_traits::value_type value_type;
typedef typename Allocator::size_type size_type;
typedef E_Access_Traits e_access_traits;
typedef typename e_access_traits::const_iterator const_e_iterator;
typedef typename Allocator::template rebind<e_access_traits>::other access_rebind;
typedef typename access_rebind::const_pointer const_e_access_traits_pointer;
typedef typename Allocator::template rebind<base_type>::other base_rebind;
typedef typename base_rebind::pointer node_pointer;
typedef typename base_rebind::const_pointer const_node_pointer;
typedef PB_DS_LEAF_C_DEC leaf;
typedef typename Allocator::template rebind<leaf>::other leaf_rebind;
typedef typename leaf_rebind::pointer leaf_pointer;
typedef typename leaf_rebind::const_pointer const_leaf_pointer;
typedef typename Allocator::template rebind<pat_trie_internal_node>::other internal_node_rebind;
typedef typename internal_node_rebind::pointer internal_node_pointer;
typedef typename internal_node_rebind::const_pointer const_internal_node_pointer;
#ifdef _GLIBCXX_DEBUG
typedef typename base_type::subtree_debug_info subtree_debug_info;
virtual subtree_debug_info
assert_valid_imp(const_e_access_traits_pointer) const;
#endif
inline size_type
get_pref_pos(const_e_iterator, const_e_iterator,
const_e_access_traits_pointer) const;
public:
typedef typename Allocator::template rebind<node_pointer>::other node_pointer_rebind;
typedef typename node_pointer_rebind::pointer node_pointer_pointer;
typedef typename node_pointer_rebind::reference node_pointer_reference;
enum
{
arr_size = E_Access_Traits::max_size + 1
};
PB_DS_STATIC_ASSERT(min_arr_size, arr_size >= 2);
#include <ext/pb_ds/detail/pat_trie_/const_child_iterator.hpp>
#include <ext/pb_ds/detail/pat_trie_/child_iterator.hpp>
pat_trie_internal_node(size_type, const const_e_iterator);
void
update_prefixes(const_e_access_traits_pointer);
const_iterator
begin() const;
iterator
begin();
const_iterator
end() const;
iterator
end();
inline node_pointer
get_child_node(const_e_iterator, const_e_iterator,
const_e_access_traits_pointer);
inline const_node_pointer
get_child_node(const_e_iterator, const_e_iterator,
const_e_access_traits_pointer) const;
inline iterator
get_child_it(const_e_iterator, const_e_iterator,
const_e_access_traits_pointer);
inline node_pointer
get_lower_bound_child_node(const_e_iterator, const_e_iterator,
size_type, const_e_access_traits_pointer);
inline node_pointer
add_child(node_pointer, const_e_iterator, const_e_iterator,
const_e_access_traits_pointer);
inline const_node_pointer
get_join_child(const_node_pointer, const_e_access_traits_pointer) const;
inline node_pointer
get_join_child(node_pointer, const_e_access_traits_pointer);
void
remove_child(node_pointer p_nd);
iterator
remove_child(iterator it);
void
replace_child(node_pointer, const_e_iterator, const_e_iterator,
const_e_access_traits_pointer);
inline const_e_iterator
pref_b_it() const;
inline const_e_iterator
pref_e_it() const;
inline size_type
get_e_ind() const;
bool
should_be_mine(const_e_iterator, const_e_iterator, size_type,
const_e_access_traits_pointer) const;
leaf_pointer
leftmost_descendant();
const_leaf_pointer
leftmost_descendant() const;
leaf_pointer
rightmost_descendant();
const_leaf_pointer
rightmost_descendant() const;
#ifdef _GLIBCXX_DEBUG
size_type
e_ind() const;
#endif
private:
pat_trie_internal_node(const pat_trie_internal_node&);
size_type
get_begin_pos() const;
const size_type m_e_ind;
const_e_iterator m_pref_b_it;
const_e_iterator m_pref_e_it;
node_pointer m_a_p_children[arr_size];
static leaf_rebind s_leaf_alloc;
static internal_node_rebind s_internal_node_alloc;
};
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::leaf_rebind
PB_DS_CLASS_C_DEC::s_leaf_alloc;
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::internal_node_rebind
PB_DS_CLASS_C_DEC::s_internal_node_alloc;
PB_DS_CLASS_T_DEC
inline typename PB_DS_CLASS_C_DEC::size_type
PB_DS_CLASS_C_DEC::
get_pref_pos(const_e_iterator b_it, const_e_iterator e_it,
const_e_access_traits_pointer p_traits) const
{
if (static_cast<size_t>(std::distance(b_it, e_it)) <= m_e_ind)
return 0;
std::advance(b_it, m_e_ind);
return 1 + p_traits->e_pos(*b_it);
}
PB_DS_CLASS_T_DEC
PB_DS_CLASS_C_DEC::
pat_trie_internal_node(size_type len, const const_e_iterator it) :
PB_DS_BASE_C_DEC(pat_trie_internal_node_type),
m_e_ind(len), m_pref_b_it(it), m_pref_e_it(it)
{
std::advance(m_pref_e_it, m_e_ind);
std::fill(m_a_p_children, m_a_p_children + arr_size,
static_cast<node_pointer>(NULL));
}
PB_DS_CLASS_T_DEC
void
PB_DS_CLASS_C_DEC::
update_prefixes(const_e_access_traits_pointer p_traits)
{
node_pointer p_first = *begin();
if (p_first->m_type == pat_trie_leaf_node_type)
{
const_leaf_pointer p = static_cast<const_leaf_pointer>(p_first);
m_pref_b_it = p_traits->begin(e_access_traits::extract_key(p->value()));
}
else
{
_GLIBCXX_DEBUG_ASSERT(p_first->m_type == pat_trie_internal_node_type);
m_pref_b_it = static_cast<internal_node_pointer>(p_first)->pref_b_it();
}
m_pref_e_it = m_pref_b_it;
std::advance(m_pref_e_it, m_e_ind);
}
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::const_iterator
PB_DS_CLASS_C_DEC::
begin() const
{
typedef node_pointer_pointer pointer_type;
pointer_type p = const_cast<pointer_type>(m_a_p_children);
return const_iterator(p + get_begin_pos(), p + arr_size);
}
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::iterator
PB_DS_CLASS_C_DEC::
begin()
{
return iterator(m_a_p_children + get_begin_pos(),
m_a_p_children + arr_size);
}
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::const_iterator
PB_DS_CLASS_C_DEC::
end() const
{
typedef node_pointer_pointer pointer_type;
pointer_type p = const_cast<pointer_type>(m_a_p_children) + arr_size;
return const_iterator(p, p);
}
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::iterator
PB_DS_CLASS_C_DEC::
end()
{ return iterator(m_a_p_children + arr_size, m_a_p_children + arr_size); }
PB_DS_CLASS_T_DEC
inline typename PB_DS_CLASS_C_DEC::node_pointer
PB_DS_CLASS_C_DEC::
get_child_node(const_e_iterator b_it, const_e_iterator e_it,
const_e_access_traits_pointer p_traits)
{
const size_type i = get_pref_pos(b_it, e_it, p_traits);
_GLIBCXX_DEBUG_ASSERT(i < arr_size);
return m_a_p_children[i];
}
PB_DS_CLASS_T_DEC
inline typename PB_DS_CLASS_C_DEC::iterator
PB_DS_CLASS_C_DEC::
get_child_it(const_e_iterator b_it, const_e_iterator e_it,
const_e_access_traits_pointer p_traits)
{
const size_type i = get_pref_pos(b_it, e_it, p_traits);
_GLIBCXX_DEBUG_ASSERT(i < arr_size);
_GLIBCXX_DEBUG_ASSERT(m_a_p_children[i] != NULL);
return iterator(m_a_p_children + i, m_a_p_children + i);
}
PB_DS_CLASS_T_DEC
inline typename PB_DS_CLASS_C_DEC::const_node_pointer
PB_DS_CLASS_C_DEC::
get_child_node(const_e_iterator b_it, const_e_iterator e_it,
const_e_access_traits_pointer p_traits) const
{ return const_cast<node_pointer>(get_child_node(b_it, e_it, p_traits)); }
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::node_pointer
PB_DS_CLASS_C_DEC::
get_lower_bound_child_node(const_e_iterator b_it, const_e_iterator e_it,
size_type checked_ind,
const_e_access_traits_pointer p_traits)
{
if (!should_be_mine(b_it, e_it, checked_ind, p_traits))
{
if (p_traits->cmp_prefixes(b_it, e_it, m_pref_b_it, m_pref_e_it, true))
return leftmost_descendant();
return rightmost_descendant();
}
size_type i = get_pref_pos(b_it, e_it, p_traits);
_GLIBCXX_DEBUG_ASSERT(i < arr_size);
if (m_a_p_children[i] != NULL)
return m_a_p_children[i];
while (++i < arr_size)
if (m_a_p_children[i] != NULL)
{
if (m_a_p_children[i]->m_type == pat_trie_leaf_node_type)
return m_a_p_children[i];
_GLIBCXX_DEBUG_ASSERT(m_a_p_children[i]->m_type == pat_trie_internal_node_type);
return static_cast<internal_node_pointer>(m_a_p_children[i])->leftmost_descendant();
}
return rightmost_descendant();
}
PB_DS_CLASS_T_DEC
inline typename PB_DS_CLASS_C_DEC::node_pointer
PB_DS_CLASS_C_DEC::
add_child(node_pointer p_nd, const_e_iterator b_it, const_e_iterator e_it,
const_e_access_traits_pointer p_traits)
{
const size_type i = get_pref_pos(b_it, e_it, p_traits);
_GLIBCXX_DEBUG_ASSERT(i < arr_size);
if (m_a_p_children[i] == NULL)
{
m_a_p_children[i] = p_nd;
p_nd->m_p_parent = this;
return p_nd;
}
return m_a_p_children[i];
}
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::const_node_pointer
PB_DS_CLASS_C_DEC::
get_join_child(const_node_pointer p_nd, const_e_access_traits_pointer p_traits) const
{
node_pointer p = const_cast<node_pointer>(p_nd);
return const_cast<internal_node_pointer>(this)->get_join_child(p, p_traits);
}
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::node_pointer
PB_DS_CLASS_C_DEC::
get_join_child(node_pointer p_nd, const_e_access_traits_pointer p_traits)
{
size_type i;
const_e_iterator b_it;
const_e_iterator e_it;
if (p_nd->m_type == pat_trie_leaf_node_type)
{
typename Type_Traits::const_key_reference r_key =
e_access_traits::extract_key(static_cast<const_leaf_pointer>(p_nd)->value());
b_it = p_traits->begin(r_key);
e_it = p_traits->end(r_key);
}
else
{
b_it = static_cast<internal_node_pointer>(p_nd)->pref_b_it();
e_it = static_cast<internal_node_pointer>(p_nd)->pref_e_it();
}
i = get_pref_pos(b_it, e_it, p_traits);
_GLIBCXX_DEBUG_ASSERT(i < arr_size);
return m_a_p_children[i];
}
PB_DS_CLASS_T_DEC
void
PB_DS_CLASS_C_DEC::
remove_child(node_pointer p_nd)
{
size_type i = 0;
for (; i < arr_size; ++i)
if (m_a_p_children[i] == p_nd)
{
m_a_p_children[i] = NULL;
return;
}
_GLIBCXX_DEBUG_ASSERT(i != arr_size);
}
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::iterator
PB_DS_CLASS_C_DEC::
remove_child(iterator it)
{
iterator ret = it;
++ret;
* it.m_p_p_cur = NULL;
return ret;
}
PB_DS_CLASS_T_DEC
void
PB_DS_CLASS_C_DEC::
replace_child(node_pointer p_nd, const_e_iterator b_it,
const_e_iterator e_it,
const_e_access_traits_pointer p_traits)
{
const size_type i = get_pref_pos(b_it, e_it, p_traits);
_GLIBCXX_DEBUG_ASSERT(i < arr_size);
m_a_p_children[i] = p_nd;
p_nd->m_p_parent = this;
}
PB_DS_CLASS_T_DEC
inline typename PB_DS_CLASS_C_DEC::const_e_iterator
PB_DS_CLASS_C_DEC::
pref_b_it() const
{ return m_pref_b_it; }
PB_DS_CLASS_T_DEC
inline typename PB_DS_CLASS_C_DEC::const_e_iterator
PB_DS_CLASS_C_DEC::
pref_e_it() const
{ return m_pref_e_it; }
PB_DS_CLASS_T_DEC
inline typename PB_DS_CLASS_C_DEC::size_type
PB_DS_CLASS_C_DEC::
get_e_ind() const
{ return m_e_ind; }
PB_DS_CLASS_T_DEC
bool
PB_DS_CLASS_C_DEC::
should_be_mine(const_e_iterator b_it, const_e_iterator e_it,
size_type checked_ind,
const_e_access_traits_pointer p_traits) const
{
if (m_e_ind == 0)
return true;
const size_type num_es = std::distance(b_it, e_it);
if (num_es < m_e_ind)
return false;
const_e_iterator key_b_it = b_it;
std::advance(key_b_it, checked_ind);
const_e_iterator key_e_it = b_it;
std::advance(key_e_it, m_e_ind);
const_e_iterator value_b_it = m_pref_b_it;
std::advance(value_b_it, checked_ind);
const_e_iterator value_e_it = m_pref_b_it;
std::advance(value_e_it, m_e_ind);
return p_traits->equal_prefixes(key_b_it, key_e_it, value_b_it,
value_e_it);
}
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::leaf_pointer
PB_DS_CLASS_C_DEC::
leftmost_descendant()
{
node_pointer p_pot =* begin();
if (p_pot->m_type == pat_trie_leaf_node_type)
return (static_cast<leaf_pointer>(p_pot));
_GLIBCXX_DEBUG_ASSERT(p_pot->m_type == pat_trie_internal_node_type);
return static_cast<internal_node_pointer>(p_pot)->leftmost_descendant();
}
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::const_leaf_pointer
PB_DS_CLASS_C_DEC::
leftmost_descendant() const
{
return const_cast<internal_node_pointer>(this)->leftmost_descendant();
}
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::leaf_pointer
PB_DS_CLASS_C_DEC::
rightmost_descendant()
{
const size_type num_children = std::distance(begin(), end());
_GLIBCXX_DEBUG_ASSERT(num_children >= 2);
iterator it = begin();
std::advance(it, num_children - 1);
node_pointer p_pot =* it;
if (p_pot->m_type == pat_trie_leaf_node_type)
return static_cast<leaf_pointer>(p_pot);
_GLIBCXX_DEBUG_ASSERT(p_pot->m_type == pat_trie_internal_node_type);
return static_cast<internal_node_pointer>(p_pot)->rightmost_descendant();
}
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::const_leaf_pointer
PB_DS_CLASS_C_DEC::
rightmost_descendant() const
{
return const_cast<internal_node_pointer>(this)->rightmost_descendant();
}
#ifdef _GLIBCXX_DEBUG
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::size_type
PB_DS_CLASS_C_DEC::
e_ind() const
{ return m_e_ind; }
#endif
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::size_type
PB_DS_CLASS_C_DEC::
get_begin_pos() const
{
size_type i;
for (i = 0; i < arr_size && m_a_p_children[i] == NULL; ++i)
;
return i;
}
#ifdef _GLIBCXX_DEBUG
PB_DS_CLASS_T_DEC
typename PB_DS_CLASS_C_DEC::subtree_debug_info
PB_DS_CLASS_C_DEC::
assert_valid_imp(const_e_access_traits_pointer p_traits) const
{
_GLIBCXX_DEBUG_ASSERT(base_type::m_type == pat_trie_internal_node_type);
_GLIBCXX_DEBUG_ASSERT(static_cast<size_type>(std::distance(pref_b_it(), pref_e_it())) == m_e_ind);
_GLIBCXX_DEBUG_ASSERT(std::distance(begin(), end()) >= 2);
for (typename pat_trie_internal_node::const_iterator it = begin();
it != end(); ++it)
{
const_node_pointer p_nd =* it;
_GLIBCXX_DEBUG_ASSERT(p_nd->m_p_parent == this);
subtree_debug_info child_ret = p_nd->assert_valid_imp(p_traits);
_GLIBCXX_DEBUG_ASSERT(static_cast<size_type>(std::distance(child_ret.first, child_ret.second)) >= m_e_ind);
_GLIBCXX_DEBUG_ASSERT(should_be_mine(child_ret.first, child_ret.second, 0, p_traits));
_GLIBCXX_DEBUG_ASSERT(get_pref_pos(child_ret.first, child_ret.second, p_traits) == static_cast<size_type>(it.m_p_p_cur - m_a_p_children));
}
return std::make_pair(pref_b_it(), pref_e_it());
}
#endif
#undef PB_DS_CLASS_T_DEC
#undef PB_DS_CLASS_C_DEC
#undef PB_DS_BASE_C_DEC
#undef PB_DS_LEAF_C_DEC
} // namespace detail
} // namespace __gnu_pbds
#endif