gsl_min_fminimizer.h

Go to the documentation of this file.

//

//  This function minimizer class has been adapted from the gslwrap project.
//  It is a C++ wrapper for the GNU Scientific Library
//  Copyright (C) 2001 Ramin Nakisa

//  This program 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 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
//  GNU General Public License for more details.

//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.


#ifndef __GSL_MIN_FMINIMIZER_H
#define __GSL_MIN_FMINIMIZER_H 

#include <gsl/gsl_errno.h>
#include <gsl/gsl_min.h>

//

class min_f
{
  public:

//
//

        virtual double operator()(const double& x);

//
//

        static double f(double x, void *p);

};

//

class min_fminimizer 
{
 public:
 
//
//
        
        min_fminimizer(const gsl_min_fminimizer_type* type=gsl_min_fminimizer_brent);

//
//
        
        ~min_fminimizer();

//
//

        int set(min_f& function, double minimum, double x_lower, double x_upper);
//
        
        int set_with_values(min_f& function, 
                                                double minimum, double f_minimum, 
                                                double x_lower,double f_lower, 
                                                double x_upper, double f_upper);

//

        int iterate();

//

        double minimum();

//

        double x_upper();

//

        double x_lower();

//
//
        void SetMaxIterations(int n);

//
        
        int GetNIterations();

//
//

        bool is_converged();
        
 private:
 
//

        void assert_set(); 
        
//

        bool isSet;

//

        bool isConverged;

//
        
        int nIterations;

//

        int maxIterations;

//
        
        gsl_min_fminimizer* s;

//
        gsl_function f;
};

#endif //__min_fminimizer_h