libstdc++-v3/include/ext/pb_ds/detail/pat_trie_/const_child_iterator.hpp

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2005, 2006, 2009, 2010 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 const_child_iterator.hpp
  38  * Contains a const_iterator for a patricia tree.
  39  */
  40
  41 struct const_iterator
  42 {
  43 public:
  44   typedef std::forward_iterator_tag iterator_category;
  45
  46   typedef typename Allocator::difference_type difference_type;
  47
  48   typedef node_pointer value_type;
  49
  50   typedef node_pointer_pointer pointer;
  51
  52   typedef node_pointer_reference reference;
  53
  54 public:
  55   inline
  56   const_iterator(node_pointer_pointer p_p_cur = 0,
  57                  node_pointer_pointer p_p_end = 0)
  58   : m_p_p_cur(p_p_cur), m_p_p_end(p_p_end)
  59   { }
  60
  61   inline bool
  62   operator==(const const_iterator& other) const
  63   { return m_p_p_cur == other.m_p_p_cur; }
  64
  65   inline bool
  66   operator!=(const const_iterator& other) const
  67   { return m_p_p_cur != other.m_p_p_cur; }
  68
  69   inline const_iterator&
  70   operator++()
  71   {
  72     do
  73       ++m_p_p_cur;
  74     while (m_p_p_cur != m_p_p_end&& * m_p_p_cur == 0);
  75     return *this;
  76   }
  77
  78   inline const_iterator
  79   operator++(int)
  80   {
  81     const_iterator ret_it(*this);
  82     operator++();
  83     return ret_it;
  84   }
  85
  86   const node_pointer_pointer
  87   operator->() const
  88   {
  89     _GLIBCXX_DEBUG_ONLY(assert_referencible();)
  90     return (m_p_p_cur);
  91   }
  92
  93   const_node_pointer
  94   operator*() const
  95   {
  96     _GLIBCXX_DEBUG_ONLY(assert_referencible();)
  97     return (*m_p_p_cur);
  98   }
  99
 100 protected:
 101 #ifdef _GLIBCXX_DEBUG
 102   void
 103   assert_referencible() const
 104   { _GLIBCXX_DEBUG_ASSERT(m_p_p_cur != m_p_p_end&& * m_p_p_cur != 0); }
 105 #endif
 106
 107 public:
 108   node_pointer_pointer m_p_p_cur;
 109   node_pointer_pointer m_p_p_end;
 110 };
 111