QuantLib_CallableBond man page

CallableBond — Callable bond base class.

Synopsis

#include <ql/experimental/callablebonds/callablebond.hpp>

Inherits Bond.

Inherited by CallableFixedRateBond.

Classes

class engine
base class for callable fixed rate bond engine
class results
results for a callable bond calculation

Public Member Functions

virtual void setupArguments (PricingEngine::arguments *) const

Inspectors

const CallabilitySchedule & callability () const
return the bond's put/call schedule

Calculations

Volatility impliedVolatility (Real targetValue, const Handle< YieldTermStructure > &discountCurve, Real accuracy, Size maxEvaluations, Volatility minVol, Volatility maxVol) const
returns the Black implied forward yield volatility

Protected Member Functions

CallableBond (Natural settlementDays, const Schedule &schedule, const DayCounter &paymentDayCounter, const Date &issueDate=Date(), const CallabilitySchedule &putCallSchedule=CallabilitySchedule())

Protected Attributes

DayCounter paymentDayCounter_

Frequency frequency_

CallabilitySchedule putCallSchedule_

boost::shared_ptr< PricingEngine > blackEngine_
must be set by derived classes for impliedVolatility() to work
RelinkableHandle< Quote > blackVolQuote_
Black fwd yield volatility quote handle to internal blackEngine_.
RelinkableHandle< YieldTermStructure > blackDiscountCurve_
Black fwd yield volatility quote handle to internal blackEngine_.

Friends

class ImpliedVolHelper

Additional Inherited Members

Detailed Description

Callable bond base class.

Base callable bond class for fixed and zero coupon bonds. Defines commonalities between fixed and zero coupon callable bonds. At present, only European and Bermudan put/call schedules supported (no American optionality), as defined by the Callability class.

Member Function Documentation

Volatility impliedVolatility (Real targetValue, const Handle< YieldTermStructure > & discountCurve, Real accuracy, Size maxEvaluations, Volatility minVol, Volatility maxVol) const

returns the Black implied forward yield volatility the forward yield volatility, see Hull, Fourth Edition, Chapter 20, pg 536). Relevant only to European put/call schedules

virtual void setupArguments (PricingEngine::arguments *) const [virtual]

When a derived argument structure is defined for an instrument, this method should be overridden to fill it. This is mandatory in case a pricing engine is used.

Reimplemented from Instrument.

Reimplemented in CallableFixedRateBond.

Author

Generated automatically by Doxygen for QuantLib from the source code.

Referenced By

blackDiscountCurve_(3), blackEngine_(3), blackVolQuote_(3), callability(3), CallableBond(3), ImpliedVolHelper(3), paymentDayCounter_(3) and putCallSchedule_(3) are aliases of QuantLib_CallableBond(3).

Fri Sep 23 2016 Version 1.8.1 QuantLib