3 // Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010
4 // Free Software Foundation, Inc.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the terms
8 // of the GNU General Public License as published by the Free Software
9 // Foundation; either version 3, or (at your option) any later
12 // This library is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // Under Section 7 of GPL version 3, you are granted additional
18 // permissions described in the GCC Runtime Library Exception, version
19 // 3.1, as published by the Free Software Foundation.
21 // You should have received a copy of the GNU General Public License and
22 // a copy of the GCC Runtime Library Exception along with this program;
23 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 // <http://www.gnu.org/licenses/>.
26 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
28 // Permission to use, copy, modify, sell, and distribute this software
29 // is hereby granted without fee, provided that the above copyright
30 // notice appears in all copies, and that both that copyright notice
31 // and this permission notice appear in supporting documentation. None
32 // of the above authors, nor IBM Haifa Research Laboratories, make any
33 // representation about the suitability of this software for any
34 // purpose. It is provided "as is" without express or implied
38 * @file debug_map_base.hpp
39 * Contains a debug-mode base for all maps.
42 #ifndef PB_DS_DEBUG_MAP_BASE_HPP
43 #define PB_DS_DEBUG_MAP_BASE_HPP
51 #include <ext/throw_allocator.h>
52 #include <debug/debug.h>
58 // Need std::pair ostream extractor.
59 template<typename _CharT, typename _Traits, typename _Tp1, typename _Tp2>
60 inline std::basic_ostream<_CharT, _Traits>&
61 operator<<(std::basic_ostream<_CharT, _Traits>& __out,
62 const std::pair<_Tp1, _Tp2>& p)
63 { return (__out << '(' << p.first << ',' << p.second << ')'); }
65 #define PB_DS_CLASS_T_DEC \
66 template<typename Key, class Eq_Fn, typename Const_Key_Reference>
68 #define PB_DS_CLASS_C_DEC \
69 debug_map_base<Key, Eq_Fn, Const_Key_Reference>
71 template<typename Key, class Eq_Fn, typename Const_Key_Reference>
75 typedef typename std::allocator<Key> key_allocator;
76 typedef typename key_allocator::size_type size_type;
77 typedef Const_Key_Reference const_key_reference;
78 typedef std::_GLIBCXX_STD_C::list<Key> key_set;
79 typedef typename key_set::iterator key_set_iterator;
80 typedef typename key_set::const_iterator const_key_set_iterator;
81 typedef __gnu_cxx::throw_allocator_random<Key> key_db_allocator;
82 typedef typename key_db_allocator::never_adjustor never_adjustor;
87 debug_map_base(const PB_DS_CLASS_C_DEC& other);
92 insert_new(const_key_reference r_key);
95 erase_existing(const_key_reference r_key);
101 check_key_exists(const_key_reference r_key) const;
104 check_key_does_not_exist(const_key_reference r_key) const;
107 check_size(size_type size) const;
110 swap(PB_DS_CLASS_C_DEC& other);
112 template<typename Cmp_Fn>
114 split(const_key_reference, Cmp_Fn, PB_DS_CLASS_C_DEC&);
117 join(PB_DS_CLASS_C_DEC& other);
121 assert_valid() const;
123 const_key_set_iterator
124 find(const_key_reference r_key) const;
127 find(const_key_reference r_key);
136 { _GLIBCXX_DEBUG_ONLY(assert_valid();) }
140 debug_map_base(const PB_DS_CLASS_C_DEC& other) : m_key_set(other.m_key_set)
141 { _GLIBCXX_DEBUG_ONLY(assert_valid();) }
146 { _GLIBCXX_DEBUG_ONLY(assert_valid();) }
151 insert_new(const_key_reference r_key)
153 _GLIBCXX_DEBUG_ONLY(assert_valid();)
155 if (find(r_key) != m_key_set.end())
157 std::cerr << "insert_new key already present " << r_key << std::endl;
161 never_adjustor never;
164 m_key_set.push_back(r_key);
168 std::cerr << "insert_new " << r_key << std::endl;
172 _GLIBCXX_DEBUG_ONLY(assert_valid();)
178 erase_existing(const_key_reference r_key)
180 _GLIBCXX_DEBUG_ONLY(assert_valid();)
181 key_set_iterator it = find(r_key);
182 if (it == m_key_set.end())
184 std::cerr << "erase_existing" << r_key << std::endl;
188 _GLIBCXX_DEBUG_ONLY(assert_valid();)
196 _GLIBCXX_DEBUG_ONLY(assert_valid();)
198 _GLIBCXX_DEBUG_ONLY(assert_valid();)
204 check_key_exists(const_key_reference r_key) const
206 _GLIBCXX_DEBUG_ONLY(assert_valid();)
207 if (find(r_key) == m_key_set.end())
209 std::cerr << "check_key_exists " << r_key << std::endl;
212 _GLIBCXX_DEBUG_ONLY(assert_valid();)
218 check_key_does_not_exist(const_key_reference r_key) const
220 _GLIBCXX_DEBUG_ONLY(assert_valid();)
221 if (find(r_key) != m_key_set.end())
225 cerr << "check_key_does_not_exist " << r_key << endl;
233 check_size(size_type size) const
235 _GLIBCXX_DEBUG_ONLY(assert_valid();)
236 const size_type key_set_size = m_key_set.size();
237 if (size != key_set_size)
239 std::cerr << "check_size " << size
240 << " " << key_set_size << std::endl;
243 _GLIBCXX_DEBUG_ONLY(assert_valid();)
249 swap(PB_DS_CLASS_C_DEC& other)
251 _GLIBCXX_DEBUG_ONLY(assert_valid();)
252 m_key_set.swap(other.m_key_set);
253 _GLIBCXX_DEBUG_ONLY(assert_valid();)
257 typename PB_DS_CLASS_C_DEC::const_key_set_iterator
259 find(const_key_reference r_key) const
261 _GLIBCXX_DEBUG_ONLY(assert_valid();)
262 typedef const_key_set_iterator iterator_type;
263 for (iterator_type it = m_key_set.begin(); it != m_key_set.end(); ++it)
264 if (m_eq(*it, r_key))
266 return m_key_set.end();
270 typename PB_DS_CLASS_C_DEC::key_set_iterator
272 find(const_key_reference r_key)
274 _GLIBCXX_DEBUG_ONLY(assert_valid();)
275 key_set_iterator it = m_key_set.begin();
276 while (it != m_key_set.end())
278 if (m_eq(*it, r_key))
283 _GLIBCXX_DEBUG_ONLY(assert_valid();)
291 const_key_set_iterator prime_it = m_key_set.begin();
292 while (prime_it != m_key_set.end())
294 const_key_set_iterator sec_it = prime_it;
296 while (sec_it != m_key_set.end())
298 _GLIBCXX_DEBUG_ASSERT(!m_eq(*sec_it, *prime_it));
299 _GLIBCXX_DEBUG_ASSERT(!m_eq(*prime_it, *sec_it));
307 template<typename Cmp_Fn>
310 split(const_key_reference r_key, Cmp_Fn cmp_fn, PB_DS_CLASS_C_DEC& other)
313 key_set_iterator it = m_key_set.begin();
314 while (it != m_key_set.end())
315 if (cmp_fn(r_key, * it))
317 other.insert_new(*it);
318 it = m_key_set.erase(it);
327 join(PB_DS_CLASS_C_DEC& other)
329 key_set_iterator it = other.m_key_set.begin();
330 while (it != other.m_key_set.end())
333 it = other.m_key_set.erase(it);
335 _GLIBCXX_DEBUG_ASSERT(other.m_key_set.empty());
338 #undef PB_DS_CLASS_T_DEC
339 #undef PB_DS_CLASS_C_DEC
341 } // namespace detail
342 } // namespace __gnu_pbds