Gecode::Options Class Reference
[Commandline options for running scripts]

Options for scripts More...

#include <driver.hh>

List of all members.

Public Member Functions
	Options (const char *s)
	Initialize options for script with name s.
Model options
Driver::StringOption	_model
	General model options.
Driver::StringOption	_symmetry
	General symmetry options.
Driver::StringOption	_propagation
	Propagation options.
Driver::StringOption	_icl
	Integer consistency level.
Driver::StringOption	_branching
	Branching options.
void	model (int v)
	Set default model value.
void	model (int v, const char *o, const char *h=NULL)
	Add model option value for value v, string o, and help h.
int	model (void) const
	Return model value.
void	symmetry (int v)
	Set default symmetry value.
void	symmetry (int v, const char *o, const char *h=NULL)
	Add symmetry option value for value v, string o, and help h.
int	symmetry (void) const
	Return symmetry value.
void	propagation (int v)
	Set default propagation value.
void	propagation (int v, const char *o, const char *h=NULL)
	Add propagation option value for value v, string o, and help h.
int	propagation (void) const
	Return propagation value.
void	icl (IntConLevel i)
	Set default integer consistency level.
IntConLevel	icl (void) const
	Return integer consistency level.
void	branching (int v)
	Set default branching value.
void	branching (int v, const char *o, const char *h=NULL)
	Add branching option value for value v, string o, and help h.
int	branching (void) const
	Return branching value.
Search options
Driver::StringOption	_search
	Search options.
Driver::UnsignedIntOption	_solutions
	How many solutions.
Driver::DoubleOption	_threads
	How many threads to use.
Driver::UnsignedIntOption	_c_d
	Copy recomputation distance.
Driver::UnsignedIntOption	_a_d
	Adaptive recomputation distance.
Driver::UnsignedIntOption	_node
	Cutoff for number of nodes.
Driver::UnsignedIntOption	_fail
	Cutoff for number of failures.
Driver::UnsignedIntOption	_time
	Cutoff for time.
Driver::StringOption	_interrupt
	Whether to catch SIGINT.
void	search (int v)
	Set default search value.
void	search (int v, const char *o, const char *h=NULL)
	Add search option value for value v, string o, and help h.
int	search (void) const
	Return search value.
void	solutions (unsigned int n)
	Set default number of solutions to search for.
unsigned int	solutions (void) const
	Return number of solutions to search for.
void	threads (double n)
	Set number of parallel threads.
double	threads (void) const
	Return number of parallel threads.
void	c_d (unsigned int d)
	Set default copy recomputation distance.
unsigned int	c_d (void) const
	Return copy recomputation distance.
void	a_d (unsigned int d)
	Set default adaptive recomputation distance.
unsigned int	a_d (void) const
	Return adaptive recomputation distance.
void	node (unsigned int n)
	Set default node cutoff.
unsigned int	node (void) const
	Return node cutoff.
void	fail (unsigned int n)
	Set default failure cutoff.
unsigned int	fail (void) const
	Return failure cutoff.
void	time (unsigned int t)
	Set default time cutoff.
unsigned int	time (void) const
	Return time cutoff.
void	interrupt (bool b)
	Set default interrupt behavior.
bool	interrupt (void) const
	Return interrupt behavior.
Execution options
Driver::StringOption	_mode
	Script mode to run.
Driver::UnsignedIntOption	_samples
	How many samples.
Driver::UnsignedIntOption	_iterations
	How many iterations per sample.
void	mode (ScriptMode em)
	Set default mode.
ScriptMode	mode (void) const
	Return mode.
void	iterations (unsigned int i)
	Set default number of iterations.
unsigned int	iterations (void) const
	Return number of iterations.
void	samples (unsigned int s)
	Set default number of samples.
unsigned int	samples (void) const
	Return number of samples.

---

Detailed Description

Options for scripts

Definition at line 306 of file driver.hh.

---

Constructor & Destructor Documentation

Gecode::Options::Options

(

const char *

s

)

Initialize options for script with name s.

Definition at line 341 of file options.cpp.

---

Member Function Documentation

void Gecode::Options::model

(

int

v

)

[inline]

Set default model value.

Definition at line 173 of file options.hpp.

void Gecode::Options::model	(	int	v,
		const char *	o,
		const char *	h = NULL
	)			[inline]

Add model option value for value v, string o, and help h.

Definition at line 177 of file options.hpp.

int Gecode::Options::model

(

void

)

const [inline]

Return model value.

Definition at line 181 of file options.hpp.

void Gecode::Options::symmetry

(

int

v

)

[inline]

Set default symmetry value.

Definition at line 186 of file options.hpp.

void Gecode::Options::symmetry	(	int	v,
		const char *	o,
		const char *	h = NULL
	)			[inline]

Add symmetry option value for value v, string o, and help h.

Definition at line 190 of file options.hpp.

int Gecode::Options::symmetry

(

void

)

const [inline]

Return symmetry value.

Reimplemented in EFPAOptions.

Definition at line 194 of file options.hpp.

void Gecode::Options::propagation

(

int

v

)

[inline]

Set default propagation value.

Definition at line 199 of file options.hpp.

void Gecode::Options::propagation	(	int	v,
		const char *	o,
		const char *	h = NULL
	)			[inline]

Add propagation option value for value v, string o, and help h.

Definition at line 203 of file options.hpp.

int Gecode::Options::propagation

(

void

)

const [inline]

Return propagation value.

Definition at line 207 of file options.hpp.

void Gecode::Options::icl

(

IntConLevel

i

)

[inline]

Set default integer consistency level.

Definition at line 212 of file options.hpp.

IntConLevel Gecode::Options::icl

(

void

)

const [inline]

Return integer consistency level.

Definition at line 216 of file options.hpp.

void Gecode::Options::branching

(

int

v

)

[inline]

Set default branching value.

Definition at line 221 of file options.hpp.

void Gecode::Options::branching	(	int	v,
		const char *	o,
		const char *	h = NULL
	)			[inline]

Add branching option value for value v, string o, and help h.

Definition at line 225 of file options.hpp.

int Gecode::Options::branching

(

void

)

const [inline]

Return branching value.

Definition at line 229 of file options.hpp.

void Gecode::Options::search

(

int

v

)

[inline]

Set default search value.

Definition at line 238 of file options.hpp.

void Gecode::Options::search	(	int	v,
		const char *	o,
		const char *	h = NULL
	)			[inline]

Add search option value for value v, string o, and help h.

Definition at line 242 of file options.hpp.

int Gecode::Options::search

(

void

)

const [inline]

Return search value.

Definition at line 246 of file options.hpp.

void Gecode::Options::solutions

(

unsigned int

n

)

[inline]

Set default number of solutions to search for.

Definition at line 251 of file options.hpp.

unsigned int Gecode::Options::solutions

(

void

)

const [inline]

Return number of solutions to search for.

Definition at line 255 of file options.hpp.

void Gecode::Options::threads

(

double

n

)

[inline]

Set number of parallel threads.

Definition at line 260 of file options.hpp.

double Gecode::Options::threads

(

void

)

const [inline]

Return number of parallel threads.

Definition at line 264 of file options.hpp.

void Gecode::Options::c_d

(

unsigned int

d

)

[inline]

Set default copy recomputation distance.

Definition at line 269 of file options.hpp.

unsigned int Gecode::Options::c_d

(

void

)

const [inline]

Return copy recomputation distance.

Definition at line 273 of file options.hpp.

void Gecode::Options::a_d

(

unsigned int

d

)

[inline]

Set default adaptive recomputation distance.

Definition at line 278 of file options.hpp.

unsigned int Gecode::Options::a_d

(

void

)

const [inline]

Return adaptive recomputation distance.

Definition at line 282 of file options.hpp.

void Gecode::Options::node

(

unsigned int

n

)

[inline]

Set default node cutoff.

Definition at line 287 of file options.hpp.

unsigned int Gecode::Options::node

(

void

)

const [inline]

Return node cutoff.

Definition at line 291 of file options.hpp.

void Gecode::Options::fail

(

unsigned int

n

)

[inline]

Set default failure cutoff.

Definition at line 296 of file options.hpp.

unsigned int Gecode::Options::fail

(

void

)

const [inline]

Return failure cutoff.

Definition at line 300 of file options.hpp.

void Gecode::Options::time

(

unsigned int

t

)

[inline]

Set default time cutoff.

Definition at line 305 of file options.hpp.

unsigned int Gecode::Options::time

(

void

)

const [inline]

Return time cutoff.

Definition at line 309 of file options.hpp.

void Gecode::Options::interrupt

(

bool

b

)

[inline]

Set default interrupt behavior.

Definition at line 314 of file options.hpp.

bool Gecode::Options::interrupt

(

void

)

const [inline]

Return interrupt behavior.

Definition at line 318 of file options.hpp.

void Gecode::Options::mode

(

ScriptMode

em

)

[inline]

Set default mode.

Definition at line 328 of file options.hpp.

ScriptMode Gecode::Options::mode

(

void

)

const [inline]

Return mode.

Definition at line 332 of file options.hpp.

void Gecode::Options::iterations

(

unsigned int

i

)

[inline]

Set default number of iterations.

Definition at line 337 of file options.hpp.

unsigned int Gecode::Options::iterations

(

void

)

const [inline]

Return number of iterations.

Definition at line 341 of file options.hpp.

void Gecode::Options::samples

(

unsigned int

s

)

[inline]

Set default number of samples.

Definition at line 346 of file options.hpp.

unsigned int Gecode::Options::samples

(

void

)

const [inline]

Return number of samples.

Definition at line 350 of file options.hpp.

---

Member Data Documentation

Driver::StringOption Gecode::Options::_model [protected]

General model options.

Definition at line 310 of file driver.hh.

Driver::StringOption Gecode::Options::_symmetry [protected]

General symmetry options.

Definition at line 311 of file driver.hh.

Driver::StringOption Gecode::Options::_propagation [protected]

Propagation options.

Definition at line 312 of file driver.hh.

Driver::StringOption Gecode::Options::_icl [protected]

Integer consistency level.

Definition at line 313 of file driver.hh.

Driver::StringOption Gecode::Options::_branching [protected]

Branching options.

Definition at line 314 of file driver.hh.

Driver::StringOption Gecode::Options::_search [protected]

Search options.

Definition at line 319 of file driver.hh.

Driver::UnsignedIntOption Gecode::Options::_solutions [protected]

How many solutions.

Definition at line 320 of file driver.hh.

Driver::DoubleOption Gecode::Options::_threads [protected]

How many threads to use.

Definition at line 321 of file driver.hh.

Driver::UnsignedIntOption Gecode::Options::_c_d [protected]

Copy recomputation distance.

Definition at line 322 of file driver.hh.

Driver::UnsignedIntOption Gecode::Options::_a_d [protected]

Adaptive recomputation distance.

Definition at line 323 of file driver.hh.

Driver::UnsignedIntOption Gecode::Options::_node [protected]

Cutoff for number of nodes.

Definition at line 324 of file driver.hh.

Driver::UnsignedIntOption Gecode::Options::_fail [protected]

Cutoff for number of failures.

Definition at line 325 of file driver.hh.

Driver::UnsignedIntOption Gecode::Options::_time [protected]

Cutoff for time.

Definition at line 326 of file driver.hh.

Driver::StringOption Gecode::Options::_interrupt [protected]

Whether to catch SIGINT.

Definition at line 327 of file driver.hh.

Driver::StringOption Gecode::Options::_mode [protected]

Script mode to run.

Definition at line 332 of file driver.hh.

Driver::UnsignedIntOption Gecode::Options::_samples [protected]

How many samples.

Definition at line 333 of file driver.hh.

Driver::UnsignedIntOption Gecode::Options::_iterations [protected]

How many iterations per sample.

Definition at line 334 of file driver.hh.

---

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

• gecode/driver.hh (Revision: 11465)
• gecode/driver/options.cpp (Revision: 11465)
• gecode/driver/options.hpp (Revision: 11766)