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 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
|
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2007 Cristina Duminuco
Copyright (C) 2007 Giorgio Facchinetti
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/cashflows/capflooredcoupon.hpp>
#include <ql/cashflows/digitalcoupon.hpp>
#include <ql/indexes/indexmanager.hpp>
#include <ql/indexes/interestrateindex.hpp>
namespace QuantLib {
DigitalCoupon::DigitalCoupon(const ext::shared_ptr<FloatingRateCoupon>& underlying,
Rate callStrike,
Position::Type callPosition,
bool isCallATMIncluded,
Rate callDigitalPayoff,
Rate putStrike,
Position::Type putPosition,
bool isPutATMIncluded,
Rate putDigitalPayoff,
ext::shared_ptr<DigitalReplication> replication,
const bool nakedOption)
: FloatingRateCoupon(underlying->date(),
underlying->nominal(),
underlying->accrualStartDate(),
underlying->accrualEndDate(),
underlying->fixingDays(),
underlying->index(),
underlying->gearing(),
underlying->spread(),
underlying->referencePeriodStart(),
underlying->referencePeriodEnd(),
underlying->dayCounter(),
underlying->isInArrears()),
underlying_(underlying), isCallATMIncluded_(isCallATMIncluded),
isPutATMIncluded_(isPutATMIncluded), nakedOption_(nakedOption) {
if (replication == nullptr)
replication = ext::make_shared<DigitalReplication>();
QL_REQUIRE(replication->gap()>0.0, "Non positive epsilon not allowed");
callLeftEps_ = callRightEps_ = putLeftEps_ = putRightEps_ = replication->gap() / 2;
replicationType_ = replication->replicationType();
if (putStrike == Null<Rate>()) {
QL_REQUIRE(putDigitalPayoff == Null<Rate>(),
"Put Cash rate non allowed if put strike is null");
}
if (callStrike == Null<Rate>()) {
QL_REQUIRE(callDigitalPayoff == Null<Rate>(),
"Call Cash rate non allowed if call strike is null");
}
if (callStrike != Null<Rate>()) {
hasCallStrike_ = true;
callStrike_ = callStrike;
switch (callPosition) {
case Position::Long :
callCsi_ = 1.0;
break;
case Position::Short :
callCsi_ = -1.0;
break;
default:
QL_FAIL("unsupported position type");
}
if (callDigitalPayoff != Null<Rate>()){
callDigitalPayoff_ = callDigitalPayoff;
isCallCashOrNothing_ = true;
}
}
if (putStrike != Null<Rate>()){
hasPutStrike_ = true;
putStrike_ = putStrike;
switch (putPosition) {
case Position::Long :
putCsi_ = 1.0;
break;
case Position::Short :
putCsi_ = -1.0;
break;
default:
QL_FAIL("unsupported position type");
}
if (putDigitalPayoff != Null<Rate>()){
putDigitalPayoff_ = putDigitalPayoff;
isPutCashOrNothing_ = true;
}
}
switch (replicationType_) {
case Replication::Central :
// do nothing
break;
case Replication::Sub :
if (hasCallStrike_) {
switch (callPosition) {
case Position::Long :
callLeftEps_ = 0.;
callRightEps_ = replication->gap();
break;
case Position::Short :
callLeftEps_ = replication->gap();
callRightEps_ = 0.;
break;
default:
QL_FAIL("unsupported position type");
}
}
if (hasPutStrike_) {
switch (putPosition) {
case Position::Long :
putLeftEps_ = replication->gap();
putRightEps_ = 0.;
break;
case Position::Short :
putLeftEps_ = 0.;
putRightEps_ = replication->gap();
break;
default:
QL_FAIL("unsupported position type");
}
}
break;
case Replication::Super :
if (hasCallStrike_) {
switch (callPosition) {
case Position::Long :
callLeftEps_ = replication->gap();
callRightEps_ = 0.;
break;
case Position::Short :
callLeftEps_ = 0.;
callRightEps_ = replication->gap();
break;
default:
QL_FAIL("unsupported position type");
}
}
if (hasPutStrike_) {
switch (putPosition) {
case Position::Long :
putLeftEps_ = 0.;
putRightEps_ = replication->gap();
break;
case Position::Short :
putLeftEps_ = replication->gap();
putRightEps_ = 0.;
break;
default:
QL_FAIL("unsupported position type");
}
}
break;
default:
QL_FAIL("unsupported replication type");
}
registerWith(underlying);
}
Rate DigitalCoupon::callOptionRate() const {
Rate callOptionRate = Rate(0.);
if(hasCallStrike_) {
// Step function
callOptionRate = isCallCashOrNothing_ ? callDigitalPayoff_ : callStrike_;
CappedFlooredCoupon next(underlying_, callStrike_ + callRightEps_);
CappedFlooredCoupon previous(underlying_, callStrike_ - callLeftEps_);
callOptionRate *= (next.rate() - previous.rate())
/ (callLeftEps_ + callRightEps_);
if (!isCallCashOrNothing_) {
// Call
CappedFlooredCoupon atStrike(underlying_, callStrike_);
Rate call = underlying_->rate() - atStrike.rate();
// Sum up
callOptionRate += call;
}
}
return callOptionRate;
}
Rate DigitalCoupon::putOptionRate() const {
Rate putOptionRate = Rate(0.);
if(hasPutStrike_) {
// Step function
putOptionRate = isPutCashOrNothing_ ? putDigitalPayoff_ : putStrike_;
CappedFlooredCoupon next(underlying_, Null<Rate>(), putStrike_ + putRightEps_);
CappedFlooredCoupon previous(underlying_, Null<Rate>(), putStrike_ - putLeftEps_);
putOptionRate *= (next.rate() - previous.rate())
/ (putLeftEps_ + putRightEps_);
if (!isPutCashOrNothing_) {
// Put
CappedFlooredCoupon atStrike(underlying_, Null<Rate>(), putStrike_);
Rate put = - underlying_->rate() + atStrike.rate();
// Sum up
putOptionRate -= put;
}
}
return putOptionRate;
}
void DigitalCoupon::deepUpdate() {
update();
underlying_->deepUpdate();
}
void DigitalCoupon::performCalculations() const {
QL_REQUIRE(underlying_->pricer(), "pricer not set");
Date fixingDate = underlying_->fixingDate();
Date today = Settings::instance().evaluationDate();
bool enforceTodaysHistoricFixings =
Settings::instance().enforcesTodaysHistoricFixings();
Rate underlyingRate = nakedOption_ ? 0.0 : underlying_->rate();
if (fixingDate < today ||
((fixingDate == today) && enforceTodaysHistoricFixings)) {
// must have been fixed
rate_ = underlyingRate + callCsi_ * callPayoff() + putCsi_ * putPayoff();
} else if (fixingDate == today) {
// might have been fixed
if (underlying_->index()->hasHistoricalFixing(fixingDate)) {
rate_ = underlyingRate + callCsi_ * callPayoff() + putCsi_ * putPayoff();
} else {
rate_ = underlyingRate + callCsi_ * callOptionRate() + putCsi_ * putOptionRate();
}
} else {
rate_ = underlyingRate + callCsi_ * callOptionRate() + putCsi_ * putOptionRate();
}
}
Rate DigitalCoupon::rate() const {
calculate();
return rate_;
}
Rate DigitalCoupon::convexityAdjustment() const {
return underlying_->convexityAdjustment();
}
Rate DigitalCoupon::callStrike() const {
if (hasCall())
return callStrike_;
else
return Null<Rate>();
}
Rate DigitalCoupon::putStrike() const {
if (hasPut())
return putStrike_;
else
return Null<Rate>();
}
Rate DigitalCoupon::callDigitalPayoff() const {
if (isCallCashOrNothing_)
return callDigitalPayoff_;
else
return Null<Rate>();
}
Rate DigitalCoupon::putDigitalPayoff() const {
if (isPutCashOrNothing_)
return putDigitalPayoff_;
else
return Null<Rate>();
}
void DigitalCoupon::accept(AcyclicVisitor& v) {
typedef FloatingRateCoupon super;
auto* v1 = dynamic_cast<Visitor<DigitalCoupon>*>(&v);
if (v1 != nullptr)
v1->visit(*this);
else
super::accept(v);
}
Rate DigitalCoupon::callPayoff() const {
// to use only if index has fixed
Rate payoff(0.);
if(hasCallStrike_) {
Rate underlyingRate = underlying_->rate();
if ( (underlyingRate - callStrike_) > 1.e-16 ) {
payoff = isCallCashOrNothing_ ? callDigitalPayoff_ : underlyingRate;
} else {
if (isCallATMIncluded_) {
if ( std::abs(callStrike_ - underlyingRate) <= 1.e-16 )
payoff = isCallCashOrNothing_ ? callDigitalPayoff_ : underlyingRate;
}
}
}
return payoff;
}
Rate DigitalCoupon::putPayoff() const {
// to use only if index has fixed
Rate payoff(0.);
if(hasPutStrike_) {
Rate underlyingRate = underlying_->rate();
if ( (putStrike_ - underlyingRate) > 1.e-16 ) {
payoff = isPutCashOrNothing_ ? putDigitalPayoff_ : underlyingRate;
} else {
// putStrike_ <= underlyingRate
if (isPutATMIncluded_) {
if ( std::abs(putStrike_ - underlyingRate) <= 1.e-16 )
payoff = isPutCashOrNothing_ ? putDigitalPayoff_ : underlyingRate;
}
}
}
return payoff;
}
}
|