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
MCLongstaffSchwartzPathEngine< GenericEngine, MC, RNG, S > Class Template Referenceabstract

Longstaff-Schwarz Monte Carlo engine for early exercise options. More...

#include <mclongstaffschwartzpathengine.hpp>

+ Inheritance diagram for MCLongstaffSchwartzPathEngine< GenericEngine, MC, RNG, S >:
+ Collaboration diagram for MCLongstaffSchwartzPathEngine< GenericEngine, MC, RNG, S >:

Public Types

typedef MC< RNG >::path_type path_type
 
typedef McSimulation< MC, RNG, S >::stats_type stats_type
 
typedef McSimulation< MC, RNG, S >::path_pricer_type path_pricer_type
 
typedef McSimulation< MC, RNG, S >::path_generator_type path_generator_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

 MCLongstaffSchwartzPathEngine (ext::shared_ptr< StochasticProcess > process, Size timeSteps, Size timeStepsPerYear, bool brownianBridge, bool antitheticVariate, bool controlVariate, Size requiredSamples, Real requiredTolerance, Size maxSamples, BigNatural seed, Size nCalibrationSamples=Null< Size >())
 
void calculate () const
 
- Public Member Functions inherited from GenericEngine< ArgumentsType, ResultsType >
PricingEngine::argumentsgetArguments () const override
 
const PricingEngine::resultsgetResults () const override
 
void reset () override
 
void update () override
 
- Public Member Functions inherited from PricingEngine
 ~PricingEngine () override=default
 
virtual argumentsgetArguments () const =0
 
virtual const resultsgetResults () const =0
 
virtual void reset ()=0
 
virtual void calculate () const =0
 
- Public Member Functions inherited from Observable
 Observable ()
 
 Observable (const Observable &)
 
Observableoperator= (const Observable &)
 
 Observable (Observable &&)=delete
 
Observableoperator= (Observable &&)=delete
 
virtual ~Observable ()=default
 
void notifyObservers ()
 
- 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 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

virtual ext::shared_ptr< LongstaffSchwartzMultiPathPricerlsmPathPricer () const =0
 
TimeGrid timeGrid () const
 
ext::shared_ptr< path_pricer_typepathPricer () const
 
ext::shared_ptr< path_generator_typepathGenerator () const
 
- 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< StochasticProcessprocess_
 
const Size timeSteps_
 
const Size timeStepsPerYear_
 
const bool brownianBridge_
 
const Size requiredSamples_
 
const Real requiredTolerance_
 
const Size maxSamples_
 
const Size seed_
 
const Size nCalibrationSamples_
 
ext::shared_ptr< LongstaffSchwartzMultiPathPricerpathPricer_
 
- Protected Attributes inherited from GenericEngine< ArgumentsType, ResultsType >
ArgumentsType arguments_
 
ResultsType results_
 
- Protected Attributes inherited from McSimulation< MC, RNG, S >
ext::shared_ptr< MonteCarloModel< MC, RNG, S > > mcModel_
 
bool antitheticVariate_
 
bool controlVariate_
 

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)
 

Detailed Description

template<class GenericEngine, template< class > class MC, class RNG, class S = Statistics>
class QuantLib::MCLongstaffSchwartzPathEngine< GenericEngine, MC, RNG, S >

Longstaff-Schwarz Monte Carlo engine for early exercise options.

References:

Francis Longstaff, Eduardo Schwartz, 2001. Valuing American Options by Simulation: A Simple Least-Squares Approach, The Review of Financial Studies, Volume 14, No. 1, 113-147

Tests:
the correctness of the returned value is tested by reproducing results available in web/literature

Definition at line 41 of file mclongstaffschwartzpathengine.hpp.

Member Typedef Documentation

◆ path_type

typedef MC<RNG>::path_type path_type

Definition at line 44 of file mclongstaffschwartzpathengine.hpp.

◆ stats_type

typedef McSimulation<MC,RNG,S>::stats_type stats_type

Definition at line 46 of file mclongstaffschwartzpathengine.hpp.

◆ path_pricer_type

typedef McSimulation<MC,RNG,S>::path_pricer_type path_pricer_type

Definition at line 48 of file mclongstaffschwartzpathengine.hpp.

◆ path_generator_type

typedef McSimulation<MC,RNG,S>::path_generator_type path_generator_type

Definition at line 50 of file mclongstaffschwartzpathengine.hpp.

Constructor & Destructor Documentation

◆ MCLongstaffSchwartzPathEngine()

MCLongstaffSchwartzPathEngine ( ext::shared_ptr< StochasticProcess process,
Size  timeSteps,
Size  timeStepsPerYear,
bool  brownianBridge,
bool  antitheticVariate,
bool  controlVariate,
Size  requiredSamples,
Real  requiredTolerance,
Size  maxSamples,
BigNatural  seed,
Size  nCalibrationSamples = Null<Size>() 
)

Definition at line 88 of file mclongstaffschwartzpathengine.hpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ calculate()

void calculate
virtual

Implements PricingEngine.

Definition at line 135 of file mclongstaffschwartzpathengine.hpp.

+ Here is the call graph for this function:

◆ lsmPathPricer()

virtual ext::shared_ptr< LongstaffSchwartzMultiPathPricer > lsmPathPricer ( ) const
protectedpure virtual

Implemented in MCAmericanPathEngine< RNG >.

◆ timeGrid()

TimeGrid timeGrid
protectedvirtual

Implements McSimulation< MC, RNG, S >.

Definition at line 159 of file mclongstaffschwartzpathengine.hpp.

+ Here is the call graph for this function:

◆ pathPricer()

ext::shared_ptr< typename MCLongstaffSchwartzPathEngine< GenericEngine, MC, RNG, S >::path_pricer_type > pathPricer
protectedvirtual

Implements McSimulation< MC, RNG, S >.

Definition at line 125 of file mclongstaffschwartzpathengine.hpp.

◆ pathGenerator()

ext::shared_ptr< typename MCLongstaffSchwartzPathEngine< GenericEngine, MC, RNG, S >::path_generator_type > pathGenerator
protectedvirtual

Implements McSimulation< MC, RNG, S >.

Definition at line 180 of file mclongstaffschwartzpathengine.hpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ process_

ext::shared_ptr<StochasticProcess> process_
protected

Definition at line 74 of file mclongstaffschwartzpathengine.hpp.

◆ timeSteps_

const Size timeSteps_
protected

Definition at line 75 of file mclongstaffschwartzpathengine.hpp.

◆ timeStepsPerYear_

const Size timeStepsPerYear_
protected

Definition at line 76 of file mclongstaffschwartzpathengine.hpp.

◆ brownianBridge_

const bool brownianBridge_
protected

Definition at line 77 of file mclongstaffschwartzpathengine.hpp.

◆ requiredSamples_

const Size requiredSamples_
protected

Definition at line 78 of file mclongstaffschwartzpathengine.hpp.

◆ requiredTolerance_

const Real requiredTolerance_
protected

Definition at line 79 of file mclongstaffschwartzpathengine.hpp.

◆ maxSamples_

const Size maxSamples_
protected

Definition at line 80 of file mclongstaffschwartzpathengine.hpp.

◆ seed_

const Size seed_
protected

Definition at line 81 of file mclongstaffschwartzpathengine.hpp.

◆ nCalibrationSamples_

const Size nCalibrationSamples_
protected

Definition at line 82 of file mclongstaffschwartzpathengine.hpp.

◆ pathPricer_

ext::shared_ptr<LongstaffSchwartzMultiPathPricer> pathPricer_
mutableprotected

Definition at line 84 of file mclongstaffschwartzpathengine.hpp.