libstdc++-v3/include/ext/pb_ds/detail/binary_heap_/const_point_iterator.hpp

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2005, 2006, 2009 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_point_iterator.hpp
  38  * Contains an iterator class returned by the table's const find and insert
  39  *     methods.
  40  */
  41
  42 #ifndef PB_DS_BINARY_HEAP_CONST_FIND_ITERATOR_HPP
  43 #define PB_DS_BINARY_HEAP_CONST_FIND_ITERATOR_HPP
  44
  45 #include <ext/pb_ds/tag_and_trait.hpp>
  46 #include <debug/debug.h>
  47
  48 namespace __gnu_pbds
  49 {
  50   namespace detail
  51   {
  52     // Const point-type iterator.
  53     template<typename Value_Type, typename Entry, bool Simple,
  54              typename Allocator>
  55     class binary_heap_const_point_iterator_
  56     {
  57     protected:
  58       typedef typename Allocator::template rebind<Entry>::other::pointer entry_pointer;
  59
  60     public:
  61       // Category.
  62       typedef trivial_iterator_tag iterator_category;
  63
  64       // Difference type.
  65       typedef trivial_iterator_difference_type difference_type;
  66
  67       // Iterator's value type.
  68       typedef Value_Type value_type;
  69
  70       // Iterator's pointer type.
  71       typedef typename Allocator::template rebind<value_type>::other::pointer
  72       pointer;
  73
  74       // Iterator's const pointer type.
  75       typedef
  76       typename Allocator::template rebind<value_type>::other::const_pointer
  77       const_pointer;
  78
  79       // Iterator's reference type.
  80       typedef
  81       typename Allocator::template rebind<value_type>::other::reference
  82       reference;
  83
  84       // Iterator's const reference type.
  85       typedef
  86       typename Allocator::template rebind<value_type>::other::const_reference
  87       const_reference;
  88
  89       inline
  90       binary_heap_const_point_iterator_(entry_pointer p_e) : m_p_e(p_e)
  91       { }
  92
  93       // Default constructor.
  94       inline
  95       binary_heap_const_point_iterator_() : m_p_e(0) { }
  96
  97       // Copy constructor.
  98       inline
  99       binary_heap_const_point_iterator_(const binary_heap_const_point_iterator_& other)
 100       : m_p_e(other.m_p_e)
 101       { }
 102
 103       // Access.
 104       inline const_pointer
 105       operator->() const
 106       {
 107         _GLIBCXX_DEBUG_ASSERT(m_p_e != 0);
 108         return to_ptr(integral_constant<int, Simple>());
 109       }
 110
 111       // Access.
 112       inline const_reference
 113       operator*() const
 114       {
 115         _GLIBCXX_DEBUG_ASSERT(m_p_e != 0);
 116         return *to_ptr(integral_constant<int, Simple>());
 117       }
 118
 119       // Compares content to a different iterator object.
 120       inline bool
 121       operator==(const binary_heap_const_point_iterator_& other) const
 122       { return m_p_e == other.m_p_e; }
 123
 124       // Compares content (negatively) to a different iterator object.
 125       inline bool
 126       operator!=(const binary_heap_const_point_iterator_& other) const
 127       { return m_p_e != other.m_p_e; }
 128
 129     private:
 130       inline const_pointer
 131       to_ptr(true_type) const
 132       { return m_p_e; }
 133
 134       inline const_pointer
 135       to_ptr(false_type) const
 136       { return *m_p_e; }
 137
 138     public:
 139       entry_pointer m_p_e;
 140     };
 141   } // namespace detail
 142 } // namespace __gnu_pbds
 143
 144 #endif