QuantLib: a free/open-source library for quantitative finance
Fully annotated sources - version 1.32
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
OneAssetOption Class Reference

Base class for options on a single asset. More...

#include <ql/instruments/oneassetoption.hpp>

+ Inheritance diagram for OneAssetOption:
+ Collaboration diagram for OneAssetOption:

Classes

class  engine
 
class  results
 Results from single-asset option calculation More...
 

Public Member Functions

 OneAssetOption (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. More...
 
- 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
 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 >
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...
 
- 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 ()
 

greeks

Real delta_
 
Real deltaForward_
 
Real elasticity_
 
Real gamma_
 
Real theta_
 
Real thetaPerDay_
 
Real vega_
 
Real rho_
 
Real dividendRho_
 
Real strikeSensitivity_
 
Real itmCashProbability_
 
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 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 Member Functions inherited from LazyObject
- 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_
 
- Protected Attributes inherited from LazyObject
bool calculated_ = false
 
bool frozen_ = false
 
bool alwaysForward_
 

Detailed Description

Base class for options on a single asset.

Definition at line 34 of file oneassetoption.hpp.

Constructor & Destructor Documentation

◆ OneAssetOption()

OneAssetOption ( const ext::shared_ptr< Payoff > &  payoff,
const ext::shared_ptr< Exercise > &  exercise 
)

Definition at line 28 of file oneassetoption.cpp.

Member Function Documentation

◆ isExpired()

bool isExpired ( ) const
overridevirtual

returns whether the instrument might have value greater than zero.

Implements Instrument.

Reimplemented in VanillaStorageOption, and VanillaSwingOption.

Definition at line 33 of file oneassetoption.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ delta()

Real delta ( ) const

Definition at line 37 of file oneassetoption.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ deltaForward()

Real deltaForward ( ) const

Definition at line 43 of file oneassetoption.cpp.

+ Here is the call graph for this function:

◆ elasticity()

Real elasticity ( ) const

Definition at line 50 of file oneassetoption.cpp.

+ Here is the call graph for this function:

◆ gamma()

Real gamma ( ) const

Definition at line 56 of file oneassetoption.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ theta()

Real theta ( ) const

Definition at line 62 of file oneassetoption.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ thetaPerDay()

Real thetaPerDay ( ) const

Definition at line 68 of file oneassetoption.cpp.

+ Here is the call graph for this function:

◆ vega()

Real vega ( ) const

Definition at line 74 of file oneassetoption.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ rho()

Real rho ( ) const

Definition at line 80 of file oneassetoption.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ dividendRho()

Real dividendRho ( ) const

Definition at line 86 of file oneassetoption.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ strikeSensitivity()

Real strikeSensitivity ( ) const

Definition at line 92 of file oneassetoption.cpp.

+ Here is the call graph for this function:

◆ itmCashProbability()

Real itmCashProbability ( ) const

Definition at line 99 of file oneassetoption.cpp.

+ Here is the call graph for this function:

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

Reimplemented in QuantoBarrierOption, QuantoForwardVanillaOption, and QuantoVanillaOption.

Definition at line 113 of file oneassetoption.cpp.

+ Here is the call graph for this function:
+ 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.

Reimplemented in QuantoBarrierOption, QuantoForwardVanillaOption, and QuantoVanillaOption.

Definition at line 106 of file oneassetoption.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ delta_

Real delta_
mutableprotected

Definition at line 63 of file oneassetoption.hpp.

◆ deltaForward_

Real deltaForward_
protected

Definition at line 63 of file oneassetoption.hpp.

◆ elasticity_

Real elasticity_
protected

Definition at line 63 of file oneassetoption.hpp.

◆ gamma_

Real gamma_
protected

Definition at line 63 of file oneassetoption.hpp.

◆ theta_

Real theta_
protected

Definition at line 63 of file oneassetoption.hpp.

◆ thetaPerDay_

Real thetaPerDay_
protected

Definition at line 64 of file oneassetoption.hpp.

◆ vega_

Real vega_
protected

Definition at line 64 of file oneassetoption.hpp.

◆ rho_

Real rho_
protected

Definition at line 64 of file oneassetoption.hpp.

◆ dividendRho_

Real dividendRho_
protected

Definition at line 64 of file oneassetoption.hpp.

◆ strikeSensitivity_

Real strikeSensitivity_
protected

Definition at line 64 of file oneassetoption.hpp.

◆ itmCashProbability_

Real itmCashProbability_
protected

Definition at line 65 of file oneassetoption.hpp.