binary_heap_/const_iterator.hpp
Go to the documentation of this file.
// -*- C++ -*-
// Copyright (C) 2005-2013 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the terms
// of the GNU General Public License as published by the Free Software
// Foundation; either version 3, or (at your option) any later
// version.
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
// Under Section 7 of GPL version 3, you are granted additional
// permissions described in the GCC Runtime Library Exception, version
// 3.1, as published by the Free Software Foundation.
// You should have received a copy of the GNU General Public License and
// a copy of the GCC Runtime Library Exception along with this program;
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
// Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
// Permission to use, copy, modify, sell, and distribute this software
// is hereby granted without fee, provided that the above copyright
// notice appears in all copies, and that both that copyright notice
// and this permission notice appear in supporting documentation. None
// of the above authors, nor IBM Haifa Research Laboratories, make any
// representation about the suitability of this software for any
// purpose. It is provided "as is" without express or implied
// warranty.
/**
* @file binary_heap_/const_iterator.hpp
* Contains an iterator class returned by the table's const find and insert
* methods.
*/
#ifndef PB_DS_BINARY_HEAP_CONST_ITERATOR_HPP
#define PB_DS_BINARY_HEAP_CONST_ITERATOR_HPP
#include <ext/pb_ds/detail/binary_heap_/point_const_iterator.hpp>
#include <debug/debug.h>
namespace __gnu_pbds
{
namespace detail
{
#define PB_DS_BIN_HEAP_CIT_BASE \
binary_heap_point_const_iterator_<Value_Type, Entry, Simple, _Alloc>
/// Const point-type iterator.
template<typename Value_Type,
typename Entry,
bool Simple,
typename _Alloc>
class binary_heap_const_iterator_ : public PB_DS_BIN_HEAP_CIT_BASE
{
private:
typedef PB_DS_BIN_HEAP_CIT_BASE base_type;
typedef typename base_type::entry_pointer entry_pointer;
public:
/// Category.
typedef std::forward_iterator_tag iterator_category;
/// Difference type.
typedef typename _Alloc::difference_type difference_type;
/// Iterator's value type.
typedef typename base_type::value_type value_type;
/// Iterator's pointer type.
typedef typename base_type::pointer pointer;
/// Iterator's const pointer type.
typedef typename base_type::const_pointer const_pointer;
/// Iterator's reference type.
typedef typename base_type::reference reference;
/// Iterator's const reference type.
typedef typename base_type::const_reference const_reference;
inline
binary_heap_const_iterator_(entry_pointer p_e) : base_type(p_e)
{ }
/// Default constructor.
inline
binary_heap_const_iterator_()
{ }
/// Copy constructor.
inline
binary_heap_const_iterator_(const binary_heap_const_iterator_& other)
: base_type(other)
{ }
/// Compares content to a different iterator object.
inline bool
operator==(const binary_heap_const_iterator_& other) const
{ return base_type::m_p_e == other.m_p_e; }
/// Compares content (negatively) to a different iterator object.
inline bool
operator!=(const binary_heap_const_iterator_& other) const
{ return base_type::m_p_e != other.m_p_e; }
inline binary_heap_const_iterator_&
operator++()
{
_GLIBCXX_DEBUG_ASSERT(base_type::m_p_e != 0);
inc();
return *this;
}
inline binary_heap_const_iterator_
operator++(int)
{
binary_heap_const_iterator_ ret_it(base_type::m_p_e);
operator++();
return ret_it;
}
private:
void
inc()
{ ++base_type::m_p_e; }
};
#undef PB_DS_BIN_HEAP_CIT_BASE
} // namespace detail
} // namespace __gnu_pbds
#endif