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
|
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2020 Lew Wei Hao
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.
*/
/*! \file fdcirvanillaengine.hpp
\brief Finite-differences CIR vanilla option engine
*/
#ifndef quantlib_fd_cir_vanilla_engine_hpp
#define quantlib_fd_cir_vanilla_engine_hpp
#include <ql/instruments/vanillaoption.hpp>
#include <ql/methods/finitedifferences/solvers/fdmbackwardsolver.hpp>
#include <ql/methods/finitedifferences/solvers/fdmsolverdesc.hpp>
#include <ql/models/equity/hestonmodel.hpp>
#include <ql/pricingengines/genericmodelengine.hpp>
#include <ql/processes/coxingersollrossprocess.hpp>
#include <ql/termstructures/volatility/equityfx/localvoltermstructure.hpp>
namespace QuantLib {
class FdmQuantoHelper;
//! Finite-differences CIR vanilla option engine
/*! \ingroup vanillaengines
\test the engine has been tested to converge among different schemes.
*/
class FdCIRVanillaEngine : public VanillaOption::engine {
public:
FdCIRVanillaEngine(ext::shared_ptr<CoxIngersollRossProcess> cirProcess,
ext::shared_ptr<GeneralizedBlackScholesProcess> bsProcess,
Size tGrid,
Size xGrid,
Size vGrid,
Size dampingSteps,
Real rho,
const FdmSchemeDesc& schemeDesc = FdmSchemeDesc::ModifiedHundsdorfer(),
ext::shared_ptr<FdmQuantoHelper> quantoHelper = {});
FdCIRVanillaEngine(ext::shared_ptr<CoxIngersollRossProcess> cirProcess,
ext::shared_ptr<GeneralizedBlackScholesProcess> bsProcess,
DividendSchedule dividends,
Size tGrid,
Size xGrid,
Size vGrid,
Size dampingSteps,
Real rho,
const FdmSchemeDesc& schemeDesc = FdmSchemeDesc::ModifiedHundsdorfer(),
ext::shared_ptr<FdmQuantoHelper> quantoHelper = {});
void calculate() const override;
FdmSolverDesc getSolverDesc(Real equityScaleFactor) const;
private:
ext::shared_ptr<GeneralizedBlackScholesProcess> bsProcess_;
ext::shared_ptr<CoxIngersollRossProcess> cirProcess_;
ext::shared_ptr<FdmQuantoHelper> quantoHelper_;
DividendSchedule dividends_;
const Size tGrid_, xGrid_, rGrid_, dampingSteps_;
const Real rho_;
const FdmSchemeDesc schemeDesc_;
};
class MakeFdCIRVanillaEngine {
public:
explicit MakeFdCIRVanillaEngine(ext::shared_ptr<CoxIngersollRossProcess> cirProcess,
ext::shared_ptr<GeneralizedBlackScholesProcess> bsProcess,
Real rho);
MakeFdCIRVanillaEngine& withQuantoHelper(
const ext::shared_ptr<FdmQuantoHelper>& quantoHelper);
MakeFdCIRVanillaEngine& withTGrid(Size tGrid);
MakeFdCIRVanillaEngine& withXGrid(Size xGrid);
MakeFdCIRVanillaEngine& withRGrid(Size rGrid);
MakeFdCIRVanillaEngine& withDampingSteps(
Size dampingSteps);
MakeFdCIRVanillaEngine& withFdmSchemeDesc(
const FdmSchemeDesc& schemeDesc);
MakeFdCIRVanillaEngine& withCashDividends(
const std::vector<Date>& dividendDates,
const std::vector<Real>& dividendAmounts);
operator ext::shared_ptr<PricingEngine>() const;
private:
ext::shared_ptr<CoxIngersollRossProcess> cirProcess_;
ext::shared_ptr<GeneralizedBlackScholesProcess> bsProcess_;
DividendSchedule dividends_;
const Real rho_;
Size tGrid_ = 10, xGrid_ = 100, rGrid_ = 100, dampingSteps_ = 0;
ext::shared_ptr<FdmSchemeDesc> schemeDesc_;
ext::shared_ptr<FdmQuantoHelper> quantoHelper_;
};
}
#endif
|