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
|
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2006, 2007 Ferdinando Ametrano
Copyright (C) 2007 StatPro Italia srl
Copyright (C) 2009 Chris Kenyon
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 makeyoyinflationcapfloor.hpp
\brief Helper class to instantiate standard yoy inflation cap/floor.
*/
#ifndef quantlib_instruments_make_yoyinflation_capfloor_hpp
#define quantlib_instruments_make_yoyinflation_capfloor_hpp
#include <ql/instruments/inflationcapfloor.hpp>
#include <ql/instruments/makevanillaswap.hpp>
namespace QuantLib {
//! helper class
/*! This class provides a more comfortable way to instantiate
standard yoy inflation cap and floor.
*/
class MakeYoYInflationCapFloor {
public:
MakeYoYInflationCapFloor(YoYInflationCapFloor::Type capFloorType,
ext::shared_ptr<YoYInflationIndex> index,
const Size& length,
Calendar cal,
const Period& observationLag,
CPI::InterpolationType interpolation);
/*! \deprecated Use the overload that passes an interpolation type instead.
Deprecated in version 1.36.
*/
[[deprecated("Use the overload that passes an interpolation type instead")]]
MakeYoYInflationCapFloor(YoYInflationCapFloor::Type capFloorType,
ext::shared_ptr<YoYInflationIndex> index,
const Size& length,
Calendar cal,
const Period& observationLag);
MakeYoYInflationCapFloor& withNominal(Real n);
MakeYoYInflationCapFloor& withEffectiveDate(const Date& effectiveDate);
MakeYoYInflationCapFloor& withFirstCapletExcluded();
MakeYoYInflationCapFloor& withPaymentDayCounter(const DayCounter&);
MakeYoYInflationCapFloor& withPaymentAdjustment(BusinessDayConvention);
MakeYoYInflationCapFloor& withFixingDays(Natural fixingDays);
MakeYoYInflationCapFloor& withPricingEngine(
const ext::shared_ptr<PricingEngine>& engine);
//! only get last coupon
MakeYoYInflationCapFloor& asOptionlet(bool b = true);
MakeYoYInflationCapFloor& withStrike(Rate strike);
MakeYoYInflationCapFloor& withAtmStrike(
const Handle<YieldTermStructure>& nominalTermStructure);
MakeYoYInflationCapFloor& withForwardStart(Period forwardStart);
operator YoYInflationCapFloor() const;
operator ext::shared_ptr<YoYInflationCapFloor>() const ;
private:
YoYInflationCapFloor::Type capFloorType_;
Size length_;
Calendar calendar_;
ext::shared_ptr<YoYInflationIndex> index_;
Period observationLag_;
CPI::InterpolationType interpolation_;
Rate strike_;
bool firstCapletExcluded_ = false, asOptionlet_ = false;
Date effectiveDate_;
Period forwardStart_;
DayCounter dayCounter_;
BusinessDayConvention roll_ = ModifiedFollowing;
Natural fixingDays_ = 0;
Real nominal_ = 1000000.0;
Handle<YieldTermStructure> nominalTermStructure_;
ext::shared_ptr<PricingEngine> engine_;
};
}
#endif
|
