QuantLib
A free/open-source library for quantitative finance
Reference manual - version 1.5
Classes | Public Member Functions | Protected Member Functions | List of all members
CoxIngersollRoss Class Reference

Cox-Ingersoll-Ross model class. More...

#include <ql/models/shortrate/onefactormodels/coxingersollross.hpp>

+ Inheritance diagram for CoxIngersollRoss:

Classes

class  Dynamics
 Dynamics of the short-rate under the Cox-Ingersoll-Ross model More...
 

Public Member Functions

 CoxIngersollRoss (Rate r0=0.05, Real theta=0.1, Real k=0.1, Real sigma=0.1)
 
virtual Real discountBondOption (Option::Type type, Real strike, Time maturity, Time bondMaturity) const
 
virtual boost::shared_ptr
< ShortRateDynamics
dynamics () const
 returns the short-rate dynamics
 
boost::shared_ptr< Latticetree (const TimeGrid &grid) const
 Return by default a trinomial recombining tree.
 
- Public Member Functions inherited from OneFactorAffineModel
 OneFactorAffineModel (Size nArguments)
 
virtual Real discountBond (Time now, Time maturity, Array factors) const
 
Real discountBond (Time now, Time maturity, Rate rate) const
 
DiscountFactor discount (Time t) const
 Implied discount curve.
 
- Public Member Functions inherited from OneFactorModel
 OneFactorModel (Size nArguments)
 
- Public Member Functions inherited from ShortRateModel
 ShortRateModel (Size nArguments)
 
- Public Member Functions inherited from CalibratedModel
 CalibratedModel (Size nArguments)
 
void update ()
 
virtual void calibrate (const std::vector< boost::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 (caps/swaptions) More...
 
Real value (const Array &params, const std::vector< boost::shared_ptr< CalibrationHelper > > &)
 
const boost::shared_ptr
< Constraint > & 
constraint () const
 
EndCriteria::Type endCriteria ()
 returns end criteria result
 
Disposable< Arrayparams () const
 Returns array of arguments on which calibration is done.
 
virtual void setParams (const Array &params)
 
- Public Member Functions inherited from Observer
 Observer (const Observer &)
 
Observeroperator= (const Observer &)
 
std::pair< std::set
< boost::shared_ptr
< Observable > >::iterator,
bool > 
registerWith (const boost::shared_ptr< Observable > &)
 
Size unregisterWith (const boost::shared_ptr< Observable > &)
 
void unregisterWithAll ()
 
- Public Member Functions inherited from Observable
 Observable (const Observable &)
 
Observableoperator= (const Observable &)
 
void notifyObservers ()
 
- Public Member Functions inherited from AffineModel
virtual Real discountBondOption (Option::Type type, Real strike, Time maturity, Time bondStart, Time bondMaturity) const
 

Protected Member Functions

Real A (Time t, Time T) const
 
Real B (Time t, Time T) const
 
Real theta () const
 
Real k () const
 
Real sigma () const
 
Real x0 () const
 
- Protected Member Functions inherited from CalibratedModel
virtual void generateArguments ()
 

Additional Inherited Members

- Protected Attributes inherited from CalibratedModel
std::vector< Parameterarguments_
 
boost::shared_ptr< Constraintconstraint_
 
EndCriteria::Type shortRateEndCriteria_
 

Detailed Description

Cox-Ingersoll-Ross model class.

This class implements the Cox-Ingersoll-Ross model defined by

\[ dr_t = k(\theta - r_t)dt + \sqrt{r_t}\sigma dW_t . \]

Bug:
this class was not tested enough to guarantee its functionality.