QuantLib
A free/open-source library for quantitative finance
Reference manual - version 1.20
Public Member Functions | List of all members
HullWhiteProcess Class Reference

Hull-White stochastic process. More...

#include <ql/processes/hullwhiteprocess.hpp>

+ Inheritance diagram for HullWhiteProcess:

Public Member Functions

 HullWhiteProcess (const Handle< YieldTermStructure > &h, Real a, Real sigma)
 
- Public Member Functions inherited from StochasticProcess1D
virtual Real evolve (Time t0, Real x0, Time dt, Real dw) const
 
virtual Real apply (Real x0, Real dx) const
 
- Public Member Functions inherited from StochasticProcess
virtual Size factors () const
 returns the number of independent factors of the process
 
virtual Time time (const Date &) const
 
void update ()
 
- Public Member Functions inherited from Observer
 Observer (const Observer &)
 
Observeroperator= (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 &)
 
Observableoperator= (const Observable &)
 
void notifyObservers ()
 

StochasticProcess1D interface

ext::shared_ptr< QuantLib::OrnsteinUhlenbeckProcessprocess_
 
Handle< YieldTermStructureh_
 
Real a_
 
Real sigma_
 
Real x0 () const
 returns the initial value of the state variable
 
Real drift (Time t, Real x) const
 returns the drift part of the equation, i.e. \( \mu(t, x_t) \)
 
Real diffusion (Time t, Real x) const
 returns the diffusion part of the equation, i.e. \( \sigma(t, x_t) \)
 
Real expectation (Time t0, Real x0, Time dt) const
 
Real stdDeviation (Time t0, Real x0, Time dt) const
 
Real variance (Time t0, Real x0, Time dt) const
 
Real a () const
 
Real sigma () const
 
Real alpha (Time t) const
 

Additional Inherited Members

- Public Types inherited from Observer
typedef boost::unordered_set< ext::shared_ptr< Observable > > set_type
 
typedef set_type::iterator iterator
 
- Protected Member Functions inherited from StochasticProcess1D
 StochasticProcess1D ()
 
 StochasticProcess1D (const ext::shared_ptr< discretization > &)
 
- Protected Member Functions inherited from StochasticProcess
 StochasticProcess ()
 
 StochasticProcess (const ext::shared_ptr< discretization > &)
 
- Protected Attributes inherited from StochasticProcess1D
ext::shared_ptr< discretizationdiscretization_
 
- Protected Attributes inherited from StochasticProcess
ext::shared_ptr< discretizationdiscretization_
 

Detailed Description

Hull-White stochastic process.

Member Function Documentation

◆ expectation()

Real expectation ( Time  t0,
Real  x0,
Time  dt 
) const
virtual

returns the expectation \( E(x_{t_0 + \Delta t} | x_{t_0} = x_0) \) of the process after a time interval \( \Delta t \) according to the given discretization. This method can be overridden in derived classes which want to hard-code a particular discretization.

Reimplemented from StochasticProcess1D.

◆ stdDeviation()

Real stdDeviation ( Time  t0,
Real  x0,
Time  dt 
) const
virtual

returns the standard deviation \( S(x_{t_0 + \Delta t} | x_{t_0} = x_0) \) of the process after a time interval \( \Delta t \) according to the given discretization. This method can be overridden in derived classes which want to hard-code a particular discretization.

Reimplemented from StochasticProcess1D.

◆ variance()

Real variance ( Time  t0,
Real  x0,
Time  dt 
) const
virtual

returns the variance \( V(x_{t_0 + \Delta t} | x_{t_0} = x_0) \) of the process after a time interval \( \Delta t \) according to the given discretization. This method can be overridden in derived classes which want to hard-code a particular discretization.

Reimplemented from StochasticProcess1D.