CbcParam.hpp

Go to the documentation of this file.

/* $Id: CbcParam.hpp 1432 2010-02-07 19:33:53Z bjarni $ */
// Copyright (C) 2002, International Business Machines
// Corporation and others.  All Rights Reserved.

#ifndef CbcParam_H
#define CbcParam_H

#include "OsiSolverInterface.hpp"
#include "CbcModel.hpp"
class ClpSimplex;
enum CbcParameterType

{ CBC_PARAM_GENERALQUERY = -100, 
  CBC_PARAM_FULLGENERALQUERY,

  CLP_PARAM_DBL_PRIMALTOLERANCE = 1, 
  CLP_PARAM_DBL_DUALTOLERANCE, 
  CBC_PARAM_DBL_CUTOFF, 
  CLP_PARAM_DBL_TIMELIMIT,
  CLP_PARAM_DBL_DUALBOUND, 
  CLP_PARAM_DBL_PRIMALWEIGHT,  
  CLP_PARAM_DBL_OBJSCALE, 
  CLP_PARAM_DBL_RHSSCALE,

  CBC_PARAM_DBL_INFEASIBILITYWEIGHT = 51, 
  CBC_PARAM_DBL_INTEGERTOLERANCE, 
  CBC_PARAM_DBL_INCREMENT, 
  CBC_PARAM_DBL_ALLOWABLEGAP,

  CBC_PARAM_DBL_DJFIX = 81, 
  CBC_PARAM_DBL_GAPRATIO, 
  CBC_PARAM_DBL_TIGHTENFACTOR,

  CLP_PARAM_INT_LOGLEVEL = 101, 
  CLP_PARAM_INT_SOLVERLOGLEVEL, 
  CBC_PARAM_INT_MAXNODES, 
  CBC_PARAM_INT_STRONGBRANCHING,
  CLP_PARAM_INT_MAXFACTOR, 
  CLP_PARAM_INT_PERTVALUE, 
  CLP_PARAM_INT_MAXITERATION, 
  CLP_PARAM_INT_PRESOLVEPASS, 
  CLP_PARAM_INT_IDIOT, 
  CLP_PARAM_INT_SPRINT,
  CLP_PARAM_INT_OUTPUTFORMAT, 
  CLP_PARAM_INT_SLPVALUE, 
  CLP_PARAM_INT_PRESOLVEOPTIONS, 
  CLP_PARAM_INT_PRINTOPTIONS, 
  CLP_PARAM_INT_SPECIALOPTIONS,

  CLP_PARAM_STR_DIRECTION = 201, 
  CLP_PARAM_STR_DUALPIVOT, 
  CLP_PARAM_STR_SCALING, 
  CLP_PARAM_STR_ERRORSALLOWED, 
  CLP_PARAM_STR_KEEPNAMES, 
  CLP_PARAM_STR_SPARSEFACTOR,
  CLP_PARAM_STR_PRIMALPIVOT, 
  CLP_PARAM_STR_PRESOLVE, 
  CLP_PARAM_STR_CRASH, 
  CLP_PARAM_STR_BIASLU, 
  CLP_PARAM_STR_PERTURBATION, 
  CLP_PARAM_STR_MESSAGES, 
  CLP_PARAM_STR_AUTOSCALE,
  CLP_PARAM_STR_CHOLESKY, 
  CLP_PARAM_STR_KKT, 
  CLP_PARAM_STR_BARRIERSCALE, 
  CLP_PARAM_STR_GAMMA, 
  CLP_PARAM_STR_CROSSOVER, 
  CLP_PARAM_STR_PFI, 
  CLP_PARAM_NOTUSED_ALGORITHM,

  CBC_PARAM_STR_NODESTRATEGY = 251, 
  CBC_PARAM_STR_BRANCHSTRATEGY, 
  CBC_PARAM_NOTUSED_ADDCUTSSTRATEGY,
  CBC_PARAM_STR_GOMORYCUTS, 
  CBC_PARAM_STR_PROBINGCUTS, 
  CBC_PARAM_STR_KNAPSACKCUTS, 
  CBC_PARAM_NOTUSED_ODDHOLECUTS,
  CBC_PARAM_STR_ROUNDING, 
  CBC_PARAM_STR_SOLVER, 
  CBC_PARAM_STR_CLIQUECUTS, 
  CBC_PARAM_STR_COSTSTRATEGY, 
  CBC_PARAM_STR_FLOWCUTS, 
  CBC_PARAM_STR_MIXEDCUTS,
  CBC_PARAM_STR_TWOMIRCUTS, 
  CBC_PARAM_STR_PREPROCESS,

  CLP_PARAM_ACTION_DIRECTORY = 301, 
  CLP_PARAM_ACTION_IMPORT, 
  CLP_PARAM_ACTION_EXPORT, 
  CLP_PARAM_ACTION_RESTORE, 
  CLP_PARAM_ACTION_SAVE, 
  CLP_PARAM_ACTION_DUALSIMPLEX, 
  CLP_PARAM_ACTION_PRIMALSIMPLEX,
  CLP_PARAM_ACTION_MAXIMIZE, 
  CLP_PARAM_ACTION_MINIMIZE, 
  CLP_PARAM_ACTION_EXIT, 
  CLP_PARAM_ACTION_STDIN, 
  CLP_PARAM_ACTION_UNITTEST, 
  CLP_PARAM_ACTION_NETLIB_DUAL, 
  CLP_PARAM_ACTION_NETLIB_PRIMAL, 
  CLP_PARAM_ACTION_SOLUTION,
  CLP_PARAM_ACTION_TIGHTEN, 
  CLP_PARAM_ACTION_FAKEBOUND, 
  CLP_PARAM_ACTION_HELP, 
  CLP_PARAM_ACTION_PLUSMINUS, 
  CLP_PARAM_ACTION_NETWORK, 
  CLP_PARAM_ACTION_ALLSLACK, 
  CLP_PARAM_ACTION_REVERSE, 
  CLP_PARAM_ACTION_BARRIER, 
  CLP_PARAM_ACTION_NETLIB_BARRIER,
  CLP_PARAM_ACTION_REALLY_SCALE, 
  CLP_PARAM_ACTION_BASISIN, 
  CLP_PARAM_ACTION_BASISOUT, 
  CLP_PARAM_ACTION_SOLVECONTINUOUS, 
  CBC_PARAM_ACTION_BAB, 
  CBC_PARAM_ACTION_MIPLIB, 
  CLP_PARAM_ACTION_CLEARCUTS,
  CLP_VERSION_NOTUSED_PRINTVERSION,

  CBC_PARAM_NOTUSED_OSLSTUFF = 401, 
  CBC_PARAM_NOTUSED_CBCSTUFF,

  CBC_PARAM_NOTUSED_INVALID = 1000
};



class CbcParam {

public:

    CbcParam (  );
    CbcParam (std::string name, std::string help,
              double lower, double upper, CbcParameterType type, bool display = true);
    CbcParam (std::string name, std::string help,
              int lower, int upper, CbcParameterType type, bool display = true);
    // Other strings will be added by insert
    CbcParam (std::string name, std::string help, std::string firstValue,
              CbcParameterType type, int defaultIndex = 0, bool display = true);
    // Action
    CbcParam (std::string name, std::string help,
              CbcParameterType type, int indexNumber = -1, bool display = true);
    CbcParam(const CbcParam &);
    CbcParam & operator=(const CbcParam & rhs);
    ~CbcParam (  );

    void append(std::string keyWord);
    void addHelp(std::string keyWord);
    inline std::string  name(  ) const {
        return name_;
    };
    inline std::string  shortHelp(  ) const {
        return shortHelp_;
    };
    int setDoubleParameter(CbcModel & model, double value) const;
    double doubleParameter(CbcModel & model) const;
    int setIntParameter(CbcModel & model, int value) const;
    int intParameter(CbcModel & model) const;
    int setDoubleParameter(ClpSimplex * model, double value) const;
    double doubleParameter(ClpSimplex * model) const;
    int setIntParameter(ClpSimplex * model, int value) const;
    int intParameter(ClpSimplex * model) const;
    int setDoubleParameter(OsiSolverInterface * model, double value) const;
    double doubleParameter(OsiSolverInterface * model) const;
    int setIntParameter(OsiSolverInterface * model, int value) const;
    int intParameter(OsiSolverInterface * model) const;
    int checkDoubleParameter(double value) const;
    std::string matchName (  ) const;
    int parameterOption ( std::string check ) const;
    void printOptions (  ) const;
    inline std::string currentOption (  ) const {
        return definedKeyWords_[currentKeyWord_];
    }
    inline void setCurrentOption ( int value ) {
        currentKeyWord_ = value;
    }
    inline void setIntValue ( int value ) {
        intValue_ = value;
    }
    inline int intValue () const {
        return intValue_;
    }
    inline void setDoubleValue ( double value ) {
        doubleValue_ = value;
    }
    inline double doubleValue () const {
        return doubleValue_;
    }
    inline void setStringValue ( std::string value ) {
        stringValue_ = value;
    }
    inline std::string stringValue () const {
        return stringValue_;
    }
    int matches (std::string input) const;
    inline CbcParameterType type() const {
        return type_;
    }
    inline bool displayThis() const {
        return display_;
    }
    inline void setLonghelp(const std::string help) {
        longHelp_ = help;
    }
    void printLongHelp() const;
    void printString() const;
    inline int indexNumber() const {
        return indexNumber_;
    }
private:
    void gutsOfConstructor();
private:

    // Type see CbcParameterType
    CbcParameterType type_;
    double lowerDoubleValue_;
    double upperDoubleValue_;
    int lowerIntValue_;
    int upperIntValue_;
    // Length of name
    unsigned int lengthName_;
    // Minimum match
    unsigned int lengthMatch_;
    std::vector<std::string> definedKeyWords_;
    std::string name_;
    std::string shortHelp_;
    std::string longHelp_;
    CbcParameterType action_;
    int currentKeyWord_;
    bool display_;
    int intValue_;
    double doubleValue_;
    std::string stringValue_;
    int indexNumber_;
};
#endif  /* CbcParam_H */