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
NonstandardSwaption Class Reference

nonstandard swaption class More...

#include <ql/instruments/nonstandardswaption.hpp>

+ Inheritance diagram for NonstandardSwaption:
+ Collaboration diagram for NonstandardSwaption:

Classes

class  arguments
 Arguments for nonstandard swaption calculation More...
 
class  engine
 base class for nonstandard swaption engines More...
 

Public Member Functions

 NonstandardSwaption (const Swaption &fromSwaption)
 
 NonstandardSwaption (ext::shared_ptr< NonstandardSwap > swap, const ext::shared_ptr< Exercise > &exercise, Settlement::Type delivery=Settlement::Physical, Settlement::Method settlementMethod=Settlement::PhysicalOTC)
 
Instrument interface
bool isExpired () const override
 returns whether the instrument might have value greater than zero. More...
 
void setupArguments (PricingEngine::arguments *) 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
 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...
 
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 ()
 

Inspectors

ext::shared_ptr< NonstandardSwapswap_
 
Settlement::Type settlementType_
 
Settlement::Method settlementMethod_
 
Settlement::Type settlementType () const
 
Settlement::Method settlementMethod () const
 
Swap::Type type () const
 
const ext::shared_ptr< NonstandardSwap > & underlyingSwap () const
 
std::vector< ext::shared_ptr< BlackCalibrationHelper > > calibrationBasket (const ext::shared_ptr< SwapIndex > &standardSwapBase, const ext::shared_ptr< SwaptionVolatilityStructure > &swaptionVolatility, BasketGeneratingEngine::CalibrationBasketType basketType=BasketGeneratingEngine::MaturityStrikeByDeltaGamma) const
 

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
 
virtual void setupExpired () const
 
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

nonstandard swaption class

Definition at line 41 of file nonstandardswaption.hpp.

Constructor & Destructor Documentation

◆ NonstandardSwaption() [1/2]

NonstandardSwaption ( const Swaption fromSwaption)

Definition at line 26 of file nonstandardswaption.cpp.

+ Here is the call graph for this function:

◆ NonstandardSwaption() [2/2]

NonstandardSwaption ( ext::shared_ptr< NonstandardSwap swap,
const ext::shared_ptr< Exercise > &  exercise,
Settlement::Type  delivery = Settlement::Physical,
Settlement::Method  settlementMethod = Settlement::PhysicalOTC 
)

Definition at line 46 of file nonstandardswaption.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 56 of file nonstandardswaption.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 62 of file nonstandardswaption.cpp.

+ Here is the caller graph for this function:

◆ settlementType()

Settlement::Type settlementType ( ) const

Definition at line 58 of file nonstandardswaption.hpp.

◆ settlementMethod()

Settlement::Method settlementMethod ( ) const

Definition at line 59 of file nonstandardswaption.hpp.

◆ type()

Swap::Type type ( ) const

Definition at line 62 of file nonstandardswaption.hpp.

◆ underlyingSwap()

const ext::shared_ptr< NonstandardSwap > & underlyingSwap ( ) const

Definition at line 64 of file nonstandardswaption.hpp.

◆ calibrationBasket()

std::vector< ext::shared_ptr< BlackCalibrationHelper > > calibrationBasket ( const ext::shared_ptr< SwapIndex > &  standardSwapBase,
const ext::shared_ptr< SwaptionVolatilityStructure > &  swaptionVolatility,
BasketGeneratingEngine::CalibrationBasketType  basketType = BasketGeneratingEngine::MaturityStrikeByDeltaGamma 
) const

Definition at line 86 of file nonstandardswaption.cpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ swap_

ext::shared_ptr<NonstandardSwap> swap_
private

Definition at line 76 of file nonstandardswaption.hpp.

◆ settlementType_

Settlement::Type settlementType_
private

Definition at line 77 of file nonstandardswaption.hpp.

◆ settlementMethod_

Settlement::Method settlementMethod_
private

Definition at line 78 of file nonstandardswaption.hpp.