QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MCHestonHullWhiteEngine< RNG, S > Class Template Reference

#include <mchestonhullwhiteengine.hpp>

+ Inheritance diagram for MCHestonHullWhiteEngine< RNG, S >:
+ Collaboration diagram for MCHestonHullWhiteEngine< RNG, S >:

Public Types

typedef MCVanillaEngine< MultiVariate, RNG, Sbase_type
 
typedef base_type::path_generator_type path_generator_type
 
typedef base_type::path_pricer_type path_pricer_type
 
typedef base_type::stats_type stats_type
 
typedef base_type::result_type result_type
 
- Public Types inherited from McSimulation< MC, RNG, S >
typedef MonteCarloModel< MC, RNG, S >::path_generator_type path_generator_type
 
typedef MonteCarloModel< MC, RNG, S >::path_pricer_type path_pricer_type
 
typedef MonteCarloModel< MC, RNG, S >::stats_type stats_type
 
typedef MonteCarloModel< MC, RNG, S >::result_type result_type
 

Public Member Functions

 MCHestonHullWhiteEngine (const ext::shared_ptr< HybridHestonHullWhiteProcess > &process, Size timeSteps, Size timeStepsPerYear, bool antitheticVariate, bool controlVariate, Size requiredSamples, Real requiredTolerance, Size maxSamples, BigNatural seed)
 
void calculate () const override
 
- Public Member Functions inherited from MCVanillaEngine< MC, RNG, S, Inst >
void calculate () const override
 
- Public Member Functions inherited from McSimulation< MC, RNG, S >
virtual ~McSimulation ()=default
 
result_type value (Real tolerance, Size maxSamples=QL_MAX_INTEGER, Size minSamples=1023) const
 add samples until the required absolute tolerance is reached More...
 
result_type valueWithSamples (Size samples) const
 simulate a fixed number of samples More...
 
result_type errorEstimate () const
 error estimated using the samples simulated so far More...
 
const stats_typesampleAccumulator () const
 access to the sample accumulator for richer statistics More...
 
void calculate (Real requiredTolerance, Size requiredSamples, Size maxSamples) const
 basic calculate method provided to inherited pricing engines More...
 

Protected Member Functions

ext::shared_ptr< path_pricer_typepathPricer () const override
 
ext::shared_ptr< path_pricer_typecontrolPathPricer () const override
 
ext::shared_ptr< PricingEnginecontrolPricingEngine () const override
 
ext::shared_ptr< path_generator_typecontrolPathGenerator () const override
 
- Protected Member Functions inherited from MCVanillaEngine< MC, RNG, S, Inst >
 MCVanillaEngine (ext::shared_ptr< StochasticProcess >, Size timeSteps, Size timeStepsPerYear, bool brownianBridge, bool antitheticVariate, bool controlVariate, Size requiredSamples, Real requiredTolerance, Size maxSamples, BigNatural seed)
 
TimeGrid timeGrid () const override
 
ext::shared_ptr< path_generator_typepathGenerator () const override
 
result_type controlVariateValue () const override
 
- Protected Member Functions inherited from McSimulation< MC, RNG, S >
 McSimulation (bool antitheticVariate, bool controlVariate)
 
virtual ext::shared_ptr< path_pricer_typepathPricer () const =0
 
virtual ext::shared_ptr< path_generator_typepathGenerator () const =0
 
virtual TimeGrid timeGrid () const =0
 
virtual ext::shared_ptr< path_pricer_typecontrolPathPricer () const
 
virtual ext::shared_ptr< path_generator_typecontrolPathGenerator () const
 
virtual ext::shared_ptr< PricingEnginecontrolPricingEngine () const
 
virtual result_type controlVariateValue () const
 

Protected Attributes

ext::shared_ptr< HybridHestonHullWhiteProcessprocess_
 
- Protected Attributes inherited from MCVanillaEngine< MC, RNG, S, Inst >
ext::shared_ptr< StochasticProcessprocess_
 
Size timeSteps_
 
Size timeStepsPerYear_
 
Size requiredSamples_
 
Size maxSamples_
 
Real requiredTolerance_
 
bool brownianBridge_
 
BigNatural seed_
 
- Protected Attributes inherited from McSimulation< MC, RNG, S >
ext::shared_ptr< MonteCarloModel< MC, RNG, S > > mcModel_
 
bool antitheticVariate_
 
bool controlVariate_
 

Additional Inherited Members

- Protected Types inherited from MCVanillaEngine< MC, RNG, S, Inst >
typedef McSimulation< MC, RNG, S >::path_generator_type path_generator_type
 
typedef McSimulation< MC, RNG, S >::path_pricer_type path_pricer_type
 
typedef McSimulation< MC, RNG, S >::stats_type stats_type
 
typedef McSimulation< MC, RNG, S >::result_type result_type
 
- Static Protected Member Functions inherited from McSimulation< MC, RNG, S >
template<class Sequence >
static Real maxError (const Sequence &sequence)
 
static Real maxError (Real error)
 

Detailed Description

template<class RNG = PseudoRandom, class S = Statistics>
class QuantLib::MCHestonHullWhiteEngine< RNG, S >

Definition at line 37 of file mchestonhullwhiteengine.hpp.

Member Typedef Documentation

◆ base_type

Definition at line 40 of file mchestonhullwhiteengine.hpp.

◆ path_generator_type

Definition at line 41 of file mchestonhullwhiteengine.hpp.

◆ path_pricer_type

Definition at line 42 of file mchestonhullwhiteengine.hpp.

◆ stats_type

Definition at line 43 of file mchestonhullwhiteengine.hpp.

◆ result_type

Definition at line 44 of file mchestonhullwhiteengine.hpp.

Constructor & Destructor Documentation

◆ MCHestonHullWhiteEngine()

MCHestonHullWhiteEngine ( const ext::shared_ptr< HybridHestonHullWhiteProcess > &  process,
Size  timeSteps,
Size  timeStepsPerYear,
bool  antitheticVariate,
bool  controlVariate,
Size  requiredSamples,
Real  requiredTolerance,
Size  maxSamples,
BigNatural  seed 
)

Definition at line 111 of file mchestonhullwhiteengine.hpp.

Member Function Documentation

◆ calculate()

void calculate
override

Definition at line 128 of file mchestonhullwhiteengine.hpp.

+ Here is the call graph for this function:

◆ pathPricer()

ext::shared_ptr< typename MCHestonHullWhiteEngine< RNG, S >::path_pricer_type > pathPricer
overrideprotectedvirtual

Implements McSimulation< MC, RNG, S >.

Definition at line 140 of file mchestonhullwhiteengine.hpp.

◆ controlPathPricer()

ext::shared_ptr< typename MCHestonHullWhiteEngine< RNG, S >::path_pricer_type > controlPathPricer
overrideprotectedvirtual

Reimplemented from McSimulation< MC, RNG, S >.

Definition at line 158 of file mchestonhullwhiteengine.hpp.

◆ controlPricingEngine()

ext::shared_ptr< PricingEngine > controlPricingEngine
overrideprotectedvirtual

Reimplemented from McSimulation< MC, RNG, S >.

Definition at line 182 of file mchestonhullwhiteengine.hpp.

◆ controlPathGenerator()

ext::shared_ptr< typename MCHestonHullWhiteEngine< RNG, S >::path_generator_type > controlPathGenerator
overrideprotectedvirtual

Reimplemented from McSimulation< MC, RNG, S >.

Definition at line 204 of file mchestonhullwhiteengine.hpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ process_

ext::shared_ptr<HybridHestonHullWhiteProcess> process_
protected

Definition at line 61 of file mchestonhullwhiteengine.hpp.