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

Abstract base-class for two-factor models. More...

#include <twofactormodel.hpp>

+ Inheritance diagram for TwoFactorModel:
+ Collaboration diagram for TwoFactorModel:

Classes

class  ShortRateDynamics
 Class describing the dynamics of the two state variables. More...
 
class  ShortRateTree
 Recombining two-dimensional tree discretizing the state variable. More...
 

Public Member Functions

 TwoFactorModel (Size nParams)
 
virtual ext::shared_ptr< ShortRateDynamicsdynamics () const =0
 Returns the short-rate dynamics. More...
 
ext::shared_ptr< Latticetree (const TimeGrid &grid) const override
 Returns a two-dimensional trinomial tree. More...
 
- Public Member Functions inherited from ShortRateModel
 ShortRateModel (Size nArguments)
 
virtual ext::shared_ptr< Latticetree (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 ArrayproblemValues () 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 &)
 
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 ()
 
- Public Member Functions inherited from Observable
 Observable ()
 
 Observable (const Observable &)
 
Observableoperator= (const Observable &)
 
 Observable (Observable &&)=delete
 
Observableoperator= (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< Parameterarguments_
 
ext::shared_ptr< Constraintconstraint_
 
EndCriteria::Type shortRateEndCriteria_ = EndCriteria::None
 
Array problemValues_
 
Integer functionEvaluation_
 

Detailed Description

Abstract base-class for two-factor models.

Definition at line 37 of file twofactormodel.hpp.

Constructor & Destructor Documentation

◆ TwoFactorModel()

TwoFactorModel ( Size  nParams)
explicit

Definition at line 26 of file twofactormodel.cpp.

Member Function Documentation

◆ dynamics()

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

Returns the short-rate dynamics.

Implemented in G2.

+ Here is the caller graph for this function:

◆ tree()

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

Returns a two-dimensional trinomial tree.

Implements ShortRateModel.

Definition at line 30 of file twofactormodel.cpp.

+ Here is the call graph for this function: