BlackVolatilityTermStructure Class Reference

Black-volatility term structure. More...

#include <ql/termstructures/volatility/equityfx/blackvoltermstructure.hpp>

Inheritance diagram for BlackVolatilityTermStructure:

Public Member Functions

Constructors

See the TermStructure documentation for issues regarding constructors.

 BlackVolatilityTermStructure (const Calendar &cal, BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter())
 
 BlackVolatilityTermStructure (BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter())
 default constructor
 
 BlackVolatilityTermStructure (const Date &referenceDate, const Calendar &cal=Calendar(), BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter())
 initialize with a fixed reference date
 
 BlackVolatilityTermStructure (Natural settlementDays, const Calendar &cal, BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter())
 calculate the reference date based on the global evaluation date
 
Visitability
virtual void accept (AcyclicVisitor &)
 
- Public Member Functions inherited from BlackVolTermStructure
 BlackVolTermStructure (const Calendar &cal, BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter())
 
 BlackVolTermStructure (BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter())
 default constructor
 
 BlackVolTermStructure (const Date &referenceDate, const Calendar &cal=Calendar(), BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter())
 initialize with a fixed reference date
 
 BlackVolTermStructure (Natural settlementDays, const Calendar &, BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter())
 calculate the reference date based on the global evaluation date
 
Volatility blackVol (const Date &maturity, Real strike, bool extrapolate=false) const
 spot volatility
 
Volatility blackVol (Time maturity, Real strike, bool extrapolate=false) const
 spot volatility
 
Real blackVariance (const Date &maturity, Real strike, bool extrapolate=false) const
 spot variance
 
Real blackVariance (Time maturity, Real strike, bool extrapolate=false) const
 spot variance
 
Volatility blackForwardVol (const Date &date1, const Date &date2, Real strike, bool extrapolate=false) const
 forward (at-the-money) volatility
 
Volatility blackForwardVol (Time time1, Time time2, Real strike, bool extrapolate=false) const
 forward (at-the-money) volatility
 
Real blackForwardVariance (const Date &date1, const Date &date2, Real strike, bool extrapolate=false) const
 forward (at-the-money) variance
 
Real blackForwardVariance (Time time1, Time time2, Real strike, bool extrapolate=false) const
 forward (at-the-money) variance
 
- Public Member Functions inherited from VolatilityTermStructure
virtual BusinessDayConvention businessDayConvention () const
 the business day convention used in tenor to date conversion
 
Date optionDateFromTenor (const Period &) const
 period/date conversion
 
virtual Rate minStrike () const =0
 the minimum strike for which the term structure can return vols
 
virtual Rate maxStrike () const =0
 the maximum strike for which the term structure can return vols
 
 VolatilityTermStructure (const Calendar &cal, BusinessDayConvention bdc, const DayCounter &dc=DayCounter())
 
 VolatilityTermStructure (BusinessDayConvention bdc, const DayCounter &dc=DayCounter())
 
 VolatilityTermStructure (const Date &referenceDate, const Calendar &cal, BusinessDayConvention bdc, const DayCounter &dc=DayCounter())
 initialize with a fixed reference date
 
 VolatilityTermStructure (Natural settlementDays, const Calendar &cal, BusinessDayConvention bdc, const DayCounter &dc=DayCounter())
 calculate the reference date based on the global evaluation date
 
- Public Member Functions inherited from TermStructure
 TermStructure (const DayCounter &dc=DayCounter())
 default constructor
 
 TermStructure (const Date &referenceDate, const Calendar &calendar=Calendar(), const DayCounter &dc=DayCounter())
 initialize with a fixed reference date
 
 TermStructure (Natural settlementDays, const Calendar &, const DayCounter &dc=DayCounter())
 calculate the reference date based on the global evaluation date
 
virtual DayCounter dayCounter () const
 the day counter used for date/time conversion
 
Time timeFromReference (const Date &date) const
 date/time conversion
 
virtual Date maxDate () const =0
 the latest date for which the curve can return values
 
virtual Time maxTime () const
 the latest time for which the curve can return values
 
virtual const DatereferenceDate () const
 the date at which discount = 1.0 and/or variance = 0.0
 
virtual Calendar calendar () const
 the calendar used for reference and/or option date calculation
 
virtual Natural settlementDays () const
 the settlementDays used for reference date calculation
 
void update ()
 
- Public Member Functions inherited from Observer
 Observer (const Observer &)
 
Observeroperator= (const Observer &)
 
std::pair< std::set
< boost::shared_ptr
< Observable > >::iterator,
bool > 
registerWith (const boost::shared_ptr< Observable > &)
 
Size unregisterWith (const boost::shared_ptr< Observable > &)
 
void unregisterWithAll ()
 
- Public Member Functions inherited from Observable
 Observable (const Observable &)
 
Observableoperator= (const Observable &)
 
void notifyObservers ()
 
- Public Member Functions inherited from Extrapolator
void enableExtrapolation (bool b=true)
 enable extrapolation in subsequent calls
 
void disableExtrapolation (bool b=true)
 disable extrapolation in subsequent calls
 
bool allowsExtrapolation () const
 tells whether extrapolation is enabled
 

Protected Member Functions

Real blackVarianceImpl (Time maturity, Real strike) const
 
- Protected Member Functions inherited from BlackVolTermStructure
virtual Volatility blackVolImpl (Time t, Real strike) const =0
 Black volatility calculation.
 
- Protected Member Functions inherited from VolatilityTermStructure
void checkStrike (Rate strike, bool extrapolate) const
 strike-range check
 
- Protected Member Functions inherited from TermStructure
void checkRange (const Date &d, bool extrapolate) const
 date-range check
 
void checkRange (Time t, bool extrapolate) const
 time-range check
 

Additional Inherited Members

- Protected Attributes inherited from TermStructure
bool moving_
 
bool updated_
 
Calendar calendar_
 

Detailed Description

Black-volatility term structure.

This abstract class acts as an adapter to BlackVolTermStructure allowing the programmer to implement only the blackVolImpl(Time, Real, bool) method in derived classes.

Volatility are assumed to be expressed on an annual basis.

Constructor & Destructor Documentation

Warning:
term structures initialized by means of this constructor must manage their own reference date by overriding the referenceDate() method.

default constructor

Warning:
term structures initialized by means of this constructor must manage their own reference date by overriding the referenceDate() method.

Member Function Documentation

Real blackVarianceImpl ( Time  maturity,
Real  strike 
) const
protectedvirtual

Returns the variance for the given strike and date calculating it from the volatility.

Implements BlackVolTermStructure.