File: ratehelpers.cpp

package info (click to toggle)
quantlib 0.2.1.cvs20020322-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 4,716 kB
  • ctags: 4,614
  • sloc: cpp: 19,601; sh: 7,389; makefile: 796; ansic: 22
file content (274 lines) | stat: -rw-r--r-- 11,386 bytes parent folder | download
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274

/*
 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 ratehelpers.cpp
    \brief rate helpers base class

    \fullpath
    ql/TermStructures/%ratehelpers.cpp
*/

// $Id: ratehelpers.cpp,v 1.18 2002/03/07 14:06:18 lballabio Exp $

#include <ql/TermStructures/ratehelpers.hpp>
#include <ql/Indexes/euribor.hpp>

namespace QuantLib {

    using Instruments::SimpleSwap;
    using Indexes::Xibor;
    using Indexes::Euribor;

    namespace TermStructures {

        RateHelper::RateHelper(const RelinkableHandle<MarketElement>& quote)
        : quote_(quote), termStructure_(0) {
            registerWith(quote_);
        }

        RateHelper::RateHelper(double quote)
        : quote_(RelinkableHandle<MarketElement>(
            Handle<MarketElement>(new SimpleMarketElement(quote)))),
        termStructure_(0) {
            registerWith(quote_);
        }

        void RateHelper::setTermStructure(TermStructure* t) {
            QL_REQUIRE(t != 0, "RateHelper: null term structure given");
            termStructure_ = t;
        }

        double RateHelper::quoteError() const {
            return quote_->value()-impliedQuote();
        }



        DepositRateHelper::DepositRateHelper(
            const RelinkableHandle<MarketElement>& rate,
            int settlementDays, int n, TimeUnit units,
            const Calendar& calendar, RollingConvention convention,
            const DayCounter& dayCounter)
        : RateHelper(rate), settlementDays_(settlementDays),
          n_(n), units_(units), calendar_(calendar), convention_(convention),
          dayCounter_(dayCounter) {}

        DepositRateHelper::DepositRateHelper(double rate,
            int settlementDays, int n, TimeUnit units,
            const Calendar& calendar, RollingConvention convention,
            const DayCounter& dayCounter)
        : RateHelper(rate), settlementDays_(settlementDays),
          n_(n), units_(units), calendar_(calendar), convention_(convention),
          dayCounter_(dayCounter) {}

        double DepositRateHelper::impliedQuote() const {
            QL_REQUIRE(termStructure_ != 0, "term structure not set");
            return (termStructure_->discount(settlement_) /
                    termStructure_->discount(maturity_)-1.0) /
                    yearFraction_;
        }

        DiscountFactor DepositRateHelper::discountGuess() const {
            QL_REQUIRE(termStructure_ != 0, "term structure not set");
            // extrapolation shouldn't be needed if the input makes sense
            // but we'll play it safe
            return termStructure_->discount(settlement_,true) /
                   (1.0+quote_->value()*yearFraction_);
        }

        void DepositRateHelper::setTermStructure(TermStructure* t) {
            RateHelper::setTermStructure(t);
            settlement_ = calendar_.advance(
                termStructure_->todaysDate(),settlementDays_,Days);
            maturity_ = calendar_.advance(
                settlement_,n_,units_,convention_);
            yearFraction_ = dayCounter_.yearFraction(settlement_,maturity_);
        }

        Date DepositRateHelper::maturity() const {
            QL_REQUIRE(termStructure_ != 0, "term structure not set");
            return maturity_;
        }



        FraRateHelper::FraRateHelper(
            const RelinkableHandle<MarketElement>& rate,
            int settlementDays, int monthsToStart, int monthsToEnd,
            const Calendar& calendar, RollingConvention convention,
            const DayCounter& dayCounter)
        : RateHelper(rate), settlementDays_(settlementDays),
          monthsToStart_(monthsToStart), monthsToEnd_(monthsToEnd),
          calendar_(calendar), convention_(convention),
          dayCounter_(dayCounter) {}

        FraRateHelper::FraRateHelper(double rate,
            int settlementDays, int monthsToStart, int monthsToEnd,
            const Calendar& calendar, RollingConvention convention,
            const DayCounter& dayCounter)
        : RateHelper(rate), settlementDays_(settlementDays),
          monthsToStart_(monthsToStart), monthsToEnd_(monthsToEnd),
          calendar_(calendar), convention_(convention),
          dayCounter_(dayCounter) {}

        double FraRateHelper::impliedQuote() const {
            QL_REQUIRE(termStructure_ != 0, "term structure not set");
            return (termStructure_->discount(start_) /
                    termStructure_->discount(maturity_)-1.0) /
                    yearFraction_;
        }

        DiscountFactor FraRateHelper::discountGuess() const {
            QL_REQUIRE(termStructure_ != 0, "term structure not set");
            // extrapolation shouldn't be needed if the input makes sense
            // but we'll play it safe
            return termStructure_->discount(start_,true) /
                   (1.0+quote_->value()*yearFraction_);
        }

        void FraRateHelper::setTermStructure(TermStructure* t) {
            RateHelper::setTermStructure(t);
            settlement_ = calendar_.advance(
                termStructure_->todaysDate(),settlementDays_,Days);
            start_ = calendar_.advance(
                settlement_,monthsToStart_,Months,convention_);
            maturity_ = calendar_.advance(
                start_,monthsToEnd_-monthsToStart_,Months,convention_);
            yearFraction_ = dayCounter_.yearFraction(start_,maturity_);
        }

        Date FraRateHelper::maturity() const {
            QL_REQUIRE(termStructure_ != 0, "term structure not set");
            return maturity_;
        }

        FuturesRateHelper::FuturesRateHelper(
            const RelinkableHandle<MarketElement>& price,
            const Date& ImmDate, int settlementDays, int nMonths,
            const Calendar& calendar, RollingConvention convention,
            const DayCounter& dayCounter)
        : RateHelper(price), ImmDate_(ImmDate),
          settlementDays_(settlementDays), nMonths_(nMonths),
          calendar_(calendar), convention_(convention),
          dayCounter_(dayCounter) {
            maturity_ = calendar_.advance(
                ImmDate_, nMonths_, Months, convention_);
            yearFraction_ = dayCounter_.yearFraction(ImmDate_, maturity_);
        }

        FuturesRateHelper::FuturesRateHelper(double price,
            const Date& ImmDate, int settlementDays, int nMonths,
            const Calendar& calendar, RollingConvention convention,
            const DayCounter& dayCounter)
        : RateHelper(price), ImmDate_(ImmDate),
          settlementDays_(settlementDays), nMonths_(nMonths),
          calendar_(calendar), convention_(convention),
          dayCounter_(dayCounter) {
            maturity_ = calendar_.advance(
                ImmDate_, nMonths_, Months, convention_);
            yearFraction_ = dayCounter_.yearFraction(ImmDate_, maturity_);
        }

        double FuturesRateHelper::impliedQuote() const {
            QL_REQUIRE(termStructure_ != 0, "term structure not set");
            return 100 * (1.0-(termStructure_->discount(ImmDate_) /
                               termStructure_->discount(maturity_)-1.0) /
                               yearFraction_);
        }

        DiscountFactor FuturesRateHelper::discountGuess() const {
            QL_REQUIRE(termStructure_ != 0, "term structure not set");
            // extrapolation shouldn't be needed if the input makes sense
            // but we'll play it safe
            return termStructure_->discount(ImmDate_,true) /
                   (1.0+(100.0-quote_->value())/100.0*yearFraction_);
        }

        Date FuturesRateHelper::maturity() const {
            return maturity_;
        }

        SwapRateHelper::SwapRateHelper(
            const RelinkableHandle<MarketElement>& rate,
            int settlementDays, int lengthInYears,
            const Calendar& calendar, RollingConvention convention,
            int fixedFrequency, bool fixedIsAdjusted,
            const DayCounter& fixedDayCount,
            int floatingFrequency)
        : RateHelper(rate), settlementDays_(settlementDays),
          lengthInYears_(lengthInYears), calendar_(calendar),
          convention_(convention),
          fixedFrequency_(fixedFrequency),
          floatingFrequency_(floatingFrequency),
          fixedIsAdjusted_(fixedIsAdjusted),
          fixedDayCount_(fixedDayCount) {}

        SwapRateHelper::SwapRateHelper(double rate,
            int settlementDays, int lengthInYears,
            const Calendar& calendar, RollingConvention convention,
            int fixedFrequency, bool fixedIsAdjusted,
            const DayCounter& fixedDayCount,
            int floatingFrequency)
        : RateHelper(rate), settlementDays_(settlementDays),
          lengthInYears_(lengthInYears), calendar_(calendar),
          convention_(convention),
          fixedFrequency_(fixedFrequency),
          floatingFrequency_(floatingFrequency),
          fixedIsAdjusted_(fixedIsAdjusted),
          fixedDayCount_(fixedDayCount) {}

        void SwapRateHelper::setTermStructure(TermStructure* t) {
            // do not set the relinkable handle as an observer -
            // force recalculation when needed
            termStructureHandle_.linkTo(
                Handle<TermStructure>(t,false),false);
            RateHelper::setTermStructure(t);
            settlement_ = calendar_.advance(
                termStructure_->todaysDate(),settlementDays_,Days);
            // dummy Libor index with curve/swap parameters
            Handle<Xibor> dummyIndex(new Xibor("dummy",
                12/floatingFrequency_,Months,settlementDays_,
                EUR, // any would do
                calendar_,true,convention_,
                t->dayCounter(), RelinkableHandle<TermStructure>()));
            swap_ = Handle<SimpleSwap>(
                new SimpleSwap(true,                // pay fixed rate
                    settlement_, lengthInYears_, Years, calendar_,
                    convention_,
                    100.0,
                    fixedFrequency_,
                    0.0,
                    fixedIsAdjusted_, fixedDayCount_,
                    floatingFrequency_, dummyIndex, settlementDays_,
                    0.0,
                    termStructureHandle_));
        }

        Date SwapRateHelper::maturity() const {
            QL_REQUIRE(termStructure_ != 0, "null term structure set");
            return swap_->maturity();
        }

        double SwapRateHelper::impliedQuote() const {
            QL_REQUIRE(termStructure_ != 0, "term structure not set");
            // we didn't register as observers - force calculation
            swap_->recalculate();
            return -swap_->NPV()/swap_->fixedLegBPS();
        }

    }

}