Coverage Report

Created: 2026-03-11 06:44

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/quantlib/ql/methods/montecarlo/earlyexercisepathpricer.hpp
Line
Count
Source
1
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
3
/*
4
 Copyright (C) 2006 Klaus Spanderen
5
6
 This file is part of QuantLib, a free-software/open-source library
7
 for financial quantitative analysts and developers - http://quantlib.org/
8
9
 QuantLib is free software: you can redistribute it and/or modify it
10
 under the terms of the QuantLib license.  You should have received a
11
 copy of the license along with this program; if not, please email
12
 <quantlib-dev@lists.sf.net>. The license is also available online at
13
 <https://www.quantlib.org/license.shtml>.
14
15
 This program is distributed in the hope that it will be useful, but WITHOUT
16
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17
 FOR A PARTICULAR PURPOSE.  See the license for more details.
18
*/
19
20
/*! \file earlyexercisepathpricer.hpp
21
    \brief base class for early exercise single-path pricers
22
*/
23
24
#ifndef quantlib_early_exercise_path_pricer_hpp
25
#define quantlib_early_exercise_path_pricer_hpp
26
27
#include <ql/math/array.hpp>
28
#include <ql/methods/montecarlo/path.hpp>
29
#include <ql/methods/montecarlo/multipath.hpp>
30
#include <functional>
31
32
namespace QuantLib {
33
34
    template <class PathType>
35
    class EarlyExerciseTraits {
36
        // dummy definition, will not work
37
    };
38
39
    template <>
40
    class EarlyExerciseTraits<Path> {
41
      public:
42
        typedef Real StateType;
43
0
        static Size pathLength(const Path& path) {
44
0
            return path.length();
45
0
        }
46
    };
47
48
    template <>
49
    class EarlyExerciseTraits<MultiPath> {
50
      public:
51
        typedef Array StateType;
52
0
        static Size pathLength(const MultiPath& path) {
53
0
            return path.pathSize();
54
0
        }
55
    };
56
57
    //! base class for early exercise path pricers
58
    /*! Returns the value of an option on a given path and given time.
59
60
        \ingroup mcarlo
61
    */
62
    template<class PathType,
63
             class TimeType=Size, class ValueType=Real>
64
    class EarlyExercisePathPricer {
65
      public:
66
        typedef typename EarlyExerciseTraits<PathType>::StateType StateType;
67
68
0
        virtual ~EarlyExercisePathPricer() = default;
Unexecuted instantiation: QuantLib::EarlyExercisePathPricer<QuantLib::MultiPath, unsigned long, double>::~EarlyExercisePathPricer()
Unexecuted instantiation: QuantLib::EarlyExercisePathPricer<QuantLib::Path, unsigned long, double>::~EarlyExercisePathPricer()
69
        virtual ValueType operator()(const PathType& path,
70
                                     TimeType t) const = 0;
71
72
        virtual StateType
73
            state(const PathType& path, TimeType t) const = 0;
74
        virtual std::vector<std::function<ValueType(StateType)> >
75
            basisSystem() const = 0;
76
    };
77
}
78
79
80
#endif