Coverage Report

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