QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
PathMultiAssetOption Class Referenceabstract

Base class for path-dependent options on multiple assets. More...

#include <pathmultiassetoption.hpp>

+ Inheritance diagram for PathMultiAssetOption:
+ Collaboration diagram for PathMultiAssetOption:

Classes

class  arguments
 Arguments for multi-asset option calculation More...
 
class  engine
 
class  results
 Results from multi-asset option calculation More...
 

Public Member Functions

 PathMultiAssetOption (const ext::shared_ptr< PricingEngine > &engine=ext::shared_ptr< PricingEngine >())
 
- Public Member Functions inherited from Instrument
 Instrument ()
 
Real NPV () const
 returns the net present value of the instrument. More...
 
Real errorEstimate () const
 returns the error estimate on the NPV when available. More...
 
const DatevaluationDate () const
 returns the date the net present value refers to. More...
 
template<typename T >
T result (const std::string &tag) const
 returns any additional result returned by the pricing engine. More...
 
const std::map< std::string, ext::any > & additionalResults () const
 returns all additional result returned by the pricing engine. More...
 
void setPricingEngine (const ext::shared_ptr< PricingEngine > &)
 set the pricing engine to be used. More...
 
virtual void fetchResults (const PricingEngine::results *) const
 
- Public Member Functions inherited from LazyObject
 LazyObject ()
 
 ~LazyObject () override=default
 
void update () override
 
bool isCalculated () const
 
void forwardFirstNotificationOnly ()
 
void alwaysForwardNotifications ()
 
void recalculate ()
 
void freeze ()
 
void unfreeze ()
 
- Public Member Functions inherited from Observable
 Observable ()
 
 Observable (const Observable &)
 
Observableoperator= (const Observable &)
 
 Observable (Observable &&)=delete
 
Observableoperator= (Observable &&)=delete
 
virtual ~Observable ()=default
 
void notifyObservers ()
 
- Public Member Functions inherited from Observer
 Observer ()=default
 
 Observer (const Observer &)
 
Observeroperator= (const Observer &)
 
virtual ~Observer ()
 
std::pair< iterator, boolregisterWith (const ext::shared_ptr< Observable > &)
 
void registerWithObservables (const ext::shared_ptr< Observer > &)
 
Size unregisterWith (const ext::shared_ptr< Observable > &)
 
void unregisterWithAll ()
 
virtual void update ()=0
 
virtual void deepUpdate ()
 

Instrument interface

bool isExpired () const override
 returns whether the instrument might have value greater than zero. More...
 
void setupArguments (PricingEngine::arguments *) const override
 
virtual ext::shared_ptr< PathPayoffpathPayoff () const =0
 
virtual std::vector< DatefixingDates () const =0
 
void setupExpired () const override
 

Additional Inherited Members

- 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 Member Functions inherited from LazyObject
- Protected Attributes inherited from Instrument
Real NPV_
 
Real errorEstimate_
 
Date valuationDate_
 
std::map< std::string, ext::any > additionalResults_
 
ext::shared_ptr< PricingEngineengine_
 
- Protected Attributes inherited from LazyObject
bool calculated_ = false
 
bool frozen_ = false
 
bool alwaysForward_
 

Detailed Description

Base class for path-dependent options on multiple assets.

Definition at line 35 of file pathmultiassetoption.hpp.

Constructor & Destructor Documentation

◆ PathMultiAssetOption()

PathMultiAssetOption ( const ext::shared_ptr< PricingEngine > &  engine = ext::shared_ptr<PricingEngine>())
explicit

Definition at line 28 of file pathmultiassetoption.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ isExpired()

bool isExpired ( ) const
overridevirtual

returns whether the instrument might have value greater than zero.

Implements Instrument.

Definition at line 34 of file pathmultiassetoption.cpp.

+ Here is the call graph for this function:

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

Definition at line 42 of file pathmultiassetoption.cpp.

+ Here is the call graph for this function:

◆ pathPayoff()

virtual ext::shared_ptr< PathPayoff > pathPayoff ( ) const
pure virtual
+ Here is the caller graph for this function:

◆ fixingDates()

virtual std::vector< Date > fixingDates ( ) const
pure virtual
+ Here is the caller graph for this function:

◆ setupExpired()

void setupExpired ( ) const
overrideprotectedvirtual

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

Reimplemented from Instrument.

Definition at line 38 of file pathmultiassetoption.cpp.