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

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

refs #368 - redesign to solve some issues regarding mutable functionality in WeightedIterator?

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.3 KB
Line 
1#ifndef _theplu_yat_utility_weighted_iterator_
2#define _theplu_yat_utility_weighted_iterator_
3
4// $Id: WeightedIterator.h 1537 2008-09-26 22:37:33Z 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 <DataWeight.h>
26#include <DataWeightProxy.h>
27
28#include <boost/iterator/iterator_facade.hpp>
29
30#include <iterator>
31
32namespace theplu {
33namespace yat {
34namespace utility {
35
36  /**
37     \brief WeightedIterator
38  */
39  template<typename DataIterator, typename WeightIterator>
40  class WeightedIterator
41    : public boost::iterator_facade<
42    WeightedIterator<DataIterator, WeightIterator>,
43    DataWeight,
44    typename std::iterator_traits<DataIterator>::iterator_category,
45    DataWeightProxy<DataIterator, WeightIterator> >
46   
47  {
48  public:
49    /**
50       \brief Constructor
51     */
52    WeightedIterator(DataIterator d, WeightIterator w)
53      : d_iter_(d), w_iter_(w)
54    {}
55   
56
57    /**
58       \brief element operator
59     */
60    DataWeightProxy<DataIterator, WeightIterator> operator[](int n) const
61    {
62      return DataWeightProxy<DataIterator, WeightIterator>(d_iter_+n, 
63                                                           w_iter_+n); 
64    }     
65   
66
67    /**
68       \brief Conversion constructor.
69       
70       Create a WeightIterator<Base> from a
71       WeightIterator<B2>. Possible if B2 is convertible to a
72       Base. Constructor allows implicit conversions such as iterator
73       to const_iterator.
74     */
75    /*
76    template<typename D2, typename W2>
77    WeightedIterator(WeightedIterator<D2, W2> other,
78            typename boost::enable_if_convertible<D2,DataIterator>::type* = 0,
79            typename boost::enable_if_convertible<W2,WeightIterator>::type* = 0)
80    {}
81    */
82
83  private:
84    friend class boost::iterator_core_access;
85
86    DataIterator d_iter_;
87    WeightIterator w_iter_;
88   
89    void advance(size_t n)
90    { std::advance(d_iter_, n); std::advance(w_iter_, n); }
91
92    void decrement(void) { --d_iter_; --w_iter_; }
93   
94    typename std::iterator_traits<DataIterator>::difference_type
95    distance_to(const WeightedIterator& other) const
96    { return std::distance(d_iter_, other.d_iter_); }
97
98    utility::DataWeightProxy<DataIterator, WeightIterator> 
99    dereference(void) const 
100    { 
101      return DataWeightProxy<DataIterator, WeightIterator>(d_iter_, 
102                                                           w_iter_); 
103    }
104
105    bool equal(const WeightedIterator& other) const
106    { return d_iter_==other.d_iter_ && w_iter_==other.w_iter_; }
107
108    void increment(void) { ++d_iter_; ++w_iter_; }
109
110  };
111
112  /**
113     \brief convenient function to create WeightedIterator
114
115     Convenient function in same fashion as std::make_pair.
116   */
117  template<typename DataIterator, typename WeightIterator>
118  WeightedIterator<DataIterator, WeightIterator> 
119  weighted_iterator(DataIterator data, WeightIterator weight)
120  {
121    return WeightedIterator<DataIterator, WeightIterator>(data, weight);
122  }
123 
124
125
126}}} // of namespace utility, yat, and theplu
127
128#endif
Note: See TracBrowser for help on using the repository browser.