Generated on for Gecode by doxygen 1.17.0
CommonPatternOptions Class Reference

Sequence database and restrictions on the patterns to mine. More...

Public Member Functions

 CommonPatternOptions (void)
void read (void)
 Validate external input before constructing a space.
const PatternMining::Database & database (void) const
const std::vector< int > & required (void) const
int support (void) const
int min_length (void) const
PatternMining::Format format (void) const
bool letters (void) const
PatternMining::Language language (void) const
void model (int v)
 Set default model value.
void model (int v, const char *o, const char *h=nullptr)
 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=nullptr)
 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=nullptr)
 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=nullptr)
 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.
void search (int v)
 Set default search value.
void search (int v, const char *o, const char *h=nullptr)
 Add search option value for value v, string o, and help h.
int search (void) const
 Return search value.
void solutions (unsigned long long int n)
 Set default number of solutions to search for.
unsigned long long 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 long long int n)
 Set default node cutoff.
unsigned long long int node (void) const
 Return node cutoff.
void fail (unsigned long long int n)
 Set default failure cutoff.
unsigned long long int fail (void) const
 Return failure cutoff.
void time (double t)
 Set default time cutoff.
double 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 restart_limit (unsigned long long int n)
 Set default restart cutoff.
unsigned long long int restart_limit (void) const
 Return restart cutoff.
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.
 Options (const char *s)
 Initialize options for script with name s.
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 guidance (const Search::HeuristicGuidance *g)
 Set guidance for heuristic search (not copied).
const Search::HeuristicGuidance * guidance (void) const
 Return guidance for heuristic search.
Public Member Functions inherited from Gecode::BaseOptions
 BaseOptions (const char *s)
 Initialize options for script with name s.
virtual void help (void)
 Print help text.
void add (Driver::BaseOption &o)
 Add new option o.
void parse (int &argc, char *argv[])
 Parse options from arguments argv (number is argc).
void parse (int &argc, char *argv[], bool strict)
 Parse options, optionally rejecting unrecognised arguments.
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).
const char * name (void) const
 Return name of script.
void name (const char *)
 Set name of script.
virtual ~BaseOptions (void)
 Destructor.

Protected Attributes

Driver::StringValueOption _sequences
Driver::StringValueOption _file
Driver::StringValueOption _support
Driver::StringValueOption _required
Driver::StringOption _format
Driver::StringOption _language
Driver::UnsignedIntOption _min_length
Driver::BoolOption _motif
std::unique_ptr< PatternMining::Database > input
std::vector< int > required_items
int threshold
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.
Driver::StringOption _search
 Search options.
Driver::UnsignedLongLongIntOption _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::UnsignedLongLongIntOption _node
 Cutoff for number of nodes.
Driver::UnsignedLongLongIntOption _fail
 Cutoff for number of failures.
Driver::DoubleOption _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::UnsignedLongLongIntOption _r_limit
 Cutoff for number of restarts.
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.
const Search::HeuristicGuidance * _guidance
 Guidance for heuristic search.
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::ProfilerOption _profiler
 Options for the CP Profiler.
Protected Attributes inherited from Gecode::BaseOptions
Driver::BaseOption * fst
 First registered option.
Driver::BaseOption * lst
 Last registered option.
const char * _name
 Script name.

Additional Inherited Members

class Gecode::Options::I_ inspect
 Set guidance for heuristic search (not copied).

Detailed Description

Sequence database and restrictions on the patterns to mine.

Definition at line 44 of file common-pattern.cpp.

Constructor & Destructor Documentation

◆ CommonPatternOptions()

CommonPatternOptions::CommonPatternOptions ( void )
inline

Definition at line 58 of file common-pattern.cpp.

Member Function Documentation

◆ read()

void CommonPatternOptions::read ( void )
inline

Validate external input before constructing a space.

Definition at line 92 of file common-pattern.cpp.

◆ database()

const PatternMining::Database & CommonPatternOptions::database ( void ) const
inline

Definition at line 131 of file common-pattern.cpp.

◆ required()

const std::vector< int > & CommonPatternOptions::required ( void ) const
inline

Definition at line 132 of file common-pattern.cpp.

◆ support()

int CommonPatternOptions::support ( void ) const
inline

Definition at line 133 of file common-pattern.cpp.

◆ min_length()

int CommonPatternOptions::min_length ( void ) const
inline

Definition at line 134 of file common-pattern.cpp.

◆ format()

PatternMining::Format CommonPatternOptions::format ( void ) const
inline

Definition at line 135 of file common-pattern.cpp.

◆ letters()

bool CommonPatternOptions::letters ( void ) const
inline

Definition at line 138 of file common-pattern.cpp.

◆ language()

PatternMining::Language CommonPatternOptions::language ( void ) const
inline

Definition at line 139 of file common-pattern.cpp.

Member Data Documentation

◆ _sequences

Driver::StringValueOption CommonPatternOptions::_sequences
protected

Definition at line 46 of file common-pattern.cpp.

◆ _file

Driver::StringValueOption CommonPatternOptions::_file
protected

Definition at line 47 of file common-pattern.cpp.

◆ _support

Driver::StringValueOption CommonPatternOptions::_support
protected

Definition at line 48 of file common-pattern.cpp.

◆ _required

Driver::StringValueOption CommonPatternOptions::_required
protected

Definition at line 49 of file common-pattern.cpp.

◆ _format

Driver::StringOption CommonPatternOptions::_format
protected

Definition at line 50 of file common-pattern.cpp.

◆ _language

Driver::StringOption CommonPatternOptions::_language
protected

Definition at line 51 of file common-pattern.cpp.

◆ _min_length

Driver::UnsignedIntOption CommonPatternOptions::_min_length
protected

Definition at line 52 of file common-pattern.cpp.

◆ _motif

Driver::BoolOption CommonPatternOptions::_motif
protected

Definition at line 53 of file common-pattern.cpp.

◆ input

std::unique_ptr<PatternMining::Database> CommonPatternOptions::input
protected

Definition at line 54 of file common-pattern.cpp.

◆ required_items

std::vector<int> CommonPatternOptions::required_items
protected

Definition at line 55 of file common-pattern.cpp.

◆ threshold

int CommonPatternOptions::threshold
protected

Definition at line 56 of file common-pattern.cpp.


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