/home/coin/SVN-release/CoinAll-1.1.0/Cbc/src/CbcParam.hpp

Go to the documentation of this file.

// 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

  { GENERALQUERY = -100,FULLGENERALQUERY,
  
    PRIMALTOLERANCE = 1, DUALTOLERANCE,CUTOFF,TIMELIMIT,
    DUALBOUND, PRIMALWEIGHT,  OBJSCALE, RHSSCALE,

  INFEASIBILITYWEIGHT = 51, INTEGERTOLERANCE,INCREMENT,ALLOWABLEGAP,

  DJFIX = 81, GAPRATIO,TIGHTENFACTOR,

  LOGLEVEL = 101, SOLVERLOGLEVEL, MAXNODES,STRONGBRANCHING,
    MAXFACTOR,PERTVALUE,MAXITERATION,PRESOLVEPASS,IDIOT,SPRINT,
    OUTPUTFORMAT,SLPVALUE,PRESOLVEOPTIONS,PRINTOPTIONS,SPECIALOPTIONS,
  
  DIRECTION=201,DUALPIVOT,SCALING,ERRORSALLOWED,KEEPNAMES,SPARSEFACTOR,
  PRIMALPIVOT,PRESOLVE,CRASH,BIASLU,PERTURBATION,MESSAGES,AUTOSCALE,
  CHOLESKY,KKT,BARRIERSCALE,GAMMA,CROSSOVER,PFI,ALGORITHM,

  NODESTRATEGY = 251,BRANCHSTRATEGY,ADDCUTSSTRATEGY,
  GOMORYCUTS,PROBINGCUTS,KNAPSACKCUTS,ODDHOLECUTS,
  ROUNDING,SOLVER,CLIQUECUTS,COSTSTRATEGY,FLOWCUTS,MIXEDCUTS,
    TWOMIRCUTS,PREPROCESS,
  
  DIRECTORY=301,IMPORT,EXPORT,RESTORE,SAVE,DUALSIMPLEX,PRIMALSIMPLEX,
  MAXIMIZE,MINIMIZE,EXIT,STDIN,UNITTEST,NETLIB_DUAL,NETLIB_PRIMAL,SOLUTION,
  TIGHTEN,FAKEBOUND,HELP,PLUSMINUS,NETWORK,ALLSLACK,REVERSE,BARRIER,NETLIB_BARRIER,
    REALLY_SCALE,BASISIN,BASISOUT,SOLVECONTINUOUS,BAB,MIPLIB,CLEARCUTS,PRINTVERSION,

  OSLSTUFF = 401,CBCSTUFF,

  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 */

---