libstdc++

branch_policy.hpp
Go to the documentation of this file.
1 // -*- C++ -*-
2
3 // Copyright (C) 2005-2013 Free Software Foundation, Inc.
4 //
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
9 // version.
10
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.
15
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.
19
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/>.
24
25 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
26
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
34 // warranty.
35
36 /**
37 * @file branch_policy/branch_policy.hpp
38 * Contains a base class for branch policies.
39 */
40
41 #ifndef PB_DS_BRANCH_POLICY_BASE_HPP
42 #define PB_DS_BRANCH_POLICY_BASE_HPP
43
44 #include <ext/pb_ds/tag_and_trait.hpp>
45
46 namespace __gnu_pbds
47 {
48 namespace detail
49 {
50 /// Primary template, base class for branch structure policies.
51 template<typename Node_CItr, typename Node_Itr, typename _Alloc>
52 struct branch_policy
53 {
54 protected:
55 typedef typename Node_Itr::value_type it_type;
56 typedef typename std::iterator_traits<it_type>::value_type value_type;
57 typedef typename value_type::first_type key_type;
58
59 typedef typename remove_const<value_type>::type rcvalue_type;
60 typedef typename remove_const<key_type>::type rckey_type;
61
62 typedef typename _Alloc::template rebind<rcvalue_type>::other rebind_v;
63 typedef typename _Alloc::template rebind<rckey_type>::other rebind_k;
64
65 typedef typename rebind_v::reference reference;
66 typedef typename rebind_v::const_reference const_reference;
67 typedef typename rebind_v::const_pointer const_pointer;
68
69 typedef typename rebind_k::const_reference key_const_reference;
70
71 static inline key_const_reference
72 extract_key(const_reference r_val)
73 { return r_val.first; }
74
75 virtual it_type
76 end() = 0;
77
78 it_type
79 end_iterator() const
80 { return const_cast<branch_policy*>(this)->end(); }
81
82 virtual
83 ~branch_policy() { }
84 };
85
86 /// Specialization for const iterators.
87 template<typename Node_CItr, typename _Alloc>
88 struct branch_policy<Node_CItr, Node_CItr, _Alloc>
89 {
90 protected:
91 typedef typename Node_CItr::value_type it_type;
92 typedef typename std::iterator_traits<it_type>::value_type value_type;
93 typedef typename remove_const<value_type>::type rcvalue_type;
94 typedef typename _Alloc::template rebind<rcvalue_type>::other rebind_v;
95 typedef typename rebind_v::reference reference;
96 typedef typename rebind_v::const_reference const_reference;
97 typedef typename rebind_v::const_pointer const_pointer;
98
99 typedef value_type key_type;
100 typedef typename rebind_v::const_reference key_const_reference;
101
102 static inline key_const_reference
103 extract_key(const_reference r_val)
104 { return r_val; }
105
106 virtual it_type
107 end() const = 0;
108
109 it_type
110 end_iterator() const
111 { return end(); }
112
113 virtual
114 ~branch_policy() { }
115 };
116 } // namespace detail
117 } // namespace __gnu_pbds
118
119 #endif // #ifndef PB_DS_BRANCH_POLICY_BASE_HPP