1 // -*- C++ -*-
2 
3 // Copyright (C) 2005-2020 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 #include <ext/pb_ds/detail/types_traits.hpp>
46 
47 namespace __gnu_pbds
48 {
49   namespace detail
50   {
51     /// Primary template, base class for branch structure policies.
52     template<typename Node_CItr, typename Node_Itr, typename _Alloc>
53       struct branch_policy
54       {
55       protected:
56 	typedef typename Node_Itr::value_type 		it_type;
57 	typedef typename std::iterator_traits<it_type>::value_type value_type;
58 	typedef typename value_type::first_type 	key_type;
59 
60 	typedef typename remove_const<value_type>::type	rcvalue_type;
61 	typedef typename remove_const<key_type>::type	rckey_type;
62 
63 	typedef rebind_traits<_Alloc, rcvalue_type>	rebind_v;
64 	typedef rebind_traits<_Alloc, rckey_type>	rebind_k;
65 
66 	typedef	typename rebind_v::reference 		reference;
67 	typedef	typename rebind_v::const_reference 	const_reference;
68 	typedef	typename rebind_v::const_pointer	const_pointer;
69 
70 	typedef	typename rebind_k::const_reference 	key_const_reference;
71 
72 	static inline key_const_reference
extract_key__gnu_pbds::detail::branch_policy73 	extract_key(const_reference r_val)
74 	{ return r_val.first; }
75 
76 	virtual it_type
77 	end() = 0;
78 
79 	it_type
end_iterator__gnu_pbds::detail::branch_policy80 	end_iterator() const
81 	{ return const_cast<branch_policy*>(this)->end(); }
82 
83 	virtual
~branch_policy__gnu_pbds::detail::branch_policy84 	~branch_policy() { }
85       };
86 
87     /// Specialization for const iterators.
88     template<typename Node_CItr, typename _Alloc>
89       struct branch_policy<Node_CItr, Node_CItr, _Alloc>
90       {
91       protected:
92 	typedef typename Node_CItr::value_type 		   it_type;
93        	typedef typename std::iterator_traits<it_type>::value_type value_type;
94 	typedef typename remove_const<value_type>::type		   rcvalue_type;
95 	typedef rebind_traits<_Alloc, rcvalue_type>	rebind_v;
96 	typedef	typename rebind_v::reference 		reference;
97 	typedef	typename rebind_v::const_reference 	const_reference;
98 	typedef	typename rebind_v::const_pointer	const_pointer;
99 
100 	typedef value_type 				key_type;
101 	typedef	typename rebind_v::const_reference 	key_const_reference;
102 
103 	static inline key_const_reference
extract_key__gnu_pbds::detail::branch_policy104 	extract_key(const_reference r_val)
105 	{ return r_val; }
106 
107 	virtual it_type
108 	end() const = 0;
109 
110 	it_type
end_iterator__gnu_pbds::detail::branch_policy111 	end_iterator() const
112 	{ return end(); }
113 
114 	virtual
~branch_policy__gnu_pbds::detail::branch_policy115 	~branch_policy() { }
116       };
117   } // namespace detail
118 } // namespace __gnu_pbds
119 
120 #endif // #ifndef PB_DS_BRANCH_POLICY_BASE_HPP
121