QuantLib_McSimulation man page

McSimulation< MC, RNG, S > — base class for Monte Carlo engines


#include <ql/pricingengines/mcsimulation.hpp>

Inherited by MCLongstaffSchwartzEngine< GenericEngine, MC, RNG, S, RNG_Calibration >, MCLongstaffSchwartzPathEngine< GenericEngine, MC, RNG, S >, and MCVanillaEngine< MC, RNG, S, Inst >.

Public Types

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

result_type value (Real tolerance, Size maxSamples=QL_MAX_INTEGER, Size minSamples=1023) const
add samples until the required absolute tolerance is reached
result_type valueWithSamples (Size samples) const
simulate a fixed number of samples
result_type errorEstimate () const
error estimated using the samples simulated so far
const stats_type & sampleAccumulator (void) const
access to the sample accumulator for richer statistics
void calculate (Real requiredTolerance, Size requiredSamples, Size maxSamples) const
basic calculate method provided to inherited pricing engines

Protected Member Functions

McSimulation (bool antitheticVariate, bool controlVariate)

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

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

virtual TimeGrid timeGrid () const =0

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

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

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

virtual result_type controlVariateValue () const

Static Protected Member Functions

template<class Sequence > static Real maxError (const Sequence &sequence)

static Real maxError (Real error)

Protected Attributes

boost::shared_ptr< MonteCarloModel< MC, RNG, S > > mcModel_

bool antitheticVariate_

bool controlVariate_

Detailed Description

template<template< class > class MC, class RNG, class S = Statistics>

class QuantLib::McSimulation< MC, RNG, S >" base class for Monte Carlo engines

Eventually this class might offer greeks methods. Deriving a class from McSimulation gives an easy way to write a Monte Carlo engine.

See McVanillaEngine as an example.


Generated automatically by Doxygen for QuantLib from the source code.

Referenced By

antitheticVariate_(3), controlPathGenerator(3), controlVariate_(3), mcModel_(3), McSimulation(3), sampleAccumulator(3) and valueWithSamples(3) are aliases of QuantLib_McSimulation(3).

QuantLib Version 1.8.1 Fri Sep 23 2016