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
|
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2009 Ferdinando Ametrano
Copyright (C) 2017 Joseph Jeisman
Copyright (C) 2017 Fabrice Lecuyer
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 makeois.hpp
\brief Helper class to instantiate overnight indexed swaps.
*/
#ifndef quantlib_makeois_hpp
#define quantlib_makeois_hpp
#include <ql/instruments/overnightindexedswap.hpp>
#include <ql/time/dategenerationrule.hpp>
#include <ql/termstructures/yieldtermstructure.hpp>
namespace QuantLib {
//! helper class
/*! This class provides a more comfortable way
to instantiate overnight indexed swaps.
*/
class MakeOIS {
public:
MakeOIS(const Period& swapTenor,
const ext::shared_ptr<OvernightIndex>& overnightIndex,
Rate fixedRate = Null<Rate>(),
const Period& fwdStart = 0*Days);
operator OvernightIndexedSwap() const;
operator ext::shared_ptr<OvernightIndexedSwap>() const ;
MakeOIS& receiveFixed(bool flag = true);
MakeOIS& withType(Swap::Type type);
MakeOIS& withNominal(Real n);
MakeOIS& withSettlementDays(Natural settlementDays);
MakeOIS& withEffectiveDate(const Date&);
MakeOIS& withTerminationDate(const Date&);
MakeOIS& withRule(DateGeneration::Rule r);
MakeOIS& withFixedLegRule(DateGeneration::Rule r);
MakeOIS& withOvernightLegRule(DateGeneration::Rule r);
MakeOIS& withPaymentFrequency(Frequency f);
MakeOIS& withFixedLegPaymentFrequency(Frequency f);
MakeOIS& withOvernightLegPaymentFrequency(Frequency f);
MakeOIS& withPaymentAdjustment(BusinessDayConvention convention);
MakeOIS& withPaymentLag(Integer lag);
MakeOIS& withPaymentCalendar(const Calendar& cal);
MakeOIS& withCalendar(const Calendar& cal);
MakeOIS& withFixedLegCalendar(const Calendar& cal);
MakeOIS& withOvernightLegCalendar(const Calendar& cal);
MakeOIS& withConvention(BusinessDayConvention bdc);
MakeOIS& withFixedLegConvention(BusinessDayConvention bdc);
MakeOIS& withOvernightLegConvention(BusinessDayConvention bdc);
MakeOIS& withTerminationDateConvention(BusinessDayConvention bdc);
MakeOIS& withFixedLegTerminationDateConvention(BusinessDayConvention bdc);
MakeOIS& withOvernightLegTerminationDateConvention(BusinessDayConvention bdc);
MakeOIS& withEndOfMonth(bool flag = true);
MakeOIS& withFixedLegEndOfMonth(bool flag = true);
MakeOIS& withOvernightLegEndOfMonth(bool flag = true);
MakeOIS& withFixedLegDayCount(const DayCounter& dc);
MakeOIS& withOvernightLegSpread(Spread sp);
MakeOIS& withDiscountingTermStructure(
const Handle<YieldTermStructure>& discountingTermStructure);
MakeOIS &withTelescopicValueDates(bool telescopicValueDates);
MakeOIS& withAveragingMethod(RateAveraging::Type averagingMethod);
MakeOIS& withLookbackDays(Natural lookbackDays);
MakeOIS& withLockoutDays(Natural lockoutDays);
MakeOIS& withObservationShift(bool applyObservationShift = true);
MakeOIS& withPricingEngine(
const ext::shared_ptr<PricingEngine>& engine);
private:
Period swapTenor_;
ext::shared_ptr<OvernightIndex> overnightIndex_;
Rate fixedRate_;
Period forwardStart_;
Natural settlementDays_ = Null<Natural>();
Date effectiveDate_, terminationDate_;
Calendar fixedCalendar_, overnightCalendar_;
Frequency fixedPaymentFrequency_ = Annual;
Frequency overnightPaymentFrequency_ = Annual;
Calendar paymentCalendar_;
BusinessDayConvention paymentAdjustment_ = Following;
Integer paymentLag_ = 0;
BusinessDayConvention fixedConvention_ = ModifiedFollowing,
fixedTerminationDateConvention_ = ModifiedFollowing,
overnightConvention_ = ModifiedFollowing,
overnightTerminationDateConvention_ = ModifiedFollowing;
DateGeneration::Rule fixedRule_ = DateGeneration::Backward;
DateGeneration::Rule overnightRule_ = DateGeneration::Backward;
bool fixedEndOfMonth_ = false, overnightEndOfMonth_ = false, isDefaultEOM_ = true;
Swap::Type type_ = Swap::Payer;
Real nominal_ = 1.0;
Spread overnightSpread_ = 0.0;
DayCounter fixedDayCount_;
ext::shared_ptr<PricingEngine> engine_;
bool telescopicValueDates_ = false;
RateAveraging::Type averagingMethod_ = RateAveraging::Compound;
Natural lookbackDays_ = Null<Natural>();
Natural lockoutDays_ = 0;
bool applyObservationShift_ = false;
};
}
#endif
|
