DepositRateHelper Class Reference

#include <ql/TermStructures/ratehelpers.hpp>

Inheritance diagram for DepositRateHelper:

Inheritance graph
[legend]
List of all members.

Detailed Description

Deposit rate.

Warning:
This class assumes that the reference date does not change between calls of setTermStructure().
Examples:

swapvaluation.cpp.


Public Member Functions

 DepositRateHelper (const Handle< Quote > &rate, Integer n, TimeUnit units, Integer settlementDays, const Calendar &calendar, BusinessDayConvention convention, const DayCounter &dayCounter)
 DepositRateHelper (Rate rate, Integer n, TimeUnit units, Integer settlementDays, const Calendar &calendar, BusinessDayConvention convention, const DayCounter &dayCounter)
Real impliedQuote () const
DiscountFactor discountGuess () const
void setTermStructure (YieldTermStructure *)
 sets the term structure to be used for pricing
Date latestDate () const
 latest relevant date


Member Function Documentation

void setTermStructure YieldTermStructure  )  [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 rate helpers be used only in term structure constructors, setting the term structure to this, i.e., the one being constructed.

Reimplemented from RateHelper.

Date latestDate  )  const [virtual]
 

latest relevant date

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

Implements RateHelper.


QuantLib.org
QuantLib
Hosted by
SourceForge.net Logo
Documentation generated by
doxygen