Option Class Reference

base option class More...

#include <ql/option.hpp>

Inheritance diagram for Option:

Classes
class	arguments
	basic option arguments More...

Public Types
enum	Type { Put = -1 , Call = 1 }
Public Types inherited from Observer
typedef set_type::iterator	iterator

Public Member Functions
	Option (ext::shared_ptr< Payoff > payoff, ext::shared_ptr< Exercise > exercise)
void	setupArguments (PricingEngine::arguments *) const override
ext::shared_ptr< Payoff >	payoff () const
ext::shared_ptr< Exercise >	exercise () const
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 Date &	valuationDate () const
	returns the date the net present value refers to.
template<typename T>
T	result (const std::string &tag) const
	returns any additional result returned by the pricing engine.
const std::map< std::string, ext::any > &	additionalResults () const
	returns all additional result returned by the pricing engine.
virtual bool	isExpired () const =0
	returns whether the instrument might have value greater than zero.
void	setPricingEngine (const ext::shared_ptr< PricingEngine > &)
	set the pricing engine to be used.
virtual void	fetchResults (const PricingEngine::results *) const
Public Member Functions inherited from LazyObject
void	update () override
bool	isCalculated () const
void	forwardFirstNotificationOnly ()
void	alwaysForwardNotifications ()
void	recalculate ()
void	freeze ()
void	unfreeze ()
Public Member Functions inherited from Observable
	Observable (const Observable &)
Observable &	operator= (const Observable &)
	Observable (Observable &&)=delete
Observable &	operator= (Observable &&)=delete
void	notifyObservers ()
Public Member Functions inherited from Observer
	Observer (const Observer &)
Observer &	operator= (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 Attributes
ext::shared_ptr< Payoff >	payoff_
ext::shared_ptr< Exercise >	exercise_
Protected Attributes inherited from Instrument
Real	NPV_
Real	errorEstimate_
Date	valuationDate_
std::map< std::string, ext::any >	additionalResults_
ext::shared_ptr< PricingEngine >	engine_
bool	calculated_ = false
bool	frozen_ = false
bool	alwaysForward_

Related Symbols
(Note that these are not member symbols.)
std::ostream &	operator<< (std::ostream &, Option::Type)

Additional Inherited Members
Protected Member Functions inherited from Instrument
void	calculate () const override
virtual void	setupExpired () const
void	performCalculations () const override

Detailed Description

base option class

Member Function Documentation

setupArguments()

void setupArguments ( PricingEngine::arguments * ) const

overridevirtual

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 PagodaOption, PartialTimeBarrierOption, SimpleChooserOption, SoftBarrierOption, Swaption, TwoAssetBarrierOption, TwoAssetCorrelationOption, VanillaStorageOption, VanillaSwingOption, and WriterExtensibleOption.