Options Class Reference

#include <support.hh>

Inherited by BIBDOptions, FileNameOptions, LangfordNumberOptions, and SizeOptions.

List of all members.

---

Detailed Description

Options for examples.

Definition at line 150 of file support.hh.

Model options
StringOption	_model
	General model options.
StringOption	_propagation
	Propagation options.
StringOption	_pk
	Propagation kind.
StringOption	_icl
	Integer consistency level.
StringOption	_branching
	Branching options.
Search options
StringOption	_search
	Search options.
UnsignedIntOption	_solutions
	How many solutions.
UnsignedIntOption	_c_d
	Copy recomputation distance.
UnsignedIntOption	_a_d
	Adaptive recomputation distance.
UnsignedIntOption	_fail
	Cutoff for number of failures.
UnsignedIntOption	_time
	Cutoff for time.
Execution options
StringOption	_mode
	Example mode to run.
UnsignedIntOption	_samples
	How many samples.
UnsignedIntOption	_iterations
	How many iterations per sample.
Model 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	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	pk (PropKind p)
	Set default propagation kind.
PropKind	pk (void) const
	Return propagation kind.
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
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	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	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.
Execution options
void	mode (ExampleMode em)
	Set default mode.
ExampleMode	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.
Public Member Functions
	Options (const char *s)
	Initialize options for example with name s.
void	add (BaseOption &o)
	Add new option o.
virtual void	help (void)
	Print help text.
void	parse (int &argc, char *argv[])
	Parse options from arguments argv (number is argc).
const char *	name (void) const
	Return name of example.
virtual	~Options (void)
	Destructor.
Protected Attributes
BaseOption *	fst
	First registered option.
BaseOption *	lst
	Last registered option.
const char *	_name
	Example name.

---

Constructor & Destructor Documentation

Options::Options

(

const char *

s

)

Initialize options for example with name s.

Definition at line 140 of file options.cc.

Options::~Options

(

void

)

[inline, virtual]

Destructor.

Definition at line 261 of file options.icc.

---

Member Function Documentation

void Options::add

(

BaseOption &

o

)

[inline]

Add new option o.

Definition at line 90 of file options.icc.

void Options::help

(

void

)

[virtual]

Print help text.

Reimplemented in BIBDOptions, FileNameOptions, LangfordNumberOptions, and SizeOptions.

Definition at line 182 of file options.cc.

void Options::parse	(	int &	argc,
		char *	argv[]
	)

Parse options from arguments argv (number is argc).

Reimplemented in BIBDOptions, FileNameOptions, LangfordNumberOptions, and SizeOptions.

Definition at line 191 of file options.cc.

const char * Options::name

(

void

)

const [inline]

Return name of example.

Definition at line 100 of file options.icc.

void Options::model

(

int

v

)

[inline]

Set default model value.

Definition at line 109 of file options.icc.

void 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 113 of file options.icc.

int Options::model

(

void

)

const [inline]

Return model value.

Definition at line 117 of file options.icc.

void Options::propagation

(

int

v

)

[inline]

Set default propagation value.

Definition at line 122 of file options.icc.

void 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 126 of file options.icc.

int Options::propagation

(

void

)

const [inline]

Return propagation value.

Definition at line 130 of file options.icc.

void Options::pk

(

PropKind

p

)

Set default propagation kind.

PropKind Options::pk

(

void

)

const [inline]

Return propagation kind.

Definition at line 139 of file options.icc.

void Options::icl

(

IntConLevel

i

)

Set default integer consistency level.

IntConLevel Options::icl

(

void

)

const [inline]

Return integer consistency level.

Definition at line 148 of file options.icc.

void Options::branching

(

int

v

)

[inline]

Set default branching value.

Definition at line 153 of file options.icc.

void 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 157 of file options.icc.

int Options::branching

(

void

)

const [inline]

Return branching value.

Definition at line 161 of file options.icc.

void Options::search

(

int

v

)

[inline]

Set default search value.

Definition at line 170 of file options.icc.

void 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 174 of file options.icc.

int Options::search

(

void

)

const [inline]

Return search value.

Definition at line 178 of file options.icc.

void Options::solutions

(

unsigned int

n

)

[inline]

Set default number of solutions to search for.

Definition at line 183 of file options.icc.

unsigned int Options::solutions

(

void

)

const [inline]

Return number of solutions to search for.

Definition at line 187 of file options.icc.

void Options::c_d

(

unsigned int

d

)

[inline]

Set default copy recomputation distance.

Definition at line 192 of file options.icc.

unsigned int Options::c_d

(

void

)

const [inline]

Return copy recomputation distance.

Definition at line 196 of file options.icc.

void Options::a_d

(

unsigned int

d

)

[inline]

Set default adaptive recomputation distance.

Definition at line 201 of file options.icc.

unsigned int Options::a_d

(

void

)

const [inline]

Return adaptive recomputation distance.

Definition at line 205 of file options.icc.

void Options::fail

(

unsigned int

n

)

[inline]

Set default failure cutoff.

Definition at line 210 of file options.icc.

unsigned int Options::fail

(

void

)

const [inline]

Return failure cutoff.

Definition at line 214 of file options.icc.

void Options::time

(

unsigned int

t

)

[inline]

Set default time cutoff.

Definition at line 219 of file options.icc.

unsigned int Options::time

(

void

)

const [inline]

Return time cutoff.

Definition at line 223 of file options.icc.

void Options::mode

(

ExampleMode

em

)

[inline]

Set default mode.

Definition at line 234 of file options.icc.

ExampleMode Options::mode

(

void

)

const [inline]

Return mode.

Definition at line 238 of file options.icc.

void Options::iterations

(

unsigned int

i

)

[inline]

Set default number of iterations.

Definition at line 243 of file options.icc.

unsigned int Options::iterations

(

void

)

const [inline]

Return number of iterations.

Definition at line 247 of file options.icc.

void Options::samples

(

unsigned int

s

)

[inline]

Set default number of samples.

Definition at line 252 of file options.icc.

unsigned int Options::samples

(

void

)

const [inline]

Return number of samples.

Definition at line 256 of file options.icc.

---

Member Data Documentation

BaseOption* Options::fst [protected]

First registered option.

Definition at line 152 of file support.hh.

BaseOption* Options::lst [protected]

Last registered option.

Definition at line 153 of file support.hh.

const char* Options::_name [protected]

Example name.

Definition at line 154 of file support.hh.

StringOption Options::_model [protected]

General model options.

Definition at line 158 of file support.hh.

StringOption Options::_propagation [protected]

Propagation options.

Definition at line 159 of file support.hh.

StringOption Options::_pk [protected]

Propagation kind.

Definition at line 160 of file support.hh.

StringOption Options::_icl [protected]

Integer consistency level.

Definition at line 161 of file support.hh.

StringOption Options::_branching [protected]

Branching options.

Definition at line 162 of file support.hh.

StringOption Options::_search [protected]

Search options.

Definition at line 167 of file support.hh.

UnsignedIntOption Options::_solutions [protected]

How many solutions.

Definition at line 168 of file support.hh.

UnsignedIntOption Options::_c_d [protected]

Copy recomputation distance.

Definition at line 169 of file support.hh.

UnsignedIntOption Options::_a_d [protected]

Adaptive recomputation distance.

Definition at line 170 of file support.hh.

UnsignedIntOption Options::_fail [protected]

Cutoff for number of failures.

Definition at line 171 of file support.hh.

UnsignedIntOption Options::_time [protected]

Cutoff for time.

Definition at line 172 of file support.hh.

StringOption Options::_mode [protected]

Example mode to run.

Definition at line 177 of file support.hh.

UnsignedIntOption Options::_samples [protected]

How many samples.

Definition at line 178 of file support.hh.

UnsignedIntOption Options::_iterations [protected]

How many iterations per sample.

Definition at line 179 of file support.hh.

---

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

• examples/support.hh (Revision: 7347)
• examples/support/options.cc (Revision: 7347)
• examples/support/options.icc (Revision: 7344)