Logo
Fully annotated reference manual - version 1.8.12
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
CommoditySwaptionAnalyticalEngineBuilder Class Reference

Analytical Approximation Engine builder for Commodity Swaptions. More...

#include <ored/portfolio/builders/commodityswaption.hpp>

+ Inheritance diagram for CommoditySwaptionAnalyticalEngineBuilder:
+ Collaboration diagram for CommoditySwaptionAnalyticalEngineBuilder:

Public Member Functions

 CommoditySwaptionAnalyticalEngineBuilder ()
 
- Public Member Functions inherited from CommoditySwaptionEngineBuilder
 CommoditySwaptionEngineBuilder (const std::string &engine)
 
- Public Member Functions inherited from CachingEngineBuilder< T, U, Args >
 CachingEngineBuilder (const string &model, const string &engine, const set< string > &tradeTypes)
 
QuantLib::ext::shared_ptr< U > engine (Args... params)
 Return a PricingEngine or a FloatingRateCouponPricer. More...
 
void reset () override
 reset the builder (e.g. clear cache) More...
 
- Public Member Functions inherited from EngineBuilder
 EngineBuilder (const string &model, const string &engine, const set< string > &tradeTypes)
 
virtual ~EngineBuilder ()
 Virtual destructor. More...
 
const string & model () const
 Return the model name. More...
 
const string & engine () const
 Return the engine name. More...
 
const set< string > & tradeTypes () const
 Return the possible trade types. More...
 
const string & configuration (const MarketContext &key)
 Return a configuration (or the default one if key not found) More...
 
virtual void reset ()
 reset the builder (e.g. clear cache) More...
 
void init (const QuantLib::ext::shared_ptr< Market > market, const map< MarketContext, string > &configurations, const map< string, string > &modelParameters, const map< string, string > &engineParameters, const std::map< std::string, std::string > &globalParameters={})
 Initialise this Builder with the market and parameters to use. More...
 
const set< std::pair< string, QuantLib::ext::shared_ptr< QuantExt::ModelBuilder > > > & modelBuilders () const
 return model builders More...
 
std::string engineParameter (const std::string &p, const std::vector< std::string > &qualifiers={}, const bool mandatory=true, const std::string &defaultValue="") const
 
std::string modelParameter (const std::string &p, const std::vector< std::string > &qualifiers={}, const bool mandatory=true, const std::string &defaultValue="") const
 

Protected Member Functions

QuantLib::ext::shared_ptr< QuantLib::PricingEngine > engineImpl (const Currency &ccy, const string &name) override
 
- Protected Member Functions inherited from CommoditySwaptionEngineBuilder
std::string keyImpl (const Currency &ccy, const string &name) override
 
- Protected Member Functions inherited from CachingEngineBuilder< T, U, Args >
virtual T keyImpl (Args...)=0
 
virtual QuantLib::ext::shared_ptr< U > engineImpl (Args...)=0
 

Additional Inherited Members

- Protected Attributes inherited from CachingEngineBuilder< T, U, Args >
map< T, QuantLib::ext::shared_ptr< U > > engines_
 
- Protected Attributes inherited from EngineBuilder
string model_
 
string engine_
 
set< string > tradeTypes_
 
QuantLib::ext::shared_ptr< Marketmarket_
 
map< MarketContext, string > configurations_
 
map< string, string > modelParameters_
 
map< string, string > engineParameters_
 
std::map< std::string, std::string > globalParameters_
 
set< std::pair< string, QuantLib::ext::shared_ptr< QuantExt::ModelBuilder > > > modelBuilders_
 

Detailed Description

Analytical Approximation Engine builder for Commodity Swaptions.

Pricing engines are cached by currency and underlying name

Definition at line 51 of file commodityswaption.hpp.

Constructor & Destructor Documentation

◆ CommoditySwaptionAnalyticalEngineBuilder()

Definition at line 53 of file commodityswaption.hpp.

53: CommoditySwaptionEngineBuilder("AnalyticalApproximation") {}
CommoditySwaptionEngineBuilder(const std::string &engine)

Member Function Documentation

◆ engineImpl()

QuantLib::ext::shared_ptr< QuantLib::PricingEngine > engineImpl ( const Currency &  ccy,
const string &  name 
)
overrideprotected

Definition at line 56 of file commodityswaption.hpp.

56 {
57 Handle<QuantLib::BlackVolTermStructure> vol =
58 market_->commodityVolatility(name, configuration(MarketContext::pricing));
59 Handle<YieldTermStructure> yts = market_->discountCurve(ccy.code(), configuration(MarketContext::pricing));
60 Real beta = parseReal(engineParameter("beta"));
61 QL_REQUIRE(beta >= 0.0, "CommoditySwaptionAnalyticalEngineBuilder: beta must be non-negative");
62 return QuantLib::ext::make_shared<QuantExt::CommoditySwaptionEngine>(yts, vol, beta);
63 }
QuantLib::ext::shared_ptr< Market > market_
std::string engineParameter(const std::string &p, const std::vector< std::string > &qualifiers={}, const bool mandatory=true, const std::string &defaultValue="") const
const string & configuration(const MarketContext &key)
Return a configuration (or the default one if key not found)
Real parseReal(const string &s)
Convert text to Real.
Definition: parsers.cpp:112
string name
+ Here is the call graph for this function: