34#ifndef GECODE_DRIVER_HH
35#define GECODE_DRIVER_HH
50#if !defined(GECODE_STATIC_LIBS) && \
51 (defined(__CYGWIN__) || defined(__MINGW32__) || defined(_MSC_VER))
53#ifdef GECODE_BUILD_DRIVER
54#define GECODE_DRIVER_EXPORT __declspec( dllexport )
56#define GECODE_DRIVER_EXPORT __declspec( dllimport )
61#ifdef GECODE_GCC_HAS_CLASS_VISIBILITY
62#define GECODE_DRIVER_EXPORT __attribute__ ((visibility("default")))
64#define GECODE_DRIVER_EXPORT
70#ifndef GECODE_BUILD_DRIVER
71#define GECODE_LIBRARY_NAME "Driver"
131 char*
argument(
int argc,
char* argv[])
const;
136 virtual int parse(
int argc,
char* argv[]) = 0;
142 static char*
strdup(
const char* s);
144 static char*
stredup(
const char* s);
146 static void strdel(
const char* s);
160 void value(
const char* v);
162 const char*
value(
void)
const;
164 virtual int parse(
int argc,
char* argv[]);
166 virtual void help(
void);
181 virtual int parse(
int argc,
char* argv[]);
208 int value(
void)
const;
210 void add(
int v,
const char* o,
const char* h =
nullptr);
212 virtual int parse(
int argc,
char* argv[]);
214 virtual void help(
void);
229 IntOption(
const char* o,
const char* e,
int v=0);
233 int value(
void)
const;
235 virtual int parse(
int argc,
char* argv[]);
237 virtual void help(
void);
251 void value(
unsigned int v);
253 unsigned int value(
void)
const;
255 virtual int parse(
int argc,
char* argv[]);
257 virtual void help(
void);
266 unsigned long long int cur;
270 unsigned long long int v=0);
272 void value(
unsigned long long int v);
274 unsigned long long int value(
void)
const;
276 virtual int parse(
int argc,
char* argv[]);
278 virtual void help(
void);
292 void value(
double v);
294 double value(
void)
const;
296 virtual int parse(
int argc,
char* argv[]);
298 virtual void help(
void);
310 BoolOption(
const char* o,
const char* e,
bool v=
false);
314 bool value(
void)
const;
316 virtual int parse(
int argc,
char* argv[]);
318 virtual void help(
void);
336 virtual int parse(
int argc,
char* argv[]);
338 virtual void help(
void);
354 int value(
void)
const;
356 virtual int parse(
int argc,
char* argv[]);
358 virtual void help(
void);
371 ProfilerOption(
const char* o,
const char* e,
unsigned int p = 0,
int v = -1);
373 void port(
unsigned int p);
375 unsigned int port(
void)
const;
381 virtual int parse(
int argc,
char* argv[]);
383 virtual void help(
void);
400 virtual void help(
void);
414 void parse(
int& argc,
char* argv[]);
427 void parse(
int& argc,
char* argv[],
bool strict);
435 const char*
name(
void)
const;
437 void name(
const char*);
486#ifdef GECODE_HAS_EXPERIMENTAL
502#ifdef GECODE_HAS_CPPROFILER
517 void model(
int v,
const char* o,
const char* h =
nullptr);
519 int model(
void)
const;
524 void symmetry(
int v,
const char* o,
const char* h =
nullptr);
531 void propagation(
int v,
const char* o,
const char* h =
nullptr);
543 void branching(
int v,
const char* o,
const char* h =
nullptr);
548 void decay(
double d);
550 double decay(
void)
const;
553 void seed(
unsigned int s);
555 unsigned int seed(
void)
const;
560 double step(
void)
const;
568 void search(
int v,
const char* o,
const char* h =
nullptr);
573 void solutions(
unsigned long long int n);
575 unsigned long long int solutions(
void)
const;
583 void c_d(
unsigned int d);
585 unsigned int c_d(
void)
const;
588 void a_d(
unsigned int d);
590 unsigned int a_d(
void)
const;
593 void d_l(
unsigned int d);
595 unsigned int d_l(
void)
const;
598 void node(
unsigned long long int n);
600 unsigned long long int node(
void)
const;
603 void fail(
unsigned long long int n);
605 unsigned long long int fail(
void)
const;
610 double time(
void)
const;
613 void assets(
unsigned int n);
615 unsigned int assets(
void)
const;
618 void slice(
unsigned int n);
620 unsigned int slice(
void)
const;
653 void relax(
double d);
655 double relax(
void)
const;
673 unsigned int samples(
void)
const;
698 int trace(
void)
const;
700#ifdef GECODE_HAS_CPPROFILER
712#ifdef GECODE_HAS_EXPERIMENTAL
722#ifdef GECODE_HAS_GIST
729 unsigned int n_click;
733 unsigned int n_solution;
741 unsigned int n_compare;
781 virtual void help(
void);
783 void parse(
int& argc,
char* argv[]);
792 void parse(
int& argc,
char* argv[],
bool strict);
799 void size(
unsigned int s);
801 unsigned int size(
void)
const;
842 mutable std::unique_ptr<Instance::Data>
_data;
857 virtual void help(
void);
859 void parse(
int& argc,
char* argv[]);
869 void parse(
int& argc,
char* argv[],
bool strict);
888 bool builtin(
unsigned int& i)
const;
891 void spec(
const char* s);
893 const char*
spec(
void)
const;
899 void param(
const char* p);
901 const char*
param(
void)
const;
920namespace Gecode {
namespace Driver {
929 template<
class BaseSpace>
937 virtual void print(std::ostream& os)
const;
951 template<
class Script,
template<
class>
class Engine,
class Options>
954 template<
class Script,
template<
class>
class Engine,
class Options,
955 template<
class,
template<
class>
class>
class Meta>
959#ifdef GECODE_HAS_FLOAT_VARS
962 template<
class BaseSpace>
967 : BaseSpace(opt.step()) {}
976 template<
class BaseSpace>
1030#ifdef GECODE_HAS_FLOAT_VARS
Base class for script options.
BaseOptions(const char *s)
Initialize options for script with name s.
void add(Driver::BaseOption &o)
Add new option o.
void parse_strict(int &argc, char *argv[])
Parse options with strict checking (equivalent to parse() with true).
const char * _name
Script name.
Driver::BaseOption * fst
First registered option.
Driver::BaseOption * lst
Last registered option.
const char * name(void) const
Return name of script.
void parse_permissive(int &argc, char *argv[])
Parse options partially (equivalent to parse() with false).
virtual void help(void)
Print help text.
void parse(int &argc, char *argv[])
Parse options from arguments argv (number is argc).
static void strdel(const char *s)
Delete heap-allocated copy of string s.
virtual void help(void)=0
Print help text.
static char * stredup(const char *s)
Create heap-allocated copy of string s with hyphen added.
const char * eopt
String for option (excluding hyphen).
char * argument(int argc, char *argv[]) const
static char * strdup(const char *s)
Create heap-allocated copy of string s.
const char * exp
Short explanation.
const char * iopt
String for option (including hyphen).
BaseOption(const char *o, const char *e)
Initialize for option o and explanation e.
virtual int parse(int argc, char *argv[])=0
Parse option at first position and return number of parsed arguments.
BaseOption * next
Next option Check for option and return its argument.
virtual int parse(int argc, char *argv[])
Parse option at first position and return number of parsed arguments.
BoolOption(const char *o, const char *e, bool v=false)
Initialize for option o and explanation e and default value v.
void value(bool v)
Set default value to v.
virtual void help(void)
Print help text.
virtual int parse(int argc, char *argv[])
Parse option at first position and return number of parsed arguments.
virtual void help(void)
Print help text.
DoubleOption(const char *o, const char *e, double v=0)
Initialize for option o and explanation e and default value v.
void value(double v)
Set default value to v.
IgnoreStepOption(BaseSpace &e)
Constructor used for cloning.
IgnoreStepOption(const Options &)
Constructor.
virtual void help(void)
Print help text.
void value(int v)
Set default value to v.
virtual int parse(int argc, char *argv[])
Parse option at first position and return number of parsed arguments.
IntOption(const char *o, const char *e, int v=0)
Initialize for option o and explanation e and default value v.
Integer propagation level option.
IntPropLevel cur
Current value.
virtual int parse(int argc, char *argv[])
Parse option at first position and return number of parsed arguments.
IplOption(IntPropLevel ipl=IPL_DEF)
Initialize with default value ipl.
virtual void help(void)
Print help text.
void value(IntPropLevel l)
Set default level to l.
void port(unsigned int p)
Set default port to p.
ProfilerOption(const char *o, const char *e, unsigned int p=0, int v=-1)
Initialize for option o and explanation e and default value v.
void execution_id(int i)
Set default execution ID to i.
int cur_execution_id
Current execution ID.
unsigned int cur_port
Current port.
virtual int parse(int argc, char *argv[])
Parse option at first position and return number of parsed arguments.
virtual void help(void)
Print help text.
Parametric base-class for scripts.
static void run(const Options &opt, Script *s=nullptr)
ScriptBase(ScriptBase &e)
Constructor used for cloning.
virtual void compare(const Space &home, std::ostream &os) const
Compare with s.
virtual void print(std::ostream &os) const
Print a solution to os.
static std::ostream & select_ostream(const char *sn, std::ofstream &ofs)
Choose output stream according to sn.
ScriptBase(const Options &opt)
Constructor.
String-valued option that may be given several times.
StringListOption(const char *o, const char *e)
Initialize for option o and explanation e.
virtual int parse(int argc, char *argv[])
Parse option at first position and return number of parsed arguments.
const char * help
Optional help text.
Value * next
Next option value.
int val
Value for an option value.
const char * opt
String for option value.
String-valued option (integer value defined by strings).
virtual int parse(int argc, char *argv[])
Parse option at first position and return number of parsed arguments.
void add(int v, const char *o, const char *h=nullptr)
Add option value for value v, string o, and help text h.
StringOption(const char *o, const char *e, int v=0)
Initialize for option o and explanation e and default value v.
virtual void help(void)
Print help text.
void value(int v)
Set default value to v.
Value * lst
Last option value.
Value * fst
First option value.
virtual void help(void)
Print help text.
void value(const char *v)
Set default value to v.
StringValueOption(const char *o, const char *e, const char *v=nullptr)
Initialize for option o and explanation e and default value v.
const char * cur
Current value.
virtual int parse(int argc, char *argv[])
Parse option at first position and return number of parsed arguments.
virtual void help(void)
Print help text.
TraceOption(int f=0)
Initialize with no tracing.
virtual int parse(int argc, char *argv[])
Parse option at first position and return number of parsed arguments.
void value(int f)
Set default trace flags to f.
void value(unsigned int v)
Set default value to v.
UnsignedIntOption(const char *o, const char *e, unsigned int v=0)
Initialize for option o and explanation e and default value v.
virtual int parse(int argc, char *argv[])
Parse option at first position and return number of parsed arguments.
unsigned int cur
Current value.
virtual void help(void)
Print help text.
Unsigned long long integer option.
virtual int parse(int argc, char *argv[])
Parse option at first position and return number of parsed arguments.
void value(unsigned long long int v)
Set default value to v.
unsigned long long int cur
Current value.
UnsignedLongLongIntOption(const char *o, const char *e, unsigned long long int v=0)
Initialize for option o and explanation e and default value v.
virtual void help(void)
Print help text.
Abstract base class for comparators.
Abstract base class for inspectors.
bool builtin(unsigned int &i) const
Test whether the instance is the number of a built-in instance.
const char * _inst
Instance string.
bool is_file(void) const
Test whether the instance names a readable file.
void parse(int &argc, char *argv[])
Parse options from arguments argv (number is argc).
void instance(const char *s)
Set default instance name.
virtual void help(void)
Print help text.
Driver::StringListOption _param
Parameters for the spec.
const char * _spec
Reader spec for instance files.
Instance::Data data(void) const
Read the instance file.
void param(const char *p)
Set the spec parameters (name=value, separated by commas).
void spec_file(const char *f)
Set the file with a reader spec that replaces spec().
std::unique_ptr< Instance::Data > _data
Data read, or null Forget the data read.
InstanceOptions(const char *s)
Initialize options for script with name s.
void spec(const char *s)
Set the reader spec for instance files.
void parse_strict(int &argc, char *argv[])
Parse options with strict checking (equivalent to parse() with true).
Driver::StringValueOption _spec_file
File with a reader spec.
void parse_permissive(int &argc, char *argv[])
Parse options partially (equivalent to parse() with false).
Named values read from an instance.
void compare(Gist::Comparator *i)
Add comparator.
void click(Gist::Inspector *i)
Add inspector that reacts on node double clicks.
void move(Gist::Inspector *i)
Add inspector that reacts on each move of the cursor.
void solution(Gist::Inspector *i)
Add inspector that reacts on each new solution that is found.
Driver::DoubleOption _relax
Probability to relax variable.
void trace(int f)
Set trace flags.
Driver::StringValueOption _log_file
Where to print statistics.
void c_d(unsigned int d)
Set default copy recomputation distance.
Driver::StringOption _model
General model options.
void log_file(const char *f)
Set default output file name for Gecode stats.
void print_last(bool p)
Set whether to print only last solution found.
Driver::StringOption _mode
Script mode to run.
void propagation(int v)
Set default propagation value.
void iterations(unsigned int i)
Set default number of iterations.
Driver::DoubleOption _decay
Decay option.
Driver::UnsignedIntOption _nogoods_limit
Limit for no-good extraction.
void a_d(unsigned int d)
Set default adaptive recomputation distance.
void profiler_id(int i)
Set profiler execution identifier.
void seed(unsigned int s)
Set default seed value.
Driver::BoolOption _nogoods
Whether to use no-goods.
void branching(int v)
Set default branching value.
Driver::UnsignedIntOption _slice
Size of a portfolio slice.
Driver::UnsignedLongLongIntOption _r_limit
Cutoff for number of restarts.
Driver::TraceOption _trace
Trace flags for tracing.
Driver::UnsignedLongLongIntOption _fail
Cutoff for number of failures.
Driver::UnsignedIntOption _d_l
Discrepancy limit for LDS.
void slice(unsigned int n)
Set default slice size in a portfolio.
Driver::UnsignedIntOption _assets
Number of assets in a portfolio.
void search(int v)
Set default search value.
Driver::UnsignedLongLongIntOption _node
Cutoff for number of nodes.
void nogoods(bool b)
Set default nogoods posting behavior.
void symmetry(int v)
Set default symmetry value.
void profiler_port(unsigned int p)
Set profiler port.
Driver::UnsignedIntOption _iterations
How many iterations per sample.
Driver::StringOption _search
Search options.
Driver::StringOption _propagation
Propagation options.
Driver::IplOption _ipl
Integer propagation level.
void restart(RestartMode r)
Set default restart mode.
Driver::UnsignedLongLongIntOption _solutions
How many solutions.
Options(const char *s)
Initialize options for script with name s.
Driver::BoolOption _print_last
Print only last solution found.
Driver::UnsignedIntOption _c_d
Copy recomputation distance.
void nogoods_limit(unsigned int l)
Set default nogoods depth limit.
void step(double s)
Set default step value.
const Search::HeuristicGuidance * _guidance
Guidance for heuristic search.
Driver::ProfilerOption _profiler
Options for the CP Profiler.
void relax(double d)
Set default relax probability.
void ipl(IntPropLevel i)
Set default integer propagation level.
Driver::DoubleOption _threads
How many threads to use.
Driver::StringOption _branching
Branching options.
Driver::StringOption _restart
Restart method option.
void assets(unsigned int n)
Set default number of assets in a portfolio.
Driver::UnsignedIntOption _seed
Seed option.
Driver::DoubleOption _step
Step option.
void time(double t)
Set default time cutoff.
Driver::UnsignedIntOption _r_scale
Restart scale factor.
void solutions(unsigned long long int n)
Set default number of solutions to search for.
Driver::DoubleOption _time
Cutoff for time.
void restart_scale(unsigned int scale)
Set default restart scale factor.
void interrupt(bool b)
Set default interrupt behavior.
void restart_base(double base)
Set default restart base.
Driver::BoolOption _interrupt
Whether to catch SIGINT.
void d_l(unsigned int d)
Set default discrepancy limit for LDS.
void model(int v)
Set default model value.
void decay(double d)
Set default decay factor.
Driver::UnsignedIntOption _a_d
Adaptive recomputation distance.
void samples(unsigned int s)
Set default number of samples.
void out_file(const char *f)
Set default output file name for solutions.
Driver::DoubleOption _r_base
Restart base.
Driver::StringOption _symmetry
General symmetry options.
void guidance(const Search::HeuristicGuidance *g)
Set guidance for heuristic search (not copied).
Driver::StringValueOption _out_file
Where to print solutions.
Driver::UnsignedIntOption _samples
How many samples.
void node(unsigned long long int n)
Set default node cutoff.
void mode(ScriptMode em)
Set default mode.
void fail(unsigned long long int n)
Set default failure cutoff.
void threads(double n)
Set number of parallel threads.
void restart_limit(unsigned long long int n)
Set default restart cutoff.
Guidance for heuristic search engines (experimental).
virtual void help(void)
Print help text.
void parse_strict(int &argc, char *argv[])
Parse options with strict checking (equivalent to parse() with true).
void parse_permissive(int &argc, char *argv[])
Parse options partially (equivalent to parse() with false).
SizeOptions(const char *s)
Initialize options for script with name s.
unsigned int _size
Size value.
void size(unsigned int s)
Set default size.
void parse(int &argc, char *argv[])
Parse options from arguments argv (number is argc).
Array with arbitrary number of elements.
#define GECODE_DRIVER_EXPORT
ScriptMode
Different modes for executing scripts.
RestartMode
Different modes for restart-based search.
@ SM_STAT
Print statistics for script.
@ SM_SOLUTION
Print solution and some statistics.
@ SM_GIST
Run script in Gist.
@ SM_TIME
Measure average runtime.
@ RM_CONSTANT
Restart with constant sequence.
@ RM_LINEAR
Restart with linear sequence.
@ RM_LUBY
Restart with Luby sequence.
@ RM_GEOMETRIC
Restart with geometric sequence.
Driver::ScriptBase< Driver::IgnoreStepOption< IntMaximizeSpace > > IntMaximizeScript
Base-class for scripts for finding solution of highest integer cost.
Driver::ScriptBase< Driver::IgnoreStepOption< Space > > Script
Base-class for scripts.
Driver::ScriptBase< Driver::ExtractStepOption< FloatMinimizeSpace > > FloatMinimizeScript
Base-class for scripts for finding solution of lowest float cost.
Driver::ScriptBase< Driver::ExtractStepOption< FloatMaximizeSpace > > FloatMaximizeScript
Base-class for scripts for finding solution of highest float cost.
Driver::ScriptBase< Driver::IgnoreStepOption< IntLexMaximizeSpace > > IntLexMaximizeScript
Base-class for scripts for finding solution of lexically highest integer costs.
Driver::ScriptBase< Driver::IgnoreStepOption< IntLexMinimizeSpace > > IntLexMinimizeScript
Base-class for scripts for finding solution of lexically lowest integer costs.
Driver::ScriptBase< Driver::IgnoreStepOption< IntMinimizeSpace > > IntMinimizeScript
Base-class for scripts for finding solution of lowest integer cost.
IntPropLevel
Propagation levels for integer propagators.
@ IPL_DEF
Simple propagation levels.
Gecode toplevel namespace