QuantLib_BootstrapHelper man page

BootstrapHelper< TS > — Base helper class for bootstrapping.

Synopsis

#include <ql/termstructures/bootstraphelper.hpp>

Inherits Observer, and Observable.

Inherited by AssetSwapHelper, BondHelper, DatedOISRateHelper, FuturesRateHelper, and RelativeDateBootstrapHelper< TS >.

Public Member Functions

BootstrapHelper (const Handle< Quote > &quote)

BootstrapHelper (Real quote)

BootstrapHelper interface

const Handle< Quote > & quote () const

virtual Real impliedQuote () const =0

Real quoteError () const

virtual void setTermStructure (TS *)
sets the term structure to be used for pricing
virtual Date earliestDate () const
earliest relevant date
virtual Date maturityDate () const
instrument's maturity date
virtual Date latestRelevantDate () const
latest relevant date
virtual Date pillarDate () const
pillar date
virtual Date latestDate () const
latest date

Observer interface

virtual void update ()

Visitability

virtual void accept (AcyclicVisitor &)

Protected Attributes

Handle< Quote > quote_

TS * termStructure_

Date earliestDate_

Date latestDate_

Date maturityDate_

Date latestRelevantDate_

Date pillarDate_

Additional Inherited Members

Detailed Description

template<class TS>

class QuantLib::BootstrapHelper< TS >" Base helper class for bootstrapping.

This class provides an abstraction for the instruments used to bootstrap a term structure.

It is advised that a bootstrap helper for an instrument contains an instance of the actual instrument class to ensure consistancy between the algorithms used during bootstrapping and later instrument pricing. This is not yet fully enforced in the available bootstrap helpers.

Member Function Documentation

void setTermStructure (TS * t) [virtual]

sets the term structure to be used for pricing

Warning

Being a pointer and not a shared_ptr, the term structure is not guaranteed to remain allocated for the whole life of the rate helper. It is responsibility of the programmer to ensure that the pointer remains valid. It is advised that this method is called only inside the term structure being bootstrapped, setting the pointer to this, i.e., the term structure itself.

Reimplemented in YearOnYearInflationSwapHelper, YoYOptionletHelper, and ZeroCouponInflationSwapHelper.

Date earliestDate () const [virtual]

earliest relevant date The earliest date at which data are needed by the helper in order to provide a quote.

Date latestRelevantDate () const [virtual]

latest relevant date The latest date at which data are needed by the helper in order to provide a quote. It does not necessarily equal the maturity of the underlying instrument.

Date latestDate () const [virtual]

latest date equal to pillarDate()

void update () [virtual]

This method must be implemented in derived classes. An instance of Observer does not call this method directly: instead, it will be called by the observables the instance registered with when they need to notify any changes.

Implements Observer.

Reimplemented in RelativeDateBootstrapHelper< TS >, and CdsHelper.

Author

Generated automatically by Doxygen for QuantLib from the source code.

Referenced By

BootstrapHelper(3), earliestDate(3), earliestDate_(3), latestDate(3), latestDate_(3), latestRelevantDate(3), latestRelevantDate_(3), pillarDate(3), pillarDate_(3), quote(3), quote_(3) and quoteError(3) are aliases of QuantLib_BootstrapHelper(3).

Fri Sep 23 2016 Version 1.8.1 QuantLib