MultiAssetOption Class Reference

Base class for options on multiple assets. More...

#include <ql/instruments/multiassetoption.hpp>

Inheritance diagram for MultiAssetOption:

Classes
class	results
	Results from multi-asset option calculation More...

Public Member Functions
	MultiAssetOption (const ext::shared_ptr< Payoff > &, const ext::shared_ptr< Exercise > &)
Instrument interface
bool	isExpired () const override
	returns whether the instrument might have value greater than zero.
Public Member Functions inherited from Option
	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.
void	setPricingEngine (const ext::shared_ptr< PricingEngine > &)
	set the pricing engine to be used.
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 ()

greeks
Real	delta_
Real	gamma_
Real	theta_
Real	vega_
Real	rho_
Real	dividendRho_
Real	delta () const
Real	gamma () const
Real	theta () const
Real	vega () const
Real	rho () const
Real	dividendRho () const
void	setupArguments (PricingEngine::arguments *) const override
void	fetchResults (const PricingEngine::results *) const override
void	setupExpired () const override

Additional Inherited Members
Public Types inherited from Option
enum	Type { Put = -1 , Call = 1 }
Public Types inherited from Observer
typedef set_type::iterator	iterator
Protected Member Functions inherited from Instrument
void	calculate () const override
void	performCalculations () const override
Protected Attributes inherited from Option
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 inherited from Option
std::ostream &	operator<< (std::ostream &, Option::Type)

Detailed Description

Base class for options on multiple assets.

Member Function Documentation

isExpired()

bool isExpired ( ) const

overridevirtual

returns whether the instrument might have value greater than zero.

Implements Instrument.

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, and TwoAssetCorrelationOption.

fetchResults()

void fetchResults ( const PricingEngine::results * r ) const

overridevirtual

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

Reimplemented from Instrument.

setupExpired()

void setupExpired ( ) const

overrideprotectedvirtual

This method must leave the instrument in a consistent state when the expiration condition is met.

Reimplemented from Instrument.