File: optimizer.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 (162 lines) | stat: -rw-r--r-- 5,958 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
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
/*
 Copyright (C) 2001, 2002 Nicolas Di Csar

 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 optimizer.hpp
    \brief Abstract optimization class

    \fullpath
    ql/Optimization/%optimizer.hpp
*/

#ifndef quantlib_optimization_optimizer_h
#define quantlib_optimization_optimizer_h

#include <ql/handle.hpp>

#include <ql/Optimization/constraint.hpp>
#include <ql/Optimization/costfunction.hpp>
#include <ql/Optimization/criteria.hpp>

namespace QuantLib {

    namespace Optimization {

        class OptimizationMethod;
        class OptimizationProblem;
        //! Optimization Method abstract class for unconstrained optimization pb
        class OptimizationMethod {
          public:
            explicit OptimizationMethod()
            : iterationNumber_(0), functionEvaluation_(0),
              gradientEvaluation_(0), functionValue_(1), squaredNorm_(1) {}
            virtual ~OptimizationMethod() {}

            //! Set initial value
            inline void setInitialValue(const Array& initialValue) {
                iterationNumber_ = 0;
                initialValue_ = initialValue;
                x_ = initialValue;
                searchDirection_ = Array(x_.size ());
            }
            //! Set optimization end criteria
            inline void setEndCriteria(
                const OptimizationEndCriteria& endCriteria) {
                endCriteria_ = endCriteria;
            }

            //! current iteration number
            inline int& iterationNumber() {
                return iterationNumber_;
            }

            //! optimization end criteria
            inline OptimizationEndCriteria& endCriteria() {
                return endCriteria_;
            }

            //! number of evaluation of cost function
            inline int& functionEvaluation() { return functionEvaluation_; }
            //! number of evaluation of cost function gradient
            inline int& gradientEvaluation() { return gradientEvaluation_; }
            //! value of cost function
            inline double& functionValue() { return functionValue_; }
            //! value of cost function gradient norm
            inline double& gradientNormValue() { return squaredNorm_; }
            //! current value of the local minimum
            Array& x() { return x_; }
            //! current value of the search direction
            Array& searchDirection() { return searchDirection_; }

            //! minimize the optimization problem P
            virtual void minimize(OptimizationProblem& P) = 0;
          protected:
            //! initial value of unknowns
            Array initialValue_;
            //! current iteration step in the Optimization process
            int iterationNumber_;
            //! optimization end criteria
            OptimizationEndCriteria endCriteria_;
            //! number of evaluation of cost function and its gradient
            int functionEvaluation_, gradientEvaluation_;
            //! function and gradient norm values of the last step
            double functionValue_, squaredNorm_;
            //! current values of the local minimum and the search direction
            Array x_, searchDirection_;
        };

        //! Unconstrained optimization pb
        class OptimizationProblem {
          public:
            //! default constructor
            OptimizationProblem(
                CostFunction& f,          // Function and it gradient vector
                Constraint& c,            // Constraint
                OptimizationMethod& meth) // Optimization method
            : costFunction_(f), constraint_(c), method_(meth) {}
            //! destructor
            ~OptimizationProblem() {}

            //! call cost function computation and increment evaluation counter
            double value(const Array& x) {
                method_.functionEvaluation()++;
                return costFunction_.value(x);
            }

            //! call cost function gradient computation and increment
            //  evaluation counter
            void gradient(Array& grad_f, const Array& x) {
                method_.gradientEvaluation()++;
                costFunction_.gradient(grad_f, x);
            }

            //! call cost function computation and it gradient
            double valueAndGradient (Array& grad_f, const Array& x) {
                method_.functionEvaluation()++;
                method_.gradientEvaluation()++;
                return costFunction_.valueAndGradient(grad_f, x);
            }

            //! Unconstrained optimization method
            OptimizationMethod &optimisationMethod () {
                return method_;
            }

            //! constraint
            Constraint& constraint() {
                return constraint_;
            }

            CostFunction& costFunction() {
                return costFunction_;
            }

            //! Minimization
            void minimize() { method_.minimize(*this); }

            Array& minimumValue() { return method_.x (); }

          protected:
            //! Unconstrained cost function
            CostFunction& costFunction_;
            //! Constraint
            Constraint& constraint_;
            //! Unconstrained optimization method
            OptimizationMethod& method_;
        };

    }

}
#endif