Clp trunk
CbcOrClpParam Class Reference

Very simple class for setting parameters. More...

#include <CbcOrClpParam.hpp>

Collaboration diagram for CbcOrClpParam:

List of all members.

Public Member Functions

Constructor and destructor
 CbcOrClpParam ()
 Constructors.
 CbcOrClpParam (std::string name, std::string help, double lower, double upper, CbcOrClpParameterType type, int display=2)
 CbcOrClpParam (std::string name, std::string help, int lower, int upper, CbcOrClpParameterType type, int display=2)
 CbcOrClpParam (std::string name, std::string help, std::string firstValue, CbcOrClpParameterType type, int whereUsed=7, int display=2)
 CbcOrClpParam (std::string name, std::string help, CbcOrClpParameterType type, int whereUsed=7, int display=2)
 CbcOrClpParam (const CbcOrClpParam &)
 Copy constructor.
CbcOrClpParamoperator= (const CbcOrClpParam &rhs)
 Assignment operator. This copies the data.
 ~CbcOrClpParam ()
 Destructor.

stuff

void append (std::string keyWord)
 Insert string (only valid for keywords)
void addHelp (std::string keyWord)
 Adds one help line.
std::string name () const
 Returns name.
std::string shortHelp () const
 Returns short help.
int setDoubleParameter (CbcModel &model, double value)
 Sets a double parameter (nonzero code if error)
const char * setDoubleParameterWithMessage (CbcModel &model, double value, int &returnCode)
 Sets double parameter and returns printable string and error code.
double doubleParameter (CbcModel &model) const
 Gets a double parameter.
int setIntParameter (CbcModel &model, int value)
 Sets a int parameter (nonzero code if error)
const char * setIntParameterWithMessage (CbcModel &model, int value, int &returnCode)
 Sets int parameter and returns printable string and error code.
int intParameter (CbcModel &model) const
 Gets a int parameter.
int setDoubleParameter (ClpSimplex *model, double value)
 Sets a double parameter (nonzero code if error)
double doubleParameter (ClpSimplex *model) const
 Gets a double parameter.
const char * setDoubleParameterWithMessage (ClpSimplex *model, double value, int &returnCode)
 Sets double parameter and returns printable string and error code.
int setIntParameter (ClpSimplex *model, int value)
 Sets a int parameter (nonzero code if error)
const char * setIntParameterWithMessage (ClpSimplex *model, int value, int &returnCode)
 Sets int parameter and returns printable string and error code.
int intParameter (ClpSimplex *model) const
 Gets a int parameter.
int setDoubleParameter (OsiSolverInterface *model, double value)
 Sets a double parameter (nonzero code if error)
const char * setDoubleParameterWithMessage (OsiSolverInterface *model, double value, int &returnCode)
 Sets double parameter and returns printable string and error code.
double doubleParameter (OsiSolverInterface *model) const
 Gets a double parameter.
int setIntParameter (OsiSolverInterface *model, int value)
 Sets a int parameter (nonzero code if error)
const char * setIntParameterWithMessage (OsiSolverInterface *model, int value, int &returnCode)
 Sets int parameter and returns printable string and error code.
int intParameter (OsiSolverInterface *model) const
 Gets a int parameter.
int checkDoubleParameter (double value) const
 Checks a double parameter (nonzero code if error)
std::string matchName () const
 Returns name which could match.
int lengthMatchName () const
 Returns length of name for ptinting.
int parameterOption (std::string check) const
 Returns parameter option which matches (-1 if none)
void printOptions () const
 Prints parameter options.
std::string currentOption () const
 Returns current parameter option.
void setCurrentOption (int value, bool printIt=false)
 Sets current parameter option.
const char * setCurrentOptionWithMessage (int value)
 Sets current parameter option and returns printable string.
void setCurrentOption (const std::string value)
 Sets current parameter option using string.
int currentOptionAsInteger () const
 Returns current parameter option position.
void setIntValue (int value)
 Sets int value.
int intValue () const
void setDoubleValue (double value)
 Sets double value.
double doubleValue () const
void setStringValue (std::string value)
 Sets string value.
std::string stringValue () const
int matches (std::string input) const
 Returns 1 if matches minimum, 2 if matches less, 0 if not matched.
CbcOrClpParameterType type () const
 type
int displayThis () const
 whether to display
void setLonghelp (const std::string help)
 Set Long help.
void printLongHelp () const
 Print Long help.
void printString () const
 Print action and string.
int whereUsed () const
 7 if used everywhere, 1 - used by clp 2 - used by cbc 4 - used by ampl

Detailed Description

Very simple class for setting parameters.

Definition at line 270 of file CbcOrClpParam.hpp.


Constructor & Destructor Documentation

CbcOrClpParam::CbcOrClpParam ( )

Constructors.

CbcOrClpParam::CbcOrClpParam ( std::string  name,
std::string  help,
double  lower,
double  upper,
CbcOrClpParameterType  type,
int  display = 2 
)
CbcOrClpParam::CbcOrClpParam ( std::string  name,
std::string  help,
int  lower,
int  upper,
CbcOrClpParameterType  type,
int  display = 2 
)
CbcOrClpParam::CbcOrClpParam ( std::string  name,
std::string  help,
std::string  firstValue,
CbcOrClpParameterType  type,
int  whereUsed = 7,
int  display = 2 
)
CbcOrClpParam::CbcOrClpParam ( std::string  name,
std::string  help,
CbcOrClpParameterType  type,
int  whereUsed = 7,
int  display = 2 
)
CbcOrClpParam::CbcOrClpParam ( const CbcOrClpParam )

Copy constructor.

CbcOrClpParam::~CbcOrClpParam ( )

Destructor.


Member Function Documentation

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

Assignment operator. This copies the data.

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

Insert string (only valid for keywords)

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

Adds one help line.

std::string CbcOrClpParam::name ( ) const [inline]

Returns name.

Definition at line 301 of file CbcOrClpParam.hpp.

std::string CbcOrClpParam::shortHelp ( ) const [inline]

Returns short help.

Definition at line 305 of file CbcOrClpParam.hpp.

int CbcOrClpParam::setDoubleParameter ( CbcModel &  model,
double  value 
)

Sets a double parameter (nonzero code if error)

const char* CbcOrClpParam::setDoubleParameterWithMessage ( CbcModel &  model,
double  value,
int &  returnCode 
)

Sets double parameter and returns printable string and error code.

double CbcOrClpParam::doubleParameter ( CbcModel &  model) const

Gets a double parameter.

int CbcOrClpParam::setIntParameter ( CbcModel &  model,
int  value 
)

Sets a int parameter (nonzero code if error)

const char* CbcOrClpParam::setIntParameterWithMessage ( CbcModel &  model,
int  value,
int &  returnCode 
)

Sets int parameter and returns printable string and error code.

int CbcOrClpParam::intParameter ( CbcModel &  model) const

Gets a int parameter.

int CbcOrClpParam::setDoubleParameter ( ClpSimplex model,
double  value 
)

Sets a double parameter (nonzero code if error)

double CbcOrClpParam::doubleParameter ( ClpSimplex model) const

Gets a double parameter.

const char* CbcOrClpParam::setDoubleParameterWithMessage ( ClpSimplex model,
double  value,
int &  returnCode 
)

Sets double parameter and returns printable string and error code.

int CbcOrClpParam::setIntParameter ( ClpSimplex model,
int  value 
)

Sets a int parameter (nonzero code if error)

const char* CbcOrClpParam::setIntParameterWithMessage ( ClpSimplex model,
int  value,
int &  returnCode 
)

Sets int parameter and returns printable string and error code.

int CbcOrClpParam::intParameter ( ClpSimplex model) const

Gets a int parameter.

int CbcOrClpParam::setDoubleParameter ( OsiSolverInterface *  model,
double  value 
)

Sets a double parameter (nonzero code if error)

const char* CbcOrClpParam::setDoubleParameterWithMessage ( OsiSolverInterface *  model,
double  value,
int &  returnCode 
)

Sets double parameter and returns printable string and error code.

double CbcOrClpParam::doubleParameter ( OsiSolverInterface *  model) const

Gets a double parameter.

int CbcOrClpParam::setIntParameter ( OsiSolverInterface *  model,
int  value 
)

Sets a int parameter (nonzero code if error)

const char* CbcOrClpParam::setIntParameterWithMessage ( OsiSolverInterface *  model,
int  value,
int &  returnCode 
)

Sets int parameter and returns printable string and error code.

int CbcOrClpParam::intParameter ( OsiSolverInterface *  model) const

Gets a int parameter.

int CbcOrClpParam::checkDoubleParameter ( double  value) const

Checks a double parameter (nonzero code if error)

std::string CbcOrClpParam::matchName ( ) const

Returns name which could match.

int CbcOrClpParam::lengthMatchName ( ) const

Returns length of name for ptinting.

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

Returns parameter option which matches (-1 if none)

void CbcOrClpParam::printOptions ( ) const

Prints parameter options.

std::string CbcOrClpParam::currentOption ( ) const [inline]

Returns current parameter option.

Definition at line 355 of file CbcOrClpParam.hpp.

void CbcOrClpParam::setCurrentOption ( int  value,
bool  printIt = false 
)

Sets current parameter option.

const char* CbcOrClpParam::setCurrentOptionWithMessage ( int  value)

Sets current parameter option and returns printable string.

void CbcOrClpParam::setCurrentOption ( const std::string  value)

Sets current parameter option using string.

int CbcOrClpParam::currentOptionAsInteger ( ) const [inline]

Returns current parameter option position.

Definition at line 365 of file CbcOrClpParam.hpp.

void CbcOrClpParam::setIntValue ( int  value)

Sets int value.

int CbcOrClpParam::intValue ( ) const [inline]

Definition at line 370 of file CbcOrClpParam.hpp.

void CbcOrClpParam::setDoubleValue ( double  value)

Sets double value.

double CbcOrClpParam::doubleValue ( ) const [inline]

Definition at line 375 of file CbcOrClpParam.hpp.

void CbcOrClpParam::setStringValue ( std::string  value)

Sets string value.

std::string CbcOrClpParam::stringValue ( ) const [inline]

Definition at line 380 of file CbcOrClpParam.hpp.

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

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

CbcOrClpParameterType CbcOrClpParam::type ( ) const [inline]

type

Definition at line 386 of file CbcOrClpParam.hpp.

int CbcOrClpParam::displayThis ( ) const [inline]

whether to display

Definition at line 390 of file CbcOrClpParam.hpp.

void CbcOrClpParam::setLonghelp ( const std::string  help) [inline]

Set Long help.

Definition at line 394 of file CbcOrClpParam.hpp.

void CbcOrClpParam::printLongHelp ( ) const

Print Long help.

void CbcOrClpParam::printString ( ) const

Print action and string.

int CbcOrClpParam::whereUsed ( ) const [inline]

7 if used everywhere, 1 - used by clp 2 - used by cbc 4 - used by ampl

Definition at line 406 of file CbcOrClpParam.hpp.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines