File: ContinuationValueTree.h

package info (click to toggle)
stopt 5.12%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 8,860 kB
  • sloc: cpp: 70,456; python: 5,950; makefile: 72; sh: 57
file content (108 lines) | stat: -rw-r--r-- 3,540 bytes parent folder | download | duplicates (3)
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
// Copyright (C) 2019 EDF
// All Rights Reserved
// This code is published under the GNU Lesser General Public License (GNU LGPL)
#ifndef CONTINUATIONVALUETREE_H
#define CONTINUATIONVALUETREE_H
#include <iostream>
#include <memory>
#include <Eigen/Dense>
#include "StOpt/tree/Tree.h"
#include "StOpt/core/grids/SpaceGrid.h"

/** \file ContinuatonValueTree.h
 *  \brief Calculate and store continuation value functon for tree method
 * \author Xavier warin
 */

namespace StOpt
{

/// \class ContinuationValueTree ContinuationValueTree.h
/// Permits to store, store  continuation values on a grid for tree methods
class ContinuationValueTree
{

private :

    std::shared_ptr< SpaceGrid >    m_grid ; ///< grid used to define stock points
    Eigen::ArrayXXd m_values ; ///< store node values  for each stock  (nb node, nb stock points)  at current date

public :
    /// \brief Default constructor
    ContinuationValueTree() {}

    /// \brief Constructor
    /// \param p_grid            grid for stocks
    /// \param p_condExp         tree for conditional expectation
    /// \param p_valuesNextDate  cash     matrix to store cash  (number of simulations by nb of stocks)
    ContinuationValueTree(const  std::shared_ptr< SpaceGrid >   &p_grid,
                          const std::shared_ptr< Tree >   &p_condExp,
                          const Eigen::ArrayXXd &p_valuesNextDate) :
        m_grid(p_grid),  m_values(p_condExp->expCondMultiple(p_valuesNextDate.transpose()).transpose())
    {
    }

    /// \brief Load another Continuation value object
    ///  Only a partial load of the objects is achieved
    /// \param p_grid   Grid to load
    /// \param p_values  continuation values for all nodes and stocks
    virtual void loadForSimulation(const  std::shared_ptr< SpaceGrid > &p_grid,
                                   const Eigen::ArrayXXd &p_values)
    {
        m_grid = p_grid;
        m_values = p_values ;
    }


    /// \brief Get continuation value for one stock point
    /// \param p_ptOfStock   grid point for interpolation
    /// \return the continuation value associated to each node used in optimization
    Eigen::ArrayXd getValueAtNodes(const Eigen::ArrayXd &p_ptOfStock) const
    {
        return m_grid->createInterpolator(p_ptOfStock)->applyVec(m_values);
    }

    /// \brief Same as before but use an interpolator
    Eigen::ArrayXd getValueAtNodes(const Interpolator   &p_interpol) const
    {
        return p_interpol.applyVec(m_values);
    }


    /// \brief Get a conditional expectation for a given
    /// \param p_node    node number
    /// \param  p_ptOfStock     stock points
    /// \return the continuation value associated to the given node used in optimization
    double  getValueAtANode(const int &p_node, const Eigen::ArrayXd &p_ptOfStock) const
    {
        return m_grid->createInterpolator(p_ptOfStock)->apply(m_values.row(p_node).transpose());
    }


    /// \brief Same as before but use an interpolator
    /// \param p_node    node number
    /// \param  p_ptOfStock     stock points
    /// \return the continuation value associated to the given node used in optimization
    double  getValueAtANode(const int &p_node, const Interpolator   &p_interpol) const
    {
        return p_interpol.apply(m_values.row(p_node).transpose());
    }

    //// \brief Get back
    ///@{
    const Eigen::ArrayXXd &getValues()  const
    {
        return m_values;
    }
    std::shared_ptr< SpaceGrid > getGrid() const
    {
        return m_grid;
    }
    ///@}

};

}


#endif