Very simple class for setting parameters. More...

#include <CbcParam.hpp>

Collaboration diagram for CbcParam:

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

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

	~CbcParam ()
	Destructor. More...

Private Attributes
data
We might as well throw all type data in - could derive?
CbcParameterType	type_

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

double	upperDoubleValue_

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

int	upperIntValue_

unsigned int	lengthName_

unsigned int	lengthMatch_

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

CbcParameterType	action_
	Action. More...

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

bool	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	indexNumber_
	index number to use for display purposes 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...

void	gutsOfConstructor ()
	gutsOfConstructor More...

Detailed Description

Very simple class for setting parameters.

Definition at line 152 of file CbcParam.hpp.

Constructor & Destructor Documentation

◆ CbcParam() [1/6]

CbcParam::CbcParam ( )

Constructors.

◆ CbcParam() [2/6]

CbcParam::CbcParam	(	std::string	name,
		std::string	help,
		double	lower,
		double	upper,
		CbcParameterType	type,
		bool	display = `true`
	)

◆ CbcParam() [3/6]

CbcParam::CbcParam	(	std::string	name,
		std::string	help,
		int	lower,
		int	upper,
		CbcParameterType	type,
		bool	display = `true`
	)

◆ CbcParam() [4/6]

CbcParam::CbcParam	(	std::string	name,
		std::string	help,
		std::string	firstValue,
		CbcParameterType	type,
		int	defaultIndex = `0`,
		bool	display = `true`
	)

◆ CbcParam() [5/6]

CbcParam::CbcParam	(	std::string	name,
		std::string	help,
		CbcParameterType	type,
		int	indexNumber = `-1`,
		bool	display = `true`
	)

◆ CbcParam() [6/6]

CbcParam::CbcParam ( const CbcParam & )

Copy constructor.

◆ ~CbcParam()

CbcParam::~CbcParam ( )

Destructor.

Member Function Documentation

◆ operator=()

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

Assignment operator. This copies the data.

◆ append()

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

Insert string (only valid for keywords)

◆ addHelp()

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

Adds one help line.

◆ name()

std::string CbcParam::name ( ) const

inline

Returns name.

Definition at line 184 of file CbcParam.hpp.

◆ shortHelp()

std::string CbcParam::shortHelp ( ) const

inline

Returns short help.

Definition at line 189 of file CbcParam.hpp.

◆ setDoubleParameter() [1/3]

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

Sets a double parameter (nonzero code if error)

◆ doubleParameter() [1/3]

double CbcParam::doubleParameter ( CbcModel & model ) const

Gets a double parameter.

◆ setIntParameter() [1/3]

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

Sets a int parameter (nonzero code if error)

◆ intParameter() [1/3]

int CbcParam::intParameter ( CbcModel & model ) const

Gets a int parameter.

◆ setDoubleParameter() [2/3]

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

Sets a double parameter (nonzero code if error)

◆ doubleParameter() [2/3]

double CbcParam::doubleParameter ( ClpSimplex * model ) const

Gets a double parameter.

◆ setIntParameter() [2/3]

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

Sets a int parameter (nonzero code if error)

◆ intParameter() [2/3]

int CbcParam::intParameter ( ClpSimplex * model ) const

Gets a int parameter.

◆ setDoubleParameter() [3/3]

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

Sets a double parameter (nonzero code if error)

◆ doubleParameter() [3/3]

double CbcParam::doubleParameter ( OsiSolverInterface * model ) const

Gets a double parameter.

◆ setIntParameter() [3/3]

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

Sets a int parameter (nonzero code if error)

◆ intParameter() [3/3]

int CbcParam::intParameter ( OsiSolverInterface * model ) const

Gets a int parameter.

◆ checkDoubleParameter()

int CbcParam::checkDoubleParameter ( double value ) const

Checks a double parameter (nonzero code if error)

◆ matchName()

std::string CbcParam::matchName ( ) const

Returns name which could match.

◆ parameterOption()

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

Returns parameter option which matches (-1 if none)

◆ printOptions()

void CbcParam::printOptions ( ) const

Prints parameter options.

◆ currentOption()

std::string CbcParam::currentOption ( ) const

inline

Returns current parameter option.

Definition at line 226 of file CbcParam.hpp.

◆ setCurrentOption()

void CbcParam::setCurrentOption ( int value )

inline

Sets current parameter option.

Definition at line 231 of file CbcParam.hpp.

◆ setIntValue()

void CbcParam::setIntValue ( int value )

inline

Sets int value.

Definition at line 236 of file CbcParam.hpp.

◆ intValue()

int CbcParam::intValue ( ) const

inline

Definition at line 240 of file CbcParam.hpp.

◆ setDoubleValue()

void CbcParam::setDoubleValue ( double value )

inline

Sets double value.

Definition at line 245 of file CbcParam.hpp.

◆ doubleValue()

double CbcParam::doubleValue ( ) const

inline

Definition at line 249 of file CbcParam.hpp.

◆ setStringValue()

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

inline

Sets string value.

Definition at line 254 of file CbcParam.hpp.

◆ stringValue()

std::string CbcParam::stringValue ( ) const

inline

Definition at line 258 of file CbcParam.hpp.

◆ matches()

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

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

◆ type()

CbcParameterType CbcParam::type ( ) const

inline

type

Definition at line 265 of file CbcParam.hpp.

◆ displayThis()

bool CbcParam::displayThis ( ) const

inline

whether to display

Definition at line 270 of file CbcParam.hpp.

◆ setLonghelp()

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

inline

Set Long help.

Definition at line 275 of file CbcParam.hpp.

◆ printLongHelp()

void CbcParam::printLongHelp ( ) const

Print Long help.

◆ printString()

void CbcParam::printString ( ) const

Print action and string.

◆ indexNumber()

int CbcParam::indexNumber ( ) const

inline

type for classification

Definition at line 284 of file CbcParam.hpp.

◆ gutsOfConstructor()

void CbcParam::gutsOfConstructor ( )

private

gutsOfConstructor

Member Data Documentation

◆ type_

CbcParameterType CbcParam::type_

private

Definition at line 300 of file CbcParam.hpp.

◆ lowerDoubleValue_

double CbcParam::lowerDoubleValue_

private

If double == okay.

Definition at line 302 of file CbcParam.hpp.

◆ upperDoubleValue_

double CbcParam::upperDoubleValue_

private

Definition at line 303 of file CbcParam.hpp.

◆ lowerIntValue_

int CbcParam::lowerIntValue_

private

If int == okay.

Definition at line 305 of file CbcParam.hpp.

◆ upperIntValue_

int CbcParam::upperIntValue_

private

Definition at line 306 of file CbcParam.hpp.

◆ lengthName_

unsigned int CbcParam::lengthName_

private

Definition at line 308 of file CbcParam.hpp.

◆ lengthMatch_

unsigned int CbcParam::lengthMatch_

private

Definition at line 310 of file CbcParam.hpp.

◆ definedKeyWords_

std::vector< std::string > CbcParam::definedKeyWords_

private

set of valid strings

Definition at line 312 of file CbcParam.hpp.

◆ name_

std::string CbcParam::name_

private

Name.

Definition at line 314 of file CbcParam.hpp.

◆ shortHelp_

std::string CbcParam::shortHelp_

private

Short help.

Definition at line 316 of file CbcParam.hpp.

◆ longHelp_

std::string CbcParam::longHelp_

private

Long help.

Definition at line 318 of file CbcParam.hpp.

◆ action_

CbcParameterType CbcParam::action_

private

Action.

Definition at line 320 of file CbcParam.hpp.

◆ currentKeyWord_

int CbcParam::currentKeyWord_

private

Current keyWord (if a keyword parameter)

Definition at line 322 of file CbcParam.hpp.

◆ display_

bool CbcParam::display_

private

Display on ?

Definition at line 324 of file CbcParam.hpp.

◆ intValue_

int CbcParam::intValue_

private

Integer parameter - current value.

Definition at line 326 of file CbcParam.hpp.

◆ doubleValue_

double CbcParam::doubleValue_

private

Double parameter - current value.

Definition at line 328 of file CbcParam.hpp.

◆ stringValue_

std::string CbcParam::stringValue_

private

String parameter - current value.

Definition at line 330 of file CbcParam.hpp.

◆ indexNumber_

int CbcParam::indexNumber_

private

index number to use for display purposes

Definition at line 332 of file CbcParam.hpp.

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

/home/ted/Projects/Cbc/Cbc/src/CbcParam.hpp

Public Member Functions

Private Attributes

stuff

Detailed Description

Constructor & Destructor Documentation

◆ CbcParam() [1/6]

◆ CbcParam() [2/6]

◆ CbcParam() [3/6]

◆ CbcParam() [4/6]

◆ CbcParam() [5/6]

◆ CbcParam() [6/6]

◆ ~CbcParam()

Member Function Documentation

◆ operator=()

◆ append()

◆ addHelp()

◆ name()

◆ shortHelp()

◆ setDoubleParameter() [1/3]

◆ doubleParameter() [1/3]

◆ setIntParameter() [1/3]

◆ intParameter() [1/3]

◆ setDoubleParameter() [2/3]

◆ doubleParameter() [2/3]

◆ setIntParameter() [2/3]

◆ intParameter() [2/3]

◆ setDoubleParameter() [3/3]

◆ doubleParameter() [3/3]

◆ setIntParameter() [3/3]

◆ intParameter() [3/3]

◆ checkDoubleParameter()

◆ matchName()

◆ parameterOption()

◆ printOptions()

◆ currentOption()

◆ setCurrentOption()

◆ setIntValue()

◆ intValue()

◆ setDoubleValue()

◆ doubleValue()

◆ setStringValue()

◆ stringValue()

◆ matches()

◆ type()

◆ displayThis()

◆ setLonghelp()

◆ printLongHelp()

◆ printString()

◆ indexNumber()

◆ gutsOfConstructor()

Member Data Documentation

◆ type_

◆ lowerDoubleValue_

◆ upperDoubleValue_

◆ lowerIntValue_

◆ upperIntValue_

◆ lengthName_

◆ lengthMatch_

◆ definedKeyWords_

◆ name_

◆ shortHelp_

◆ longHelp_

◆ action_

◆ currentKeyWord_

◆ display_

◆ intValue_

◆ doubleValue_

◆ stringValue_

◆ indexNumber_