/usr/include/dune/grid/common/entityiterator.hh is in libdune-grid-dev 2.5.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_GRID_ENTITYITERATOR_HH
#define DUNE_GRID_ENTITYITERATOR_HH
#include <cstddef>
#include <iterator>
#include <dune/grid/common/entitypointer.hh>
namespace Dune
{
/** \class EntityIterator
* \brief interface class for an iterator over grid entities
* \ingroup GIEntityPointer
*
* An entity iterator is an iterator over a subset of entities within a
* hierarchical grid. It is an extension of the Dune::EntityPointer
* interface.
*
* Examples of entity iterators are:
* - iterators over the leaf level (LeafGridView::Iterator)
* - iterators over a grid level (LevelGridView::Iterator)
* - iterators over the children of an entity (Grid::HierarchicIterator)
* .
*
* See also the documentation of Dune::EntityPointer.
*
* \tparam codim codimension of entities this iterator walks over
* \tparam Grid type of the grid implementation
* \tparam IteratorImp type of the iterator implementation
*/
template< int codim, class Grid, class IteratorImp >
class EntityIterator
: public EntityPointer< Grid, IteratorImp >
{
typedef EntityPointer< Grid, IteratorImp > Base;
protected:
using Base::realIterator;
public:
typedef typename Grid::template Codim< codim >::Entity Entity;
/** \brief prefix increment operator */
EntityIterator &operator++ ()
{
realIterator.increment();
return *this;
}
/** \brief postfix increment operator */
EntityIterator operator++ (int)
{
EntityIterator tmp(*this);
realIterator.increment();
return tmp;
}
// The dereferencing operators are overridden here to avoid calling
// the deprecated versions in the EntityPointer facade.
// The behavior when dereferencing the EntityIterator facade depends on
// the way the grid implementation handles returning entities. The implementation
// may either return a reference to an entity stored inside the EntityIterator
// implementation or a temporary Entity object. This object has to be forwarded through
// the facade to the user, which requires a little trickery, especially for operator->().
//
// In order to avoid confusing users reading the Doxygen documentation, we provide "clean"
// function signatures to Doxygen and hide the actual implementations.
#ifdef DOXYGEN
/** \brief Dereferencing operator. */
const Entity& operator*() const;
/** \brief Pointer operator. */
const Entity& operator->() const;
#else // DOXYGEN
/** \brief Dereferencing operator. */
typename std::conditional<
std::is_lvalue_reference<
decltype(realIterator.dereference())
>::value,
const Entity&,
Entity
>::type
operator*() const
{
return realIterator.dereference();
}
/** \brief Pointer operator. */
decltype(handle_proxy_member_access(realIterator.dereference()))
operator->() const
{
return handle_proxy_member_access(realIterator.dereference());
}
#endif // DOXYGEN
/** \brief Checks for equality. */
bool operator==(const EntityIterator& rhs) const
{
return this->realIterator.equals(rhs.realIterator);
}
/** \brief Checks for inequality. */
bool operator!=(const EntityIterator& rhs) const
{
return !this->realIterator.equals(rhs.realIterator);
}
/** \name Implementor's interface
* \{
*/
/** \brief default construct (undefined) iterator */
EntityIterator ( )
{}
/** \brief copy constructor from implementaton */
EntityIterator ( const IteratorImp &imp )
: Base( imp )
{}
/** \} */
};
} // namespace Dune
namespace std
{
template< int codim, class Grid, class IteratorImp >
struct iterator_traits< Dune::EntityIterator< codim, Grid, IteratorImp > >
{
typedef ptrdiff_t difference_type;
typedef const typename IteratorImp::Entity value_type;
typedef value_type *pointer;
typedef value_type &reference;
typedef forward_iterator_tag iterator_category;
};
} // namespace std
#endif // #ifndef DUNE_GRID_ENTITYITERATOR_HH
|