GSLSimAnMinimizer.h

Go to the documentation of this file.

// @(#)root/mathmore:$Id$
// Author: L. Moneta Wed Dec 20 17:16:32 2006
 
/**********************************************************************
 *                                                                    *
 * Copyright (c) 2006  LCG ROOT Math Team, CERN/PH-SFT                *
 *                                                                    *
 * This library is free software; you can redistribute it and/or      *
 * modify it under the terms of the GNU General Public License        *
 * as published by the Free Software Foundation; either version 2     *
 * of the License, or (at your option) any later version.             *
 *                                                                    *
 * This library 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 GNU   *
 * General Public License for more details.                           *
 *                                                                    *
 * You should have received a copy of the GNU General Public License  *
 * along with this library (see file COPYING); if not, write          *
 * to the Free Software Foundation, Inc., 59 Temple Place, Suite      *
 * 330, Boston, MA 02111-1307 USA, or contact the author.             *
 *                                                                    *
 **********************************************************************/
 
// Header file for class GSLSimAnMinimizer
 
#ifndef ROOT_Math_GSLSimAnMinimizer
#define ROOT_Math_GSLSimAnMinimizer
 
 
 
#include "Math/BasicMinimizer.h"
 
 
#include "Math/IFunctionfwd.h"
 
#include "Math/IParamFunctionfwd.h"
 
 
 
#include "Math/GSLSimAnnealing.h"
 
 
 
 
namespace ROOT {
 
   namespace Math {
 
 
 
//_____________________________________________________________________________________
   /**
      GSLSimAnMinimizer class for minimization using simulated annealing
      using the algorithm from
      <A HREF="http://www.gnu.org/software/gsl/manual/html_node/Simulated-Annealing.html">
      GSL</A>.
      It implements the ROOT::Minimizer interface and
      a plug-in (name "GSLSimAn") exists to instantiate this class via the plug-in manager
      Configuration (Setting/getting) the options is done through the methods defined in the
      ROOT::Math::Minimizer class.
      The user needs to call the base class method ROOT::Math::Minimizer::SetOptions to set the
      corresponding options.
      Here is some code example for increasing n_tries from 200 (default) to 1000
       ```
         ROOT::Math::GenAlgoOptions simanOpt;
         simanOpt.SetValue("n_tries", 1000);
         ROOT::Math::MinimizerOptions opt;
         opt.SetExtraOptions(simanOpt);
         minimizer->SetOptions(opt);
       ```
 
      @ingroup MultiMin
   */
   class GSLSimAnMinimizer : public ROOT::Math::BasicMinimizer {
 
   public:
      /**
         Default constructor
      */
      GSLSimAnMinimizer(int type = 0);
 
      /**
         Destructor (no operations)
      */
      ~GSLSimAnMinimizer() override;
 
   private:
      // usually copying is non trivial, so we make this unaccessible
 
      /**
         Copy constructor
      */
      GSLSimAnMinimizer(const GSLSimAnMinimizer &) : ROOT::Math::BasicMinimizer() {}
 
      /**
         Assignment operator
      */
      GSLSimAnMinimizer &operator=(const GSLSimAnMinimizer &rhs)
      {
         if (this == &rhs)
            return *this; // time saving self-test
         return *this;
      }
 
   public:
      /// method to perform the minimization
      bool Minimize() override;
 
      /// number of calls
      unsigned int NCalls() const override;
 
      /// Get current minimizer option parameters
      const GSLSimAnParams &MinimizerParameters() const { return fSolver.Params(); }
 
      /// set new minimizer option parameters using directly the GSLSimAnParams structure
      void SetParameters(const GSLSimAnParams &params)
      {
         fSolver.SetParams(params);
         DoSetMinimOptions(params); // store new parameters also in MinimizerOptions
      }
 
   protected:
      /// set minimizer option parameters from stored ROOT::Math::MinimizerOptions (fOpt)
      void DoSetSimAnParameters(const MinimizerOptions &opt);
 
      /// Set the Minimizer options from the simulated annealing parameters
      void DoSetMinimOptions(const GSLSimAnParams &params);
 
   private:
      ROOT::Math::GSLSimAnnealing fSolver;
 
 
};
 
   } // end namespace Math
 
} // end namespace ROOT
 
 
#endif /* ROOT_Math_GSLSimAnMinimizer */