C++ Reference
C++ Reference: Routing
Detailed Description
Definition at line 1915 of file constraint_solveri.h.
Public Member Functions | |
LocalSearchMonitor (Solver *const solver) | |
~LocalSearchMonitor () override | |
std::string | DebugString () const override |
virtual void | BeginOperatorStart ()=0 |
Local search operator events. More... | |
virtual void | EndOperatorStart ()=0 |
virtual void | BeginMakeNextNeighbor (const LocalSearchOperator *op)=0 |
virtual void | EndMakeNextNeighbor (const LocalSearchOperator *op, bool neighbor_found, const Assignment *delta, const Assignment *deltadelta)=0 |
virtual void | BeginFilterNeighbor (const LocalSearchOperator *op)=0 |
virtual void | EndFilterNeighbor (const LocalSearchOperator *op, bool neighbor_found)=0 |
virtual void | BeginAcceptNeighbor (const LocalSearchOperator *op)=0 |
virtual void | EndAcceptNeighbor (const LocalSearchOperator *op, bool neighbor_found)=0 |
virtual void | BeginFiltering (const LocalSearchFilter *filter)=0 |
virtual void | EndFiltering (const LocalSearchFilter *filter, bool reject)=0 |
void | Install () override |
Install itself on the solver. More... | |
virtual void | EnterSearch () |
Beginning of the search. More... | |
virtual void | RestartSearch () |
Restart the search. More... | |
virtual void | ExitSearch () |
End of the search. More... | |
virtual void | BeginNextDecision (DecisionBuilder *const b) |
Before calling DecisionBuilder::Next. More... | |
virtual void | EndNextDecision (DecisionBuilder *const b, Decision *const d) |
After calling DecisionBuilder::Next, along with the returned decision. More... | |
virtual void | ApplyDecision (Decision *const d) |
Before applying the decision. More... | |
virtual void | RefuteDecision (Decision *const d) |
Before refuting the decision. More... | |
virtual void | AfterDecision (Decision *const d, bool apply) |
Just after refuting or applying the decision, apply is true after Apply. More... | |
virtual void | BeginFail () |
Just when the failure occurs. More... | |
virtual void | EndFail () |
After completing the backtrack. More... | |
virtual void | BeginInitialPropagation () |
Before the initial propagation. More... | |
virtual void | EndInitialPropagation () |
After the initial propagation. More... | |
virtual bool | AcceptSolution () |
This method is called when a solution is found. More... | |
virtual bool | AtSolution () |
This method is called when a valid solution is found. More... | |
virtual void | NoMoreSolutions () |
When the search tree is finished. More... | |
virtual bool | LocalOptimum () |
When a local optimum is reached. More... | |
virtual bool | AcceptDelta (Assignment *delta, Assignment *deltadelta) |
virtual void | AcceptNeighbor () |
After accepting a neighbor during local search. More... | |
virtual void | AcceptUncheckedNeighbor () |
After accepting an unchecked neighbor during local search. More... | |
virtual bool | IsUncheckedSolutionLimitReached () |
Returns true if the limit of solutions has been reached including unchecked solutions. More... | |
Solver * | solver () const |
virtual void | PeriodicCheck () |
Periodic call to check limits in long running methods. More... | |
virtual int | ProgressPercent () |
Returns a percentage representing the propress of the search before reaching limits. More... | |
virtual void | Accept (ModelVisitor *const visitor) const |
Accepts the given model visitor. More... | |
Static Public Attributes | |
static constexpr int | kNoProgress = -1 |
Constructor & Destructor Documentation
◆ LocalSearchMonitor()
|
explicit |
◆ ~LocalSearchMonitor()
|
override |
Member Function Documentation
◆ Accept()
|
virtualinherited |
Accepts the given model visitor.
Reimplemented in RegularLimit, and OptimizeVar.
◆ AcceptDelta()
|
virtualinherited |
Reimplemented in OptimizeVar.
◆ AcceptNeighbor()
|
virtualinherited |
After accepting a neighbor during local search.
◆ AcceptSolution()
|
virtualinherited |
This method is called when a solution is found.
It asserts whether the solution is valid. A value of false indicates that the solution should be discarded.
Reimplemented in OptimizeVar.
◆ AcceptUncheckedNeighbor()
|
virtualinherited |
After accepting an unchecked neighbor during local search.
Reimplemented in SearchLog.
◆ AfterDecision()
|
virtualinherited |
Just after refuting or applying the decision, apply is true after Apply.
This is called only if the Apply() or Refute() methods have not failed.
◆ ApplyDecision()
|
virtualinherited |
Before applying the decision.
Reimplemented in SearchLog.
◆ AtSolution()
|
virtualinherited |
This method is called when a valid solution is found.
If the return value is true, then search will resume after. If the result is false, then search will stop there.
Reimplemented in SearchLog, ImprovementSearchLimit, and OptimizeVar.
◆ BeginAcceptNeighbor()
|
pure virtual |
◆ BeginFail()
|
virtualinherited |
Just when the failure occurs.
Reimplemented in SearchLog.
◆ BeginFiltering()
|
pure virtual |
◆ BeginFilterNeighbor()
|
pure virtual |
◆ BeginInitialPropagation()
|
virtualinherited |
Before the initial propagation.
Reimplemented in SearchLog.
◆ BeginMakeNextNeighbor()
|
pure virtual |
◆ BeginNextDecision()
|
virtualinherited |
Before calling DecisionBuilder::Next.
Reimplemented in OptimizeVar, and SearchLimit.
◆ BeginOperatorStart()
|
pure virtual |
Local search operator events.
◆ DebugString()
|
inlineoverridevirtual |
Reimplemented from BaseObject.
Definition at line 1920 of file constraint_solveri.h.
◆ EndAcceptNeighbor()
|
pure virtual |
◆ EndFail()
|
virtualinherited |
After completing the backtrack.
◆ EndFiltering()
|
pure virtual |
◆ EndFilterNeighbor()
|
pure virtual |
◆ EndInitialPropagation()
|
virtualinherited |
After the initial propagation.
Reimplemented in SearchLog.
◆ EndMakeNextNeighbor()
|
pure virtual |
◆ EndNextDecision()
|
virtualinherited |
After calling DecisionBuilder::Next, along with the returned decision.
◆ EndOperatorStart()
|
pure virtual |
◆ EnterSearch()
|
virtualinherited |
Beginning of the search.
Reimplemented in SearchLog, SearchLimit, OptimizeVar, and SolutionCollector.
◆ ExitSearch()
|
virtualinherited |
End of the search.
Reimplemented in SearchLog, and RegularLimit.
◆ Install()
|
overridevirtual |
Install itself on the solver.
Reimplemented from SearchMonitor.
◆ IsUncheckedSolutionLimitReached()
|
inlinevirtualinherited |
Returns true if the limit of solutions has been reached including unchecked solutions.
Reimplemented in RegularLimit.
Definition at line 3706 of file constraint_solver.h.
◆ LocalOptimum()
|
virtualinherited |
When a local optimum is reached.
If 'true' is returned, the last solution is discarded and the search proceeds with the next one.
◆ NoMoreSolutions()
|
virtualinherited |
When the search tree is finished.
Reimplemented in SearchLog.
◆ PeriodicCheck()
|
virtualinherited |
Periodic call to check limits in long running methods.
Reimplemented in SearchLimit.
◆ ProgressPercent()
|
inlinevirtualinherited |
Returns a percentage representing the propress of the search before reaching limits.
Reimplemented in RegularLimit.
Definition at line 3715 of file constraint_solver.h.
◆ RefuteDecision()
|
virtualinherited |
Before refuting the decision.
Reimplemented in SearchLog, SearchLimit, and OptimizeVar.
◆ RestartSearch()
|
virtualinherited |
Restart the search.
◆ solver()
|
inlineinherited |
Definition at line 3708 of file constraint_solver.h.
Member Data Documentation
◆ kNoProgress
|
staticconstexprinherited |
Definition at line 3637 of file constraint_solver.h.
The documentation for this class was generated from the following file: