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