QuantLib
A free/open-source library for quantitative finance
Reference manual - version 1.20
Classes | Public Member Functions | Protected Member Functions | List of all members
DividendBarrierOption Class Reference

Single-asset barrier option with discrete dividends. More...

#include <ql/instruments/dividendbarrieroption.hpp>

+ Inheritance diagram for DividendBarrierOption:

Classes

class  arguments
 Arguments for dividend barrier option calculation More...
 
class  engine
 Dividend-barrier-option engine base class More...
 

Public Member Functions

 DividendBarrierOption (Barrier::Type barrierType, Real barrier, Real rebate, const ext::shared_ptr< StrikedTypePayoff > &payoff, const ext::shared_ptr< Exercise > &exercise, const std::vector< Date > &dividendDates, const std::vector< Real > &dividends)
 
- Public Member Functions inherited from BarrierOption
 BarrierOption (Barrier::Type barrierType, Real barrier, Real rebate, const ext::shared_ptr< StrikedTypePayoff > &payoff, const ext::shared_ptr< Exercise > &exercise)
 
Volatility impliedVolatility (Real price, const ext::shared_ptr< GeneralizedBlackScholesProcess > &process, Real accuracy=1.0e-4, Size maxEvaluations=100, Volatility minVol=1.0e-7, Volatility maxVol=4.0) const
 
- Public Member Functions inherited from OneAssetOption
 OneAssetOption (const ext::shared_ptr< Payoff > &, const ext::shared_ptr< Exercise > &)
 
bool isExpired () const
 returns whether the instrument might have value greater than zero.
 
Real delta () const
 
Real deltaForward () const
 
Real elasticity () const
 
Real gamma () const
 
Real theta () const
 
Real thetaPerDay () const
 
Real vega () const
 
Real rho () const
 
Real dividendRho () const
 
Real strikeSensitivity () const
 
Real itmCashProbability () const
 
void fetchResults (const PricingEngine::results *) const
 
- Public Member Functions inherited from Option
 Option (const ext::shared_ptr< Payoff > &payoff, const ext::shared_ptr< Exercise > &exercise)
 
void setupArguments (PricingEngine::arguments *) const
 
ext::shared_ptr< Payoffpayoff ()
 
ext::shared_ptr< Exerciseexercise ()
 
- Public Member Functions inherited from Instrument
Real NPV () const
 returns the net present value of the instrument.
 
Real errorEstimate () const
 returns the error estimate on the NPV when available.
 
const DatevaluationDate () const
 returns the date the net present value refers to.
 
template<typename T >
result (const std::string &tag) const
 returns any additional result returned by the pricing engine.
 
const std::map< std::string, boost::any > & additionalResults () const
 returns all additional result returned by the pricing engine.
 
void setPricingEngine (const ext::shared_ptr< PricingEngine > &)
 set the pricing engine to be used. More...
 
- Public Member Functions inherited from LazyObject
void update ()
 
void recalculate ()
 
void freeze ()
 
void unfreeze ()
 
void alwaysForwardNotifications ()
 
- Public Member Functions inherited from Observable
 Observable (const Observable &)
 
Observableoperator= (const Observable &)
 
void notifyObservers ()
 
- Public Member Functions inherited from Observer
 Observer (const Observer &)
 
Observeroperator= (const Observer &)
 
std::pair< iterator, bool > registerWith (const ext::shared_ptr< Observable > &)
 
void registerWithObservables (const ext::shared_ptr< Observer > &)
 
Size unregisterWith (const ext::shared_ptr< Observable > &)
 
void unregisterWithAll ()
 
virtual void deepUpdate ()
 

Protected Member Functions

void setupArguments (PricingEngine::arguments *) const
 
- Protected Member Functions inherited from OneAssetOption
void setupExpired () const
 
- Protected Member Functions inherited from Instrument
void calculate () const
 
virtual void performCalculations () const
 
- Protected Member Functions inherited from LazyObject

Additional Inherited Members

- Public Types inherited from Option
enum  Type { Put = -1, Call = 1 }
 
- Public Types inherited from Observer
typedef boost::unordered_set< ext::shared_ptr< Observable > > set_type
 
typedef set_type::iterator iterator
 
- Protected Attributes inherited from BarrierOption
Barrier::Type barrierType_
 
Real barrier_
 
Real rebate_
 
- Protected Attributes inherited from OneAssetOption
Real delta_
 
Real deltaForward_
 
Real elasticity_
 
Real gamma_
 
Real theta_
 
Real thetaPerDay_
 
Real vega_
 
Real rho_
 
Real dividendRho_
 
Real strikeSensitivity_
 
Real itmCashProbability_
 
- Protected Attributes inherited from Option
ext::shared_ptr< Payoffpayoff_
 
ext::shared_ptr< Exerciseexercise_
 
- Protected Attributes inherited from Instrument
Real NPV_
 
Real errorEstimate_
 
Date valuationDate_
 
std::map< std::string, boost::any > additionalResults_
 
ext::shared_ptr< PricingEngineengine_
 
- Protected Attributes inherited from LazyObject
bool calculated_
 
bool frozen_
 
bool alwaysForward_
 

Detailed Description

Single-asset barrier option with discrete dividends.

Member Function Documentation

◆ setupArguments()

void setupArguments ( PricingEngine::arguments *  ) const
protectedvirtual

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 BarrierOption.