OneFactorModel Class Reference

Single-factor short-rate model abstract class. More...

#include <ql/models/shortrate/onefactormodel.hpp>

Inheritance diagram for OneFactorModel:

Classes
class	ShortRateDynamics
	Base class describing the short-rate dynamics. More...
class	ShortRateTree
	Recombining trinomial tree discretizing the state variable. More...

Public Member Functions
	OneFactorModel (Size nArguments)
virtual ext::shared_ptr< ShortRateDynamics >	dynamics () const =0
	returns the short-rate dynamics
ext::shared_ptr< Lattice >	tree (const TimeGrid &grid) const override
	Return by default a trinomial recombining tree.
Public Member Functions inherited from ShortRateModel
	ShortRateModel (Size nArguments)
Public Member Functions inherited from CalibratedModel
	CalibratedModel (Size nArguments)
void	update () override
virtual void	calibrate (const std::vector< 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)
Real	value (const Array &params, const std::vector< ext::shared_ptr< CalibrationHelper > > &)
const ext::shared_ptr< Constraint > &	constraint () const
EndCriteria::Type	endCriteria () const
	Returns end criteria result.
const Array &	problemValues () const
	Returns the problem values.
Array	params () const
	Returns array of arguments on which calibration is done.
virtual void	setParams (const Array &params)
Integer	functionEvaluation () const
Public Member Functions inherited from Observer
	Observer (const Observer &)
Observer &	operator= (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 ()
Public Member Functions inherited from Observable
	Observable (const Observable &)
Observable &	operator= (const Observable &)
	Observable (Observable &&)=delete
Observable &	operator= (Observable &&)=delete
void	notifyObservers ()

Additional Inherited Members
Public Types inherited from Observer
typedef set_type::iterator	iterator
Protected Member Functions inherited from CalibratedModel
virtual void	generateArguments ()
Protected Attributes inherited from CalibratedModel
std::vector< Parameter >	arguments_
ext::shared_ptr< Constraint >	constraint_
EndCriteria::Type	shortRateEndCriteria_ = EndCriteria::None
Array	problemValues_
Integer	functionEvaluation_

Detailed Description

Single-factor short-rate model abstract class.

Member Function Documentation

dynamics()

virtual ext::shared_ptr< ShortRateDynamics > dynamics ( ) const

pure virtual

returns the short-rate dynamics

Implemented in BlackKarasinski, CoxIngersollRoss, ExtendedCoxIngersollRoss, GeneralizedHullWhite, HullWhite, and Vasicek.

tree()

ext::shared_ptr< Lattice > tree ( const TimeGrid & grid ) const

overridevirtual

Return by default a trinomial recombining tree.

Implements ShortRateModel.