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
|
/*
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 costfunction.hpp
\brief Optimization cost function class
\fullpath
ql/Optimization/%costfunction.hpp
*/
#ifndef quantlib_optimization_costfunction_h
#define quantlib_optimization_costfunction_h
#include <ql/qldefines.hpp>
#include <ql/array.hpp>
namespace QuantLib {
namespace Optimization {
//! Cost function abstract class for optimization problem
class CostFunction {
public:
//! method to overload to compute the cost functon value in x
virtual double value(const Array& x) = 0;
//! method to overload to compute grad_f, the first derivative of
// the cost function with respect to x
virtual void gradient(Array& grad, const Array& x) {
double eps = finiteDifferenceEpsilon(), fp, fm;
Array xx(x);
for (Size i=0; i<x.size(); i++) {
xx[i] += eps;
fp = value(xx);
xx[i] -= 2.0*eps;
fm = value(xx);
grad[i] = 0.5*(fp - fm)/eps;
xx[i] = x[i];
}
std::cout << "Gradient at " << x << " = " << grad << std::endl;
}
//! method to overload to compute grad_f, the first derivative of
// the cost function with respect to x and also the cost function
virtual double valueAndGradient(Array& grad, const Array& x) {
gradient(grad, x);
return value(x);
}
//! Default epsilon for finite difference method :
virtual double finiteDifferenceEpsilon() { return 1e-8; }
};
}
}
#endif
|