QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
Loading...
Searching...
No Matches
piecewisezeroinflationcurve.hpp
Go to the documentation of this file.
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
3/*
4 Copyright (C) 2007 Chris Kenyon
5 Copyright (C) 2007, 2008 StatPro Italia srl
6 Copyright (C) 2011 Ferdinando Ametrano
7
8 This file is part of QuantLib, a free-software/open-source library
9 for financial quantitative analysts and developers - http://quantlib.org/
10
11 QuantLib is free software: you can redistribute it and/or modify it
12 under the terms of the QuantLib license. You should have received a
13 copy of the license along with this program; if not, please email
14 <quantlib-dev@lists.sf.net>. The license is also available online at
15 <http://quantlib.org/license.shtml>.
16
17 This program is distributed in the hope that it will be useful, but WITHOUT
18 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 FOR A PARTICULAR PURPOSE. See the license for more details.
20*/
21
22/*! \file piecewisezeroinflationcurve.hpp
23 \brief Piecewise zero-inflation term structure
24*/
25
26#ifndef quantlib_piecewise_zero_inflation_curve_hpp
27#define quantlib_piecewise_zero_inflation_curve_hpp
28
32#include <utility>
33
34namespace QuantLib {
35
36 //! Piecewise zero-inflation term structure
37 template <class Interpolator,
38 template <class> class Bootstrap = IterativeBootstrap,
39 class Traits = ZeroInflationTraits>
41 : public InterpolatedZeroInflationCurve<Interpolator>,
42 public LazyObject {
43 private:
47 public:
48 typedef Traits traits_type;
49 typedef Interpolator interpolator_type;
50
51 //! \name Constructors
52 //@{
54 const Date& referenceDate,
58 std::vector<ext::shared_ptr<typename Traits::helper> > instruments,
59 const ext::shared_ptr<Seasonality>& seasonality = {},
60 Real accuracy = 1.0e-14,
61 const Interpolator& i = Interpolator())
67 i),
68 instruments_(std::move(instruments)), accuracy_(accuracy) {
69 bootstrap_.setup(this);
70 }
71
73
74 /*! \deprecated Use the other overload and pass the base date directly
75 instead of using a lag. A base rate is not needed.
76 Deprecated in version 1.34.
77 */
80 const Date& referenceDate,
81 const Calendar& calendar,
83 const Period& lag,
85 Rate baseZeroRate,
86 std::vector<ext::shared_ptr<typename Traits::helper> > instruments,
87 Real accuracy = 1.0e-12,
88 const Interpolator& i = Interpolator())
92 lag,
94 baseZeroRate,
95 i),
96 instruments_(std::move(instruments)), accuracy_(accuracy) {
97 bootstrap_.setup(this);
98 }
99
101 //@}
102
103 //! \name Inflation interface
104 //@{
105 Date baseDate() const override;
106 Date maxDate() const override;
107 //@
108 //! \name Inspectors
109 //@{
110 const std::vector<Time>& times() const;
111 const std::vector<Date>& dates() const;
112 const std::vector<Real>& data() const;
113 std::vector<std::pair<Date, Real> > nodes() const;
114 //@}
115 //! \name Observer interface
116 //@{
117 void update() override;
118 //@}
119 private:
120 // methods
121 void performCalculations() const override;
122 // data members
123 std::vector<ext::shared_ptr<typename Traits::helper> > instruments_;
125
126 friend class Bootstrap<this_curve>;
127 friend class BootstrapError<this_curve>;
129 };
130
131
132 // inline and template definitions
133
134 template <class I, template <class> class B, class T>
136 if (!this->hasExplicitBaseDate())
137 this->calculate();
138 return base_curve::baseDate();
139 }
140
141 template <class I, template <class> class B, class T>
143 this->calculate();
144 return base_curve::maxDate();
145 }
146
147 template <class I, template <class> class B, class T>
148 const std::vector<Time>& PiecewiseZeroInflationCurve<I,B,T>::times() const {
149 calculate();
150 return base_curve::times();
151 }
152
153 template <class I, template <class> class B, class T>
154 const std::vector<Date>& PiecewiseZeroInflationCurve<I,B,T>::dates() const {
155 calculate();
156 return base_curve::dates();
157 }
158
159 template <class I, template <class> class B, class T>
160 const std::vector<Real>& PiecewiseZeroInflationCurve<I,B,T>::data() const {
161 calculate();
162 return base_curve::rates();
163 }
164
165 template <class I, template <class> class B, class T>
166 std::vector<std::pair<Date, Real> >
168 calculate();
169 return base_curve::nodes();
170 }
171
172 template <class I, template <class> class B, class T>
174 bootstrap_.calculate();
175 }
176
177 template <class I, template<class> class B, class T>
179 base_curve::update();
181 }
182
183}
184
185#endif
calendar class
Definition: calendar.hpp:61
Concrete date class.
Definition: date.hpp:125
day counter class
Definition: daycounter.hpp:44
ext::shared_ptr< Seasonality > seasonality() const
Inflation term structure based on the interpolation of zero rates.
Framework for calculation on demand and result caching.
Definition: lazyobject.hpp:35
void update() override
Definition: lazyobject.hpp:188
Piecewise zero-inflation term structure.
InterpolatedZeroInflationCurve< Interpolator > base_curve
Date baseDate() const override
minimum (base) date
const std::vector< Date > & dates() const
const std::vector< Real > & data() const
std::vector< std::pair< Date, Real > > nodes() const
const std::vector< Time > & times() const
std::vector< ext::shared_ptr< typename Traits::helper > > instruments_
Date maxDate() const override
the latest date for which the curve can return values
QL_DEPRECATED_DISABLE_WARNING QL_DEPRECATED PiecewiseZeroInflationCurve(const Date &referenceDate, const Calendar &calendar, const DayCounter &dayCounter, const Period &lag, Frequency frequency, Rate baseZeroRate, std::vector< ext::shared_ptr< typename Traits::helper > > instruments, Real accuracy=1.0e-12, const Interpolator &i=Interpolator())
PiecewiseZeroInflationCurve(const Date &referenceDate, Date baseDate, Frequency frequency, const DayCounter &dayCounter, std::vector< ext::shared_ptr< typename Traits::helper > > instruments, const ext::shared_ptr< Seasonality > &seasonality={}, Real accuracy=1.0e-14, const Interpolator &i=Interpolator())
PiecewiseZeroInflationCurve< Interpolator, Bootstrap, Traits > this_curve
virtual const Date & referenceDate() const
the date at which discount = 1.0 and/or variance = 0.0
virtual Calendar calendar() const
the calendar used for reference and/or option date calculation
virtual DayCounter dayCounter() const
the day counter used for date/time conversion
Frequency
Frequency of events.
Definition: frequency.hpp:37
QL_REAL Real
real number
Definition: types.hpp:50
Real Rate
interest rates
Definition: types.hpp:70
inflation bootstrap traits
universal piecewise-term-structure boostrapper.
framework for calculation on demand and result caching
Definition: any.hpp:35
STL namespace.
#define QL_DEPRECATED
Definition: qldefines.hpp:215
#define QL_DEPRECATED_DISABLE_WARNING
Definition: qldefines.hpp:216
#define QL_DEPRECATED_ENABLE_WARNING
Definition: qldefines.hpp:217