Gecode::FlatZinc::FlatZincOptions Class Reference

Options for running FlatZinc models More...

`#include <flatzinc.hh>`

## Search options

Gecode::Driver::IntOption | _solutions
| How many solutions.
Gecode::Driver::BoolOption | _allSolutions
| Return all solutions.
Gecode::Driver::DoubleOption | _threads
| How many threads to use.
Gecode::Driver::BoolOption | _free
| Use free search.
Gecode::Driver::DoubleOption | _decay
| Decay option.
Gecode::Driver::UnsignedIntOption | _c_d
| Copy recomputation distance.
Gecode::Driver::UnsignedIntOption | _a_d
| Adaptive recomputation distance.
Gecode::Driver::UnsignedIntOption | _node
| Cutoff for number of nodes.
Gecode::Driver::UnsignedIntOption | _fail
| Cutoff for number of failures.
Gecode::Driver::UnsignedIntOption | _time
| Cutoff for time.
Gecode::Driver::UnsignedIntOption | _time_limit
| Cutoff for time (for compatibility with flatzinc command line).
Gecode::Driver::IntOption | _seed
| Random seed.
Gecode::Driver::StringOption | _restart
| Restart method option.
Gecode::Driver::DoubleOption | _r_base
| Restart base.
Gecode::Driver::UnsignedIntOption | _r_scale
| Restart scale factor.
Gecode::Driver::BoolOption | _nogoods
| Whether to use no-goods.
Gecode::Driver::UnsignedIntOption | _nogoods_limit
| Depth limit for extracting no-goods.
Gecode::Driver::BoolOption | _interrupt
| Whether to catch SIGINT.
Gecode::Driver::DoubleOption | _step
| Step option.

## Execution options

Gecode::Driver::StringOption | _mode
| Script mode to run.
Gecode::Driver::BoolOption | _stat
| Emit statistics.
Gecode::Driver::StringValueOption | _output
| Output file.
Gecode::Driver::IntOption | _profiler_id
| Use this execution id for the CP-profiler.
Gecode::Driver::UnsignedIntOption | _profiler_port
| Connect to this port.
Gecode::Driver::BoolOption | _profiler_info
| Whether solution information should be sent to the CP-profiler.
| FlatZincOptions (const char *s)
| Constructor.
void | parse (int &argc, char *argv[])
| Script mode to run.
virtual void | help (void)
| Script mode to run.
int | solutions (void) const
| Script mode to run.
bool | allSolutions (void) const
| Script mode to run.
double | threads (void) const
| Script mode to run.
bool | free (void) const
| Script mode to run.
unsigned int | c_d (void) const
| Script mode to run.
unsigned int | a_d (void) const
| Script mode to run.
unsigned int | node (void) const
| Script mode to run.
unsigned int | fail (void) const
| Script mode to run.
unsigned int | time (void) const
| Script mode to run.
int | seed (void) const
| Script mode to run.
double | step (void) const
| Script mode to run.
const char * | output (void) const
| Script mode to run.
Gecode::ScriptMode | mode (void) const
| Script mode to run.
double | decay (void) const
| Script mode to run.
RestartMode | restart (void) const
| Script mode to run.
void | restart (RestartMode rm)
| Script mode to run.
double | restart_base (void) const
| Script mode to run.
void | restart_base (double d)
| Script mode to run.
unsigned int | restart_scale (void) const
| Script mode to run.
void | restart_scale (int i)
| Script mode to run.
bool | nogoods (void) const
| Script mode to run.
unsigned int | nogoods_limit (void) const
| Script mode to run.
bool | interrupt (void) const
| Script mode to run.
int | profiler_id (void) const
| Script mode to run.
unsigned int | profiler_port (void) const
| Script mode to run.
bool | profiler_info (void) const
| Script mode to run.
void | allSolutions (bool b)
| Script mode to run.

## Additional Inherited Members

Public Member Functions inherited from Gecode::BaseOptions
| BaseOptions (const char *s)
| Initialize options for script with name s.
void | add (Driver::BaseOption &o)
| Add new option o.
void | parse (int &argc, char *argv[])
| Parse options from arguments argv (number is argc).
const char * | name (void) const
| Return name of script.
void | name (const char *)
| Set name of script.
virtual | ~BaseOptions (void)
| Destructor.
Protected Attributes inherited from Gecode::BaseOptions
Driver::BaseOption * | fst
| First registered option.
Driver::BaseOption * | lst
| Last registered option.
const char * | _name
| Script name.

## Detailed Description

Options for running FlatZinc models

Definition at line 226 of file flatzinc.hh.

## Constructor & Destructor Documentation

## FlatZincOptions()

Gecode::FlatZinc::FlatZincOptions::FlatZincOptions | ( | const char * | s | ) |

inline

Constructor.

Definition at line 268 of file flatzinc.hh.

## Member Function Documentation

## parse()

void Gecode::FlatZinc::FlatZincOptions::parse | ( | int & | argc,
|  | char * | argv[] )

inline

Script mode to run.

Definition at line 332 of file flatzinc.hh.

## help()

virtual void Gecode::FlatZinc::FlatZincOptions::help | ( | void |  | ) |

inline virtual

Script mode to run.

Reimplemented from Gecode::BaseOptions.

Definition at line 344 of file flatzinc.hh.

## solutions()

int Gecode::FlatZinc::FlatZincOptions::solutions | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 351 of file flatzinc.hh.

## allSolutions() [1/2]

bool Gecode::FlatZinc::FlatZincOptions::allSolutions | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 352 of file flatzinc.hh.

## threads()

double Gecode::FlatZinc::FlatZincOptions::threads | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 353 of file flatzinc.hh.

## free()

bool Gecode::FlatZinc::FlatZincOptions::free | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 354 of file flatzinc.hh.

## c_d()

unsigned int Gecode::FlatZinc::FlatZincOptions::c_d | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 355 of file flatzinc.hh.

## a_d()

unsigned int Gecode::FlatZinc::FlatZincOptions::a_d | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 356 of file flatzinc.hh.

## node()

unsigned int Gecode::FlatZinc::FlatZincOptions::node | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 357 of file flatzinc.hh.

## fail()

unsigned int Gecode::FlatZinc::FlatZincOptions::fail | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 358 of file flatzinc.hh.

## time()

unsigned int Gecode::FlatZinc::FlatZincOptions::time | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 359 of file flatzinc.hh.

## seed()

int Gecode::FlatZinc::FlatZincOptions::seed | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 360 of file flatzinc.hh.

## step()

double Gecode::FlatZinc::FlatZincOptions::step | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 361 of file flatzinc.hh.

## output()

const char * Gecode::FlatZinc::FlatZincOptions::output | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 362 of file flatzinc.hh.

## mode()

Gecode::ScriptMode Gecode::FlatZinc::FlatZincOptions::mode | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 364 of file flatzinc.hh.

## decay()

double Gecode::FlatZinc::FlatZincOptions::decay | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 368 of file flatzinc.hh.

## restart() [1/2]

RestartMode Gecode::FlatZinc::FlatZincOptions::restart | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 369 of file flatzinc.hh.

## restart() [2/2]

void Gecode::FlatZinc::FlatZincOptions::restart | ( | RestartMode | rm | ) |

inline

Script mode to run.

Definition at line 372 of file flatzinc.hh.

## restart_base() [1/2]

double Gecode::FlatZinc::FlatZincOptions::restart_base | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 375 of file flatzinc.hh.

## restart_base() [2/2]

void Gecode::FlatZinc::FlatZincOptions::restart_base | ( | double | d | ) |

inline

Script mode to run.

Definition at line 376 of file flatzinc.hh.

## restart_scale() [1/2]

unsigned int Gecode::FlatZinc::FlatZincOptions::restart_scale | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 377 of file flatzinc.hh.

## restart_scale() [2/2]

void Gecode::FlatZinc::FlatZincOptions::restart_scale | ( | int | i | ) |

inline

Script mode to run.

Definition at line 378 of file flatzinc.hh.

## nogoods()

bool Gecode::FlatZinc::FlatZincOptions::nogoods | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 379 of file flatzinc.hh.

## nogoods_limit()

unsigned int Gecode::FlatZinc::FlatZincOptions::nogoods_limit | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 380 of file flatzinc.hh.

## interrupt()

bool Gecode::FlatZinc::FlatZincOptions::interrupt | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 381 of file flatzinc.hh.

## profiler_id()

int Gecode::FlatZinc::FlatZincOptions::profiler_id | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 385 of file flatzinc.hh.

## profiler_port()

unsigned int Gecode::FlatZinc::FlatZincOptions::profiler_port | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 386 of file flatzinc.hh.

## profiler_info()

bool Gecode::FlatZinc::FlatZincOptions::profiler_info | ( | void |  | ) | const

inline

Script mode to run.

Definition at line 387 of file flatzinc.hh.

## allSolutions() [2/2]

void Gecode::FlatZinc::FlatZincOptions::allSolutions | ( | bool | b | ) |

inline

Script mode to run.

Definition at line 391 of file flatzinc.hh.

## Member Data Documentation

## _solutions

Gecode::Driver::IntOption Gecode::FlatZinc::FlatZincOptions::_solutions

protected

How many solutions.

Definition at line 230 of file flatzinc.hh.

## _allSolutions

Gecode::Driver::BoolOption Gecode::FlatZinc::FlatZincOptions::_allSolutions

protected

Return all solutions.

Definition at line 231 of file flatzinc.hh.

## _threads

Gecode::Driver::DoubleOption Gecode::FlatZinc::FlatZincOptions::_threads

protected

How many threads to use.

Definition at line 232 of file flatzinc.hh.

## _free

Gecode::Driver::BoolOption Gecode::FlatZinc::FlatZincOptions::_free

protected

Use free search.

Definition at line 233 of file flatzinc.hh.

## _decay

Gecode::Driver::DoubleOption Gecode::FlatZinc::FlatZincOptions::_decay

protected

Decay option.

Definition at line 234 of file flatzinc.hh.

## _c_d

Gecode::Driver::UnsignedIntOption Gecode::FlatZinc::FlatZincOptions::_c_d

protected

Copy recomputation distance.

Definition at line 235 of file flatzinc.hh.

## _a_d

Gecode::Driver::UnsignedIntOption Gecode::FlatZinc::FlatZincOptions::_a_d

protected

Adaptive recomputation distance.

Definition at line 236 of file flatzinc.hh.

## _node

Gecode::Driver::UnsignedIntOption Gecode::FlatZinc::FlatZincOptions::_node

protected

Cutoff for number of nodes.

Definition at line 237 of file flatzinc.hh.

## _fail

Gecode::Driver::UnsignedIntOption Gecode::FlatZinc::FlatZincOptions::_fail

protected

Cutoff for number of failures.

Definition at line 238 of file flatzinc.hh.

## _time

Gecode::Driver::UnsignedIntOption Gecode::FlatZinc::FlatZincOptions::_time

protected

Cutoff for time.

Definition at line 239 of file flatzinc.hh.

## _time_limit

Gecode::Driver::UnsignedIntOption Gecode::FlatZinc::FlatZincOptions::_time_limit

protected

Cutoff for time (for compatibility with flatzinc command line).

Definition at line 240 of file flatzinc.hh.

## _seed

Gecode::Driver::IntOption Gecode::FlatZinc::FlatZincOptions::_seed

protected

Random seed.

Definition at line 241 of file flatzinc.hh.

## _restart

Gecode::Driver::StringOption Gecode::FlatZinc::FlatZincOptions::_restart

protected

Restart method option.

Definition at line 242 of file flatzinc.hh.

## _r_base

Gecode::Driver::DoubleOption Gecode::FlatZinc::FlatZincOptions::_r_base

protected

Restart base.

Definition at line 243 of file flatzinc.hh.

## _r_scale

Gecode::Driver::UnsignedIntOption Gecode::FlatZinc::FlatZincOptions::_r_scale

protected

Restart scale factor.

Definition at line 244 of file flatzinc.hh.

## _nogoods

Gecode::Driver::BoolOption Gecode::FlatZinc::FlatZincOptions::_nogoods

protected

Whether to use no-goods.

Definition at line 245 of file flatzinc.hh.

## _nogoods_limit

Gecode::Driver::UnsignedIntOption Gecode::FlatZinc::FlatZincOptions::_nogoods_limit

protected

Depth limit for extracting no-goods.

Definition at line 246 of file flatzinc.hh.

## _interrupt

Gecode::Driver::BoolOption Gecode::FlatZinc::FlatZincOptions::_interrupt

protected

Whether to catch SIGINT.

Definition at line 247 of file flatzinc.hh.

## _step

Gecode::Driver::DoubleOption Gecode::FlatZinc::FlatZincOptions::_step

protected

Step option.

Definition at line 248 of file flatzinc.hh.

## _mode

Gecode::Driver::StringOption Gecode::FlatZinc::FlatZincOptions::_mode

protected

Script mode to run.

Definition at line 253 of file flatzinc.hh.

## _stat

Gecode::Driver::BoolOption Gecode::FlatZinc::FlatZincOptions::_stat

protected

Emit statistics.

Definition at line 254 of file flatzinc.hh.

## _output

Gecode::Driver::StringValueOption Gecode::FlatZinc::FlatZincOptions::_output

protected

Output file.

Definition at line 255 of file flatzinc.hh.

## _profiler_id

Gecode::Driver::IntOption Gecode::FlatZinc::FlatZincOptions::_profiler_id

protected

Use this execution id for the CP-profiler.

Definition at line 259 of file flatzinc.hh.

## _profiler_port

Gecode::Driver::UnsignedIntOption Gecode::FlatZinc::FlatZincOptions::_profiler_port

protected

Connect to this port.

Definition at line 260 of file flatzinc.hh.

## _profiler_info

Gecode::Driver::BoolOption Gecode::FlatZinc::FlatZincOptions::_profiler_info

protected

Whether solution information should be sent to the CP-profiler.

Definition at line 261 of file flatzinc.hh.

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

- gecode/flatzinc.hh