File: model.hpp

package info (click to toggle)
quantlib 0.2.1.cvs20020322-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 4,716 kB
  • ctags: 4,614
  • sloc: cpp: 19,601; sh: 7,389; makefile: 796; ansic: 22
file content (117 lines) | stat: -rw-r--r-- 3,841 bytes parent folder | download
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
/*
 Copyright (C) 2001, 2002 Sadruddin Rejeb

 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 ferdinando@ametrano.net
 The license is also available online at http://quantlib.org/html/license.html

 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 model.hpp
    \brief Abstract interest rate model class

    \fullpath
    ql/InterestRateModelling/%model.hpp
*/

// $Id: model.hpp,v 1.21 2002/03/06 07:16:06 sadrejeb Exp $

#ifndef quantlib_interest_rate_modelling_model_h
#define quantlib_interest_rate_modelling_model_h

#include <ql/array.hpp>
#include <ql/option.hpp>
#include <ql/termstructure.hpp>
#include <ql/InterestRateModelling/parameter.hpp>
#include <ql/Optimization/optimizer.hpp>


namespace QuantLib {

    namespace InterestRateModelling {

        class CalibrationSet;

        //! Abstract short-rate model class
        class Model : public Patterns::Observer, 
                      public Patterns::Observable {
          public:
            Model(Size nParameters, 
                  const RelinkableHandle<TermStructure>& termStructure)
            : parameters_(nParameters), termStructure_(termStructure) {
                registerWith(termStructure_);
            }

            virtual ~Model() {}

            void update() { 
                generateParameters();
                notifyObservers(); 
            }

            void calibrate(
                CalibrationSet& instruments,
                const Handle<Optimization::OptimizationMethod>& method);

            //! Returns the present term structure implied by the model
            const RelinkableHandle<TermStructure>& termStructure() const {
                return termStructure_;
            }

          protected:
            virtual void generateParameters() {}

            Handle<Optimization::Constraint> constraint_;
            std::vector<Parameter> parameters_;

          private:
            Array params() {
                Size size = 0, i;
                for (i=0; i<parameters_.size(); i++)
                    size += parameters_[i].size();
                Array params(size);
                Size k = 0;
                for (i=0; i<parameters_.size(); i++) {
                    for (Size j=0; j<parameters_[i].size(); j++, k++) {
                        params[k] = parameters_[i].params()[j];
                    }
                }
                return params; 
            }

            void setParams(const Array& params) {
                Array::const_iterator p = params.begin();
                for (Size i=0; i<parameters_.size(); i++) {
                    for (Size j=0; j<parameters_[i].size(); j++, p++) {
                        QL_REQUIRE(p!=params.end(),"Parameter array too small");
                        parameters_[i].setParam(j, *p);
                    }
                }
                QL_REQUIRE(p==params.end(),"Parameter array too big!");
                update();
            }

            class CalibrationFunction;
            friend class CalibrationFunction;
            const RelinkableHandle<TermStructure>& termStructure_;
        };

        class AffineModel {
          public:
            virtual double discountBondOption(
                Option::Type type,
                double strike,
                Time maturity,
                Time bondMaturity) const = 0;
        };

    }

}
#endif