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

Options for scripts More...

#include <driver.hh>

List of all members.

Classes
class	_I
	Helper class storing Gist inspectors. More...
Public Member Functions
	Options (const char *s)
	Initialize options for script with name s.
Public Attributes
class Gecode::Options::_I	inspect
	Helper class storing Gist inspectors.
Model options
Driver::StringOption	_model
	General model options.
Driver::StringOption	_symmetry
	General symmetry options.
Driver::StringOption	_propagation
	Propagation options.
Driver::IplOption	_ipl
	Integer propagation level.
Driver::StringOption	_branching
	Branching options.
Driver::DoubleOption	_decay
	Decay option.
Driver::UnsignedIntOption	_seed
	Seed option.
Driver::DoubleOption	_step
	Step option.
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	ipl (IntPropLevel i)
	Set default integer propagation level.
IntPropLevel	ipl (void) const
	Return integer propagation 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.
void	decay (double d)
	Set default decay factor.
double	decay (void) const
	Return decay factor.
void	seed (unsigned int s)
	Set default seed value.
unsigned int	seed (void) const
	Return seed value.
void	step (double s)
	Set default step value.
double	step (void) const
	Return step 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	_d_l
	Discrepancy limit for LDS.
Driver::UnsignedIntOption	_node
	Cutoff for number of nodes.
Driver::UnsignedIntOption	_fail
	Cutoff for number of failures.
Driver::UnsignedIntOption	_time
	Cutoff for time.
Driver::UnsignedIntOption	_assets
	Number of assets in a portfolio.
Driver::UnsignedIntOption	_slice
	Size of a portfolio slice.
Driver::StringOption	_restart
	Restart method option.
Driver::DoubleOption	_r_base
	Restart base.
Driver::UnsignedIntOption	_r_scale
	Restart scale factor.
Driver::BoolOption	_nogoods
	Whether to use no-goods.
Driver::UnsignedIntOption	_nogoods_limit
	Limit for no-good extraction.
Driver::DoubleOption	_relax
	Probability to relax variable.
Driver::BoolOption	_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	d_l (unsigned int d)
	Set default discrepancy limit for LDS.
unsigned int	d_l (void) const
	Return discrepancy limit for LDS.
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	assets (unsigned int n)
	Set default number of assets in a portfolio.
unsigned int	assets (void) const
	Return slice size in a portfolio.
void	slice (unsigned int n)
	Set default slice size in a portfolio.
unsigned int	slice (void) const
	Return slice size in a portfolio.
void	restart (RestartMode r)
	Set default restart mode.
RestartMode	restart (void) const
	Return restart mode.
void	restart_base (double base)
	Set default restart base.
double	restart_base (void) const
	Return restart base.
void	restart_scale (unsigned int scale)
	Set default restart scale factor.
unsigned int	restart_scale (void) const
	Return restart scale factor.
void	nogoods (bool b)
	Set default nogoods posting behavior.
bool	nogoods (void) const
	Return whether nogoods are used.
void	nogoods_limit (unsigned int l)
	Set default nogoods depth limit.
unsigned int	nogoods_limit (void) const
	Return depth limit for nogoods.
void	relax (double d)
	Set default relax probability.
double	relax (void) const
	Return default relax probability.
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.
Driver::BoolOption	_print_last
	Print only last solution found.
Driver::StringValueOption	_out_file
	Where to print solutions.
Driver::StringValueOption	_log_file
	Where to print statistics.
Driver::TraceOption	_trace
	Trace flags for tracing.
Driver::IntOption	_profiler_id
	Use this execution id for the CP-profiler.
Driver::UnsignedIntOption	_profiler_port
	Connect to this port.
Driver::BoolOption	_profiler_info
	Whether solution information should be sent to the CPProfiler.
void	mode (ScriptMode em)
	Set default mode.
ScriptMode	mode (void) const
	Return mode.
void	samples (unsigned int s)
	Set default number of samples.
unsigned int	samples (void) const
	Return number of samples.
void	iterations (unsigned int i)
	Set default number of iterations.
unsigned int	iterations (void) const
	Return number of iterations.
void	print_last (bool p)
	Set whether to print only last solution found.
bool	print_last (void) const
	Return whether to print only last solution found.
void	out_file (const char *f)
	Set default output file name for solutions.
const char *	out_file (void) const
	Get file name for solutions.
void	log_file (const char *f)
	Set default output file name for Gecode stats.
const char *	log_file (void) const
	Get file name for Gecode stats.
void	trace (int f)
	Set trace flags.
int	trace (void) const
	Return trace flags.
void	profiler_id (int i)
	Set profiler execution identifier.
int	profiler_id (void) const
	Return profiler execution id.
void	profiler_port (unsigned int p)
	Set profiler port.
unsigned int	profiler_port (void) const
	Return profiler execution id.
void	profiler_info (bool b)
	Whether solution info should be sent to profiler.
bool	profiler_info (void) const
	Return whether solution info should be sent to profiler.

---

Detailed Description

Options for scripts

Definition at line 366 of file driver.hh.

---

Constructor & Destructor Documentation

Gecode::Options::Options

(

const char *

s

)

Initialize options for script with name s.

Definition at line 576 of file options.cpp.

---

Member Function Documentation

void Gecode::Options::model

(

int

v

)

[inline]

Set default model value.

Definition at line 177 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 181 of file options.hpp.

int Gecode::Options::model

(

void

)

const [inline]

Return model value.

Definition at line 185 of file options.hpp.

void Gecode::Options::symmetry

(

int

v

)

[inline]

Set default symmetry value.

Definition at line 190 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 194 of file options.hpp.

int Gecode::Options::symmetry

(

void

)

const [inline]

Return symmetry value.

Reimplemented in EFPAOptions.

Definition at line 198 of file options.hpp.

void Gecode::Options::propagation

(

int

v

)

[inline]

Set default propagation value.

Definition at line 203 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 207 of file options.hpp.

int Gecode::Options::propagation

(

void

)

const [inline]

Return propagation value.

Definition at line 211 of file options.hpp.

void Gecode::Options::ipl

(

IntPropLevel

i

)

[inline]

Set default integer propagation level.

Definition at line 216 of file options.hpp.

IntPropLevel Gecode::Options::ipl

(

void

)

const [inline]

Return integer propagation level.

Definition at line 220 of file options.hpp.

void Gecode::Options::branching

(

int

v

)

[inline]

Set default branching value.

Definition at line 225 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 229 of file options.hpp.

int Gecode::Options::branching

(

void

)

const [inline]

Return branching value.

Definition at line 233 of file options.hpp.

void Gecode::Options::decay

(

double

d

)

[inline]

Set default decay factor.

Definition at line 238 of file options.hpp.

double Gecode::Options::decay

(

void

)

const [inline]

Return decay factor.

Definition at line 242 of file options.hpp.

void Gecode::Options::seed

(

unsigned int

s

)

[inline]

Set default seed value.

Definition at line 247 of file options.hpp.

unsigned int Gecode::Options::seed

(

void

)

const [inline]

Return seed value.

Definition at line 251 of file options.hpp.

void Gecode::Options::step

(

double

s

)

[inline]

Set default step value.

Definition at line 256 of file options.hpp.

double Gecode::Options::step

(

void

)

const [inline]

Return step value.

Definition at line 260 of file options.hpp.

void Gecode::Options::search

(

int

v

)

[inline]

Set default search value.

Definition at line 270 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 274 of file options.hpp.

int Gecode::Options::search

(

void

)

const [inline]

Return search value.

Definition at line 278 of file options.hpp.

void Gecode::Options::solutions

(

unsigned int

n

)

[inline]

Set default number of solutions to search for.

Definition at line 283 of file options.hpp.

unsigned int Gecode::Options::solutions

(

void

)

const [inline]

Return number of solutions to search for.

Definition at line 287 of file options.hpp.

void Gecode::Options::threads

(

double

n

)

[inline]

Set number of parallel threads.

Definition at line 292 of file options.hpp.

double Gecode::Options::threads

(

void

)

const [inline]

Return number of parallel threads.

Definition at line 296 of file options.hpp.

void Gecode::Options::c_d

(

unsigned int

d

)

[inline]

Set default copy recomputation distance.

Definition at line 301 of file options.hpp.

unsigned int Gecode::Options::c_d

(

void

)

const [inline]

Return copy recomputation distance.

Definition at line 305 of file options.hpp.

void Gecode::Options::a_d

(

unsigned int

d

)

[inline]

Set default adaptive recomputation distance.

Definition at line 310 of file options.hpp.

unsigned int Gecode::Options::a_d

(

void

)

const [inline]

Return adaptive recomputation distance.

Definition at line 314 of file options.hpp.

void Gecode::Options::d_l

(

unsigned int

d

)

[inline]

Set default discrepancy limit for LDS.

Definition at line 319 of file options.hpp.

unsigned int Gecode::Options::d_l

(

void

)

const [inline]

Return discrepancy limit for LDS.

Definition at line 323 of file options.hpp.

void Gecode::Options::node

(

unsigned int

n

)

[inline]

Set default node cutoff.

Definition at line 328 of file options.hpp.

unsigned int Gecode::Options::node

(

void

)

const [inline]

Return node cutoff.

Definition at line 332 of file options.hpp.

void Gecode::Options::fail

(

unsigned int

n

)

[inline]

Set default failure cutoff.

Definition at line 337 of file options.hpp.

unsigned int Gecode::Options::fail

(

void

)

const [inline]

Return failure cutoff.

Definition at line 341 of file options.hpp.

void Gecode::Options::time

(

unsigned int

t

)

[inline]

Set default time cutoff.

Definition at line 346 of file options.hpp.

unsigned int Gecode::Options::time

(

void

)

const [inline]

Return time cutoff.

Definition at line 350 of file options.hpp.

void Gecode::Options::assets

(

unsigned int

n

)

[inline]

Set default number of assets in a portfolio.

Definition at line 355 of file options.hpp.

unsigned int Gecode::Options::assets

(

void

)

const [inline]

Return slice size in a portfolio.

Definition at line 359 of file options.hpp.

void Gecode::Options::slice

(

unsigned int

n

)

[inline]

Set default slice size in a portfolio.

Definition at line 364 of file options.hpp.

unsigned int Gecode::Options::slice

(

void

)

const [inline]

Return slice size in a portfolio.

Definition at line 368 of file options.hpp.

void Gecode::Options::restart

(

RestartMode

r

)

[inline]

Set default restart mode.

Definition at line 373 of file options.hpp.

RestartMode Gecode::Options::restart

(

void

)

const [inline]

Return restart mode.

Definition at line 377 of file options.hpp.

void Gecode::Options::restart_base

(

double

base

)

[inline]

Set default restart base.

Definition at line 382 of file options.hpp.

double Gecode::Options::restart_base

(

void

)

const [inline]

Return restart base.

Definition at line 386 of file options.hpp.

void Gecode::Options::restart_scale

(

unsigned int

scale

)

[inline]

Set default restart scale factor.

Definition at line 391 of file options.hpp.

unsigned int Gecode::Options::restart_scale

(

void

)

const [inline]

Return restart scale factor.

Definition at line 395 of file options.hpp.

void Gecode::Options::nogoods

(

bool

b

)

[inline]

Set default nogoods posting behavior.

Definition at line 400 of file options.hpp.

bool Gecode::Options::nogoods

(

void

)

const [inline]

Return whether nogoods are used.

Definition at line 404 of file options.hpp.

void Gecode::Options::nogoods_limit

(

unsigned int

l

)

[inline]

Set default nogoods depth limit.

Definition at line 409 of file options.hpp.

unsigned int Gecode::Options::nogoods_limit

(

void

)

const [inline]

Return depth limit for nogoods.

Definition at line 413 of file options.hpp.

void Gecode::Options::relax

(

double

d

)

[inline]

Set default relax probability.

Definition at line 418 of file options.hpp.

double Gecode::Options::relax

(

void

)

const [inline]

Return default relax probability.

Definition at line 422 of file options.hpp.

void Gecode::Options::interrupt

(

bool

b

)

[inline]

Set default interrupt behavior.

Definition at line 429 of file options.hpp.

bool Gecode::Options::interrupt

(

void

)

const [inline]

Return interrupt behavior.

Definition at line 433 of file options.hpp.

void Gecode::Options::mode

(

ScriptMode

em

)

[inline]

Set default mode.

Definition at line 443 of file options.hpp.

ScriptMode Gecode::Options::mode

(

void

)

const [inline]

Return mode.

Definition at line 447 of file options.hpp.

void Gecode::Options::samples

(

unsigned int

s

)

[inline]

Set default number of samples.

Definition at line 452 of file options.hpp.

unsigned int Gecode::Options::samples

(

void

)

const [inline]

Return number of samples.

Definition at line 456 of file options.hpp.

void Gecode::Options::iterations

(

unsigned int

i

)

[inline]

Set default number of iterations.

Definition at line 461 of file options.hpp.

unsigned int Gecode::Options::iterations

(

void

)

const [inline]

Return number of iterations.

Definition at line 465 of file options.hpp.

void Gecode::Options::print_last

(

bool

p

)

[inline]

Set whether to print only last solution found.

Definition at line 470 of file options.hpp.

bool Gecode::Options::print_last

(

void

)

const [inline]

Return whether to print only last solution found.

Definition at line 474 of file options.hpp.

void Gecode::Options::out_file

(

const char *

f

)

[inline]

Set default output file name for solutions.

Definition at line 479 of file options.hpp.

const char * Gecode::Options::out_file

(

void

)

const [inline]

Get file name for solutions.

Definition at line 484 of file options.hpp.

void Gecode::Options::log_file

(

const char *

f

)

[inline]

Set default output file name for Gecode stats.

Definition at line 489 of file options.hpp.

const char * Gecode::Options::log_file

(

void

)

const [inline]

Get file name for Gecode stats.

Definition at line 494 of file options.hpp.

void Gecode::Options::trace

(

int

f

)

[inline]

Set trace flags.

Definition at line 499 of file options.hpp.

int Gecode::Options::trace

(

void

)

const [inline]

Return trace flags.

Definition at line 504 of file options.hpp.

void Gecode::Options::profiler_id

(

int

i

)

[inline]

Set profiler execution identifier.

Definition at line 515 of file options.hpp.

int Gecode::Options::profiler_id

(

void

)

const [inline]

Return profiler execution id.

Definition at line 519 of file options.hpp.

void Gecode::Options::profiler_port

(

unsigned int

p

)

[inline]

Set profiler port.

Definition at line 523 of file options.hpp.

unsigned int Gecode::Options::profiler_port

(

void

)

const [inline]

Return profiler execution id.

Definition at line 527 of file options.hpp.

void Gecode::Options::profiler_info

(

bool

b

)

[inline]

Whether solution info should be sent to profiler.

Definition at line 531 of file options.hpp.

bool Gecode::Options::profiler_info

(

void

)

const [inline]

Return whether solution info should be sent to profiler.

Definition at line 535 of file options.hpp.

---

Member Data Documentation

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

General model options.

Definition at line 370 of file driver.hh.

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

General symmetry options.

Definition at line 371 of file driver.hh.

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

Propagation options.

Definition at line 372 of file driver.hh.

Driver::IplOption Gecode::Options::_ipl [protected]

Integer propagation level.

Definition at line 373 of file driver.hh.

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

Branching options.

Definition at line 374 of file driver.hh.

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

Decay option.

Definition at line 375 of file driver.hh.

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

Seed option.

Definition at line 376 of file driver.hh.

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

Step option.

Definition at line 377 of file driver.hh.

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

Search options.

Definition at line 382 of file driver.hh.

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

How many solutions.

Definition at line 383 of file driver.hh.

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

How many threads to use.

Definition at line 384 of file driver.hh.

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

Copy recomputation distance.

Definition at line 385 of file driver.hh.

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

Adaptive recomputation distance.

Definition at line 386 of file driver.hh.

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

Discrepancy limit for LDS.

Definition at line 387 of file driver.hh.

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

Cutoff for number of nodes.

Definition at line 388 of file driver.hh.

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

Cutoff for number of failures.

Definition at line 389 of file driver.hh.

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

Cutoff for time.

Definition at line 390 of file driver.hh.

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

Number of assets in a portfolio.

Definition at line 391 of file driver.hh.

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

Size of a portfolio slice.

Definition at line 392 of file driver.hh.

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

Restart method option.

Definition at line 393 of file driver.hh.

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

Restart base.

Definition at line 394 of file driver.hh.

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

Restart scale factor.

Definition at line 395 of file driver.hh.

Driver::BoolOption Gecode::Options::_nogoods [protected]

Whether to use no-goods.

Definition at line 396 of file driver.hh.

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

Limit for no-good extraction.

Definition at line 397 of file driver.hh.

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

Probability to relax variable.

Definition at line 398 of file driver.hh.

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

Whether to catch SIGINT.

Definition at line 399 of file driver.hh.

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

Script mode to run.

Definition at line 404 of file driver.hh.

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

How many samples.

Definition at line 405 of file driver.hh.

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

How many iterations per sample.

Definition at line 406 of file driver.hh.

Driver::BoolOption Gecode::Options::_print_last [protected]

Print only last solution found.

Definition at line 407 of file driver.hh.

Driver::StringValueOption Gecode::Options::_out_file [protected]

Where to print solutions.

Definition at line 408 of file driver.hh.

Driver::StringValueOption Gecode::Options::_log_file [protected]

Where to print statistics.

Definition at line 409 of file driver.hh.

Driver::TraceOption Gecode::Options::_trace [protected]

Trace flags for tracing.

Definition at line 410 of file driver.hh.

Driver::IntOption Gecode::Options::_profiler_id [protected]

Use this execution id for the CP-profiler.

Definition at line 413 of file driver.hh.

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

Connect to this port.

Definition at line 414 of file driver.hh.

Driver::BoolOption Gecode::Options::_profiler_info [protected]

Whether solution information should be sent to the CPProfiler.

Definition at line 415 of file driver.hh.

class Gecode::Options::_I Gecode::Options::inspect

Helper class storing Gist inspectors.

---

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

• gecode/driver.hh
• gecode/driver/options.cpp
• gecode/driver/options.hpp