QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
Loading...
Searching...
No Matches
pathwisemultiproduct.hpp
Go to the documentation of this file.
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
3/*
4Copyright (C) 2006, 2008 Mark Joshi
5
6This file is part of QuantLib, a free-software/open-source library
7for financial quantitative analysts and developers - http://quantlib.org/
8
9QuantLib is free software: you can redistribute it and/or modify it
10under the terms of the QuantLib license. You should have received a
11copy 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<http://quantlib.org/license.shtml>.
14
15This program is distributed in the hope that it will be useful, but WITHOUT
16ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17FOR A PARTICULAR PURPOSE. See the license for more details.
18*/
19
20
21#ifndef quantlib_market_model_pathwise_multi_product_hpp
22#define quantlib_market_model_pathwise_multi_product_hpp
23
24#include <ql/types.hpp>
25#include <vector>
26#include <memory>
27
28namespace QuantLib {
29
30 class EvolutionDescription;
31 class CurveState;
32
33 //! market-model pathwise product
34 /*! This is the abstract base class that encapsulates the notion of a
35 product: it contains the information that would be in the termsheet
36 of the product.
37
38 It's useful to have it be able to do several products simultaneously.
39 The products would have to have the same underlying rate times of
40 course. The class is therefore really encapsulating the notion of a
41 multi-product.
42
43 For each time evolved to, it generates the cash flows associated to
44 that time for the state of the yield curve. If one was doing a
45 callable product then this would encompass the product and its
46 exercise strategy.
47
48 This class differs from market-model multi-product in that it also returns the
49 derivative of the pay-off with respect to each forward rate
50
51 */
52
54 {
55 public:
56 struct CashFlow {
58 std::vector<Real > amount;
59 };
61
62 virtual std::vector<Size> suggestedNumeraires() const = 0;
63 virtual const EvolutionDescription& evolution() const = 0;
64 virtual std::vector<Time> possibleCashFlowTimes() const = 0;
65 virtual Size numberOfProducts() const = 0;
67
68 virtual bool alreadyDeflated() const =0;
69
70 //! during simulation put product at start of path
71 virtual void reset() = 0;
72 //! return value indicates whether path is finished, TRUE means done
73 virtual bool nextTimeStep(
74 const CurveState& currentState,
75 std::vector<Size>& numberCashFlowsThisStep,
76 std::vector<std::vector<MarketModelPathwiseMultiProduct::CashFlow> >& cashFlowsGenerated) = 0;
77 //! returns a newly-allocated copy of itself
78 virtual std::unique_ptr<MarketModelPathwiseMultiProduct> clone() const = 0;
79 };
80
81}
82
83
84#endif
Curve state for market-model simulations
Definition: curvestate.hpp:41
Market-model evolution description.
virtual std::vector< Time > possibleCashFlowTimes() const =0
virtual Size numberOfProducts() const =0
virtual bool alreadyDeflated() const =0
virtual void reset()=0
during simulation put product at start of path
virtual std::vector< Size > suggestedNumeraires() const =0
virtual ~MarketModelPathwiseMultiProduct()=default
virtual Size maxNumberOfCashFlowsPerProductPerStep() const =0
virtual bool nextTimeStep(const CurveState &currentState, std::vector< Size > &numberCashFlowsThisStep, std::vector< std::vector< MarketModelPathwiseMultiProduct::CashFlow > > &cashFlowsGenerated)=0
return value indicates whether path is finished, TRUE means done
virtual const EvolutionDescription & evolution() const =0
virtual std::unique_ptr< MarketModelPathwiseMultiProduct > clone() const =0
returns a newly-allocated copy of itself
std::size_t Size
size of a container
Definition: types.hpp:58
Definition: any.hpp:35
Custom types.