YoYInflationCurveObserverMoving< Interpolator > Class Template Reference

Inflation term structure based on the interpolation of zero rates. More...

#include <qle/termstructures/yoyinflationcurveobservermoving.hpp>

Inheritance diagram for YoYInflationCurveObserverMoving< Interpolator >:

Collaboration diagram for YoYInflationCurveObserverMoving< Interpolator >:

Public Member Functions
	YoYInflationCurveObserverMoving (Natural settlementDays, const Calendar &calendar, const DayCounter &dayCounter, const Period &lag, Frequency frequency, bool indexIsInterpolated, const std::vector< Time > &times, const std::vector< Handle< Quote > > &rates, const QuantLib::ext::shared_ptr< Seasonality > &seasonality=QuantLib::ext::shared_ptr< Seasonality >(), const Interpolator &interpolator=Interpolator())
InflationTermStructure interface
Date	baseDate () const override
Time	maxTime () const override
Date	maxDate () const override
Inspectors
const std::vector< Time > &	times () const
const std::vector< Real > &	data () const
const std::vector< Rate > &	rates () const
const std::vector< Handle< Quote > > &	quotes () const
Observer interface
void	update () override

Private Member Functions
LazyObject interface
void	performCalculations () const override

YoYInflationTermStructure Interface
std::vector< Handle< Quote > >	quotes_
bool	indexIsInterpolated_
Date	baseDate_
Rate	yoyRateImpl (Time t) const override

Detailed Description

template<class Interpolator>
class QuantExt::YoYInflationCurveObserverMoving< Interpolator >

Inflation term structure based on the interpolation of zero rates.

Definition at line 40 of file yoyinflationcurveobservermoving.hpp.

Constructor & Destructor Documentation

YoYInflationCurveObserverMoving()

YoYInflationCurveObserverMoving	(	Natural	settlementDays,
		const Calendar &	calendar,
		const DayCounter &	dayCounter,
		const Period &	lag,
		Frequency	frequency,
		bool	indexIsInterpolated,
		const std::vector< Time > &	times,
		const std::vector< Handle< Quote > > &	rates,
		const QuantLib::ext::shared_ptr< Seasonality > &	seasonality = QuantLib::ext::shared_ptr<Seasonality>(),
		const Interpolator &	interpolator = Interpolator()
	)

Definition at line 91 of file yoyinflationcurveobservermoving.hpp.

    : YoYInflationTermStructure(settlementDays, calendar, dayCounter, rates[0]->value(), lag, frequency, indexIsInterpolated, seasonality),
      InterpolatedCurve<Interpolator>(std::vector<Time>(), std::vector<Real>(), interpolator), quotes_(rates), indexIsInterpolated_(indexIsInterpolated) {
 
    QL_REQUIRE(times.size() > 1, "too few times: " << times.size());
    this->times_.resize(times.size());
    this->times_[0] = times[0];
    for (Size i = 1; i < times.size(); i++) {
        QL_REQUIRE(times[i] > times[i - 1], "times not sorted");
        this->times_[i] = times[i];
    }
 
    QL_REQUIRE(this->quotes_.size() == this->times_.size(),
               "quotes/times count mismatch: " << this->quotes_.size() << " vs " << this->times_.size());
 
    // initialise data vector, values are copied from quotes in performCalculations()
    this->data_.resize(this->times_.size());
    for (Size i = 0; i < this->times_.size(); i++)
        this->data_[0] = 0.0;
 
    this->interpolation_ =
        this->interpolator_.interpolate(this->times_.begin(), this->times_.end(), this->data_.begin());
    this->interpolation_.update();
 
    // register with each of the quotes
    for (Size i = 0; i < this->quotes_.size(); i++)
        registerWith(this->quotes_[i]);
}

Here is the call graph for this function:

Member Function Documentation

baseDate()

Date baseDate

override

Definition at line 124 of file yoyinflationcurveobservermoving.hpp.

                                                                           {
    // if indexIsInterpolated we fixed the dates in the constructor
    calculate();
    return baseDate_;
}

maxTime()

Time maxTime

override

Definition at line 130 of file yoyinflationcurveobservermoving.hpp.

{ return this->times_.back(); }

maxDate()

Date maxDate

override

Definition at line 132 of file yoyinflationcurveobservermoving.hpp.

{ return this->maxDate_; }

times()

const std::vector< Time > & times

Definition at line 139 of file yoyinflationcurveobservermoving.hpp.

                                                                                                 {
    return this->times_;
}

Here is the caller graph for this function:

data()

const std::vector< Real > & data

Definition at line 148 of file yoyinflationcurveobservermoving.hpp.

                                                                                                {
    calculate();
    return this->data_;
}

rates()

const std::vector< Rate > & rates

Definition at line 143 of file yoyinflationcurveobservermoving.hpp.

                                                                                                 {
    calculate();
    return this->data_;
}

quotes()

const std::vector< Handle< Quote > > & quotes

(

)

const

Definition at line 64 of file yoyinflationcurveobservermoving.hpp.

{ return quotes_; };

update()

void update

override

Definition at line 153 of file yoyinflationcurveobservermoving.hpp.

                                                                          {
    LazyObject::update();
    YoYInflationTermStructure::update();
}

performCalculations()

void performCalculations

overrideprivate

Definition at line 158 of file yoyinflationcurveobservermoving.hpp.

                                                                                             {
    Date d = Settings::instance().evaluationDate();
    Date d0 = d - this->observationLag();
    if (!indexIsInterpolated_) {
        baseDate_ = inflationPeriod(d0, this->frequency_).first;
    } else {
        baseDate_ = d0;
    }
 
    for (Size i = 0; i < this->times_.size(); ++i)
        this->data_[i] = quotes_[i]->value();
    this->interpolation_ =
        this->interpolator_.interpolate(this->times_.begin(), this->times_.end(), this->data_.begin());
    this->interpolation_.update();
}

yoyRateImpl()

Rate yoyRateImpl ( Time  t ) const

overrideprotected

Definition at line 134 of file yoyinflationcurveobservermoving.hpp.

                                                                                           {
    calculate();
    return this->interpolation_(t, true);
}

Member Data Documentation

quotes_

std::vector<Handle<Quote> > quotes_

protected

Definition at line 83 of file yoyinflationcurveobservermoving.hpp.

indexIsInterpolated_

bool indexIsInterpolated_

protected

Definition at line 84 of file yoyinflationcurveobservermoving.hpp.

baseDate_

Date baseDate_

mutableprotected

Definition at line 85 of file yoyinflationcurveobservermoving.hpp.