File: discountingperpetualfuturesengine.cpp

package info (click to toggle)
quantlib 1.41-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 41,480 kB
  • sloc: cpp: 400,885; makefile: 6,547; python: 214; sh: 150; lisp: 86
file content (261 lines) | stat: -rw-r--r-- 12,714 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
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

/*
 Copyright (C) 2025 Hiroto Ogawa

 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
 <quantlib-dev@lists.sf.net>. The license is also available online at
 <https://www.quantlib.org/license.shtml>.

 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.
*/

#include <ql/math/integrals/trapezoidintegral.hpp>
#include <ql/math/interpolations/backwardflatinterpolation.hpp>
#include <ql/math/interpolations/cubicinterpolation.hpp>
#include <ql/math/interpolations/linearinterpolation.hpp>
#include <ql/pricingengines/futures/discountingperpetualfuturesengine.hpp>
#include <ql/time/daycounters/yearfractiontodate.hpp>
#include <ql/settings.hpp>

namespace QuantLib {

    DiscountingPerpetualFuturesEngine::DiscountingPerpetualFuturesEngine(
        const Handle<YieldTermStructure>& domesticDiscountCurve,
        const Handle<YieldTermStructure>& foreignDiscountCurve,
        const Handle<Quote>& assetSpot,
        const std::vector<Time>& fundingTimes,
        const std::vector<Rate>& fundingRates,
        const std::vector<Spread>& interestRateDiffs,
        const DiscountingPerpetualFuturesEngine::InterpolationType fundingInterpType,
        const Real maxT)
    : domesticDiscountCurve_(domesticDiscountCurve),
      foreignDiscountCurve_(foreignDiscountCurve), assetSpot_(assetSpot),
      fundingTimes_(fundingTimes), fundingRates_(fundingRates),
      interestRateDiffs_(interestRateDiffs), fundingInterpType_(fundingInterpType), maxT_(maxT) {
        registerWith(domesticDiscountCurve_);
        registerWith(foreignDiscountCurve_);
        registerWith(assetSpot_);
        QL_REQUIRE(!fundingTimes_.empty(), "fundingTimes is empty");
        QL_REQUIRE(!fundingRates_.empty(), "fundingRates is empty");
        QL_REQUIRE(!interestRateDiffs_.empty(), "interestRateDiffs is empty");
        QL_REQUIRE(fundingTimes_.size() == fundingRates_.size(),
                   "fundingTimes and fundingRates must have the same size.");
        QL_REQUIRE(fundingTimes_.size() == interestRateDiffs_.size(),
                   "fundingTimes and interestRateDiffs must have the same size.");
    }

    void DiscountingPerpetualFuturesEngine::calculate() const {
        QL_REQUIRE(!domesticDiscountCurve_.empty(),
                   "domestic discounting term structure handle is empty");
        QL_REQUIRE(!foreignDiscountCurve_.empty(),
                   "foreign discounting term structure handle is empty");
        QL_REQUIRE(!assetSpot_.empty(), "asset spot handle is empty");

        results_.value = 0.0;
        results_.errorEstimate = Null<Real>();

        QL_REQUIRE(
            arguments_.payoffType == PerpetualFutures::Linear ||
                arguments_.payoffType == PerpetualFutures::Inverse,
            "Only Linear and Inverse payoffs are supported in DiscountingPerpetualFuturesEngine");

        // Linear payoff <--> Inverse payoff:
        // 1. exchange domestic and foreign curves
        // 2. future price: f <--> 1/f
        auto effDomCurve = arguments_.payoffType == PerpetualFutures::Linear ?
                               domesticDiscountCurve_ : foreignDiscountCurve_;
        auto effForCurve = arguments_.payoffType == PerpetualFutures::Linear ?
                               foreignDiscountCurve_ : domesticDiscountCurve_;

        Period fundingFreq = arguments_.fundingFrequency;
        Date refDate = Settings::instance().evaluationDate();
        DayCounter dc = arguments_.dc;
        Calendar cal = arguments_.cal;
        
        Interpolation fundingRateInterp =
            DiscountingPerpetualFuturesEngine::selectInterpolation(fundingTimes_, fundingRates_);
        fundingRateInterp.enableExtrapolation();
        QL_REQUIRE(fundingRateInterp(fundingRateInterp.xMax()) > 0,
                   "fundingRate at max time is negative. Because the last funding rate is "
                   "flatly extrapolated, integral diverges.");
        Interpolation interestRateDiffInterp =
            DiscountingPerpetualFuturesEngine::selectInterpolation(fundingTimes_,
                                                                   interestRateDiffs_);
        interestRateDiffInterp.enableExtrapolation();

        Real factor = 0.;
        if (fundingFreq.length() > 0) { 
            // discrete-time case
            std::vector<Real> timeGrid;
            Real tGrid = 0.;
            while (tGrid < maxT_) {
                timeGrid.push_back(tGrid);
                Real tUnit = 0.;
                Date date = yearFractionToDate(dc, refDate, tGrid);
                Real daysInYear = dc.dayCount(Date(1, January, date.year()), Date(1, January, date.year()+1));
                switch (fundingFreq.units()) { 
                    case Years:
                        tGrid += fundingFreq.length();
                        break;
                    case Months:
                        tUnit = 1. / 12.;
                        tGrid += tUnit * fundingFreq.length();
                        break;
                    case Weeks:
                    case Days:
                        tGrid = dc.yearFraction(refDate, cal.advance(date, fundingFreq));
                        break;
                    case Hours:
                        tUnit = 1. / daysInYear / 24.;
                        tGrid += tUnit * fundingFreq.length();
                        break;
                    case Minutes:
                        tUnit = 1. / daysInYear / 24. / 60.;
                        tGrid += tUnit * fundingFreq.length();
                        break;
                    case Seconds:
                        tUnit = 1. / daysInYear / 24. / 60. / 60.;
                        tGrid += tUnit * fundingFreq.length();
                        break;
                    case Milliseconds:
                        tUnit = 1. / daysInYear / 24. / 60. / 60. / 1000.;
                        tGrid += tUnit * fundingFreq.length();
                        break;
                    case Microseconds:
                        tUnit = 1. / daysInYear / 24. / 60. / 60. / 1000. / 1000.;
                        tGrid += tUnit * fundingFreq.length();
                        break;
                    default:
                        QL_FAIL("Unknown unit in fundingFrequency");
                }
            }
            std::vector<Rate> fundingRateGrid(timeGrid.size());
            std::vector<Spread> interestRateDiffGrid(timeGrid.size());
            for (Size i = 0; i < timeGrid.size(); ++i) {
                Real time = timeGrid[i];
                fundingRateGrid[i] = fundingRateInterp(time);
                interestRateDiffGrid[i] = interestRateDiffInterp(time);
            }
            
            if (arguments_.fundingType == PerpetualFutures::FundingWithCurrentSpot) {
                Real ratio = 1.;
                Size i;
                for (i = 0; i < timeGrid.size() - 1; ++i) {
                    Real time = timeGrid[i];
                    Real nextTime = timeGrid[i + 1];
                    ratio = effForCurve->discount(nextTime) / effForCurve->discount(time)
                          / effDomCurve->discount(nextTime) * effDomCurve->discount(time);
                    fundingRateGrid[i] *= ratio;
                    interestRateDiffGrid[i] *= ratio;
                }
                // for i = timeGrid.size() - 1
                fundingRateGrid[i] *= ratio;
                interestRateDiffGrid[i] *= ratio;
            }
            auto productIRDiff = [timeGrid, fundingRateGrid](Size i) {
                Real ret = 1.;
                for (Size j = 0; j <= i; ++j) {
                    ret /= 1. + fundingRateGrid[j];
                }
                return ret;
            };
            Real sum = 0.;
            std::vector<Real> df_dom, df_for;
            for (Size i = 0; i < timeGrid.size() - 1; ++i) {
                Real time = timeGrid[i];
                sum += productIRDiff(i) * (fundingRateGrid[i] - interestRateDiffGrid[i])
                       * effForCurve->discount(time) / effDomCurve->discount(time);
                df_dom.push_back(effDomCurve->discount(time));
                df_for.push_back(effForCurve->discount(time));
            }
            Size iLast = timeGrid.size() - 1;
            Real timeLast = timeGrid[iLast];
            Real productIRDiffLast = productIRDiff(iLast);
            Real fundingRateGridLast = fundingRateGrid[iLast];
            Real interestRateDiffGridLast = interestRateDiffGrid[iLast];

            Real domRateLast =
                effDomCurve->forwardRate(timeLast, timeLast, Continuous, NoFrequency).rate();
            Real forRateLast =
                effForCurve->forwardRate(timeLast, timeLast, Continuous, NoFrequency).rate();

            // for t > maxT_, assume flat extrapolation on all rates
            Real lastTerm = productIRDiffLast
                             * (fundingRateGridLast - interestRateDiffGridLast)
                             * effForCurve->discount(timeLast) / effDomCurve->discount(timeLast);
            Real timeStep = (timeGrid.back() - timeGrid.front()) / (timeGrid.size() - 1);
            Real ratio =
                1. / (1. + fundingRateGridLast) * exp(-timeStep * (forRateLast - domRateLast));
            sum += lastTerm / (1. - ratio);
            factor = sum;

        } else {
            // continuous-time case
            TrapezoidIntegral<Default> integrator(1.e-6, 30);
            Real fundingRateXMax = fundingRateInterp.xMax();
            auto expIRDiff = [&fundingRateInterp, &integrator, fundingRateXMax](Real s) -> Real {
                if (s < fundingRateXMax) {
                    return exp(-integrator(fundingRateInterp, 0., s));
                } else {
                    return exp(-integrator(fundingRateInterp, 0., fundingRateXMax) -
                               fundingRateInterp(fundingRateXMax) * (s - fundingRateXMax));
                }
            };

            auto timeIntegrand = [fundingRateInterp, interestRateDiffInterp, integrator, expIRDiff,
                                  effDomCurve, effForCurve](Real s) -> Real {
                return (fundingRateInterp(s) - interestRateDiffInterp(s)) * expIRDiff(s)
                       * effForCurve->discount(s) / effDomCurve->discount(s);
            };
            factor = integrator(timeIntegrand, 0., maxT_);

            // for t > maxT_, assume flat extrapolaiton on all rates
            Real fundingRateLast = fundingRateInterp(maxT_);
            Real interestRateDiffLast = interestRateDiffInterp(maxT_);
            Real expIRDiff_last = expIRDiff(maxT_);
            Real domRateLast =
                effDomCurve->forwardRate(maxT_, maxT_, Continuous, NoFrequency).rate();
            Real forRateLast =
                effForCurve->forwardRate(maxT_, maxT_, Continuous, NoFrequency).rate();
            Real ratio = fundingRateLast + forRateLast - domRateLast;
            factor += (fundingRateLast - interestRateDiffLast) * expIRDiff_last *
                      effForCurve->discount(maxT_) / effDomCurve->discount(maxT_) / ratio;
        }

        if (arguments_.payoffType == PerpetualFutures::Linear) {
            results_.value = assetSpot_->value() * factor;
        } else {
            results_.value = assetSpot_->value() / factor;
        }
    }

    Interpolation
    DiscountingPerpetualFuturesEngine::selectInterpolation(const std::vector<Time>& times,
                                                           const std::vector<Real>& values) const {
        Interpolation interpolator;
        switch (fundingInterpType_) {
            case Linear:
                interpolator = LinearInterpolation(times.begin(), times.end(), values.begin());
                break;
            case PiecewiseConstant:
                interpolator =
                    BackwardFlatInterpolation(times.begin(), times.end(), values.begin());
                break;
            case CubicSpline:
                interpolator = CubicNaturalSpline(times.begin(), times.end(), values.begin());
                break;
            default:
                QL_FAIL("Unknown interpolation type");
        }
        return interpolator;
    }

}