OSBonminSolver.h

Go to the documentation of this file.

/* $Id: OSBonminSolver.h 5284 2017-12-08 13:52:50Z stefan $ */
#ifndef BONMINSOLVER_H
#define BONMINSOLVER_H

#include "OSConfig.h"
#include "OSDefaultSolver.h"
#include "OSrLWriter.h"
#include "OSInstance.h"
#include "OSParameters.h"
#include "OSnLNode.h"
#include "OSiLReader.h"
#include "OSrLReader.h"
#include "OSoLReader.h"
#include "OSInstance.h"
#include "OSExpressionTree.h"
#include "OSnLNode.h"
#include "OSDataStructures.h"
#include "OSFileUtil.h"
#include "OSErrorClass.h"

#include "OSResult.h"
#include "OSInstance.h"
#include "OSOption.h"

#include <cstddef>
#include <cstdlib>
#include <cctype>
#include <cassert>
#include <stack>
#include <string>
#include <iostream>
#include <vector>
#include <map>

#include "BonCbc.hpp"
#include "BonTMINLP.hpp"
#include "BonBonminSetup.hpp"

// for Stefan
class BonminProblem : public Bonmin::TMINLP
{



public:

    BonminProblem(OSInstance *osinstance_ , OSOption *osoption_);

    virtual ~BonminProblem();

    OSInstance *osinstance;

    OSOption *osoption;

    Bonmin::TMINLP::SolverReturn status;


    virtual bool get_variables_types(Ipopt::Index n, VariableType* var_types);

    virtual bool get_variables_linearity(Ipopt::Index n, Ipopt::TNLP::LinearityType* var_types);

    virtual bool get_constraints_linearity(Ipopt::Index m, Ipopt::TNLP::LinearityType* const_types);

    virtual bool get_nlp_info(Ipopt::Index& n, Ipopt::Index&m, Ipopt::Index& nnz_jac_g,
                              Ipopt::Index& nnz_h_lag, Ipopt::TNLP::IndexStyleEnum& index_style);



    //virtual bool get_nlp_info(Index& n, Index& m, Index& nnz_jac_g,
    //                       Index& nnz_h_lag, IndexStyleEnum& index_style);

    virtual bool get_bounds_info(Ipopt::Index n, Ipopt::Number* x_l, Ipopt::Number* x_u,
                                 Ipopt::Index m, Ipopt::Number* g_l, Ipopt::Number* g_u);

    virtual bool get_starting_point(Ipopt::Index n, bool init_x, Ipopt::Number* x,
                                    bool init_z, Ipopt::Number* z_L, Ipopt::Number* z_U,
                                    Ipopt::Index m, bool init_lambda,
                                    Ipopt::Number* lambda);

    virtual bool eval_f(Ipopt::Index n, const Ipopt::Number* x, bool new_x, Ipopt::Number& obj_value);

    virtual bool eval_grad_f(Ipopt::Index n, const Ipopt::Number* x, bool new_x, Ipopt::Number* grad_f);

    virtual bool eval_g(Ipopt::Index n, const Ipopt::Number* x, bool new_x, Ipopt::Index m, Ipopt::Number* g);

    virtual bool eval_jac_g(Ipopt::Index n, const Ipopt::Number* x, bool new_x,
                            Ipopt::Index m, Ipopt::Index nele_jac, Ipopt::Index* iRow, Ipopt::Index *jCol,
                            Ipopt::Number* values);

    virtual bool eval_h(Ipopt::Index n, const Ipopt::Number* x, bool new_x,
                        Ipopt::Number obj_factor, Ipopt::Index m, const Ipopt::Number* lambda,
                        bool new_lambda, Ipopt::Index nele_hess, Ipopt::Index* iRow,
                        Ipopt::Index* jCol, Ipopt::Number* values);



    virtual bool get_scaling_parameters(Ipopt::Number& obj_scaling,
                                        bool& use_x_scaling, Ipopt::Index n,
                                        Ipopt::Number* x_scaling,
                                        bool& use_g_scaling, Ipopt::Index m,
                                        Ipopt::Number* g_scaling);

    virtual void finalize_solution(Bonmin::TMINLP::SolverReturn status_,
                                   Ipopt::Index n, const Ipopt::Number* x, Ipopt::Number obj_value);

    virtual const SosInfo * sosConstraints() const
    {
        return NULL;
    }
    virtual const BranchingInfo* branchingInfo() const
    {
        return NULL;
    }

    void printSolutionAtEndOfAlgorithm()
    {
        printSol_ = true;
    }





private:
    bool printSol_;

private:
    //  HS071_NLP();




    std::string bonminErrorMsg;


};


class BonminSolver : public DefaultSolver
{
public:



    BonminSolver();

    ~BonminSolver();



    Ipopt::SmartPtr<BonminProblem> tminlp;

    // this is a Bonmin BonCbc object;
    Bonmin::Bab bb;

    Bonmin::TMINLP::SolverReturn status;

    //SmartPtr<IpoptApplication> app;


    virtual void  solve() throw (ErrorClass) ;

    virtual void  buildSolverInstance() throw(ErrorClass);

    virtual void  setSolverOptions() throw(ErrorClass);

    void dataEchoCheck();

    OSiLReader *m_osilreader;

    OSoLReader *m_osolreader;



    void writeResult();


private:
    OSrLWriter  *osrlwriter;

    Bonmin::BonminSetup bonminSetup;

    std::string bonminErrorMsg;
};


#endif /*BONMINSOLVER_H*/