QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.38
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
OneFactorModel Class Referenceabstract

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

#include <onefactormodel.hpp>

+ Inheritance diagram for OneFactorModel:
+ Collaboration 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)
 
 ~OneFactorModel () override=default
 
virtual ext::shared_ptr< ShortRateDynamics > dynamics () const =0
 returns the short-rate dynamics More...
 
ext::shared_ptr< Lattice > tree (const TimeGrid &grid) const override
 Return by default a trinomial recombining tree. More...
 
- Public Member Functions inherited from ShortRateModel
 ShortRateModel (Size nArguments)
 
virtual ext::shared_ptr< Lattice > tree (const TimeGrid &) const =0
 
- 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) More...
 
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. 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)
 
Integer functionEvaluation () const
 
- Public Member Functions inherited from Observer
 Observer ()=default
 
 Observer (const Observer &)
 
Observer & operator= (const Observer &)
 
virtual ~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 update ()=0
 
virtual void deepUpdate ()
 
- Public Member Functions inherited from Observable
 Observable ()=default
 
 Observable (const Observable &)
 
Observable & operator= (const Observable &)
 
 Observable (Observable &&)=delete
 
Observable & operator= (Observable &&)=delete
 
virtual ~Observable ()=default
 
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.

Definition at line 38 of file onefactormodel.hpp.

Constructor & Destructor Documentation

◆ OneFactorModel()

OneFactorModel ( Size  nArguments)
explicit

Definition at line 86 of file onefactormodel.cpp.

◆ ~OneFactorModel()

~OneFactorModel ( )
overridedefault

Member Function Documentation

◆ dynamics()

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

returns the short-rate dynamics

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

+ Here is the caller graph for this function:

◆ tree()

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

Return by default a trinomial recombining tree.

Implements ShortRateModel.

Reimplemented in BlackKarasinski, CoxIngersollRoss, ExtendedCoxIngersollRoss, and HullWhite.

Definition at line 90 of file onefactormodel.cpp.

+ Here is the call graph for this function: