C++ Reference

C++ Reference: Routing

Solver::SearchLogParameters

Detailed Description

Creates a search monitor from logging parameters.

Definition at line 2297 of file constraint_solver.h.

Public Attributes

int branch_period = 1
 SearchMonitors will display a periodic search log every branch_period branches explored. More...
 
OptimizeVarobjective = nullptr
 SearchMonitors will display values of objective or variable (both cannot be used together). More...
 
IntVarvariable = nullptr
 
double scaling_factor = 1.0
 When displayed, objective or var values will be scaled and offset by the given values in the following way: scaling_factor * (value + offset). More...
 
double offset = 0
 
std::function< std::string()> display_callback
 SearchMonitors will display the result of display_callback at each new solution found and when the search finishes if display_on_new_solutions_only is false. More...
 
bool display_on_new_solutions_only = true
 To be used to protect from cases where display_callback assumes variables are instantiated, which only happens in AtSolution(). More...
 

Member Data Documentation

◆ branch_period

int branch_period = 1

SearchMonitors will display a periodic search log every branch_period branches explored.

Definition at line 2300 of file constraint_solver.h.

◆ display_callback

std::function<std::string()> display_callback

SearchMonitors will display the result of display_callback at each new solution found and when the search finishes if display_on_new_solutions_only is false.

Definition at line 2313 of file constraint_solver.h.

◆ display_on_new_solutions_only

bool display_on_new_solutions_only = true

To be used to protect from cases where display_callback assumes variables are instantiated, which only happens in AtSolution().

Definition at line 2316 of file constraint_solver.h.

◆ objective

OptimizeVar* objective = nullptr

SearchMonitors will display values of objective or variable (both cannot be used together).

Definition at line 2303 of file constraint_solver.h.

◆ offset

double offset = 0

Definition at line 2309 of file constraint_solver.h.

◆ scaling_factor

double scaling_factor = 1.0

When displayed, objective or var values will be scaled and offset by the given values in the following way: scaling_factor * (value + offset).

Definition at line 2308 of file constraint_solver.h.

◆ variable

IntVar* variable = nullptr

Definition at line 2304 of file constraint_solver.h.


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