source: trunk/yat/utility/WeightedIterator.h @ 1532

Last change on this file since 1532 was 1532, checked in by Peter, 13 years ago

refs #368 - const version is now working

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.9 KB
Line 
1#ifndef _theplu_yat_utility_weighted_iterator_
2#define _theplu_yat_utility_weighted_iterator_
3
4// $Id: WeightedIterator.h 1532 2008-09-24 22:06:47Z peter $
5
6/*
7  Copyright (C) 2008 Peter Johansson
8
9  This file is part of the yat library, http://dev.thep.lu.se/yat
10
11  The yat library is free software; you can redistribute it and/or
12  modify it under the terms of the GNU General Public License as
13  published by the Free Software Foundation; either version 3 of the
14  License, or (at your option) any later version.
15
16  The yat library is distributed in the hope that it will be useful,
17  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  General Public License for more details.
20
21  You should have received a copy of the GNU General Public License
22  along with yat. If not, see <http://www.gnu.org/licenses/>.
23*/
24
25#include <boost/iterator/iterator_facade.hpp>
26
27#include <iterator>
28
29namespace theplu {
30namespace yat {
31namespace utility {
32
33  /**
34     @brief WeightedIterator
35  */
36  template<typename DataIterator, typename WeightIterator>
37  class WeightedIterator
38    : public boost::iterator_facade<
39    WeightedIterator<DataIterator, WeightIterator>,
40    DataWeight,
41    std::random_access_iterator_tag,
42    DataWeight>
43   
44  {
45  public:
46    /**
47       \brief Constructor
48     */
49    WeightedIterator(DataIterator d, WeightIterator w)
50      : d_iter_(d), w_iter_(w)
51    {}
52
53    /**
54       \brief Conversion constructor.
55
56       Create a WeightIterator<Base> from a
57       WeightIterator<B2>. Possible if B2 is convertible to a
58       Base. Constructor allows implicit conversions such as iterator
59       to const_iterator.
60     */
61    /*
62    template<typename D2, typename W2>
63    WeightedIterator(WeightedIterator<D2, W2> other,
64            typename boost::enable_if_convertible<D2,DataIterator>::type* = 0,
65            typename boost::enable_if_convertible<W2,WeightIterator>::type* = 0)
66    {}
67    */
68
69  private:
70    friend class boost::iterator_core_access;
71
72    DataIterator d_iter_;
73    WeightIterator w_iter_;
74
75    void advance(size_t n)
76    { std::advance(d_iter_, n); std::advance(w_iter_, n); }
77
78    void decrement(void) { --d_iter_; --w_iter_; }
79
80    typename std::iterator_traits<DataIterator>::difference_type
81    distance_to(const WeightedIterator& other) const
82    { return std::distance(d_iter_, other.d_iter_); }
83
84    DataWeight dereference(void) const 
85    { return DataWeight(*d_iter_, *w_iter_); }
86
87    bool equal(const WeightedIterator& other) const
88    { return d_iter_==other.d_iter_ && w_iter_==other.w_iter_; }
89
90    void increment(void) { ++d_iter_; ++w_iter_; }
91
92  };
93
94  /**
95     \brief convenient function to create WeightedIterator
96
97     Convenient function in same fashion as std::make_pair.
98   */
99  template<typename DataIterator, typename WeightIterator>
100  WeightedIterator<DataIterator, WeightIterator> 
101  weighted_iterator(DataIterator data, WeightIterator weight)
102  {
103    return WeightedIterator<DataIterator, WeightIterator>(data, weight);
104  }
105 
106
107
108}}} // of namespace utility, yat, and theplu
109
110#endif
Note: See TracBrowser for help on using the repository browser.