GHOST
Public Member Functions | Public Attributes | List of all members
ghost::Options Struct Reference

#include <options.hpp>

Collaboration diagram for ghost::Options:
Collaboration graph

Public Member Functions

 Options ()
 Unique constructor. More...
 
 ~Options ()=default
 Default destructor. More...
 
 Options (const Options &other)
 Unique copy constructor. More...
 
 Options (Options &&other)
 Unique move constructor. More...
 
Optionsoperator= (Options other)
 

Public Attributes

bool custom_starting_point
 To force starting the search on a custom variables assignment. More...
 
bool resume_search
 Allowing stop-and-resume computation. More...
 
bool parallel_runs
 To enable parallel runs of the solver. Using all available physical cores if number_threads is not specified. More...
 
int number_threads
 Number of threads the solver will use for the search. More...
 
std::shared_ptr< Printprint
 Allowing custom solution print (by derivating a class from ghost::Print) More...
 
int tabu_time_local_min
 Number of local moves a variable of a local minimum is marked tabu. More...
 
int tabu_time_selected
 Number of local moves a selected variable is marked tabu. More...
 
int percent_chance_escape_plateau
 Percentage of chance to espace a (1-dimension, ie, related to 1 variable) plateau rather than exploring it. More...
 
int reset_threshold
 Number of variables marked as tabu required to trigger a reset. More...
 
int restart_threshold
 Trigger a restart every 'restart_threshold' reset. Set to 0 to never trigger restarts. More...
 
int number_variables_to_reset
 Number of variables to randomly change the value at each reset. More...
 
int number_start_samplings
 Number of variable assignments the solver randomly draw, if custom_starting_point and resume_search are false. More...
 

Detailed Description

Options is a structure containing all optional arguments for Solver::solve.

See also
Print

Constructor & Destructor Documentation

◆ Options() [1/3]

ghost::Options::Options ( )

Unique constructor.

◆ ~Options()

ghost::Options::~Options ( )
default

Default destructor.

◆ Options() [2/3]

ghost::Options::Options ( const Options other)

Unique copy constructor.

◆ Options() [3/3]

ghost::Options::Options ( Options &&  other)

Unique move constructor.

Member Function Documentation

◆ operator=()

Options& ghost::Options::operator= ( Options  other)

Unique copy assign operator

No move assign operator on purpose (yes, we violate the rule of 5 here).

Member Data Documentation

◆ custom_starting_point

bool ghost::Options::custom_starting_point

To force starting the search on a custom variables assignment.

◆ number_start_samplings

int ghost::Options::number_start_samplings

Number of variable assignments the solver randomly draw, if custom_starting_point and resume_search are false.

◆ number_threads

int ghost::Options::number_threads

Number of threads the solver will use for the search.

◆ number_variables_to_reset

int ghost::Options::number_variables_to_reset

Number of variables to randomly change the value at each reset.

◆ parallel_runs

bool ghost::Options::parallel_runs

To enable parallel runs of the solver. Using all available physical cores if number_threads is not specified.

◆ percent_chance_escape_plateau

int ghost::Options::percent_chance_escape_plateau

Percentage of chance to espace a (1-dimension, ie, related to 1 variable) plateau rather than exploring it.

◆ print

std::shared_ptr<Print> ghost::Options::print

Allowing custom solution print (by derivating a class from ghost::Print)

◆ reset_threshold

int ghost::Options::reset_threshold

Number of variables marked as tabu required to trigger a reset.

◆ restart_threshold

int ghost::Options::restart_threshold

Trigger a restart every 'restart_threshold' reset. Set to 0 to never trigger restarts.

◆ resume_search

bool ghost::Options::resume_search

Allowing stop-and-resume computation.

◆ tabu_time_local_min

int ghost::Options::tabu_time_local_min

Number of local moves a variable of a local minimum is marked tabu.

◆ tabu_time_selected

int ghost::Options::tabu_time_selected

Number of local moves a selected variable is marked tabu.


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