minimizer.hh

Go to the documentation of this file.

/* -*- mia-c++  -*-
 *
 * This file is part of MIA - a toolbox for medical image analysis 
 * Copyright (c) Leipzig, Madrid 1999-2017 Gert Wollny
 *
 * MIA 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 3 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 MIA; if not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef mia_core_minimizer_hh
#define mia_core_minimizer_hh

#include <memory>
#include <vector>

#include <mia/core/factory.hh>
#include <mia/core/handler.hh>
#include <mia/core/vector.hh>

NS_MIA_BEGIN


class EXPORT_CORE  CMinimizer : public CProductBase {
public: 

        typedef CMinimizer plugin_data; 
        typedef CMinimizer plugin_type; 

        typedef std::shared_ptr<CMinimizer> Pointer; 
        
        enum EMinimizerResult {failure, 
                               success  
        }; 

        static const char *const type_descr; 
        
        static const char *const data_descr; 
        
        class Problem : public CPropertyFlagHolder{
        public:
                virtual ~Problem(); 

                double  f(size_t n, const double *x); 

                void    df(size_t n, const double *x, double *g); 
                double  fdf(size_t n, const double *x, double *g); 

                double  f(const std::vector<double>& x); 
                
                void    df(const std::vector<double>& x, std::vector<double>& g); 
                
                double  fdf(const std::vector<double>& x, std::vector<double>& g); 

                double  f(const CDoubleVector& x); 
                
                void    df(const CDoubleVector& x, CDoubleVector& g); 
                
                double  fdf(const CDoubleVector& x, CDoubleVector& g); 


                size_t size() const; 
        private: 
                virtual double  do_f(const CDoubleVector& x) = 0; 
                virtual void    do_df(const CDoubleVector& x, CDoubleVector&  g) = 0; 
                virtual double  do_fdf(const CDoubleVector& x, CDoubleVector&  g) = 0; 
                virtual size_t do_size() const = 0; 
        }; 

        typedef std::shared_ptr<Problem> PProblem; 

        CMinimizer(); 

        void set_problem(PProblem x);
        
        
        virtual ~CMinimizer(); 

        
        int run(CDoubleVector& x); 
        
protected: 
        Problem *get_problem_pointer();  
        
        size_t size() const; 

        Problem& get_problem(); 
private: 
        virtual void do_set_problem();
        virtual int do_run(CDoubleVector& x) = 0;

        PProblem m_problem;
}; 

typedef CMinimizer::Pointer PMinimizer; 

typedef TFactory<CMinimizer> CMinimizerPlugin;

typedef THandlerSingleton<TFactoryPluginHandler<CMinimizerPlugin> > CMinimizerPluginHandler;

FACTORY_TRAIT(CMinimizerPluginHandler); 

inline CMinimizer::Problem& CMinimizer::get_problem()
{
        return *m_problem;
}

inline 
PMinimizer produce_minimizer(const std::string& descr) 
{
        return CMinimizerPluginHandler::instance().produce(descr); 
}

        
NS_MIA_END

#endif