tree_iterator.hpp 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  1. // boost heap: node tree iterator helper classes
  2. //
  3. // Copyright (C) 2010 Tim Blechmann
  4. //
  5. // Distributed under the Boost Software License, Version 1.0. (See
  6. // accompanying file LICENSE_1_0.txt or copy at
  7. // http://www.boost.org/LICENSE_1_0.txt)
  8. #ifndef BOOST_HEAP_DETAIL_TREE_ITERATOR_HPP
  9. #define BOOST_HEAP_DETAIL_TREE_ITERATOR_HPP
  10. #include <functional>
  11. #include <vector>
  12. #include <boost/core/allocator_access.hpp>
  13. #include <boost/iterator/iterator_adaptor.hpp>
  14. #include <boost/type_traits/conditional.hpp>
  15. #include <queue>
  16. namespace boost { namespace heap { namespace detail {
  17. template < typename type >
  18. struct identity
  19. {
  20. type& operator()( type& x ) const noexcept
  21. {
  22. return x;
  23. }
  24. const type& operator()( const type& x ) const noexcept
  25. {
  26. return x;
  27. }
  28. };
  29. template < typename Node >
  30. struct dereferencer
  31. {
  32. template < typename Iterator >
  33. Node* operator()( Iterator const& it )
  34. {
  35. return static_cast< Node* >( *it );
  36. }
  37. };
  38. template < typename Node >
  39. struct pointer_to_reference
  40. {
  41. template < typename Iterator >
  42. const Node* operator()( Iterator const& it )
  43. {
  44. return static_cast< const Node* >( &*it );
  45. }
  46. };
  47. template < typename HandleType, typename Alloc, typename ValueCompare >
  48. struct unordered_tree_iterator_storage
  49. {
  50. unordered_tree_iterator_storage( ValueCompare const& )
  51. {}
  52. void push( HandleType h )
  53. {
  54. data_.push_back( h );
  55. }
  56. HandleType const& top( void )
  57. {
  58. return data_.back();
  59. }
  60. void pop( void )
  61. {
  62. data_.pop_back();
  63. }
  64. bool empty( void ) const
  65. {
  66. return data_.empty();
  67. }
  68. std::vector< HandleType, typename boost::allocator_rebind< Alloc, HandleType >::type > data_;
  69. };
  70. template < typename ValueType, typename HandleType, typename Alloc, typename ValueCompare, typename ValueExtractor >
  71. struct ordered_tree_iterator_storage : ValueExtractor
  72. {
  73. struct compare_values_by_handle : ValueExtractor, ValueCompare
  74. {
  75. compare_values_by_handle( ValueCompare const& cmp ) :
  76. ValueCompare( cmp )
  77. {}
  78. bool operator()( HandleType const& lhs, HandleType const& rhs ) const
  79. {
  80. ValueType const& lhs_value = ValueExtractor::operator()( lhs->value );
  81. ValueType const& rhs_value = ValueExtractor::operator()( rhs->value );
  82. return ValueCompare::operator()( lhs_value, rhs_value );
  83. }
  84. };
  85. ordered_tree_iterator_storage( ValueCompare const& cmp ) :
  86. data_( compare_values_by_handle( cmp ) )
  87. {}
  88. void push( HandleType h )
  89. {
  90. data_.push( h );
  91. }
  92. void pop( void )
  93. {
  94. data_.pop();
  95. }
  96. HandleType const& top( void )
  97. {
  98. return data_.top();
  99. }
  100. bool empty( void ) const noexcept
  101. {
  102. return data_.empty();
  103. }
  104. std::priority_queue< HandleType,
  105. std::vector< HandleType, typename boost::allocator_rebind< Alloc, HandleType >::type >,
  106. compare_values_by_handle >
  107. data_;
  108. };
  109. /* tree iterator helper class
  110. *
  111. * Requirements:
  112. * Node provides child_iterator
  113. * ValueExtractor can convert Node->value to ValueType
  114. *
  115. * */
  116. template < typename Node,
  117. typename ValueType,
  118. typename Alloc = std::allocator< Node >,
  119. typename ValueExtractor = identity< typename Node::value_type >,
  120. typename PointerExtractor = dereferencer< Node >,
  121. bool check_null_pointer = false,
  122. bool ordered_iterator = false,
  123. typename ValueCompare = std::less< ValueType > >
  124. class tree_iterator :
  125. public boost::iterator_adaptor<
  126. tree_iterator< Node, ValueType, Alloc, ValueExtractor, PointerExtractor, check_null_pointer, ordered_iterator, ValueCompare >,
  127. const Node*,
  128. ValueType,
  129. boost::forward_traversal_tag >,
  130. ValueExtractor,
  131. PointerExtractor
  132. {
  133. typedef boost::iterator_adaptor<
  134. tree_iterator< Node, ValueType, Alloc, ValueExtractor, PointerExtractor, check_null_pointer, ordered_iterator, ValueCompare >,
  135. const Node*,
  136. ValueType,
  137. boost::forward_traversal_tag >
  138. adaptor_type;
  139. friend class boost::iterator_core_access;
  140. typedef typename std::conditional<
  141. ordered_iterator,
  142. ordered_tree_iterator_storage< ValueType, const Node*, Alloc, ValueCompare, ValueExtractor >,
  143. unordered_tree_iterator_storage< const Node*, Alloc, ValueCompare > >::type unvisited_node_container;
  144. public:
  145. tree_iterator( void ) :
  146. adaptor_type( 0 ),
  147. unvisited_nodes( ValueCompare() )
  148. {}
  149. tree_iterator( ValueCompare const& cmp ) :
  150. adaptor_type( 0 ),
  151. unvisited_nodes( cmp )
  152. {}
  153. tree_iterator( const Node* it, ValueCompare const& cmp ) :
  154. adaptor_type( it ),
  155. unvisited_nodes( cmp )
  156. {
  157. if ( it )
  158. discover_nodes( it );
  159. }
  160. /* fills the iterator from a list of possible top nodes */
  161. template < typename NodePointerIterator >
  162. tree_iterator( NodePointerIterator begin, NodePointerIterator end, const Node* top_node, ValueCompare const& cmp ) :
  163. adaptor_type( 0 ),
  164. unvisited_nodes( cmp )
  165. {
  166. BOOST_STATIC_ASSERT( ordered_iterator );
  167. if ( begin == end )
  168. return;
  169. adaptor_type::base_reference() = top_node;
  170. discover_nodes( top_node );
  171. for ( NodePointerIterator it = begin; it != end; ++it ) {
  172. const Node* current_node = static_cast< const Node* >( &*it );
  173. if ( current_node != top_node )
  174. unvisited_nodes.push( current_node );
  175. }
  176. }
  177. bool operator!=( tree_iterator const& rhs ) const
  178. {
  179. return adaptor_type::base() != rhs.base();
  180. }
  181. bool operator==( tree_iterator const& rhs ) const
  182. {
  183. return !operator!=( rhs );
  184. }
  185. const Node* get_node() const
  186. {
  187. return adaptor_type::base_reference();
  188. }
  189. private:
  190. void increment( void )
  191. {
  192. if ( unvisited_nodes.empty() )
  193. adaptor_type::base_reference() = 0;
  194. else {
  195. const Node* next = unvisited_nodes.top();
  196. unvisited_nodes.pop();
  197. discover_nodes( next );
  198. adaptor_type::base_reference() = next;
  199. }
  200. }
  201. ValueType const& dereference() const
  202. {
  203. return ValueExtractor::operator()( adaptor_type::base_reference()->value );
  204. }
  205. void discover_nodes( const Node* n )
  206. {
  207. for ( typename Node::const_child_iterator it = n->children.begin(); it != n->children.end(); ++it ) {
  208. const Node* n = PointerExtractor::operator()( it );
  209. if ( check_null_pointer && n == nullptr )
  210. continue;
  211. unvisited_nodes.push( n );
  212. }
  213. }
  214. unvisited_node_container unvisited_nodes;
  215. };
  216. template < typename Node, typename NodeList >
  217. struct list_iterator_converter
  218. {
  219. typename NodeList::const_iterator operator()( const Node* node )
  220. {
  221. return NodeList::s_iterator_to( *node );
  222. }
  223. Node* operator()( typename NodeList::const_iterator it )
  224. {
  225. return const_cast< Node* >( static_cast< const Node* >( &*it ) );
  226. }
  227. };
  228. template < typename Node,
  229. typename NodeIterator,
  230. typename ValueType,
  231. typename ValueExtractor = identity< typename Node::value_type >,
  232. typename IteratorCoverter = identity< NodeIterator > >
  233. class recursive_tree_iterator :
  234. public boost::iterator_adaptor< recursive_tree_iterator< Node, NodeIterator, ValueType, ValueExtractor, IteratorCoverter >,
  235. NodeIterator,
  236. ValueType const,
  237. boost::bidirectional_traversal_tag >,
  238. ValueExtractor,
  239. IteratorCoverter
  240. {
  241. typedef boost::iterator_adaptor<
  242. recursive_tree_iterator< Node, NodeIterator, ValueType, ValueExtractor, IteratorCoverter >,
  243. NodeIterator,
  244. ValueType const,
  245. boost::bidirectional_traversal_tag >
  246. adaptor_type;
  247. friend class boost::iterator_core_access;
  248. public:
  249. recursive_tree_iterator( void ) :
  250. adaptor_type( 0 )
  251. {}
  252. explicit recursive_tree_iterator( NodeIterator const& it ) :
  253. adaptor_type( it )
  254. {}
  255. void increment( void )
  256. {
  257. NodeIterator next = adaptor_type::base_reference();
  258. const Node* n = get_node( next );
  259. if ( n->children.empty() ) {
  260. const Node* parent = get_node( next )->get_parent();
  261. ++next;
  262. while ( true ) {
  263. if ( parent == nullptr || next != parent->children.end() )
  264. break;
  265. next = IteratorCoverter::operator()( parent );
  266. parent = get_node( next )->get_parent();
  267. ++next;
  268. }
  269. } else
  270. next = n->children.begin();
  271. adaptor_type::base_reference() = next;
  272. return;
  273. }
  274. ValueType const& dereference() const
  275. {
  276. return ValueExtractor::operator()( get_node( adaptor_type::base_reference() )->value );
  277. }
  278. static const Node* get_node( NodeIterator const& it )
  279. {
  280. return static_cast< const Node* >( &*it );
  281. }
  282. const Node* get_node() const
  283. {
  284. return get_node( adaptor_type::base_reference() );
  285. }
  286. };
  287. }}} // namespace boost::heap::detail
  288. #endif /* BOOST_HEAP_DETAIL_TREE_ITERATOR_HPP */