YoYInflationCurveObserverStatic< Interpolator > Class Template Reference

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

#include <qle/termstructures/yoyinflationcurveobserverstatic.hpp>

Inheritance diagram for YoYInflationCurveObserverStatic< Interpolator >:

Collaboration diagram for YoYInflationCurveObserverStatic< Interpolator >:

Public Member Functions
	YoYInflationCurveObserverStatic (const Date &referenceDate, const Calendar &calendar, const DayCounter &dayCounter, const Period &lag, Frequency frequency, bool indexIsInterpolated, const std::vector< Date > &dates, 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
Date	maxDate () const
Inspectors
const std::vector< Date > &	dates () const
const std::vector< Time > &	times () const
const std::vector< Real > &	data () const
const std::vector< Rate > &	rates () const
std::vector< std::pair< Date, Rate > >	nodes () const
const std::vector< Handle< Quote > > &	quotes () const
Observer interface
void	update ()

Private Member Functions
LazyObject interface
void	performCalculations () const

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

Detailed Description

template<class Interpolator>
class QuantExt::YoYInflationCurveObserverStatic< Interpolator >

Inflation term structure based on the interpolation of zero rates.

Definition at line 40 of file yoyinflationcurveobserverstatic.hpp.

Constructor & Destructor Documentation

YoYInflationCurveObserverStatic()

YoYInflationCurveObserverStatic	(	const Date &	referenceDate,
		const Calendar &	calendar,
		const DayCounter &	dayCounter,
		const Period &	lag,
		Frequency	frequency,
		bool	indexIsInterpolated,
		const std::vector< Date > &	dates,
		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 yoyinflationcurveobserverstatic.hpp.

    : YoYInflationTermStructure(referenceDate, calendar, dayCounter, rates[0]->value(), lag, frequency,
                                indexIsInterpolated, seasonality),
      InterpolatedCurve<Interpolator>(std::vector<Time>(), std::vector<Real>(), interpolator), dates_(dates),
      quotes_(rates), indexIsInterpolated_(indexIsInterpolated) {
 
    QL_REQUIRE(dates_.size() > 1, "too few dates: " << dates_.size());
 
    /**
    // check that the data starts from the beginning,
    // i.e. referenceDate - lag, at least must be in the relevant
    // period
    std::pair<Date,Date> lim =
    inflationPeriod(yTS->referenceDate() - this->observationLag(), frequency);
    QL_REQUIRE(lim.first <= dates_[0] && dates_[0] <= lim.second,
    "first data date is not in base period, date: " << dates_[0]
    << " not within [" << lim.first << "," << lim.second << "]");
    **/
 
    // by convention, if the index is not interpolated we pull all the dates
    // back to the start of their inflationPeriods
    // otherwise the time calculations will be inconsistent
    if (!indexIsInterpolated_) {
        for (Size i = 0; i < dates_.size(); i++) {
            dates_[i] = inflationPeriod(dates_[i], frequency).first;
        }
    }
 
    QL_REQUIRE(this->quotes_.size() == dates_.size(),
               "quotes/dates count mismatch: " << this->quotes_.size() << " vs " << dates_.size());
 
    // initialise data vector, values are copied from quotes in performCalculations()
    this->data_.resize(dates_.size());
    for (Size i = 0; i < dates_.size(); i++)
        this->data_[0] = 0.0;
 
    this->times_.resize(dates_.size());
    this->times_[0] = timeFromReference(dates_[0]);
    for (Size i = 1; i < dates_.size(); i++) {
        QL_REQUIRE(dates_[i] > dates_[i - 1], "dates not sorted");
 
        // but must be greater than -1
        QL_REQUIRE(this->data_[i] > -1.0, "zero inflation data < -100 %");
 
        // this can be negative
        this->times_[i] = timeFromReference(dates_[i]);
        QL_REQUIRE(!close(this->times_[i], this->times_[i - 1]), "two dates correspond to the same time "
                                                                 "under this curve's day count convention");
    }
 
    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 < quotes_.size(); i++)
        registerWith(quotes_[i]);
}

Member Function Documentation

baseDate()

Date baseDate

Definition at line 154 of file yoyinflationcurveobserverstatic.hpp.

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

maxDate()

Date maxDate

Definition at line 160 of file yoyinflationcurveobserverstatic.hpp.

                                                                          {
    Date d;
    if (indexIsInterpolated()) {
        d = dates_.back();
    } else {
        d = inflationPeriod(dates_.back(), frequency()).second;
    }
    return d;
}

dates()

const std::vector< Date > & dates

Definition at line 179 of file yoyinflationcurveobserverstatic.hpp.

{ return dates_; }

times()

const std::vector< Time > & times

Definition at line 175 of file yoyinflationcurveobserverstatic.hpp.

                                                                                                 {
    return this->times_;
}

data()

const std::vector< Real > & data

Definition at line 186 of file yoyinflationcurveobserverstatic.hpp.

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

rates()

const std::vector< Rate > & rates

Definition at line 181 of file yoyinflationcurveobserverstatic.hpp.

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

nodes()

std::vector< std::pair< Date, Rate > > nodes

Definition at line 191 of file yoyinflationcurveobserverstatic.hpp.

                                                                                                          {
    calculate();
    std::vector<std::pair<Date, Rate> > results(dates_.size());
    for (Size i = 0; i < dates_.size(); ++i)
        results[i] = std::make_pair(dates_[i], this->data_[i]);
    return results;
}

quotes()

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

(

)

const

Definition at line 64 of file yoyinflationcurveobserverstatic.hpp.

{ return quotes_; };

update()

void update

Definition at line 199 of file yoyinflationcurveobserverstatic.hpp.

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

performCalculations()

void performCalculations

private

Definition at line 204 of file yoyinflationcurveobserverstatic.hpp.

                                                                                             {
    for (Size i = 0; i < dates_.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

protected

Definition at line 170 of file yoyinflationcurveobserverstatic.hpp.

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

Member Data Documentation

dates_

std::vector<Date> dates_

mutableprotected

Definition at line 83 of file yoyinflationcurveobserverstatic.hpp.

quotes_

std::vector<Handle<Quote> > quotes_

protected

Definition at line 84 of file yoyinflationcurveobserverstatic.hpp.

indexIsInterpolated_

bool indexIsInterpolated_

protected

Definition at line 85 of file yoyinflationcurveobserverstatic.hpp.