1 |
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
2 |
|
3 |
/* |
4 |
Copyright (C) 2001, 2002, 2003 Nicolas Di Césaré |
5 |
Copyright (C) 2009 Frédéric Degraeve |
6 |
|
7 |
This file is part of QuantLib, a free-software/open-source library |
8 |
for financial quantitative analysts and developers - http://quantlib.org/ |
9 |
|
10 |
QuantLib is free software: you can redistribute it and/or modify it |
11 |
under the terms of the QuantLib license. You should have received a |
12 |
copy of the license along with this program; if not, please email |
13 |
<quantlib-dev@lists.sf.net>. The license is also available online at |
14 |
<http://quantlib.org/license.shtml>. |
15 |
|
16 |
This program is distributed in the hope that it will be useful, but WITHOUT |
17 |
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
18 |
FOR A PARTICULAR PURPOSE. See the license for more details. |
19 |
*/ |
20 |
|
21 |
/*! \file steepestdescent.hpp |
22 |
\brief Steepest descent optimization method |
23 |
*/ |
24 |
|
25 |
#ifndef quantlib_optimization_steepest_descent_h |
26 |
#define quantlib_optimization_steepest_descent_h |
27 |
|
28 |
#include "optimization/LineSearchBasedMethod.hpp" |
29 |
|
30 |
namespace QuantLib { |
31 |
|
32 |
//! Multi-dimensional steepest-descent class |
33 |
/*! User has to provide line-search method and optimization end criteria |
34 |
|
35 |
search direction \f$ = - f'(x) \f$ |
36 |
*/ |
37 |
class SteepestDescent : public LineSearchBasedMethod { |
38 |
public: |
39 |
SteepestDescent(LineSearch* lineSearch = NULL) |
40 |
: LineSearchBasedMethod(lineSearch) {} |
41 |
private: |
42 |
//! \name LineSearchBasedMethod interface |
43 |
//@{ |
44 |
DynamicVector<RealType> getUpdatedDirection(const Problem& P, |
45 |
RealType gold2, |
46 |
const DynamicVector<RealType>& oldGradient); |
47 |
//@} |
48 |
}; |
49 |
|
50 |
} |
51 |
|
52 |
#endif |