QuantLib: a free/open-source library for quantitative finance
Reference manual - version 1.40
Loading...
Searching...
No Matches
MargrabeOption Class Reference

Margrabe option on two assets. More...

#include <ql/instruments/margrabeoption.hpp>

Inheritance diagram for MargrabeOption:

Classes

class  arguments
 Extra arguments for Margrabe option. More...
class  engine
 Margrabe option engine base class More...
class  results
 Extra results for Margrabe option. More...

Public Member Functions

 MargrabeOption (Integer Q1, Integer Q2, const ext::shared_ptr< Exercise > &)
void setupArguments (PricingEngine::arguments *) const override
Real delta1 () const
Real delta2 () const
Real gamma1 () const
Real gamma2 () const
void fetchResults (const PricingEngine::results *) const override
Public Member Functions inherited from MultiAssetOption
 MultiAssetOption (const ext::shared_ptr< Payoff > &, const ext::shared_ptr< Exercise > &)
bool isExpired () const override
 returns whether the instrument might have value greater than zero.
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
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< Payoffpayoff () const
ext::shared_ptr< Exerciseexercise () 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 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, 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 &)
Observableoperator= (const Observable &)
 Observable (Observable &&)=delete
Observableoperator= (Observable &&)=delete
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 Attributes

Integer Q1_
Integer Q2_
Real delta1_
Real delta2_
Real gamma1_
Real gamma2_
Real delta_
Real gamma_
Real theta_
Real vega_
Real rho_
Real dividendRho_
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, ext::any > additionalResults_
ext::shared_ptr< PricingEngineengine_
bool calculated_ = false
bool frozen_ = false
bool alwaysForward_

Additional Inherited Members

Public Types inherited from Option
enum  Type { Put = -1 , Call = 1 }
Public Types inherited from Observer
typedef set_type::iterator iterator
void setupExpired () const override
Protected Member Functions inherited from Instrument
void calculate () const override
void performCalculations () const override

Detailed Description

Margrabe option on two assets.

This option gives the holder the right to exchange Q2 stocks of the second asset for Q1 stocks of the first at expiration.

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.

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