File: gaussian1dmodel.i

package info (click to toggle)
quantlib-swig 1.40-3
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 2,276 kB
  • sloc: python: 6,024; java: 1,552; cs: 774; makefile: 309; sh: 22
file content (297 lines) | stat: -rw-r--r-- 12,582 bytes parent folder | download | duplicates (2)
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

/*
 Copyright (C) 2014 Matthias Groncki
 Copyright (C) 2017, 2018 Matthias Lungwitz

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

#ifndef quantlib_gaussian1dmodel_i
#define quantlib_gaussian1dmodel_i

%include stochasticprocess.i
%include date.i
%include options.i
%include indexes.i
%include optimizers.i
%include calibrationhelpers.i
%include observer.i

%{
using QuantLib::Gaussian1dModel;
%}

%shared_ptr(Gaussian1dModel)
class Gaussian1dModel : public TermStructureConsistentModel {
    public:
        const ext::shared_ptr<StochasticProcess1D> stateProcess() const;

        const Real numeraire(const Time t, const Real y = 0.0,
                             const Handle<YieldTermStructure> &yts =
                                 Handle<YieldTermStructure>()) const;

        const Real zerobond(const Time T, const Time t = 0.0,
                            const Real y = 0.0,
                            const Handle<YieldTermStructure> &yts =
                                Handle<YieldTermStructure>());

        const Real numeraire(const Date &referenceDate, const Real y = 0.0,
                             const Handle<YieldTermStructure> &yts =
                                 Handle<YieldTermStructure>()) const;

        const Real zerobond(const Date &maturity,
                            const Date &referenceDate = Null<Date>(),
                            const Real y = 0.0,
                            const Handle<YieldTermStructure> &yts =
                                Handle<YieldTermStructure>()) const;

        const Real zerobondOption(
            const Option::Type &type, const Date &expiry, const Date &valueDate,
            const Date &maturity, const Rate strike,
            const Date &referenceDate = Null<Date>(), const Real y = 0.0,
            const Handle<YieldTermStructure> &yts =
                Handle<YieldTermStructure>(),
            const Real yStdDevs = 7.0, const Size yGridPoints = 64,
            const bool extrapolatePayoff = true,
            const bool flatPayoffExtrapolation = false) const;

        const Real forwardRate(const Date &fixing,
                               const Date &referenceDate = Null<Date>(),
                               const Real y = 0.0,
                               ext::shared_ptr<IborIndex> iborIdx =
                                   ext::shared_ptr<IborIndex>()) const;

        const Real swapRate(const Date &fixing, const Period &tenor,
                            const Date &referenceDate = Null<Date>(),
                            const Real y = 0.0,
                            ext::shared_ptr<SwapIndex> swapIdx =
                                ext::shared_ptr<SwapIndex>()) const;

        const Real swapAnnuity(const Date &fixing, const Period &tenor,
                               const Date &referenceDate = Null<Date>(),
                               const Real y = 0.0,
                               ext::shared_ptr<SwapIndex> swapIdx =
                                   ext::shared_ptr<SwapIndex>()) const;
};

%{
using QuantLib::Gsr;
using QuantLib::MarkovFunctional;
%}


%shared_ptr(Gsr)
class Gsr : public Gaussian1dModel {
    #if defined(SWIGCSHARP)
    %rename("parameters") params;
    #endif
  public:
    Gsr(const Handle<YieldTermStructure> &termStructure,
           const std::vector<Date> &volstepdates,
           const std::vector<Handle<Quote> > &volatilities,
           const std::vector<Handle<Quote> > &reversions, const Real T = 60.0);
    
    void calibrateVolatilitiesIterative(
            const std::vector<ext::shared_ptr<BlackCalibrationHelper> > &helpers,
            OptimizationMethod &method, const EndCriteria &endCriteria,
            const Constraint &constraint = Constraint(),
            const std::vector<Real> &weights = std::vector<Real>());

    const Array &reversion() const;

    const Array &volatility() const;

    // Calibrated Model functions
    Array params() const;
    void calibrate(
            const std::vector<ext::shared_ptr<CalibrationHelper> >& instruments,
            OptimizationMethod& method, const EndCriteria& endCriteria,
            const Constraint& constraint = Constraint(),
            const std::vector<Real>& weights = std::vector<Real>(),
            const std::vector<bool>& fixParameters = std::vector<bool>());
    void setParams(const Array& params);
    Real value(const Array& params,
               const std::vector<ext::shared_ptr<CalibrationHelper> >& instruments);
    const ext::shared_ptr<Constraint>& constraint() const;
    EndCriteria::Type endCriteria() const;
    const Array& problemValues() const;
    Integer functionEvaluation() const;
};


%rename (MarkovFunctionalSettings) MarkovFunctional::ModelSettings;
%feature ("flatnested") ModelSettings;

%shared_ptr(MarkovFunctional)
class MarkovFunctional : public Gaussian1dModel {
    #if defined(SWIGCSHARP)
    %rename("parameters") params;
    #endif
  public:
  
    struct ModelSettings {
       enum Adjustments {
            AdjustNone = 0,
            AdjustDigitals = 1 << 0,
            AdjustYts = 1 << 1,
            ExtrapolatePayoffFlat = 1 << 2,
            NoPayoffExtrapolation = 1 << 3,
            KahaleSmile = 1 << 4,
            SmileExponentialExtrapolation = 1 << 5,
            KahaleInterpolation = 1 << 6,
            SmileDeleteArbitragePoints = 1 << 7,
            SabrSmile = 1 << 8
        };

        ModelSettings();
        
        ModelSettings(Size yGridPoints, Real yStdDevs, Size gaussHermitePoints,
                      Real digitalGap, Real marketRateAccuracy,
                      Real lowerRateBound, Real upperRateBound,
                      int adjustments,
                      const std::vector<Real>& smileMoneyCheckpoints = std::vector<Real>());
        void validate();
    };

    // Constructor for a swaption smile calibrated model
    MarkovFunctional(const Handle<YieldTermStructure> &termStructure,
                     const Real reversion,
                     const std::vector<Date> &volstepdates,
                     const std::vector<Real> &volatilities,
                     const Handle<SwaptionVolatilityStructure> &swaptionVol,
                     const std::vector<Date> &swaptionExpiries,
                     const std::vector<Period> &swaptionTenors,
                     const ext::shared_ptr<SwapIndex> &swapIndexBase,
                     const MarkovFunctional::ModelSettings &modelSettings =
                         ModelSettings());
    
    // Constructor for a caplet smile calibrated model
    MarkovFunctional(const Handle<YieldTermStructure> &termStructure,
                     const Real reversion,
                     const std::vector<Date> &volstepdates,
                     const std::vector<Real> &volatilities,
                     const Handle<OptionletVolatilityStructure> &capletVol,
                     const std::vector<Date> &capletExpiries,
                     const ext::shared_ptr<IborIndex> &iborIndex,
                     const MarkovFunctional::ModelSettings &modelSettings =
                         ModelSettings());
                         
    const Array &volatility();

    void calibrate(
        const std::vector<ext::shared_ptr<CalibrationHelper> > &helper,
        OptimizationMethod &method, const EndCriteria &endCriteria,
        const Constraint &constraint = Constraint(),
        const std::vector<Real> &weights = std::vector<Real>(),
        const std::vector<bool> &fixParameters = std::vector<bool>());  

    //  Calibrated Model functions
    Array params() const;
    void setParams(const Array& params);
    Real value(const Array& params,
               const std::vector<ext::shared_ptr<CalibrationHelper> >& instruments);
    const ext::shared_ptr<Constraint>& constraint() const;
    EndCriteria::Type endCriteria() const;
    const Array& problemValues() const;
    Integer functionEvaluation() const;
};

// Pricing Engines

%{
using QuantLib::Gaussian1dCapFloorEngine;
using QuantLib::Gaussian1dSwaptionEngine;
using QuantLib::Gaussian1dJamshidianSwaptionEngine;
using QuantLib::Gaussian1dNonstandardSwaptionEngine;
using QuantLib::Gaussian1dFloatFloatSwaptionEngine;
%}

%shared_ptr(Gaussian1dCapFloorEngine)
class Gaussian1dCapFloorEngine : public PricingEngine {
  public:
    Gaussian1dCapFloorEngine(const ext::shared_ptr<Gaussian1dModel> &model,
                             const int integrationPoints = 64, const Real stddevs = 7.0,
                             const bool extrapolatePayoff = true,
                             const bool flatPayoffExtrapolation = false,
                             const Handle<YieldTermStructure> &discountCurve =
                                                           Handle<YieldTermStructure>());
};

%shared_ptr(Gaussian1dSwaptionEngine)
class Gaussian1dSwaptionEngine : public PricingEngine {
    #if defined(SWIGPYTHON)
    %rename(NoProb) None;
    #endif
  public:
    enum Probabilities { None, Naive, Digital };
    Gaussian1dSwaptionEngine(const ext::shared_ptr<Gaussian1dModel> &model,
                             const int integrationPoints = 64, const Real stddevs = 7.0,
                             const bool extrapolatePayoff = true,
                             const bool flatPayoffExtrapolation = false,
                             const Handle<YieldTermStructure> &discountCurve =
                                                           Handle<YieldTermStructure>(),
                             const Gaussian1dSwaptionEngine::Probabilities probabilities =
                                                        Gaussian1dSwaptionEngine::None);
};

%shared_ptr(Gaussian1dJamshidianSwaptionEngine)
class Gaussian1dJamshidianSwaptionEngine : public PricingEngine {
  public:
    Gaussian1dJamshidianSwaptionEngine(const ext::shared_ptr<Gaussian1dModel>& model);
};

%shared_ptr(Gaussian1dNonstandardSwaptionEngine)
class Gaussian1dNonstandardSwaptionEngine : public PricingEngine {
    #if defined(SWIGPYTHON)
    %rename(NoProb) None;
    #endif
  public:
    enum Probabilities { None, Naive, Digital };
    Gaussian1dNonstandardSwaptionEngine(
            const ext::shared_ptr<Gaussian1dModel> &model,
            const int integrationPoints = 64, const Real stddevs = 7.0,
            const bool extrapolatePayoff = true,
            const bool flatPayoffExtrapolation = false,
            const Handle<Quote> &oas = Handle<Quote>(), // continuously
                                                        // compounded w.r.t. yts
                                                        // daycounter
            const Handle<YieldTermStructure> &discountCurve =
                                                 Handle<YieldTermStructure>(),
            const Gaussian1dNonstandardSwaptionEngine::Probabilities probabilities =
                                   Gaussian1dNonstandardSwaptionEngine::None);
};

%shared_ptr(Gaussian1dFloatFloatSwaptionEngine)
class Gaussian1dFloatFloatSwaptionEngine : public PricingEngine {
    #if defined(SWIGPYTHON)
    %rename(NoProb) None;
    #endif
  public:
    enum Probabilities {  None,
                          Naive,
                          Digital };
    Gaussian1dFloatFloatSwaptionEngine(
                const ext::shared_ptr<Gaussian1dModel> &model,
                const int integrationPoints = 64, const Real stddevs = 7.0,
                const bool extrapolatePayoff = true,
                const bool flatPayoffExtrapolation = false,
                const Handle<Quote> &oas = Handle<Quote>(),
                const Handle<YieldTermStructure> &discountCurve =
                                                 Handle<YieldTermStructure>(),
                const bool includeTodaysExercise = false,
                const Gaussian1dFloatFloatSwaptionEngine::Probabilities probabilities =
                                    Gaussian1dFloatFloatSwaptionEngine::None);
};

#endif