iteratorrange.hh 2.87 KB
Newer Older
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
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*****************************************************************************
 *   See the file COPYING for full copying permissions.                      *
 *                                                                           *
 *   This program 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 of the License, or       *
 *   (at your option) any later version.                                     *
 *                                                                           *
 *   This program 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.                            *
 *                                                                           *
 *   You should have received a copy of the GNU General Public License       *
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.   *
 *****************************************************************************/
/*!
 * \file
 * \ingroup Common
 * \brief Simple range between begin and end iterators
 *        that can be used to support range-based for loops.
 *        The implementation is strongly inspired by the one provided in Dune, see
 *        https://gitlab.dune-project.org/core/dune-common/-/blob/master/dune/common/iteratorrange.hh
 */
#ifndef FRACKIT_COMMON_ITERATORRANGE_HH
#define FRACKIT_COMMON_ITERATORRANGE_HH

namespace Frackit {

/*!
 * \ingroup Common
 * \brief Simple range between begin and end iterators
 *        that can be used to support range-based for loops.
 *        The implementation is strongly inspired by the one provided in Dune, see
 *        https://gitlab.dune-project.org/core/dune-common/-/blob/master/dune/common/iteratorrange.hh
 *
 * \tparam Iterator  The type of iterator
 */
template<typename Iterator>
class IteratorRange
{

public:
    ///@{
    //! The iterators belonging to this range.
    using iterator = Iterator;
    using const_iterator = Iterator;
    ///@}

    //! Constructs an iterator range on [begin, end).
    IteratorRange(const Iterator& begin, const Iterator& end)
    : begin_(begin)
    , end_(end)
    {}

    //! Default constructor
    IteratorRange() = default;

    //! Returns an iterator pointing to the begin of the range.
    Iterator begin() const { return begin_; }

    //! Returns an iterator pointing past the end of the range.
    Iterator end() const { return end_; }

private:
    Iterator begin_;
    Iterator end_;
};

} // end namespace Frackit

#endif // FRACKIT_COMMON_ITERATORRANGE_HH