Coverage Report

Created: 2026-06-08 06:47

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/quantlib/ql/experimental/barrieroption/vannavolgabarrierengine.cpp
Line
Count
Source
1
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
3
/*
4
 Copyright (C) 2013 Yue Tian
5
6
 This file is part of QuantLib, a free-software/open-source library
7
 for financial quantitative analysts and developers - http://quantlib.org/
8
9
 QuantLib is free software: you can redistribute it and/or modify it
10
 under the terms of the QuantLib license.  You should have received a
11
 copy of the license along with this program; if not, please email
12
 <quantlib-dev@lists.sf.net>. The license is also available online at
13
 <https://www.quantlib.org/license.shtml>.
14
15
 This program is distributed in the hope that it will be useful, but WITHOUT
16
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17
 FOR A PARTICULAR PURPOSE.  See the license for more details.
18
*/
19
20
#include <ql/experimental/barrieroption/vannavolgabarrierengine.hpp>
21
#include <ql/experimental/barrieroption/vannavolgainterpolation.hpp>
22
#include <ql/math/matrix.hpp>
23
#include <ql/pricingengines/barrier/analyticbarrierengine.hpp>
24
#include <ql/pricingengines/blackdeltacalculator.hpp>
25
#include <ql/pricingengines/blackformula.hpp>
26
#include <ql/quotes/simplequote.hpp>
27
#include <ql/termstructures/volatility/equityfx/blackconstantvol.hpp>
28
#include <ql/time/calendars/nullcalendar.hpp>
29
#include <utility>
30
31
using std::pow;
32
using std::log;
33
using std::sqrt;
34
35
namespace QuantLib {
36
37
    VannaVolgaBarrierEngine::VannaVolgaBarrierEngine(Handle<DeltaVolQuote> atmVol,
38
                                                     Handle<DeltaVolQuote> vol25Put,
39
                                                     Handle<DeltaVolQuote> vol25Call,
40
                                                     Handle<Quote> spotFX,
41
                                                     Handle<YieldTermStructure> domesticTS,
42
                                                     Handle<YieldTermStructure> foreignTS,
43
                                                     const bool adaptVanDelta,
44
                                                     const Real bsPriceWithSmile)
45
0
    : atmVol_(std::move(atmVol)), vol25Put_(std::move(vol25Put)), vol25Call_(std::move(vol25Call)),
46
0
      T_(atmVol_->maturity()), spotFX_(std::move(spotFX)), domesticTS_(std::move(domesticTS)),
47
0
      foreignTS_(std::move(foreignTS)), adaptVanDelta_(adaptVanDelta),
48
0
      bsPriceWithSmile_(bsPriceWithSmile) {
49
0
        QL_REQUIRE(vol25Put_->delta() == -0.25, "25 delta put is required by vanna volga method");
50
0
        QL_REQUIRE(vol25Call_->delta() == 0.25, "25 delta call is required by vanna volga method");
51
52
0
        QL_REQUIRE(vol25Put_->maturity() == vol25Call_->maturity() &&
53
0
                       vol25Put_->maturity() == atmVol_->maturity(),
54
0
                   "Maturity of 3 vols are not the same");
55
56
0
        QL_REQUIRE(!domesticTS_.empty(), "domestic yield curve is not defined");
57
0
        QL_REQUIRE(!foreignTS_.empty(), "foreign yield curve is not defined");
58
59
0
        registerWith(atmVol_);
60
0
        registerWith(vol25Put_);
61
0
        registerWith(vol25Call_);
62
0
        registerWith(spotFX_);
63
0
        registerWith(domesticTS_);
64
0
        registerWith(foreignTS_);
65
0
    }
66
67
0
    void VannaVolgaBarrierEngine::calculate() const {
68
69
0
        QL_REQUIRE(arguments_.barrierType == Barrier::UpIn || arguments_.barrierType == Barrier::UpOut ||
70
0
            arguments_.barrierType == Barrier::DownIn || arguments_.barrierType == Barrier::DownOut,
71
0
            "Invalid barrier type");
72
73
0
        const Real sigmaShift_vega = 0.0001;
74
0
        const Real sigmaShift_volga = 0.0001;
75
0
        const Real spotShift_delta = 0.0001 * spotFX_->value();
76
0
        const Real sigmaShift_vanna = 0.0001;
77
78
0
        Handle<Quote> x0Quote(
79
0
            ext::make_shared<SimpleQuote>(spotFX_->value())); //used for shift
80
0
        Handle<Quote> atmVolQuote(
81
0
            ext::make_shared<SimpleQuote>(atmVol_->value())); //used for shift
82
83
0
        ext::shared_ptr<BlackVolTermStructure> blackVolTS =
84
0
            ext::make_shared<BlackConstantVol>(
85
0
                Settings::instance().evaluationDate(),
86
0
                NullCalendar(), atmVolQuote, Actual365Fixed());
87
0
        ext::shared_ptr<BlackScholesMertonProcess> stochProcess =
88
0
            ext::make_shared<BlackScholesMertonProcess>(
89
0
                                 x0Quote,
90
0
                                 foreignTS_,
91
0
                                 domesticTS_,
92
0
                                 Handle<BlackVolTermStructure>(blackVolTS));
93
94
0
        ext::shared_ptr<PricingEngine> engineBS =
95
0
            ext::make_shared<AnalyticBarrierEngine>(stochProcess);
96
97
0
        BlackDeltaCalculator blackDeltaCalculatorAtm(
98
0
                        Option::Call, atmVol_->deltaType(), x0Quote->value(),
99
0
                        domesticTS_->discount(T_), foreignTS_->discount(T_),
100
0
                        atmVol_->value() * sqrt(T_));
101
0
        Real atmStrike = blackDeltaCalculatorAtm.atmStrike(atmVol_->atmType());
102
103
0
        Real call25Vol = vol25Call_->value();
104
0
        Real put25Vol = vol25Put_->value();
105
106
0
        BlackDeltaCalculator blackDeltaCalculatorPut25(Option::Put, vol25Put_->deltaType(), x0Quote->value(), 
107
0
                                                      domesticTS_->discount(T_), foreignTS_->discount(T_),
108
0
                                                      put25Vol * sqrt(T_));
109
0
        Real put25Strike = blackDeltaCalculatorPut25.strikeFromDelta(-0.25);
110
0
        BlackDeltaCalculator blackDeltaCalculatorCall25(Option::Call, vol25Call_->deltaType(), x0Quote->value(), 
111
0
                                                      domesticTS_->discount(T_), foreignTS_->discount(T_),
112
0
                                                      call25Vol * sqrt(T_));
113
0
        Real call25Strike = blackDeltaCalculatorCall25.strikeFromDelta(0.25);
114
115
116
        //here use vanna volga interpolated smile to price vanilla
117
0
        std::vector<Real> strikes;
118
0
        std::vector<Real> vols;
119
0
        strikes.push_back(put25Strike);
120
0
        vols.push_back(put25Vol);
121
0
        strikes.push_back(atmStrike);
122
0
        vols.push_back(atmVol_->value());
123
0
        strikes.push_back(call25Strike);
124
0
        vols.push_back(call25Vol);
125
0
        VannaVolga vannaVolga(x0Quote->value(), domesticTS_->discount(T_), foreignTS_->discount(T_), T_);
126
0
        Interpolation interpolation = vannaVolga.interpolate(strikes.begin(), strikes.end(), vols.begin());
127
0
        interpolation.enableExtrapolation();
128
0
        const ext::shared_ptr<StrikedTypePayoff> payoff =
129
0
                                        ext::dynamic_pointer_cast<StrikedTypePayoff>(arguments_.payoff);
130
0
        Real strikeVol = interpolation(payoff->strike());
131
132
        //vanilla option price
133
0
        Real forward = x0Quote->value() * foreignTS_->discount(T_) / domesticTS_->discount(T_);
134
0
        Real vanillaOption = blackFormula(payoff->optionType(), payoff->strike(), 
135
0
                                      forward, 
136
0
                                      strikeVol * sqrt(T_),
137
0
                                      domesticTS_->discount(T_));
138
0
        results_.additionalResults["Forward"] = forward;
139
0
        results_.additionalResults["StrikeVol"] = strikeVol;
140
141
        //spot > barrier up&out 0
142
0
        if(x0Quote->value() >= arguments_.barrier && arguments_.barrierType == Barrier::UpOut){
143
0
            results_.value = 0.0;
144
0
            results_.additionalResults["VanillaPrice"] = adaptVanDelta_? bsPriceWithSmile_ : vanillaOption;
145
0
            results_.additionalResults["BarrierInPrice"] = adaptVanDelta_? bsPriceWithSmile_ : vanillaOption;
146
0
            results_.additionalResults["BarrierOutPrice"] = Real(0.0);
147
0
        }
148
        //spot > barrier up&in vanilla
149
0
        else if(x0Quote->value() >= arguments_.barrier && arguments_.barrierType == Barrier::UpIn){
150
0
            results_.value = adaptVanDelta_? bsPriceWithSmile_ : vanillaOption;
151
0
            results_.additionalResults["VanillaPrice"] = adaptVanDelta_? bsPriceWithSmile_ : vanillaOption;
152
0
            results_.additionalResults["BarrierInPrice"] = adaptVanDelta_? bsPriceWithSmile_ : vanillaOption;
153
0
            results_.additionalResults["BarrierOutPrice"] = Real(0.0);
154
0
        }
155
        //spot < barrier down&out 0
156
0
        else if(x0Quote->value() <= arguments_.barrier && arguments_.barrierType == Barrier::DownOut){
157
0
            results_.value = 0.0;
158
0
            results_.additionalResults["VanillaPrice"] = adaptVanDelta_? bsPriceWithSmile_ : vanillaOption;
159
0
            results_.additionalResults["BarrierInPrice"] = adaptVanDelta_? bsPriceWithSmile_ : vanillaOption;
160
0
            results_.additionalResults["BarrierOutPrice"] = Real(0.0);
161
0
        }
162
        //spot < barrier down&in vanilla
163
0
        else if(x0Quote->value() <= arguments_.barrier && arguments_.barrierType == Barrier::DownIn){
164
0
            results_.value = adaptVanDelta_? bsPriceWithSmile_ : vanillaOption;
165
0
            results_.additionalResults["VanillaPrice"] = adaptVanDelta_? bsPriceWithSmile_ : vanillaOption;
166
0
            results_.additionalResults["BarrierInPrice"] = adaptVanDelta_? bsPriceWithSmile_ : vanillaOption;
167
0
            results_.additionalResults["BarrierOutPrice"] = Real(0.0);
168
0
        }
169
0
        else{
170
171
            //set up BS barrier option pricing
172
            //only calculate out barrier option price
173
            // in barrier price = vanilla - out barrier
174
0
            Barrier::Type barrierType;
175
0
            if(arguments_.barrierType == Barrier::UpOut)
176
0
                barrierType = arguments_.barrierType;
177
0
            else if(arguments_.barrierType == Barrier::UpIn)
178
0
                barrierType = Barrier::UpOut;
179
0
            else if(arguments_.barrierType == Barrier::DownOut)
180
0
                barrierType = arguments_.barrierType;
181
0
            else
182
0
                barrierType = Barrier::DownOut;
183
184
0
            BarrierOption barrierOption(barrierType,
185
0
                                        arguments_.barrier,
186
0
                                        arguments_.rebate,
187
0
                                        ext::dynamic_pointer_cast<StrikedTypePayoff>(arguments_.payoff),
188
0
                                        arguments_.exercise);
189
190
0
            barrierOption.setPricingEngine(engineBS);
191
192
            //BS price with atm vol
193
0
            Real priceBS = barrierOption.NPV();
194
0
            Real price25CallBS = blackFormula(Option::Call,call25Strike,
195
0
                                              forward, 
196
0
                                              atmVol_->value() * sqrt(T_),
197
0
                                              domesticTS_->discount(T_));
198
0
            Real price25PutBS = blackFormula(Option::Put,put25Strike,
199
0
                                              forward,
200
0
                                              atmVol_->value() * sqrt(T_),
201
0
                                              domesticTS_->discount(T_));
202
203
            //market price
204
0
            Real price25CallMkt = blackFormula(Option::Call,call25Strike,
205
0
                                              forward, 
206
0
                                              call25Vol * sqrt(T_),
207
0
                                              domesticTS_->discount(T_));
208
0
            Real price25PutMkt = blackFormula(Option::Put,put25Strike,
209
0
                                              forward,
210
0
                                              put25Vol * sqrt(T_),
211
0
                                              domesticTS_->discount(T_));
212
213
214
            //Analytical Black Scholes formula for vanilla option
215
0
            NormalDistribution norm;
216
0
            Real d1atm = (std::log(forward/atmStrike) 
217
0
                           + 0.5*std::pow(atmVolQuote->value(),2.0) * T_)/(atmVolQuote->value() * sqrt(T_));
218
0
            Real vegaAtm_Analytical = x0Quote->value() * norm(d1atm) * sqrt(T_) * foreignTS_->discount(T_);
219
0
            Real vannaAtm_Analytical = vegaAtm_Analytical/x0Quote->value() *(1.0 - d1atm/(atmVolQuote->value()*sqrt(T_)));
220
0
            Real volgaAtm_Analytical = vegaAtm_Analytical * d1atm * (d1atm - atmVolQuote->value() * sqrt(T_))/atmVolQuote->value();
221
222
0
            Real d125call = (std::log(forward/call25Strike) 
223
0
                           + 0.5*std::pow(atmVolQuote->value(),2.0) * T_)/(atmVolQuote->value() * sqrt(T_));
224
0
            Real vega25Call_Analytical = x0Quote->value() * norm(d125call) * sqrt(T_) * foreignTS_->discount(T_);
225
0
            Real vanna25Call_Analytical = vega25Call_Analytical/x0Quote->value() *(1.0 - d125call/(atmVolQuote->value()*sqrt(T_)));
226
0
            Real volga25Call_Analytical = vega25Call_Analytical * d125call * (d125call - atmVolQuote->value() * sqrt(T_))/atmVolQuote->value();
227
228
0
            Real d125Put = (std::log(forward/put25Strike) 
229
0
                           + 0.5*std::pow(atmVolQuote->value(),2.0) * T_)/(atmVolQuote->value() * sqrt(T_));
230
0
            Real vega25Put_Analytical = x0Quote->value() * norm(d125Put) * sqrt(T_) * foreignTS_->discount(T_);
231
0
            Real vanna25Put_Analytical = vega25Put_Analytical/x0Quote->value() *(1.0 - d125Put/(atmVolQuote->value()*sqrt(T_)));
232
0
            Real volga25Put_Analytical = vega25Put_Analytical * d125Put * (d125Put - atmVolQuote->value() * sqrt(T_))/atmVolQuote->value();
233
234
235
            //BS vega
236
0
            ext::static_pointer_cast<SimpleQuote> (atmVolQuote.currentLink())->setValue(atmVolQuote->value() + sigmaShift_vega);
237
0
            barrierOption.recalculate();
238
0
            Real vegaBarBS = (barrierOption.NPV() - priceBS)/sigmaShift_vega;
239
240
0
            ext::static_pointer_cast<SimpleQuote> (atmVolQuote.currentLink())->setValue(atmVolQuote->value() - sigmaShift_vega);//setback
241
242
            //BS volga
243
244
            //vegaBar2
245
            //base NPV
246
0
            ext::static_pointer_cast<SimpleQuote> (atmVolQuote.currentLink())->setValue(atmVolQuote->value() + sigmaShift_volga);
247
0
            barrierOption.recalculate();
248
0
            Real priceBS2 = barrierOption.NPV();
249
250
            //shifted npv
251
0
            ext::static_pointer_cast<SimpleQuote> (atmVolQuote.currentLink())->setValue(atmVolQuote->value() + sigmaShift_vega);
252
0
            barrierOption.recalculate();
253
0
            Real vegaBarBS2 = (barrierOption.NPV() - priceBS2)/sigmaShift_vega;
254
0
            Real volgaBarBS = (vegaBarBS2 - vegaBarBS)/sigmaShift_volga;
255
256
0
            ext::static_pointer_cast<SimpleQuote> (atmVolQuote.currentLink())->setValue(atmVolQuote->value() 
257
0
                                                                                               - sigmaShift_volga 
258
0
                                                                                               - sigmaShift_vega);//setback
259
260
            //BS Delta
261
            //base delta
262
0
            ext::static_pointer_cast<SimpleQuote> (x0Quote.currentLink())->setValue(x0Quote->value() + spotShift_delta);//shift forth
263
0
            barrierOption.recalculate();
264
0
            Real priceBS_delta1 = barrierOption.NPV();
265
266
0
            ext::static_pointer_cast<SimpleQuote> (x0Quote.currentLink())->setValue(x0Quote->value() - 2 * spotShift_delta);//shift back
267
0
            barrierOption.recalculate();
268
0
            Real priceBS_delta2 = barrierOption.NPV();
269
270
0
            ext::static_pointer_cast<SimpleQuote> (x0Quote.currentLink())->setValue(x0Quote->value() +  spotShift_delta);//set back
271
0
            Real deltaBar1 = (priceBS_delta1 - priceBS_delta2)/(2.0*spotShift_delta);
272
273
            //shifted delta
274
0
            ext::static_pointer_cast<SimpleQuote> (atmVolQuote.currentLink())->setValue(atmVolQuote->value() + sigmaShift_vanna);//shift sigma
275
0
            ext::static_pointer_cast<SimpleQuote> (x0Quote.currentLink())->setValue(x0Quote->value() + spotShift_delta);//shift forth
276
0
            barrierOption.recalculate();
277
0
            priceBS_delta1 = barrierOption.NPV();
278
279
0
            ext::static_pointer_cast<SimpleQuote> (x0Quote.currentLink())->setValue(x0Quote->value() - 2 * spotShift_delta);//shift back
280
0
            barrierOption.recalculate();
281
0
            priceBS_delta2 = barrierOption.NPV();
282
283
0
            ext::static_pointer_cast<SimpleQuote> (x0Quote.currentLink())->setValue(x0Quote->value() +  spotShift_delta);//set back
284
0
            Real deltaBar2 = (priceBS_delta1 - priceBS_delta2)/(2.0*spotShift_delta);
285
286
0
            Real vannaBarBS = (deltaBar2 - deltaBar1)/sigmaShift_vanna;
287
288
0
            ext::static_pointer_cast<SimpleQuote> (atmVolQuote.currentLink())->setValue(atmVolQuote->value() - sigmaShift_vanna);//set back
289
290
            //Matrix
291
0
            Matrix A(3,3,0.0);
292
293
            //analytical
294
0
            A[0][0] = vegaAtm_Analytical;
295
0
            A[0][1] = vega25Call_Analytical;
296
0
            A[0][2] = vega25Put_Analytical;
297
0
            A[1][0] = vannaAtm_Analytical;
298
0
            A[1][1] = vanna25Call_Analytical;
299
0
            A[1][2] = vanna25Put_Analytical;
300
0
            A[2][0] = volgaAtm_Analytical;
301
0
            A[2][1] = volga25Call_Analytical;
302
0
            A[2][2] = volga25Put_Analytical;
303
304
0
            Array b(3,0.0);
305
0
            b[0] = vegaBarBS;
306
0
            b[1] = vannaBarBS;
307
0
            b[2] = volgaBarBS;
308
309
0
            Array q = inverse(A) * b;
310
311
            //touch probability
312
0
            CumulativeNormalDistribution cnd;
313
0
            Real mu = domesticTS_->zeroRate(T_, Continuous).rate() - foreignTS_->zeroRate(T_, Continuous).rate() - pow(atmVol_->value(), 2.0)/2.0;
314
0
            Real h2 = (log(arguments_.barrier/x0Quote->value()) + mu*T_)/(atmVol_->value()*sqrt(T_));
315
0
            Real h2Prime = (log(x0Quote->value()/arguments_.barrier) + mu*T_)/(atmVol_->value()*sqrt(T_));
316
0
            Real probTouch = 0.0;
317
0
            if(arguments_.barrierType == Barrier::UpIn || arguments_.barrierType == Barrier::UpOut)
318
0
                probTouch = cnd(h2Prime) + pow(arguments_.barrier/x0Quote->value(), 2.0*mu/pow(atmVol_->value(), 2.0))*cnd(-h2);
319
0
            else
320
0
                probTouch = cnd(-h2Prime) + pow(arguments_.barrier/x0Quote->value(), 2.0*mu/pow(atmVol_->value(), 2.0))*cnd(h2);
321
0
            Real p_survival = 1.0 - probTouch;
322
323
0
            Real lambda = p_survival ;
324
0
            Real adjust = q[1]*(price25CallMkt - price25CallBS)
325
0
                        + q[2]*(price25PutMkt - price25PutBS);
326
0
            Real outPrice = priceBS + lambda*adjust;//
327
0
            Real inPrice;
328
329
            //adapt Vanilla delta
330
0
            if (adaptVanDelta_) {
331
0
                outPrice += lambda*(bsPriceWithSmile_ - vanillaOption);
332
                //capfloored by (0, vanilla)
333
0
                outPrice = std::max(0.0, std::min(bsPriceWithSmile_, outPrice));
334
0
                inPrice = bsPriceWithSmile_ - outPrice;
335
0
            }
336
0
            else{
337
                //capfloored by (0, vanilla)
338
0
                outPrice = std::max(0.0, std::min(vanillaOption, outPrice));
339
0
                inPrice = vanillaOption - outPrice;
340
0
            }
341
342
0
            if(arguments_.barrierType == Barrier::DownOut || arguments_.barrierType == Barrier::UpOut)
343
0
                results_.value = outPrice;
344
0
            else
345
0
                results_.value = inPrice;
346
0
            results_.additionalResults["VanillaPrice"] = vanillaOption;
347
0
            results_.additionalResults["BarrierInPrice"] = inPrice;
348
0
            results_.additionalResults["BarrierOutPrice"] = outPrice;
349
0
            results_.additionalResults["lambda"] = lambda;
350
0
         }
351
0
    }
352
}