CbcGenCbcParam.hpp

Go to the documentation of this file.

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

  This code is licensed under the terms of the Eclipse Public License (EPL).

  $Id: CbcGenCbcParam.hpp 2465 2019-01-03 19:26:52Z unxusr $
*/
/*
  This file is part of cbc-generic.
*/

#ifndef CbcCbcParam_H
#define CbcCbcParam_H

/* \file CbcGenCbcParam.hpp
   \brief Declarations for parameters that act on a CbcModel object.
*/

/*
  $Id: CbcGenCbcParam.hpp 2465 2019-01-03 19:26:52Z unxusr $
*/

class CbcCbcParam : public CoinParam {

public:

  typedef enum { CBCCBC_FIRSTPARAM = CbcGenParam::CBCGEN_LASTPARAM + 1,

    ALLOWABLEGAP,
    COSTSTRATEGY,
    CUTDEPTH,
    CUTOFF,
    CUTPASS,
    DIRECTION,
    GAPRATIO,
    INCREMENT,
    INFEASIBILITYWEIGHT,
    INTEGERTOLERANCE,
    LOGLEVEL,
    MAXIMIZE,
    MAXNODES,
    MINIMIZE,
    MIPOPTIONS,
    MOREMIPOPTIONS,
    NUMBERANALYZE,
    NUMBERBEFORE,
    NUMBERMINI,
    STRONGBRANCHING,
    TIMELIMIT_BAB,

    CBCCBC_LASTPARAM

  } CbcCbcParamCode;


  CbcCbcParam();

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

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

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

  CbcCbcParam(CbcCbcParamCode code, std::string name, std::string help,
    std::string dflt, bool display = true);

  CbcCbcParam(CbcCbcParamCode code, std::string name, std::string help,
    bool display = true);

  CbcCbcParam(const CbcCbcParam &orig);

  CbcCbcParam *clone();

  CbcCbcParam &operator=(const CbcCbcParam &rhs);

  ~CbcCbcParam();



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

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

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

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


private:

  CbcCbcParamCode paramCode_;

  CbcModel *obj_;

};

/*
  Declare the utility functions.
*/

namespace CbcCbcParamUtils {
void addCbcCbcParams(int &numParams, CoinParamVec &paramVec,
  CbcModel *model);
void loadCbcParamObj(const CoinParamVec paramVec, int first, int last,
  CbcModel *model);
void setCbcModelDefaults(CbcModel *model);

int pushCbcCbcDbl(CoinParam *param);
int pushCbcCbcInt(CoinParam *param);
}

#endif

/* vi: softtabstop=2 shiftwidth=2 expandtab tabstop=2
*/