#include <ql/pricingengines/forward/mcforwardeuropeanhestonengine.hpp>

Inheritance diagram for MCForwardEuropeanHestonEngine< RNG, S, P >:

Collaboration diagram for MCForwardEuropeanHestonEngine< RNG, S, P >:

Public Types
typedef MCForwardVanillaEngine< MultiVariate, RNG, S >::path_generator_type	path_generator_type

typedef MCForwardVanillaEngine< MultiVariate, RNG, S >::path_pricer_type	path_pricer_type

typedef MCForwardVanillaEngine< MultiVariate, RNG, S >::stats_type	stats_type

Public Types inherited from MCForwardVanillaEngine< MC, RNG, S >
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

Public Types inherited from Observer
typedef set_type::iterator	iterator

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
	MCForwardEuropeanHestonEngine (const ext::shared_ptr< P > &process, Size timeSteps, Size timeStepsPerYear, bool antitheticVariate, Size requiredSamples, Real requiredTolerance, Size maxSamples, BigNatural seed, bool controlVariate=false)

Public Member Functions inherited from MCForwardVanillaEngine< MC, RNG, S >
	MCForwardVanillaEngine (ext::shared_ptr< StochasticProcess > process, Size timeSteps, Size timeStepsPerYear, bool brownianBridge, bool antitheticVariate, Size requiredSamples, Real requiredTolerance, Size maxSamples, BigNatural seed, bool controlVariate=false)

void	calculate () const override

Public Member Functions inherited from GenericEngine< ForwardOptionArguments< VanillaOption::arguments >, VanillaOption::results >
PricingEngine::arguments *	getArguments () const override

const PricingEngine::results *	getResults () const override

void	reset () override

void	update () override

Public Member Functions inherited from PricingEngine
	~PricingEngine () override=default

virtual arguments *	getArguments () const =0

virtual const results *	getResults () const =0

virtual void	reset ()=0

virtual void	calculate () const =0

Public Member Functions inherited from Observable
	Observable ()

	Observable (const Observable &)

Observable &	operator= (const Observable &)

	Observable (Observable &&)=delete

Observable &	operator= (Observable &&)=delete

virtual	~Observable ()=default

void	notifyObservers ()

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 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_type &	sampleAccumulator () 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_type >	pathPricer () const override

ext::shared_ptr< path_pricer_type >	controlPathPricer () const override

ext::shared_ptr< PricingEngine >	controlPricingEngine () const override

Protected Member Functions inherited from MCForwardVanillaEngine< MC, RNG, S >
TimeGrid	timeGrid () const override

Real	controlVariateValue () const override

ext::shared_ptr< path_generator_type >	pathGenerator () const override

Protected Member Functions inherited from McSimulation< MC, RNG, S >
	McSimulation (bool antitheticVariate, bool controlVariate)

virtual ext::shared_ptr< path_pricer_type >	pathPricer () const =0

virtual ext::shared_ptr< path_generator_type >	pathGenerator () const =0

virtual TimeGrid	timeGrid () const =0

virtual ext::shared_ptr< path_pricer_type >	controlPathPricer () const

virtual ext::shared_ptr< path_generator_type >	controlPathGenerator () const

virtual ext::shared_ptr< PricingEngine >	controlPricingEngine () const

virtual result_type	controlVariateValue () const

Additional Inherited Members
Static Protected Member Functions inherited from McSimulation< MC, RNG, S >
template<class Sequence >
static Real	maxError (const Sequence &sequence)

static Real	maxError (Real error)

Protected Attributes inherited from MCForwardVanillaEngine< MC, RNG, S >
ext::shared_ptr< StochasticProcess >	process_

Size	timeSteps_

Size	timeStepsPerYear_

Size	requiredSamples_

Size	maxSamples_

Real	requiredTolerance_

bool	brownianBridge_

BigNatural	seed_

Protected Attributes inherited from GenericEngine< ForwardOptionArguments< VanillaOption::arguments >, VanillaOption::results >
ForwardOptionArguments< VanillaOption::arguments >	arguments_

VanillaOption::results	results_

Protected Attributes inherited from McSimulation< MC, RNG, S >
ext::shared_ptr< MonteCarloModel< MC, RNG, S > >	mcModel_

bool	antitheticVariate_

bool	controlVariate_

Detailed Description

template<class RNG = PseudoRandom, class S = Statistics, class P = HestonProcess>
class QuantLib::MCForwardEuropeanHestonEngine< RNG, S, P >

References:

Control Variate trade-off considerations discussed in pull request: https://github.com/lballabio/QuantLib/pull/948

Tests:

Heston MC prices for a flat Heston process are compared to analytical BS prices with the same volatility for a range of moneynesses
Heston MC prices for a forward-starting option resetting at t=0 are compared to semi-analytical Heston prices for a range of moneynesses

Definition at line 48 of file mcforwardeuropeanhestonengine.hpp.

Member Typedef Documentation

◆ path_generator_type

typedef MCForwardVanillaEngine<MultiVariate,RNG,S>::path_generator_type path_generator_type

Definition at line 53 of file mcforwardeuropeanhestonengine.hpp.

◆ path_pricer_type

typedef MCForwardVanillaEngine<MultiVariate,RNG,S>::path_pricer_type path_pricer_type

Definition at line 56 of file mcforwardeuropeanhestonengine.hpp.

◆ stats_type

typedef MCForwardVanillaEngine<MultiVariate,RNG,S>::stats_type stats_type

Definition at line 58 of file mcforwardeuropeanhestonengine.hpp.

Constructor & Destructor Documentation

◆ MCForwardEuropeanHestonEngine()

MCForwardEuropeanHestonEngine	(	const ext::shared_ptr< P > &	process,
		Size	timeSteps,
		Size	timeStepsPerYear,
		bool	antitheticVariate,
		Size	requiredSamples,
		Real	requiredTolerance,
		Size	maxSamples,
		BigNatural	seed,
		bool	controlVariate = `false`
	)