contrib/libstdc++/include/ext/pb_ds/detail/left_child_next_sibling_heap_/const_iterator.hpp

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2005, 2006 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 2, 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 // You should have received a copy of the GNU General Public License
  17 // along with this library; see the file COPYING.  If not, write to
  18 // the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
  19 // MA 02111-1307, USA.
  20
  21 // As a special exception, you may use this file as part of a free
  22 // software library without restriction.  Specifically, if other files
  23 // instantiate templates or use macros or inline functions from this
  24 // file, or you compile this file and link it with other files to
  25 // produce an executable, this file does not by itself cause the
  26 // resulting executable to be covered by the GNU General Public
  27 // License.  This exception does not however invalidate any other
  28 // reasons why the executable file might be covered by the GNU General
  29 // Public License.
  30
  31 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
  32
  33 // Permission to use, copy, modify, sell, and distribute this software
  34 // is hereby granted without fee, provided that the above copyright
  35 // notice appears in all copies, and that both that copyright notice
  36 // and this permission notice appear in supporting documentation. None
  37 // of the above authors, nor IBM Haifa Research Laboratories, make any
  38 // representation about the suitability of this software for any
  39 // purpose. It is provided "as is" without express or implied
  40 // warranty.
  41
  42 /**
  43  * @file const_iterator.hpp
  44  * Contains an iterator class returned by the table's const find and insert
  45  *     methods.
  46  */
  47
  48 #ifndef PB_DS_LEFT_CHILD_NEXT_SIBLING_HEAP_CONST_ITERATOR_HPP
  49 #define PB_DS_LEFT_CHILD_NEXT_SIBLING_HEAP_CONST_ITERATOR_HPP
  50
  51 #include <ext/pb_ds/detail/left_child_next_sibling_heap_/const_point_iterator.hpp>
  52 #include <debug/debug.h>
  53
  54 namespace pb_ds
  55 {
  56   namespace detail
  57   {
  58
  59 #define PB_DS_CLASS_C_DEC                                               \
  60     left_child_next_sibling_heap_const_iterator_<Node, Allocator>
  61
  62 #define PB_DS_BASE_C_DEC                                                \
  63     left_child_next_sibling_heap_node_const_point_iterator_<Node, Allocator>
  64
  65     // Const point-type iterator.
  66     template<typename Node, class Allocator>
  67     class left_child_next_sibling_heap_const_iterator_ : public PB_DS_BASE_C_DEC
  68     {
  69
  70     private:
  71       typedef typename PB_DS_BASE_C_DEC::node_pointer node_pointer;
  72
  73       typedef PB_DS_BASE_C_DEC base_type;
  74
  75     public:
  76
  77       // Category.
  78       typedef std::forward_iterator_tag iterator_category;
  79
  80       // Difference type.
  81       typedef typename Allocator::difference_type difference_type;
  82
  83       // Iterator's value type.
  84       typedef typename base_type::value_type value_type;
  85
  86       // Iterator's pointer type.
  87       typedef typename base_type::pointer pointer;
  88
  89       // Iterator's const pointer type.
  90       typedef typename base_type::const_pointer const_pointer;
  91
  92       // Iterator's reference type.
  93       typedef typename base_type::reference reference;
  94
  95       // Iterator's const reference type.
  96       typedef typename base_type::const_reference const_reference;
  97
  98     public:
  99
 100       inline
 101       left_child_next_sibling_heap_const_iterator_(node_pointer p_nd) : base_type(p_nd)
 102       { }
 103
 104       // Default constructor.
 105       inline
 106       left_child_next_sibling_heap_const_iterator_()
 107       { }
 108
 109       // Copy constructor.
 110       inline
 111       left_child_next_sibling_heap_const_iterator_(const PB_DS_CLASS_C_DEC& other) : base_type(other)
 112       { }
 113
 114       // Compares content to a different iterator object.
 115       inline bool
 116       operator==(const PB_DS_CLASS_C_DEC& other) const
 117       { return (base_type::m_p_nd == other.m_p_nd); }
 118
 119       // Compares content (negatively) to a different iterator object.
 120       inline bool
 121       operator!=(const PB_DS_CLASS_C_DEC& other) const
 122       { return (base_type::m_p_nd != other.m_p_nd); }
 123
 124       inline PB_DS_CLASS_C_DEC&
 125       operator++()
 126       {
 127         _GLIBCXX_DEBUG_ASSERT(base_type::m_p_nd != NULL);
 128         inc();
 129         return (*this);
 130       }
 131
 132       inline PB_DS_CLASS_C_DEC
 133       operator++(int)
 134       {
 135         PB_DS_CLASS_C_DEC ret_it(base_type::m_p_nd);
 136         operator++();
 137         return (ret_it);
 138       }
 139
 140     private:
 141       void
 142       inc()
 143       {
 144         if (base_type::m_p_nd->m_p_next_sibling != NULL)
 145           {
 146             base_type::m_p_nd = base_type::m_p_nd->m_p_next_sibling;
 147             while (base_type::m_p_nd->m_p_l_child != NULL)
 148               base_type::m_p_nd = base_type::m_p_nd->m_p_l_child;
 149             return;
 150           }
 151
 152         while (true)
 153           {
 154             node_pointer p_next = base_type::m_p_nd;
 155             base_type::m_p_nd = base_type::m_p_nd->m_p_prev_or_parent;
 156             if (base_type::m_p_nd == NULL || base_type::m_p_nd->m_p_l_child == p_next)
 157               return;
 158           }
 159       }
 160     };
 161
 162 #undef PB_DS_CLASS_C_DEC
 163 #undef PB_DS_BASE_C_DEC
 164
 165   } // namespace detail
 166 } // namespace pb_ds
 167
 168 #endif