File: defaultprobability.i

package info (click to toggle)
quantlib-swig 1.40-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,276 kB
  • sloc: python: 6,024; java: 1,552; cs: 774; makefile: 309; sh: 22
file content (413 lines) | stat: -rw-r--r-- 14,463 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
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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
/*
 Copyright (C) 2008, 2009 StatPro Italia srl
 Copyright (C) 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_default_probability_structures_i
#define quantlib_default_probability_structures_i

%include common.i
%include types.i
%include date.i
%include calendars.i
%include daycounters.i
%include scheduler.i
%include observer.i
%include marketelements.i
%include interpolation.i
%include termstructures.i
%include piecewiseyieldcurve.i
%include bonds.i

%{
using QuantLib::DefaultProbabilityTermStructure;
%}

%shared_ptr(DefaultProbabilityTermStructure);
class DefaultProbabilityTermStructure : public TermStructure {
  private:
    DefaultProbabilityTermStructure();
  public:
    Probability defaultProbability(const Date&, bool extrapolate = false);
    Probability defaultProbability(Time, bool extrapolate = false);
    Probability defaultProbability(const Date&, const Date&,
                                   bool extrapolate = false);
    Probability defaultProbability(Time, Time, bool extrapolate = false);

    Probability survivalProbability(const Date&, bool extrapolate = false);
    Probability survivalProbability(Time, bool extrapolate = false);

    Real defaultDensity(const Date&, bool extrapolate = false);
    Real defaultDensity(Time, bool extrapolate = false);

    Real hazardRate(const Date&, bool extrapolate = false);
    Real hazardRate(Time, bool extrapolate = false);
};


%template(DefaultProbabilityTermStructureHandle)
Handle<DefaultProbabilityTermStructure>;
%template(RelinkableDefaultProbabilityTermStructureHandle)
RelinkableHandle<DefaultProbabilityTermStructure>;


// concrete curves


// flat forward curve

%{
using QuantLib::FlatHazardRate;
%}

%shared_ptr(FlatHazardRate);
class FlatHazardRate : public DefaultProbabilityTermStructure {
  public:
    FlatHazardRate(Integer settlementDays,
                   const Calendar& calendar,
                   const Handle<Quote>& hazardRate,
                   const DayCounter& dayCounter);
    FlatHazardRate(const Date& todaysDate,
                   const Handle<Quote>& hazardRate,
                   const DayCounter& dayCounter);
};


%{
using QuantLib::InterpolatedHazardRateCurve;
%}

// add other instantiations both here and below the class
%shared_ptr(InterpolatedHazardRateCurve<BackwardFlat>);

template <class Interpolator>
class InterpolatedHazardRateCurve : public DefaultProbabilityTermStructure {
  public:
    InterpolatedHazardRateCurve(const std::vector<Date>& dates,
                                const std::vector<Real>& hazardRates,
                                const DayCounter& dayCounter,
                                const Calendar& calendar = Calendar(),
                                const Interpolator& i = Interpolator());
    const std::vector<Date>& dates() const;
    const std::vector<Real>& hazardRates() const;
    #if !defined(SWIGR)
    std::vector<std::pair<Date,Real> > nodes() const;
    #endif
};

%template(HazardRateCurve) InterpolatedHazardRateCurve<BackwardFlat>;


%{
using QuantLib::InterpolatedDefaultDensityCurve;
%}

// add other instantiations both here and below the class
%shared_ptr(InterpolatedDefaultDensityCurve<Linear>);

template <class Interpolator>
class InterpolatedDefaultDensityCurve : public DefaultProbabilityTermStructure {
  public:
    InterpolatedDefaultDensityCurve(const std::vector<Date>& dates,
                                    const std::vector<Real>& densities,
                                    const DayCounter& dayCounter,
                                    const Calendar& calendar = Calendar(),
                                    const Interpolator& i = Interpolator());
    const std::vector<Date>& dates() const;
    const std::vector<Real>& defaultDensities() const;
    #if !defined(SWIGR)
    std::vector<std::pair<Date,Real> > nodes() const;
    #endif
};

%template(DefaultDensityCurve) InterpolatedDefaultDensityCurve<Linear>;


%{
using QuantLib::InterpolatedSurvivalProbabilityCurve;
%}

// add other instantiations both here and below the class
%shared_ptr(InterpolatedSurvivalProbabilityCurve<Linear>);

template <class Interpolator>
class InterpolatedSurvivalProbabilityCurve : public DefaultProbabilityTermStructure {
  public:
    InterpolatedSurvivalProbabilityCurve(const std::vector<Date>& dates,
                                         const std::vector<Probability>& probabilities,
                                         const DayCounter& dayCounter,
                                         const Calendar& calendar = Calendar(),
                                         const Interpolator& i = Interpolator());
    const std::vector<Date>& dates() const;
    const std::vector<Probability>& survivalProbabilities() const;
    #if !defined(SWIGR)
    std::vector<std::pair<Date,Real> > nodes() const;
    #endif
};

%template(SurvivalProbabilityCurve) InterpolatedSurvivalProbabilityCurve<Linear>;


%{
using QuantLib::DefaultProbabilityHelper;
using QuantLib::SpreadCdsHelper;
using QuantLib::UpfrontCdsHelper;
%}

// rate helpers for curve bootstrapping

%shared_ptr(DefaultProbabilityHelper)
class DefaultProbabilityHelper : public Observable {
  public:
    Handle<Quote> quote() const;
    Date latestDate() const;
    Date earliestDate() const;
    Date maturityDate() const;
    Date latestRelevantDate() const;
    Date pillarDate() const;
    Real impliedQuote() const;
    Real quoteError() const;
  private:
    DefaultProbabilityHelper();
};

#if defined(SWIGCSHARP)
SWIG_STD_VECTOR_ENHANCED( ext::shared_ptr<DefaultProbabilityHelper> )
#endif
namespace std {
    %template(DefaultProbabilityHelperVector)
    vector<ext::shared_ptr<DefaultProbabilityHelper> >;
}


%shared_ptr(SpreadCdsHelper)
class SpreadCdsHelper : public DefaultProbabilityHelper {
  public:
    #if defined(SWIGPYTHON)
    %feature("kwargs") SpreadCdsHelper;
    SpreadCdsHelper(
            const std::variant<Real, Handle<Quote>>& spread,
            const Period& tenor,
            Integer settlementDays,
            const Calendar& calendar,
            Frequency frequency,
            BusinessDayConvention convention,
            DateGeneration::Rule rule,
            const DayCounter& dayCounter,
            Real recoveryRate,
            const Handle<YieldTermStructure>& discountCurve,
            bool settlesAccrual = true,
            bool paysAtDefaultTime = true,
            const Date& startDate = Date(),
            const DayCounter& lastPeriodDayCounter = DayCounter(),
            bool rebatesAccrual = true,
            CreditDefaultSwap::PricingModel model = CreditDefaultSwap::Midpoint);
    #else
    SpreadCdsHelper(
            const Handle<Quote>& spread,
            const Period& tenor,
            Integer settlementDays,
            const Calendar& calendar,
            Frequency frequency,
            BusinessDayConvention convention,
            DateGeneration::Rule rule,
            const DayCounter& dayCounter,
            Real recoveryRate,
            const Handle<YieldTermStructure>& discountCurve,
            bool settlesAccrual = true,
            bool paysAtDefaultTime = true,
            const Date& startDate = Date(),
            const DayCounter& lastPeriodDayCounter = DayCounter(),
            bool rebatesAccrual = true,
            CreditDefaultSwap::PricingModel model = CreditDefaultSwap::Midpoint);
    SpreadCdsHelper(
            Rate spread,
            const Period& tenor,
            Integer settlementDays,
            const Calendar& calendar,
            Frequency frequency,
            BusinessDayConvention convention,
            DateGeneration::Rule rule,
            const DayCounter& dayCounter,
            Real recoveryRate,
            const Handle<YieldTermStructure>& discountCurve,
            bool settlesAccrual = true,
            bool paysAtDefaultTime = true,
            const Date& startDate = Date(),
            const DayCounter& lastPeriodDayCounter = DayCounter(),
            bool rebatesAccrual = true,
            CreditDefaultSwap::PricingModel model = CreditDefaultSwap::Midpoint);
    #endif
};


%shared_ptr(UpfrontCdsHelper)
class UpfrontCdsHelper : public DefaultProbabilityHelper {
  public:
    #if defined(SWIGPYTHON)
    %feature("kwargs") UpfrontCdsHelper;
    UpfrontCdsHelper(
            const std::variant<Real, Handle<Quote>>& upfront,
            Rate spread,
            const Period& tenor,
            Integer settlementDays,
            const Calendar& calendar,
            Frequency frequency,
            BusinessDayConvention convention,
            DateGeneration::Rule rule,
            const DayCounter& dayCounter,
            Real recoveryRate,
            const Handle<YieldTermStructure>& discountCurve,
            Natural upfrontSettlementDays=0,
            bool settlesAccrual = true,
            bool paysAtDefaultTime = true,
            const Date& startDate = Date(),
            const DayCounter& lastPeriodDayCounter = DayCounter(),
            bool rebatesAccrual = true,
            CreditDefaultSwap::PricingModel model = CreditDefaultSwap::Midpoint);
    #else
    UpfrontCdsHelper(
            const Handle<Quote>& upfront,
            Rate spread,
            const Period& tenor,
            Integer settlementDays,
            const Calendar& calendar,
            Frequency frequency,
            BusinessDayConvention convention,
            DateGeneration::Rule rule,
            const DayCounter& dayCounter,
            Real recoveryRate,
            const Handle<YieldTermStructure>& discountCurve,
            Natural upfrontSettlementDays=0,
            bool settlesAccrual = true,
            bool paysAtDefaultTime = true,
            const Date& startDate = Date(),
            const DayCounter& lastPeriodDayCounter = DayCounter(),
            bool rebatesAccrual = true,
            CreditDefaultSwap::PricingModel model = CreditDefaultSwap::Midpoint);
    UpfrontCdsHelper(
            Rate upfront,
            Rate spread,
            const Period& tenor,
            Integer settlementDays,
            const Calendar& calendar,
            Frequency frequency,
            BusinessDayConvention convention,
            DateGeneration::Rule rule,
            const DayCounter& dayCounter,
            Real recoveryRate,
            const Handle<YieldTermStructure>& discountCurve,
            Natural upfrontSettlementDays=0,
            bool settlesAccrual = true,
            bool paysAtDefaultTime = true,
            const Date& startDate = Date(),
            const DayCounter& lastPeriodDayCounter = DayCounter(),
            bool rebatesAccrual = true,
            CreditDefaultSwap::PricingModel model = CreditDefaultSwap::Midpoint);
    #endif
};



// bootstrap traits

%{
using QuantLib::HazardRate;
using QuantLib::DefaultDensity;
%}

struct HazardRate {};
struct DefaultDensity {};

// curve

%{
using QuantLib::PiecewiseDefaultCurve;
%}

/* We have to resort to a macro, because the R implementation of shared_ptr
   can't take class templates with two or more template arguments. */

%define export_piecewise_default_curve(Name,Traits,Interpolator)

%{
typedef PiecewiseDefaultCurve<Traits, Interpolator> Name;
%}

%shared_ptr(Name);
class Name : public DefaultProbabilityTermStructure {
  public:
    %extend {
        Name(const Date& referenceDate,
             const std::vector<ext::shared_ptr<DefaultProbabilityHelper> >& instruments,
             const DayCounter& dayCounter,
             const Interpolator& i = Interpolator(),
             const _IterativeBootstrap& b = _IterativeBootstrap()) {
            return new Name(referenceDate, instruments, dayCounter,
                            i, Name::bootstrap_type(b.accuracy, b.minValue, b.maxValue));
        }
        Name(Integer settlementDays, const Calendar& calendar,
             const std::vector<ext::shared_ptr<DefaultProbabilityHelper> >& instruments,
             const DayCounter& dayCounter,
             const Interpolator& i = Interpolator(),
             const _IterativeBootstrap& b = _IterativeBootstrap()) {
            return new Name(settlementDays, calendar, instruments, dayCounter,
                            i, Name::bootstrap_type(b.accuracy, b.minValue, b.maxValue));
        }
        Name(const Date& referenceDate,
             const std::vector<ext::shared_ptr<DefaultProbabilityHelper> >& instruments,
             const DayCounter& dayCounter,
             const _IterativeBootstrap& b) {
            return new Name(referenceDate, instruments, dayCounter,
                            Interpolator(), Name::bootstrap_type(b.accuracy, b.minValue, b.maxValue));
        }
        Name(Integer settlementDays, const Calendar& calendar,
             const std::vector<ext::shared_ptr<DefaultProbabilityHelper> >& instruments,
             const DayCounter& dayCounter,
             const _IterativeBootstrap& b) {
            return new Name(settlementDays, calendar, instruments, dayCounter,
                            Interpolator(), Name::bootstrap_type(b.accuracy, b.minValue, b.maxValue));
        }
    }
    const std::vector<Date>& dates() const;
    const std::vector<Time>& times() const;
    #if !defined(SWIGR)
    std::vector<std::pair<Date,Real> > nodes() const;
    #endif
};

%enddef

// add other instantiations if you need them
export_piecewise_default_curve(PiecewiseFlatHazardRate,HazardRate,BackwardFlat);


// bond engine based on default probability

%{
using QuantLib::RiskyBondEngine;
%}

%shared_ptr(RiskyBondEngine)
class RiskyBondEngine : public PricingEngine {
  public:
    RiskyBondEngine(const Handle<DefaultProbabilityTermStructure>& defaultCurve,
                    Real recoveryRate,
                    const Handle<YieldTermStructure>& riskFreeCurve);
};


#endif