File: qdplusamericanengine.hpp

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 (130 lines) | stat: -rw-r--r-- 4,452 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
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

/*
 Copyright (C) 2022 Klaus Spanderen

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

#ifndef quantlib_qd_plus_american_engine_hpp
#define quantlib_qd_plus_american_engine_hpp

#include <ql/utilities/null.hpp>
#include <ql/instruments/vanillaoption.hpp>
#include <ql/processes/blackscholesprocess.hpp>
#include <ql/math/distributions/normaldistribution.hpp>


namespace QuantLib {

    class Interpolation;
    class ChebyshevInterpolation;
    class QdPlusBoundaryEvaluator;

    namespace detail {

        class QdPutCallParityEngine: public VanillaOption::engine {
          public:
            explicit QdPutCallParityEngine(
                ext::shared_ptr<GeneralizedBlackScholesProcess> process);

            void calculate() const override;

          protected:
            virtual Real calculatePut(
                Real S, Real K, Rate r, Rate q, Volatility vol, Time T) const = 0;

            const ext::shared_ptr<GeneralizedBlackScholesProcess> process_;

          private:
            Real calculatePutWithEdgeCases(
               Real S, Real K, Rate r, Rate q, Volatility vol, Time T) const;
        };

        class QdPlusAddOnValue {
          public:
            QdPlusAddOnValue(Time T,
                             Real S,
                             Real K,
                             Rate r,
                             Rate q,
                             Volatility vol,
                             Real xmax,
                             ext::shared_ptr<Interpolation> q_z);

            Real operator()(Real z) const;
          private:
            const Time T_;
            const Real S_, K_, xmax_;
            const Rate r_, q_;
            const Volatility vol_;
            const ext::shared_ptr<Interpolation> q_z_;
            const CumulativeNormalDistribution Phi_;
        };
    }


    //! American engine based on the QD+ approximation to the exercise boundary.
    /*! The main purpose of this engine is to provide a good initial guess to the exercise
        boundary for the superior fixed point American engine QdFpAmericanEngine

        References:
        Li, M. (2009), “Analytical Approximations for the Critical Stock Prices
                        of American Options: A Performance Comparison,”
                        Working paper, Georgia Institute of Technology.

        https://mpra.ub.uni-muenchen.de/15018/1/MPRA_paper_15018.pdf
    */
    class QdPlusAmericanEngine: public detail::QdPutCallParityEngine {
      public:
        enum SolverType {Brent, Newton, Ridder, Halley, SuperHalley};

        explicit QdPlusAmericanEngine(
            ext::shared_ptr<GeneralizedBlackScholesProcess>,
            Size interpolationPoints = 8,
            SolverType solverType = Halley,
            Real eps = 1e-6,
            Size maxIter = Null<Size>());

        std::pair<Size, Real> putExerciseBoundaryAtTau(
            Real S, Real K, Rate r, Rate q,
            Volatility vol, Time T, Time tau) const;

        ext::shared_ptr<ChebyshevInterpolation> getPutExerciseBoundary(
            Real S, Real K, Rate r, Rate q, Volatility vol, Time T) const;

        static Real xMax(Real K, Rate r, Rate q);

      protected:
        Real calculatePut(
            Real S, Real K, Rate r, Rate q, Volatility vol, Time T) const override;

      private:
        template <class Solver>
        Real buildInSolver(
            const QdPlusBoundaryEvaluator& eval,
            Solver solver, Real S, Real strike, Size maxIter,
            Real guess = Null<Real>()) const;

        const Size interpolationPoints_;
        const SolverType solverType_;
        const Real eps_;
        const Size maxIter_;
    };
}

#endif