/usr/include/ql/pricingengines/vanilla/mcvanillaengine.hpp is in libquantlib0-dev 1.12-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | /* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2003 Ferdinando Ametrano
Copyright (C) 2003, 2004, 2005, 2007 StatPro Italia srl
This file is part of QuantLib, a free-software/open-source library
for financial quantitative analysts and developers - http://quantlib.org/
QuantLib is free software: you can redistribute it and/or modify it
under the terms of the QuantLib license. You should have received a
copy of the license along with this program; if not, please email
<quantlib-dev@lists.sf.net>. The license is also available online at
<http://quantlib.org/license.shtml>.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the license for more details.
*/
/*! \file mcvanillaengine.hpp
\brief Monte Carlo vanilla option engine
*/
#ifndef quantlib_mcvanilla_engine_hpp
#define quantlib_mcvanilla_engine_hpp
#include <ql/pricingengines/mcsimulation.hpp>
#include <ql/instruments/vanillaoption.hpp>
namespace QuantLib {
//! Pricing engine for vanilla options using Monte Carlo simulation
/*! \ingroup vanillaengines */
template <template <class> class MC, class RNG,
class S = Statistics, class Inst = VanillaOption>
class MCVanillaEngine : public Inst::engine,
public McSimulation<MC,RNG,S> {
public:
void calculate() const {
McSimulation<MC,RNG,S>::calculate(requiredTolerance_,
requiredSamples_,
maxSamples_);
this->results_.value = this->mcModel_->sampleAccumulator().mean();
if (RNG::allowsErrorEstimate)
this->results_.errorEstimate =
this->mcModel_->sampleAccumulator().errorEstimate();
}
protected:
typedef typename McSimulation<MC,RNG,S>::path_generator_type
path_generator_type;
typedef typename McSimulation<MC,RNG,S>::path_pricer_type
path_pricer_type;
typedef typename McSimulation<MC,RNG,S>::stats_type
stats_type;
typedef typename McSimulation<MC,RNG,S>::result_type
result_type;
// constructor
MCVanillaEngine(const boost::shared_ptr<StochasticProcess>&,
Size timeSteps,
Size timeStepsPerYear,
bool brownianBridge,
bool antitheticVariate,
bool controlVariate,
Size requiredSamples,
Real requiredTolerance,
Size maxSamples,
BigNatural seed);
// McSimulation implementation
TimeGrid timeGrid() const;
boost::shared_ptr<path_generator_type> pathGenerator() const {
Size dimensions = process_->factors();
TimeGrid grid = this->timeGrid();
typename RNG::rsg_type generator =
RNG::make_sequence_generator(dimensions*(grid.size()-1),seed_);
return boost::shared_ptr<path_generator_type>(
new path_generator_type(process_, grid,
generator, brownianBridge_));
}
result_type controlVariateValue() const;
// data members
boost::shared_ptr<StochasticProcess> process_;
Size timeSteps_, timeStepsPerYear_;
Size requiredSamples_, maxSamples_;
Real requiredTolerance_;
bool brownianBridge_;
BigNatural seed_;
};
// template definitions
template <template <class> class MC, class RNG, class S, class Inst>
inline MCVanillaEngine<MC,RNG,S,Inst>::MCVanillaEngine(
const boost::shared_ptr<StochasticProcess>& process,
Size timeSteps,
Size timeStepsPerYear,
bool brownianBridge,
bool antitheticVariate,
bool controlVariate,
Size requiredSamples,
Real requiredTolerance,
Size maxSamples,
BigNatural seed)
: McSimulation<MC,RNG,S>(antitheticVariate, controlVariate),
process_(process), timeSteps_(timeSteps),
timeStepsPerYear_(timeStepsPerYear),
requiredSamples_(requiredSamples), maxSamples_(maxSamples),
requiredTolerance_(requiredTolerance),
brownianBridge_(brownianBridge), seed_(seed) {
QL_REQUIRE(timeSteps != Null<Size>() ||
timeStepsPerYear != Null<Size>(),
"no time steps provided");
QL_REQUIRE(timeSteps == Null<Size>() ||
timeStepsPerYear == Null<Size>(),
"both time steps and time steps per year were provided");
QL_REQUIRE(timeSteps != 0,
"timeSteps must be positive, " << timeSteps <<
" not allowed");
QL_REQUIRE(timeStepsPerYear != 0,
"timeStepsPerYear must be positive, " << timeStepsPerYear <<
" not allowed");
this->registerWith(process_);
}
template <template <class> class MC, class RNG, class S, class Inst>
inline typename MCVanillaEngine<MC,RNG,S,Inst>::result_type
MCVanillaEngine<MC,RNG,S,Inst>::controlVariateValue() const {
boost::shared_ptr<PricingEngine> controlPE =
this->controlPricingEngine();
QL_REQUIRE(controlPE,
"engine does not provide "
"control variation pricing engine");
typename Inst::arguments* controlArguments =
dynamic_cast<typename Inst::arguments*>(
controlPE->getArguments());
QL_REQUIRE(controlArguments, "engine is using inconsistent arguments");
*controlArguments = this->arguments_;
controlPE->calculate();
const typename Inst::results* controlResults =
dynamic_cast<const typename Inst::results*>(
controlPE->getResults());
QL_REQUIRE(controlResults,
"engine returns an inconsistent result type");
return result_type(controlResults->value);
}
template <template <class> class MC, class RNG, class S, class Inst>
inline TimeGrid MCVanillaEngine<MC,RNG,S,Inst>::timeGrid() const {
Date lastExerciseDate = this->arguments_.exercise->lastDate();
Time t = process_->time(lastExerciseDate);
if (this->timeSteps_ != Null<Size>()) {
return TimeGrid(t, this->timeSteps_);
} else if (this->timeStepsPerYear_ != Null<Size>()) {
Size steps = static_cast<Size>(this->timeStepsPerYear_*t);
return TimeGrid(t, std::max<Size>(steps, 1));
} else {
QL_FAIL("time steps not specified");
}
}
}
#endif
|