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
154
155
156
157
158
159
|
/*
Copyright (C) 2000, 2001, 2002 RiskMap srl
This file is part of QuantLib, a free-software/open-source library
for financial quantitative analysts and developers - http://quantlib.org/
QuantLib is free software: you can redistribute it and/or modify it under the
terms of the QuantLib license. You should have received a copy of the
license along with this program; if not, please email ferdinando@ametrano.net
The license is also available online at http://quantlib.org/html/license.html
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 license for more details.
*/
/*! \file couplingiterator.hpp
\brief Iterator mapping a function to a pair of underlying sequences
\fullpath
ql/Utilities/%couplingiterator.hpp
*/
// $Id: couplingiterator.hpp,v 1.5 2002/01/16 14:40:56 nando Exp $
#ifndef quantlib_coupling_iterator_h
#define quantlib_coupling_iterator_h
#include <ql/Utilities/iteratorcategories.hpp>
namespace QuantLib {
namespace Utilities {
//! Iterator mapping a function to a pair of underlying sequences
/*! This iterator advances two underlying iterators and returns the
values obtained by applying a function to the two values such
iterators point to.
*/
template <class Iterator1, class Iterator2, class Function>
class coupling_iterator : public QL_ITERATOR<
typename lowest_category_iterator<
typename QL_ITERATOR_TRAITS<Iterator1>::iterator_category,
typename QL_ITERATOR_TRAITS<Iterator2>::iterator_category>::
iterator_category,
typename Function::result_type,
typename QL_ITERATOR_TRAITS<Iterator1>::difference_type,
const typename Function::result_type*,
const typename Function::result_type&>
{
public:
/* These typedefs are needed even though inherited from
QL_ITERATOR (see 14.6.2.3 of the standard). */
typedef typename Function::result_type value_type;
typedef typename QL_ITERATOR_TRAITS<Iterator1>::difference_type
difference_type;
typedef const typename Function::result_type* pointer;
typedef const typename Function::result_type& reference;
coupling_iterator(Iterator1 it1, Iterator2 it2, Function f)
: it1_(it1), it2_(it2), f_(f) {}
//! \name Dereferencing
//@{
reference operator*() const {
x_ = f_(*it1_,*it2_);
return x_;
}
pointer operator->() const {
x_ = f_(*it1_,*it2_);
return &x_;
}
//@}
//! \name Random access
//@{
value_type operator[](difference_type n) const {
return *(*this+n) ;
}
//@}
//! \name Increment and decrement
//@{
coupling_iterator& operator++() {
++it1_; ++it2_;
return *this;
}
coupling_iterator operator++(int ) {
coupling_iterator tmp = *this;
++it1_; ++it2_;
return tmp;
}
coupling_iterator& operator--() {
--it1_; --it2_;
return *this;
}
coupling_iterator operator--(int ) {
coupling_iterator tmp = *this;
--it1_; --it2_;
return tmp;
}
coupling_iterator& operator+=(difference_type n) {
it1_+=n; it2_+=n;
return *this;
}
coupling_iterator& operator-=(difference_type n) {
it1_-=n; it2_-=n;
return *this;
}
coupling_iterator operator+ (difference_type n) const {
return coupling_iterator(it1_+n,it2_+n,f_);
}
coupling_iterator operator- (difference_type n) const {
return coupling_iterator(it1_-n,it2_-n,f_);
}
//@}
//! \name Difference
//@{
difference_type operator-(const coupling_iterator& rhs) const {
return it1_-rhs.it1_;
}
//@}
//! \name Comparisons
//@{
bool operator==(const coupling_iterator& rhs) const {
return it1_ == rhs.it1_;
}
bool operator!=(const coupling_iterator& rhs) const {
return it1_ != rhs.it1_;
}
//@}
private:
Iterator1 it1_;
Iterator2 it2_;
Function f_;
mutable value_type x_;
};
//! helper function to create combining iterators
/*! \relates coupling_iterator */
template <class It1, class It2, class Function>
coupling_iterator<It1,It2,Function>
make_coupling_iterator(It1 it1, It2 it2, Function f);
// inline definitions
template <class It1, class It2, class Function>
inline coupling_iterator<It1,It2,Function>
make_coupling_iterator(It1 it1, It2 it2, Function f) {
return coupling_iterator<It1,It2,Function>(it1,it2,f);
}
}
}
#endif
|
