ov_tree_map_/node_iterators.hpp
Go to the documentation of this file.
// -*- C++ -*-
// Copyright (C) 2005-2026 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 ov_tree_map_/node_iterators.hpp
* Contains an implementation class for ov_tree_.
*/
#ifndef PB_DS_OV_TREE_NODE_ITERATORS_HPP
#define PB_DS_OV_TREE_NODE_ITERATORS_HPP
#include <ext/pb_ds/tag_and_trait.hpp>
#include <ext/pb_ds/detail/type_utils.hpp>
#include <debug/debug.h>
namespace __gnu_pbds
{
namespace detail
{
#define PB_DS_OV_TREE_CONST_NODE_ITERATOR_C_DEC \
ov_tree_node_const_it_<Value_Type, Metadata_Type, _Alloc>
/// Const node reference.
template<typename Value_Type, typename Metadata_Type, typename _Alloc>
class ov_tree_node_const_it_
{
protected:
typedef typename rebind_traits<_Alloc, Value_Type>::pointer
pointer;
typedef typename rebind_traits<_Alloc, Value_Type>::const_pointer
const_pointer;
typedef typename rebind_traits<_Alloc, Metadata_Type>::const_pointer
const_metadata_pointer;
typedef PB_DS_OV_TREE_CONST_NODE_ITERATOR_C_DEC this_type;
protected:
template<typename Ptr>
inline static Ptr
mid_pointer(Ptr p_begin, Ptr p_end)
{
_GLIBCXX_DEBUG_ASSERT(p_end >= p_begin);
return (p_begin + (p_end - p_begin) / 2);
}
public:
typedef trivial_iterator_tag iterator_category;
typedef trivial_iterator_difference_type difference_type;
typedef typename rebind_traits<_Alloc, Value_Type>::const_pointer
value_type;
typedef typename rebind_traits<_Alloc,
typename remove_const<Value_Type>::type>::const_pointer
reference;
typedef typename rebind_traits<_Alloc,
typename remove_const<Value_Type>::type>::const_pointer
const_reference;
typedef Metadata_Type metadata_type;
typedef typename rebind_traits<_Alloc, metadata_type>::const_reference
metadata_const_reference;
public:
inline
ov_tree_node_const_it_(const_pointer p_nd = 0,
const_pointer p_begin_nd = 0,
const_pointer p_end_nd = 0,
const_metadata_pointer p_metadata = 0)
: m_p_value(const_cast<pointer>(p_nd)),
m_p_begin_value(const_cast<pointer>(p_begin_nd)),
m_p_end_value(const_cast<pointer>(p_end_nd)),
m_p_metadata(p_metadata)
{ }
inline const_reference
operator*() const
{ return m_p_value; }
inline metadata_const_reference
get_metadata() const
{
enum
{
has_metadata = !is_same<Metadata_Type, null_type>::value
};
PB_DS_STATIC_ASSERT(should_have_metadata, has_metadata);
_GLIBCXX_DEBUG_ASSERT(m_p_metadata != 0);
return *m_p_metadata;
}
/// Returns the node iterator associated with the left node.
inline this_type
get_l_child() const
{
if (m_p_begin_value == m_p_value)
return (this_type(m_p_begin_value, m_p_begin_value, m_p_begin_value));
const_metadata_pointer p_begin_metadata =
m_p_metadata - (m_p_value - m_p_begin_value);
return (this_type(mid_pointer(m_p_begin_value, m_p_value),
m_p_begin_value,
m_p_value,
mid_pointer(p_begin_metadata, m_p_metadata)));
}
/// Returns the node iterator associated with the right node.
inline this_type
get_r_child() const
{
if (m_p_value == m_p_end_value)
return (this_type(m_p_end_value, m_p_end_value, m_p_end_value));
const_metadata_pointer p_end_metadata =
m_p_metadata + (m_p_end_value - m_p_value);
return (this_type(mid_pointer(m_p_value + 1, m_p_end_value),
m_p_value + 1,
m_p_end_value,(m_p_metadata == 0) ?
0 : mid_pointer(m_p_metadata + 1, p_end_metadata)));
}
inline bool
operator==(const this_type& other) const
{
const bool is_end = m_p_begin_value == m_p_end_value;
const bool is_other_end = other.m_p_begin_value == other.m_p_end_value;
if (is_end)
return (is_other_end);
if (is_other_end)
return (is_end);
return m_p_value == other.m_p_value;
}
inline bool
operator!=(const this_type& other) const
{ return !operator==(other); }
public:
pointer m_p_value;
pointer m_p_begin_value;
pointer m_p_end_value;
const_metadata_pointer m_p_metadata;
};
#define PB_DS_OV_TREE_NODE_ITERATOR_C_DEC \
ov_tree_node_it_<Value_Type, Metadata_Type, _Alloc>
/// Node reference.
template<typename Value_Type, typename Metadata_Type, typename _Alloc>
class ov_tree_node_it_ : public PB_DS_OV_TREE_CONST_NODE_ITERATOR_C_DEC
{
private:
typedef PB_DS_OV_TREE_NODE_ITERATOR_C_DEC this_type;
typedef PB_DS_OV_TREE_CONST_NODE_ITERATOR_C_DEC base_type;
typedef typename base_type::pointer pointer;
typedef typename base_type::const_pointer const_pointer;
typedef
typename base_type::const_metadata_pointer
const_metadata_pointer;
public:
typedef trivial_iterator_tag iterator_category;
typedef trivial_iterator_difference_type difference_type;
typedef typename rebind_traits<_Alloc, Value_Type>::pointer
value_type;
typedef typename rebind_traits<_Alloc,
typename remove_const<Value_Type>::type>::pointer
reference;
typedef typename rebind_traits<_Alloc,
typename remove_const<Value_Type>::type>::pointer
const_reference;
inline
ov_tree_node_it_(const_pointer p_nd = 0, const_pointer p_begin_nd = 0, const_pointer p_end_nd = 0, const_metadata_pointer p_metadata = 0) : base_type(p_nd, p_begin_nd, p_end_nd, p_metadata)
{ }
/// Access.
inline reference
operator*() const
{ return reference(base_type::m_p_value); }
/// Returns the node reference associated with the left node.
inline ov_tree_node_it_
get_l_child() const
{
if (base_type::m_p_begin_value == base_type::m_p_value)
return (this_type(base_type::m_p_begin_value, base_type::m_p_begin_value, base_type::m_p_begin_value));
const_metadata_pointer p_begin_metadata =
base_type::m_p_metadata - (base_type::m_p_value - base_type::m_p_begin_value);
return (this_type(base_type::mid_pointer(base_type::m_p_begin_value, base_type::m_p_value),
base_type::m_p_begin_value,
base_type::m_p_value,
base_type::mid_pointer(p_begin_metadata, base_type::m_p_metadata)));
}
/// Returns the node reference associated with the right node.
inline ov_tree_node_it_
get_r_child() const
{
if (base_type::m_p_value == base_type::m_p_end_value)
return this_type(base_type::m_p_end_value, base_type::m_p_end_value,
base_type::m_p_end_value);
const_metadata_pointer p_end_metadata =
base_type::m_p_metadata + (base_type::m_p_end_value - base_type::m_p_value);
return (this_type(base_type::mid_pointer(base_type::m_p_value + 1, base_type::m_p_end_value),
base_type::m_p_value + 1,
base_type::m_p_end_value,(base_type::m_p_metadata == 0)?
0 : base_type::mid_pointer(base_type::m_p_metadata + 1, p_end_metadata)));
}
};
#undef PB_DS_OV_TREE_NODE_ITERATOR_C_DEC
#undef PB_DS_OV_TREE_CONST_NODE_ITERATOR_C_DEC
} // namespace detail
} // namespace __gnu_pbds
#endif
debug.h
tag_and_trait.hpp
type_utils.hpp
__gnu_pbds::trivial_iterator_difference_type
void trivial_iterator_difference_type
Prohibit moving trivial iterators.
Definition tag_and_trait.hpp:79
__gnu_pbds
GNU extensions for policy-based data structures for public use.
Definition assoc_container.hpp:52
__gnu_pbds::trivial_iterator_tag
A trivial iterator tag. Signifies that the iterators has none of std::iterators's movement abilities.
Definition tag_and_trait.hpp:76
__gnu_pbds::detail::rebind_traits
Consistent API for accessing allocator-related types.
Definition types_traits.hpp:140
__gnu_pbds::detail::ov_tree_node_const_it_::get_l_child
this_type get_l_child() const
Returns the node iterator associated with the left node.
Definition ov_tree_map_/node_iterators.hpp:135
__gnu_pbds::detail::ov_tree_node_const_it_::get_r_child
this_type get_r_child() const
Returns the node iterator associated with the right node.
Definition ov_tree_map_/node_iterators.hpp:151
__gnu_pbds::detail::ov_tree_node_it_
Node reference.
Definition ov_tree_map_/node_iterators.hpp:198
__gnu_pbds::detail::ov_tree_node_it_::get_r_child
ov_tree_node_it_ get_r_child() const
Returns the node reference associated with the right node.
Definition ov_tree_map_/node_iterators.hpp:255
__gnu_pbds::detail::ov_tree_node_it_::operator*
reference operator*() const
Access.
Definition ov_tree_map_/node_iterators.hpp:234
__gnu_pbds::detail::ov_tree_node_it_::get_l_child
ov_tree_node_it_ get_l_child() const
Returns the node reference associated with the left node.
Definition ov_tree_map_/node_iterators.hpp:239