| 1 | 
gezelter | 
1741 | 
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ | 
| 2 | 
  | 
  | 
 | 
| 3 | 
  | 
  | 
/* | 
| 4 | 
  | 
  | 
 Copyright (C) 2006 Ferdinando Ametrano | 
| 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 linesearchbasedmethod.hpp | 
| 22 | 
  | 
  | 
    \brief Abstract optimization method class | 
| 23 | 
  | 
  | 
*/ | 
| 24 | 
  | 
  | 
 | 
| 25 | 
  | 
  | 
#ifndef quantlib_line_search_based_optimization_method_h | 
| 26 | 
  | 
  | 
#define quantlib_line_search_based_optimization_method_h | 
| 27 | 
  | 
  | 
 | 
| 28 | 
  | 
  | 
#include "optimization/Method.hpp" | 
| 29 | 
  | 
  | 
#include "math/DynamicVector.hpp" | 
| 30 | 
  | 
  | 
 | 
| 31 | 
  | 
  | 
using namespace OpenMD; | 
| 32 | 
  | 
  | 
namespace QuantLib { | 
| 33 | 
  | 
  | 
 | 
| 34 | 
  | 
  | 
    class LineSearch; | 
| 35 | 
  | 
  | 
 | 
| 36 | 
  | 
  | 
    class LineSearchBasedMethod : public OptimizationMethod { | 
| 37 | 
  | 
  | 
      public: | 
| 38 | 
  | 
  | 
        LineSearchBasedMethod(LineSearch* lSearch = NULL); | 
| 39 | 
  | 
  | 
        virtual ~LineSearchBasedMethod() {} | 
| 40 | 
  | 
  | 
 | 
| 41 | 
  | 
  | 
        virtual EndCriteria::Type minimize(Problem& P, | 
| 42 | 
  | 
  | 
                                           const EndCriteria& endCriteria); | 
| 43 | 
  | 
  | 
      protected: | 
| 44 | 
  | 
  | 
        //! computes the new search direction | 
| 45 | 
  | 
  | 
        virtual DynamicVector<RealType> | 
| 46 | 
  | 
  | 
        getUpdatedDirection(const Problem &P, | 
| 47 | 
  | 
  | 
                            RealType gold2, | 
| 48 | 
  | 
  | 
                            const DynamicVector<RealType>& gradient) = 0; | 
| 49 | 
  | 
  | 
        //! line search | 
| 50 | 
  | 
  | 
       LineSearch* lineSearch_; | 
| 51 | 
  | 
  | 
    }; | 
| 52 | 
  | 
  | 
 | 
| 53 | 
  | 
  | 
} | 
| 54 | 
  | 
  | 
 | 
| 55 | 
  | 
  | 
#endif |