CommodityModel Class Reference

#include <qle/models/commoditymodel.hpp>

Inheritance diagram for CommodityModel:

Collaboration diagram for CommodityModel:

Public Member Functions
virtual const QuantLib::ext::shared_ptr< Parametrization >	parametrizationBase () const =0
virtual Handle< PriceTermStructure >	termStructure () const =0
virtual const Currency &	currency () const =0
virtual Size	n () const =0
virtual Size	m () const =0
virtual QuantLib::ext::shared_ptr< StochasticProcess >	stateProcess () const =0
virtual QuantLib::Real	forwardPrice (const QuantLib::Time t, const QuantLib::Time T, const QuantLib::Array &x, const QuantLib::Handle< QuantExt::PriceTermStructure > &priceCurve=QuantLib::Handle< QuantExt::PriceTermStructure >()) const =0
Public Member Functions inherited from LinkableCalibratedModel
	LinkableCalibratedModel ()
void	update () override
virtual void	calibrate (const std::vector< QuantLib::ext::shared_ptr< CalibrationHelper > > &, OptimizationMethod &method, const EndCriteria &endCriteria, const Constraint &constraint=Constraint(), const std::vector< Real > &weights=std::vector< Real >(), const std::vector< bool > &fixParameters=std::vector< bool >())
	Calibrate to a set of market instruments (usually caps/swaptions) More...
virtual void	calibrate (const std::vector< QuantLib::ext::shared_ptr< BlackCalibrationHelper > > &, OptimizationMethod &method, const EndCriteria &endCriteria, const Constraint &constraint=Constraint(), const std::vector< Real > &weights=std::vector< Real >(), const std::vector< bool > &fixParameters=std::vector< bool >())
	for backward compatibility More...
Real	value (const Array &params, const std::vector< QuantLib::ext::shared_ptr< CalibrationHelper > > &)
Real	value (const Array &params, const std::vector< QuantLib::ext::shared_ptr< BlackCalibrationHelper > > &)
	for backward compatibility More...
const QuantLib::ext::shared_ptr< Constraint > &	constraint () const
EndCriteria::Type	endCriteria () const
	Returns end criteria result. More...
const Array &	problemValues () const
	Returns the problem values. More...
Array	params () const
	Returns array of arguments on which calibration is done. More...
virtual void	setParams (const Array &params)
virtual void	setParam (Size idx, const Real value)

Additional Inherited Members
Protected Member Functions inherited from LinkableCalibratedModel
virtual void	generateArguments ()
Protected Attributes inherited from LinkableCalibratedModel
std::vector< QuantLib::ext::shared_ptr< Parameter > >	arguments_
QuantLib::ext::shared_ptr< Constraint >	constraint_
EndCriteria::Type	endCriteria_
Array	problemValues_

Detailed Description

Definition at line 34 of file commoditymodel.hpp.

Member Function Documentation

parametrizationBase()

virtual const QuantLib::ext::shared_ptr< Parametrization > parametrizationBase ( ) const

pure virtual

parametrization (as base class)

Implemented in CommoditySchwartzModel.

termStructure()

virtual Handle< PriceTermStructure > termStructure ( ) const

pure virtual

price term structure to which the model is (initially) calibrated

Implemented in CommoditySchwartzModel.

currency()

virtual const Currency & currency ( ) const

pure virtual

currency of the commodity

Implemented in CommoditySchwartzModel.

n()

virtual Size n ( ) const

pure virtual

dimension of model state

Implemented in CommoditySchwartzModel.

m()

virtual Size m ( ) const

pure virtual

number of Brownians to evolve the state

Implemented in CommoditySchwartzModel.

stateProcess()

virtual QuantLib::ext::shared_ptr< StochasticProcess > stateProcess ( ) const

pure virtual

stochastic process, this has dimension n() and m() Brownian drivers

Implemented in CommoditySchwartzModel.

forwardPrice()

virtual QuantLib::Real forwardPrice ( const QuantLib::Time  t, const QuantLib::Time  T, const QuantLib::Array &  x, const QuantLib::Handle< QuantExt::PriceTermStructure > &  priceCurve = QuantLib::Handle< QuantExt::PriceTermStructure >()  ) const

pure virtual

stochastic forward price curve F(t,T) at future time t depending on state (of dimension n())

Implemented in CommoditySchwartzModel.