CbcGenOsiParam.hpp

Go to the documentation of this file.

/*
  Copyright (C) 2007, Lou Hafer, International Business Machines Corporation
  and others.  All Rights Reserved.

  This file is part of cbc-generic.
*/

#ifndef CbcOsiParam_H
#define CbcOsiParam_H

/* \file CbcGenOsiParam.hpp
   \brief Declarations for parameters that act on a OsiSolverInterface object.
*/

/*
  $Id: CbcGenOsiParam.hpp 1173 2009-06-04 09:44:10Z forrest $
*/

class CbcOsiParam : public CoinParam {

public:


    typedef enum { CBCOSI_FIRSTPARAM = CbcCbcParam::CBCCBC_LASTPARAM + 1,

                   ALGORITHM, ALLSLACK, AUTOSCALE, BARRIER, BARRIERSCALE,
                   BASISIN, BASISOUT, BIASLU, CHOLESKY, CRASH, CROSSOVER,
                   DUALBOUND, DUALPIVOT, DUALSIMPLEX, DUALTOLERANCE, FAKEBOUND,
                   GAMMA, IDIOT, KEEPNAMES, KKT, MAXITERATION, MAXHOTITS, NETLIB_BARRIER,
                   NETLIB_DUAL, NETLIB_PRIMAL, NETWORK, OBJSCALE, PERTURBATION,
                   PERTVALUE, PFI, PLUSMINUS, PRESOLVE, PRESOLVEOPTIONS, PRESOLVEPASS,
                   PRIMALPIVOT, PRIMALSIMPLEX, PRIMALTOLERANCE, REALLY_SCALE,
                   RESTORE, REVERSE, RHSSCALE, SAVE, SCALING, SLPVALUE, SOLVERLOGLEVEL,
                   SPARSEFACTOR, SPECIALOPTIONS, SPRINT, TIGHTEN,

                   CBCOSI_LASTPARAM

                 } CbcOsiParamCode ;


    CbcOsiParam() ;

    CbcOsiParam(CbcOsiParamCode code, std::string name, std::string help,
                double lower, double upper, double dflt = 0.0,
                bool display = true) ;

    CbcOsiParam(CbcOsiParamCode code, std::string name, std::string help,
                int lower, int upper, int dflt = 0,
                bool display = true) ;

    CbcOsiParam(CbcOsiParamCode code, std::string name, std::string help,
                std::string firstValue, int dflt, bool display = true) ;

    CbcOsiParam(CbcOsiParamCode code, std::string name, std::string help,
                std::string dflt, bool display = true) ;

    CbcOsiParam(CbcOsiParamCode code, std::string name, std::string help,
                bool display = true) ;

    CbcOsiParam(const CbcOsiParam &orig) ;

    CbcOsiParam *clone() ;

    CbcOsiParam &operator=(const CbcOsiParam &rhs) ;

    ~CbcOsiParam() ;



    inline CbcOsiParamCode paramCode() const {
        return (paramCode_) ;
    }

    inline void setParamCode(CbcOsiParamCode code) {
        paramCode_ = code ;
    }

    inline OsiSolverInterface *obj() const {
        return (obj_) ;
    }

    inline void setObj(OsiSolverInterface *obj) {
        obj_ = obj ;
    }



private:


    CbcOsiParamCode paramCode_ ;

    OsiSolverInterface *obj_ ;


} ;



/*
  Declare the utility functions.
*/

namespace CbcOsiParamUtils {
void addCbcOsiParams(int &numParams, CoinParamVec &paramVec,
                     OsiSolverInterface *osi) ;
void loadOsiParamObj(const CoinParamVec paramVec,
                     CbcGenCtlBlk *ctlBlk) ;
void setOsiSolverInterfaceDefaults(OsiSolverInterface *osi) ;

int pushCbcOsiLogLevel(CoinParam *param) ;
int pushCbcOsiInt(CoinParam *param) ;
int pushCbcOsiDbl(CoinParam *param) ;
int pushCbcOsiKwd(CoinParam *param) ;
int pushCbcOsiHint(CoinParam *param) ;
}


#endif