3 // Copyright (C) 2005, 2006, 2009, 2010 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the terms
7 // of the GNU General Public License as published by the Free Software
8 // Foundation; either version 3, or (at your option) any later
11 // This library is distributed in the hope that it will be useful, but
12 // WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
25 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
27 // Permission to use, copy, modify, sell, and distribute this software
28 // is hereby granted without fee, provided that the above copyright
29 // notice appears in all copies, and that both that copyright notice
30 // and this permission notice appear in supporting documentation. None
31 // of the above authors, nor IBM Haifa Research Laboratories, make any
32 // representation about the suitability of this software for any
33 // purpose. It is provided "as is" without express or implied
37 * @file tree_policy.hpp
38 * Contains tree-related policies.
41 #ifndef PB_DS_TREE_POLICY_HPP
42 #define PB_DS_TREE_POLICY_HPP
44 #include <bits/c++config.h>
46 #include <ext/pb_ds/detail/type_utils.hpp>
47 #include <ext/pb_ds/detail/basic_tree_policy/basic_tree_policy_base.hpp>
51 // A null node updator, indicating that no node updates are required.
52 template<typename Const_Node_Iterator,
53 typename Node_Iterator,
56 struct null_tree_node_update
59 #define PB_DS_CLASS_T_DEC \
60 template<typename Const_Node_Iterator, class Node_Iterator, class Cmp_Fn, class Allocator>
62 #define PB_DS_CLASS_C_DEC \
63 tree_order_statistics_node_update<Const_Node_Iterator, Node_Iterator, Cmp_Fn, Allocator>
65 #define PB_DS_BASE_C_DEC \
66 detail::basic_tree_policy_base<Const_Node_Iterator, Node_Iterator, Allocator>
68 // Functor updating ranks of entrees.
69 template<typename Const_Node_Iterator, typename Node_Iterator,
70 typename Cmp_Fn, typename Allocator>
71 class tree_order_statistics_node_update : private PB_DS_BASE_C_DEC
74 typedef PB_DS_BASE_C_DEC base_type;
77 typedef Cmp_Fn cmp_fn;
78 typedef Allocator allocator_type;
79 typedef typename allocator_type::size_type size_type;
80 typedef typename base_type::key_type key_type;
81 typedef typename base_type::const_key_reference const_key_reference;
83 typedef size_type metadata_type;
84 typedef Const_Node_Iterator const_node_iterator;
85 typedef Node_Iterator node_iterator;
86 typedef typename const_node_iterator::value_type const_iterator;
87 typedef typename node_iterator::value_type iterator;
89 // Finds an entry by __order. Returns a const_iterator to the
90 // entry with the __order order, or a const_iterator to the
91 // container object's end if order is at least the size of the
94 find_by_order(size_type order) const;
96 // Finds an entry by __order. Returns an iterator to the entry
97 // with the __order order, or an iterator to the container
98 // object's end if order is at least the size of the container
101 find_by_order(size_type order);
103 // Returns the order of a key within a sequence. For exapmle, if
104 // r_key is the smallest key, this method will return 0; if r_key
105 // is a key between the smallest and next key, this method will
106 // return 1; if r_key is a key larger than the largest key, this
107 // method will return the size of r_c.
109 order_of_key(const_key_reference r_key) const;
112 // Const reference to the container's value-type.
113 typedef typename base_type::const_reference const_reference;
115 // Const pointer to the container's value-type.
116 typedef typename base_type::const_pointer const_pointer;
118 typedef typename allocator_type::template rebind<metadata_type>::other metadata_rebind;
119 // Const metadata reference.
120 typedef typename metadata_rebind::const_reference const_metadata_reference;
122 // Metadata reference.
123 typedef typename metadata_rebind::reference metadata_reference;
125 // Returns the const_node_iterator associated with the tree's root node.
126 virtual const_node_iterator
127 node_begin() const = 0;
129 // Returns the node_iterator associated with the tree's root node.
130 virtual node_iterator
133 // Returns the const_node_iterator associated with a just-after leaf node.
134 virtual const_node_iterator
135 node_end() const = 0;
137 // Returns the node_iterator associated with a just-after leaf node.
138 virtual node_iterator
141 // Access to the cmp_fn object.
146 // Updates the rank of a node through a node_iterator node_it;
147 // end_nd_it is the end node iterator.
149 operator()(node_iterator node_it, const_node_iterator end_nd_it) const;
152 ~tree_order_statistics_node_update();
155 #include <ext/pb_ds/detail/tree_policy/order_statistics_imp.hpp>
157 #undef PB_DS_CLASS_T_DEC
158 #undef PB_DS_CLASS_C_DEC
159 #undef PB_DS_BASE_C_DEC
161 } // namespace __gnu_pbds