levenbergmarquardt.hpp

Go to the documentation of this file.

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 
/*
 Copyright (C) 2006 Klaus Spanderen
 Copyright (C) 2015 Peter Caspers
 
 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
 <quantlib-dev@lists.sf.net>. The license is also available online at
 <http://quantlib.org/license.shtml>.
 
 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 levenbergmarquardt.hpp
    \brief Levenberg-Marquardt optimization method
*/
 
#ifndef quantlib_optimization_levenberg_marquardt_hpp
#define quantlib_optimization_levenberg_marquardt_hpp
 
#include <ql/math/optimization/problem.hpp>
 
namespace QuantLib {
 
    //! Levenberg-Marquardt optimization method
    /*! This implementation is based on MINPACK
        (<http://www.netlib.org/minpack>,
        <http://www.netlib.org/cephes/linalg.tgz>)
        It has a built in fd scheme to compute
        the jacobian, which is used by default.
        If useCostFunctionsJacobian is true the
        corresponding method in the cost function
        of the problem is used instead. Note that
        the default implementation of the jacobian
        in CostFunction uses a central difference
        (order 2, but requiring more function
        evaluations) compared to the forward
        difference implemented here (order 1).
 
        \ingroup optimizers
    */
    class LevenbergMarquardt : public OptimizationMethod {
      public:
        LevenbergMarquardt(Real epsfcn = 1.0e-8,
                           Real xtol = 1.0e-8,
                           Real gtol = 1.0e-8,
                           bool useCostFunctionsJacobian = false);
        EndCriteria::Type minimize(Problem& P,
                                   const EndCriteria& endCriteria) override;
 
        /*! \deprecated Don't use this method; inspect the result of minimize instead.
                        Deprecated in version 1.36.
        */
        [[deprecated("Don't use this method; inspect the result of minimize instead")]]
        virtual Integer getInfo() const { return info_; }
 
        /*! \deprecated Don't use this method; it is for internal use.
                        Deprecated in version 1.37.
        */
        [[deprecated("Don't use this method; it is for internal use")]]
        void fcn(int m, int n, Real* x, Real* fvec, int*) { fcn(m, n, x, fvec); }
 
        /*! \deprecated Don't use this method; it is for internal use.
                        Deprecated in version 1.37.
        */
        [[deprecated("Don't use this method; it is for internal use")]]
        void jacFcn(int m, int n, Real* x, Real* fjac, int*) { jacFcn(m, n, x, fjac); }
      private:
        void fcn(int m, int n, Real* x, Real* fvec);
        void jacFcn(int m, int n, Real* x, Real* fjac);
 
        Problem* currentProblem_;
        Array initCostValues_;
        Matrix initJacobian_;
        mutable Integer info_ = 0; // remove together with getInfo
        const Real epsfcn_, xtol_, gtol_;
        const bool useCostFunctionsJacobian_;
    };
 
}
 
 
#endif