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

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

#include <ql/instruments/oneassetoption.hpp>

Inheritance diagram for OneAssetOption:

Classes

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

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 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_

Detailed Description

Base class for options on a single asset.

Member Function Documentation

◆ isExpired()

bool isExpired ( ) const
overridevirtual

returns whether the instrument might have value greater than zero.

Implements Instrument.

Reimplemented in VanillaStorageOption, VanillaSwingOption, and WriterExtensibleOption.

◆ 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, QuantoDoubleBarrierOption, QuantoForwardVanillaOption, and QuantoVanillaOption.

◆ setupExpired()

void setupExpired ( ) const
overrideprotectedvirtual

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

Reimplemented from Instrument.