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_LEFT_CHILD_NEXT_SIBLING_HEAP_CONST_FIND_ITERATOR_HPP
49 #define PB_DS_LEFT_CHILD_NEXT_SIBLING_HEAP_CONST_FIND_ITERATOR_HPP
50 
51 #include <ext/pb_ds/tag_and_trait.hpp>
52 #include <debug/debug.h>
53 
54 namespace pb_ds
55 {
56   namespace detail
57   {
58 
59 #define PB_DS_CLASS_T_DEC			\
60     template<typename Node, class Allocator>
61 
62 #define PB_DS_CLASS_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_node_const_point_iterator_
68     {
69 
70     protected:
71       typedef typename Allocator::template rebind<Node>::other::pointer node_pointer;
72 
73     public:
74 
75       // Category.
76       typedef trivial_iterator_tag iterator_category;
77 
78       // Difference type.
79       typedef trivial_iterator_difference_type difference_type;
80 
81       // Iterator's value type.
82       typedef typename Node::value_type value_type;
83 
84       // Iterator's pointer type.
85       typedef
86       typename Allocator::template rebind<
87 	value_type>::other::pointer
88       pointer;
89 
90       // Iterator's const pointer type.
91       typedef
92       typename Allocator::template rebind<
93 	value_type>::other::const_pointer
94       const_pointer;
95 
96       // Iterator's reference type.
97       typedef
98       typename Allocator::template rebind<
99 	value_type>::other::reference
100       reference;
101 
102       // Iterator's const reference type.
103       typedef
104       typename Allocator::template rebind<
105 	value_type>::other::const_reference
106       const_reference;
107 
108     public:
109 
110       inline
left_child_next_sibling_heap_node_const_point_iterator_(node_pointer p_nd)111       left_child_next_sibling_heap_node_const_point_iterator_(node_pointer p_nd) : m_p_nd(p_nd)
112       { }
113 
114       // Default constructor.
115       inline
left_child_next_sibling_heap_node_const_point_iterator_()116       left_child_next_sibling_heap_node_const_point_iterator_() : m_p_nd(NULL)
117       { }
118 
119       // Copy constructor.
120       inline
left_child_next_sibling_heap_node_const_point_iterator_(const PB_DS_CLASS_C_DEC & other)121       left_child_next_sibling_heap_node_const_point_iterator_(const PB_DS_CLASS_C_DEC& other) : m_p_nd(other.m_p_nd)
122       { }
123 
124       // Access.
125       inline const_pointer
operator ->() const126       operator->() const
127       {
128 	_GLIBCXX_DEBUG_ASSERT(m_p_nd != NULL);
129 	return &m_p_nd->m_value;
130       }
131 
132       // Access.
133       inline const_reference
operator *() const134       operator*() const
135       {
136 	_GLIBCXX_DEBUG_ASSERT(m_p_nd != NULL);
137 	return m_p_nd->m_value;
138       }
139 
140       // Compares content to a different iterator object.
141       inline bool
operator ==(const PB_DS_CLASS_C_DEC & other) const142       operator==(const PB_DS_CLASS_C_DEC& other) const
143       { return m_p_nd == other.m_p_nd; }
144 
145       // Compares content (negatively) to a different iterator object.
146       inline bool
operator !=(const PB_DS_CLASS_C_DEC & other) const147       operator!=(const PB_DS_CLASS_C_DEC& other) const
148       { return m_p_nd != other.m_p_nd; }
149 
150     public:
151       node_pointer m_p_nd;
152     };
153 
154 #undef PB_DS_CLASS_T_DEC
155 #undef PB_DS_CLASS_C_DEC
156 
157   } // namespace detail
158 } // namespace pb_ds
159 
160 #endif
161