libstdc++-v3/include/ext/pb_ds/detail/binary_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_BINARY_HEAP_CONST_ITERATOR_HPP
  49 #define PB_DS_BINARY_HEAP_CONST_ITERATOR_HPP
  50
  51 #include <ext/pb_ds/detail/binary_heap_/const_point_iterator.hpp>
  52 #include <debug/debug.h>
  53
  54 namespace __gnu_pbds
  55 {
  56   namespace detail
  57   {
  58
  59 #define PB_DS_CLASS_C_DEC \
  60     binary_heap_const_iterator_<Value_Type, Entry, Simple, Allocator>
  61
  62 #define PB_DS_BASE_C_DEC \
  63     binary_heap_const_point_iterator_<Value_Type, Entry, Simple, Allocator>
  64
  65     // Const point-type iterator.
  66     template<typename Value_Type,
  67              typename Entry,
  68              bool Simple,
  69              class Allocator>
  70     class binary_heap_const_iterator_ : public PB_DS_BASE_C_DEC
  71     {
  72
  73     private:
  74       typedef typename PB_DS_BASE_C_DEC::entry_pointer entry_pointer;
  75
  76       typedef PB_DS_BASE_C_DEC base_type;
  77
  78     public:
  79
  80       // Category.
  81       typedef std::forward_iterator_tag iterator_category;
  82
  83       // Difference type.
  84       typedef typename Allocator::difference_type difference_type;
  85
  86       // Iterator's value type.
  87       typedef typename base_type::value_type value_type;
  88
  89       // Iterator's pointer type.
  90       typedef typename base_type::pointer pointer;
  91
  92       // Iterator's const pointer type.
  93       typedef typename base_type::const_pointer const_pointer;
  94
  95       // Iterator's reference type.
  96       typedef typename base_type::reference reference;
  97
  98       // Iterator's const reference type.
  99       typedef typename base_type::const_reference const_reference;
 100
 101     public:
 102
 103       inline
 104       binary_heap_const_iterator_(entry_pointer p_e) : base_type(p_e)
 105       { }
 106
 107       // Default constructor.
 108       inline
 109       binary_heap_const_iterator_()
 110       { }
 111
 112       // Copy constructor.
 113       inline
 114       binary_heap_const_iterator_(const PB_DS_CLASS_C_DEC& other) : base_type(other)
 115       { }
 116
 117       // Compares content to a different iterator object.
 118       inline bool
 119       operator==(const PB_DS_CLASS_C_DEC& other) const
 120       {
 121         return base_type::m_p_e == other.m_p_e;
 122       }
 123
 124       // Compares content (negatively) to a different iterator object.
 125       inline bool
 126       operator!=(const PB_DS_CLASS_C_DEC& other) const
 127       {
 128         return base_type::m_p_e != other.m_p_e;
 129       }
 130
 131       inline PB_DS_CLASS_C_DEC&
 132       operator++()
 133       {
 134         _GLIBCXX_DEBUG_ASSERT(base_type::m_p_e != NULL);
 135         inc();
 136         return *this;
 137       }
 138
 139       inline PB_DS_CLASS_C_DEC
 140       operator++(int)
 141       {
 142         PB_DS_CLASS_C_DEC ret_it(base_type::m_p_e);
 143         operator++();
 144         return ret_it;
 145       }
 146
 147     private:
 148       void
 149       inc()
 150       { ++base_type::m_p_e; }
 151     };
 152
 153 #undef PB_DS_CLASS_C_DEC
 154 #undef PB_DS_BASE_C_DEC
 155   } // namespace detail
 156 } // namespace __gnu_pbds
 157
 158 #endif