Very simple class for setting parameters. More...

#include <CbcOrClpParam.hpp>

Collaboration diagram for CbcOrClpParam:

Public Member Functions
Constructor and destructor
	CbcOrClpParam ()
	Constructors. More...

	CbcOrClpParam (std::string name, std::string help, double lower, double upper, CbcOrClpParameterType type, int display=2)
	Constructors. More...

	CbcOrClpParam (std::string name, std::string help, int lower, int upper, CbcOrClpParameterType type, int display=2)
	Constructors. More...

	CbcOrClpParam (std::string name, std::string help, std::string firstValue, CbcOrClpParameterType type, int whereUsed=7, int display=2)
	Constructors. More...

	CbcOrClpParam (std::string name, std::string help, CbcOrClpParameterType type, int whereUsed=7, int display=2)
	Constructors. More...

	CbcOrClpParam (const CbcOrClpParam &)
	Copy constructor. More...

CbcOrClpParam &	operator= (const CbcOrClpParam &rhs)
	Assignment operator. This copies the data. More...

	~CbcOrClpParam ()
	Destructor. More...

Private Attributes
data
We might as well throw all type data in - could derive?
CbcOrClpParameterType	type_
	If double == okay. More...

double	lowerDoubleValue_
	If double == okay. More...

double	upperDoubleValue_
	If double == okay. More...

int	lowerIntValue_
	If int == okay. More...

int	upperIntValue_
	If double == okay. More...

unsigned int	lengthName_
	If double == okay. More...

unsigned int	lengthMatch_
	If double == okay. More...

std::vector< std::string >	definedKeyWords_
	set of valid strings More...

std::string	name_
	Name. More...

std::string	shortHelp_
	Short help. More...

std::string	longHelp_
	Long help. More...

CbcOrClpParameterType	action_
	Action. More...

int	currentKeyWord_
	Current keyWord (if a keyword parameter) More...

int	display_
	Display on ? More...

int	intValue_
	Integer parameter - current value. More...

double	doubleValue_
	Double parameter - current value. More...

std::string	stringValue_
	String parameter - current value. More...

int	whereUsed_
	7 if used everywhere, 1 - used by clp 2 - used by cbc 4 - used by ampl More...

int	fakeKeyWord_
	If >=0 then integers allowed as a fake keyword So minusnnnn would got to -nnnn in currentKeyword_ and plusnnnn would go to fakeKeyword_+nnnn. More...

int	fakeValue_
	Return this as main value if an integer. 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)
	Sets a double parameter (nonzero code if error) More...

const char *	setDoubleParameterWithMessage (CbcModel &model, double value, int &returnCode)
	Sets double parameter and returns printable string and error code. More...

double	doubleParameter (CbcModel &model) const
	Gets a double parameter. More...

int	setIntParameter (CbcModel &model, int value)
	Sets a int parameter (nonzero code if error) More...

const char *	setIntParameterWithMessage (CbcModel &model, int value, int &returnCode)
	Sets int parameter and returns printable string and error code. More...

int	intParameter (CbcModel &model) const
	Gets a int parameter. More...

int	setDoubleParameter (ClpSimplex *model, double value)
	Sets a double parameter (nonzero code if error) More...

double	doubleParameter (ClpSimplex *model) const
	Gets a double parameter. More...

const char *	setDoubleParameterWithMessage (ClpSimplex *model, double value, int &returnCode)
	Sets double parameter and returns printable string and error code. More...

int	setIntParameter (ClpSimplex *model, int value)
	Sets a int parameter (nonzero code if error) More...

const char *	setIntParameterWithMessage (ClpSimplex *model, int value, int &returnCode)
	Sets int parameter and returns printable string and error code. More...

int	intParameter (ClpSimplex *model) const
	Gets a int parameter. More...

int	setDoubleParameter (OsiSolverInterface *model, double value)
	Sets a double parameter (nonzero code if error) More...

const char *	setDoubleParameterWithMessage (OsiSolverInterface *model, double value, int &returnCode)
	Sets double parameter and returns printable string and error code. More...

double	doubleParameter (OsiSolverInterface *model) const
	Gets a double parameter. More...

int	setIntParameter (OsiSolverInterface *model, int value)
	Sets a int parameter (nonzero code if error) More...

const char *	setIntParameterWithMessage (OsiSolverInterface *model, int value, int &returnCode)
	Sets int parameter and returns printable string and error code. 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	lengthMatchName () const
	Returns length of name for ptinting. 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, bool printIt=false)
	Sets current parameter option. More...

const char *	setCurrentOptionWithMessage (int value)
	Sets current parameter option and returns printable string. More...

void	setCurrentOption (const std::string value)
	Sets current parameter option using string. More...

const char *	setCurrentOptionWithMessage (const std::string value)
	Sets current parameter option using string with message. More...

int	currentOptionAsInteger () const
	Returns current parameter option position. More...

int	currentOptionAsInteger (int &fakeInteger) const
	Returns current parameter option position but if fake keyword returns a fake value and sets fakeInteger to true value. More...

void	setIntValue (int value)
	Sets int value. More...

const char *	setIntValueWithMessage (int value)
	Sets int value with message. More...

int	intValue () const
	Insert string (only valid for keywords) More...

void	setDoubleValue (double value)
	Sets double value. More...

const char *	setDoubleValueWithMessage (double value)
	Sets double value with message. More...

double	doubleValue () const
	Insert string (only valid for keywords) More...

void	setStringValue (std::string value)
	Sets string value. More...

std::string	stringValue () const
	Insert string (only valid for keywords) More...

int	matches (std::string input) const
	Returns 1 if matches minimum, 2 if matches less, 0 if not matched. More...

CbcOrClpParameterType	type () const
	type More...

int	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	whereUsed () const
	7 if used everywhere, 1 - used by clp 2 - used by cbc 4 - used by ampl More...

int	fakeKeyWord () const
	Gets value of fake keyword. More...

void	setFakeKeyWord (int value, int fakeValue)
	Sets value of fake keyword. More...

void	setFakeKeyWord (int fakeValue)
	Sets value of fake keyword to current size of keywords. More...

void	gutsOfConstructor ()
	gutsOfConstructor More...

Detailed Description

Very simple class for setting parameters.

Definition at line 300 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`
	)

Constructors.

CbcOrClpParam::CbcOrClpParam	(	std::string	name,
		std::string	help,
		int	lower,
		int	upper,
		CbcOrClpParameterType	type,
		int	display = `2`
	)

Constructors.

CbcOrClpParam::CbcOrClpParam	(	std::string	name,
		std::string	help,
		std::string	firstValue,
		CbcOrClpParameterType	type,
		int	whereUsed = `7`,
		int	display = `2`
	)

Constructors.

CbcOrClpParam::CbcOrClpParam	(	std::string	name,
		std::string	help,
		CbcOrClpParameterType	type,
		int	whereUsed = `7`,
		int	display = `2`
	)

Constructors.

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 331 of file CbcOrClpParam.hpp.

References name_.

std::string CbcOrClpParam::shortHelp ( ) const

inline

Returns short help.

Definition at line 336 of file CbcOrClpParam.hpp.

References shortHelp_.

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 387 of file CbcOrClpParam.hpp.

References currentKeyWord_, and definedKeyWords_.

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.

const char* CbcOrClpParam::setCurrentOptionWithMessage ( const std::string value )

Sets current parameter option using string with message.

int CbcOrClpParam::currentOptionAsInteger ( ) const

Returns current parameter option position.

int CbcOrClpParam::currentOptionAsInteger ( int & fakeInteger ) const

Returns current parameter option position but if fake keyword returns a fake value and sets fakeInteger to true value.

If not fake then fakeInteger is -COIN_INT_MAX

void CbcOrClpParam::setIntValue ( int value )

Sets int value.

const char* CbcOrClpParam::setIntValueWithMessage ( int value )

Sets int value with message.

int CbcOrClpParam::intValue ( ) const

inline

Insert string (only valid for keywords)

Definition at line 410 of file CbcOrClpParam.hpp.

References intValue_.

void CbcOrClpParam::setDoubleValue ( double value )

Sets double value.

const char* CbcOrClpParam::setDoubleValueWithMessage ( double value )

Sets double value with message.

double CbcOrClpParam::doubleValue ( ) const

inline

Insert string (only valid for keywords)

Definition at line 418 of file CbcOrClpParam.hpp.

References doubleValue_.

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

Sets string value.

std::string CbcOrClpParam::stringValue ( ) const

inline

Insert string (only valid for keywords)

Definition at line 424 of file CbcOrClpParam.hpp.

References stringValue_.

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 431 of file CbcOrClpParam.hpp.

References type_.

int CbcOrClpParam::displayThis ( ) const

inline

whether to display

Definition at line 436 of file CbcOrClpParam.hpp.

References display_.

void CbcOrClpParam::setLonghelp ( const std::string help )

inline

Set Long help.

Definition at line 441 of file CbcOrClpParam.hpp.

References longHelp_.

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 454 of file CbcOrClpParam.hpp.

References whereUsed_.

int CbcOrClpParam::fakeKeyWord ( ) const

inline

Gets value of fake keyword.

Definition at line 459 of file CbcOrClpParam.hpp.

References fakeKeyWord_.

void CbcOrClpParam::setFakeKeyWord	(	int	value,
		int	fakeValue
	)

inline

Sets value of fake keyword.

Definition at line 464 of file CbcOrClpParam.hpp.

References fakeKeyWord_, and fakeValue_.

void CbcOrClpParam::setFakeKeyWord ( int fakeValue )

Sets value of fake keyword to current size of keywords.

void CbcOrClpParam::gutsOfConstructor ( )

private

gutsOfConstructor

Member Data Documentation

CbcOrClpParameterType CbcOrClpParam::type_

private

If double == okay.

Definition at line 483 of file CbcOrClpParam.hpp.

Referenced by type().

double CbcOrClpParam::lowerDoubleValue_

private

If double == okay.

Definition at line 485 of file CbcOrClpParam.hpp.

double CbcOrClpParam::upperDoubleValue_

private

If double == okay.

Definition at line 486 of file CbcOrClpParam.hpp.

int CbcOrClpParam::lowerIntValue_

private

If int == okay.

Definition at line 488 of file CbcOrClpParam.hpp.

int CbcOrClpParam::upperIntValue_

private

If double == okay.

Definition at line 489 of file CbcOrClpParam.hpp.

unsigned int CbcOrClpParam::lengthName_

private

If double == okay.

Definition at line 491 of file CbcOrClpParam.hpp.

unsigned int CbcOrClpParam::lengthMatch_

private

If double == okay.

Definition at line 493 of file CbcOrClpParam.hpp.

std::vector< std::string > CbcOrClpParam::definedKeyWords_

private

set of valid strings

Definition at line 495 of file CbcOrClpParam.hpp.

Referenced by currentOption().

std::string CbcOrClpParam::name_

private

Name.

Definition at line 497 of file CbcOrClpParam.hpp.

Referenced by name().

std::string CbcOrClpParam::shortHelp_

private

Short help.

Definition at line 499 of file CbcOrClpParam.hpp.

Referenced by shortHelp().

std::string CbcOrClpParam::longHelp_

private

Long help.

Definition at line 501 of file CbcOrClpParam.hpp.

Referenced by setLonghelp().

CbcOrClpParameterType CbcOrClpParam::action_

private

Action.

Definition at line 503 of file CbcOrClpParam.hpp.

int CbcOrClpParam::currentKeyWord_

private

Current keyWord (if a keyword parameter)

Definition at line 505 of file CbcOrClpParam.hpp.

Referenced by currentOption().

int CbcOrClpParam::display_

private

Display on ?

Definition at line 507 of file CbcOrClpParam.hpp.

Referenced by displayThis().

int CbcOrClpParam::intValue_

private

Integer parameter - current value.

Definition at line 509 of file CbcOrClpParam.hpp.

Referenced by intValue().

double CbcOrClpParam::doubleValue_

private

Double parameter - current value.

Definition at line 511 of file CbcOrClpParam.hpp.

Referenced by doubleValue().

std::string CbcOrClpParam::stringValue_

private

String parameter - current value.

Definition at line 513 of file CbcOrClpParam.hpp.

Referenced by stringValue().

int CbcOrClpParam::whereUsed_

private

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

Definition at line 519 of file CbcOrClpParam.hpp.

Referenced by whereUsed().

int CbcOrClpParam::fakeKeyWord_

private

If >=0 then integers allowed as a fake keyword So minusnnnn would got to -nnnn in currentKeyword_ and plusnnnn would go to fakeKeyword_+nnnn.

Definition at line 524 of file CbcOrClpParam.hpp.

Referenced by fakeKeyWord(), and setFakeKeyWord().

int CbcOrClpParam::fakeValue_

private

Return this as main value if an integer.

Definition at line 526 of file CbcOrClpParam.hpp.

Referenced by setFakeKeyWord().

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

/tmp/Bcp-1.4.4/Clp/src/CbcOrClpParam.hpp

Public Member Functions

Private Attributes

stuff

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation