Cbc  2.8.12
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members
CbcParam Class Reference

Very simple class for setting parameters. More...

#include <CbcParam.hpp>

Public Member Functions

Constructor and destructor
 CbcParam ()
 Constructors. More...
 
 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)
 
 CbcParam (std::string name, std::string help, std::string firstValue, CbcParameterType type, int defaultIndex=0, bool display=true)
 
 CbcParam (std::string name, std::string help, CbcParameterType type, int indexNumber=-1, bool display=true)
 
 CbcParam (const CbcParam &)
 Copy constructor. More...
 
CbcParamoperator= (const CbcParam &rhs)
 Assignment operator. This copies the data. More...
 
 ~CbcParam ()
 Destructor. More...
 

stuff

void append (std::string keyWord)
 Insert string (only valid for keywords) More...
 
void addHelp (std::string keyWord)
 Adds one help line. More...
 
std::string name () const
 Returns name. More...
 
std::string shortHelp () const
 Returns short help. More...
 
int setDoubleParameter (CbcModel &model, double value) const
 Sets a double parameter (nonzero code if error) More...
 
double doubleParameter (CbcModel &model) const
 Gets a double parameter. More...
 
int setIntParameter (CbcModel &model, int value) const
 Sets a int parameter (nonzero code if error) More...
 
int intParameter (CbcModel &model) const
 Gets a int parameter. More...
 
int setDoubleParameter (ClpSimplex *model, double value) const
 Sets a double parameter (nonzero code if error) More...
 
double doubleParameter (ClpSimplex *model) const
 Gets a double parameter. More...
 
int setIntParameter (ClpSimplex *model, int value) const
 Sets a int parameter (nonzero code if error) More...
 
int intParameter (ClpSimplex *model) const
 Gets a int parameter. More...
 
int setDoubleParameter (OsiSolverInterface *model, double value) const
 Sets a double parameter (nonzero code if error) More...
 
double doubleParameter (OsiSolverInterface *model) const
 Gets a double parameter. More...
 
int setIntParameter (OsiSolverInterface *model, int value) const
 Sets a int parameter (nonzero code if error) More...
 
int intParameter (OsiSolverInterface *model) const
 Gets a int parameter. More...
 
int checkDoubleParameter (double value) const
 Checks a double parameter (nonzero code if error) More...
 
std::string matchName () const
 Returns name which could match. More...
 
int parameterOption (std::string check) const
 Returns parameter option which matches (-1 if none) More...
 
void printOptions () const
 Prints parameter options. More...
 
std::string currentOption () const
 Returns current parameter option. More...
 
void setCurrentOption (int value)
 Sets current parameter option. More...
 
void setIntValue (int value)
 Sets int value. More...
 
int intValue () const
 
void setDoubleValue (double value)
 Sets double value. More...
 
double doubleValue () const
 
void setStringValue (std::string value)
 Sets string value. More...
 
std::string stringValue () const
 
int matches (std::string input) const
 Returns 1 if matches minimum, 2 if matches less, 0 if not matched. More...
 
CbcParameterType type () const
 type More...
 
bool displayThis () const
 whether to display More...
 
void setLonghelp (const std::string help)
 Set Long help. More...
 
void printLongHelp () const
 Print Long help. More...
 
void printString () const
 Print action and string. More...
 
int indexNumber () const
 type for classification More...
 

Detailed Description

Very simple class for setting parameters.

Definition at line 153 of file CbcParam.hpp.

Constructor & Destructor Documentation

CbcParam::CbcParam ( )

Constructors.

CbcParam::CbcParam ( std::string  name,
std::string  help,
double  lower,
double  upper,
CbcParameterType  type,
bool  display = true 
)
CbcParam::CbcParam ( std::string  name,
std::string  help,
int  lower,
int  upper,
CbcParameterType  type,
bool  display = true 
)
CbcParam::CbcParam ( std::string  name,
std::string  help,
std::string  firstValue,
CbcParameterType  type,
int  defaultIndex = 0,
bool  display = true 
)
CbcParam::CbcParam ( std::string  name,
std::string  help,
CbcParameterType  type,
int  indexNumber = -1,
bool  display = true 
)
CbcParam::CbcParam ( const CbcParam )

Copy constructor.

CbcParam::~CbcParam ( )

Destructor.

Member Function Documentation

CbcParam& CbcParam::operator= ( const CbcParam rhs)

Assignment operator. This copies the data.

void CbcParam::append ( std::string  keyWord)

Insert string (only valid for keywords)

void CbcParam::addHelp ( std::string  keyWord)

Adds one help line.

std::string CbcParam::name ( ) const
inline

Returns name.

Definition at line 186 of file CbcParam.hpp.

std::string CbcParam::shortHelp ( ) const
inline

Returns short help.

Definition at line 190 of file CbcParam.hpp.

int CbcParam::setDoubleParameter ( CbcModel model,
double  value 
) const

Sets a double parameter (nonzero code if error)

double CbcParam::doubleParameter ( CbcModel model) const

Gets a double parameter.

int CbcParam::setIntParameter ( CbcModel model,
int  value 
) const

Sets a int parameter (nonzero code if error)

int CbcParam::intParameter ( CbcModel model) const

Gets a int parameter.

int CbcParam::setDoubleParameter ( ClpSimplex *  model,
double  value 
) const

Sets a double parameter (nonzero code if error)

double CbcParam::doubleParameter ( ClpSimplex *  model) const

Gets a double parameter.

int CbcParam::setIntParameter ( ClpSimplex *  model,
int  value 
) const

Sets a int parameter (nonzero code if error)

int CbcParam::intParameter ( ClpSimplex *  model) const

Gets a int parameter.

int CbcParam::setDoubleParameter ( OsiSolverInterface *  model,
double  value 
) const

Sets a double parameter (nonzero code if error)

double CbcParam::doubleParameter ( OsiSolverInterface *  model) const

Gets a double parameter.

int CbcParam::setIntParameter ( OsiSolverInterface *  model,
int  value 
) const

Sets a int parameter (nonzero code if error)

int CbcParam::intParameter ( OsiSolverInterface *  model) const

Gets a int parameter.

int CbcParam::checkDoubleParameter ( double  value) const

Checks a double parameter (nonzero code if error)

std::string CbcParam::matchName ( ) const

Returns name which could match.

int CbcParam::parameterOption ( std::string  check) const

Returns parameter option which matches (-1 if none)

void CbcParam::printOptions ( ) const

Prints parameter options.

std::string CbcParam::currentOption ( ) const
inline

Returns current parameter option.

Definition at line 226 of file CbcParam.hpp.

void CbcParam::setCurrentOption ( int  value)
inline

Sets current parameter option.

Definition at line 230 of file CbcParam.hpp.

void CbcParam::setIntValue ( int  value)
inline

Sets int value.

Definition at line 234 of file CbcParam.hpp.

int CbcParam::intValue ( ) const
inline

Definition at line 237 of file CbcParam.hpp.

void CbcParam::setDoubleValue ( double  value)
inline

Sets double value.

Definition at line 241 of file CbcParam.hpp.

double CbcParam::doubleValue ( ) const
inline

Definition at line 244 of file CbcParam.hpp.

void CbcParam::setStringValue ( std::string  value)
inline

Sets string value.

Definition at line 248 of file CbcParam.hpp.

std::string CbcParam::stringValue ( ) const
inline

Definition at line 251 of file CbcParam.hpp.

int CbcParam::matches ( std::string  input) const

Returns 1 if matches minimum, 2 if matches less, 0 if not matched.

CbcParameterType CbcParam::type ( ) const
inline

type

Definition at line 257 of file CbcParam.hpp.

bool CbcParam::displayThis ( ) const
inline

whether to display

Definition at line 261 of file CbcParam.hpp.

void CbcParam::setLonghelp ( const std::string  help)
inline

Set Long help.

Definition at line 265 of file CbcParam.hpp.

void CbcParam::printLongHelp ( ) const

Print Long help.

void CbcParam::printString ( ) const

Print action and string.

int CbcParam::indexNumber ( ) const
inline

type for classification

Definition at line 273 of file CbcParam.hpp.


The documentation for this class was generated from the following file: