OR-Tools  8.2
SearchLog

Detailed Description

The base class of all search logs that periodically outputs information when the search is running.

Definition at line 2023 of file constraint_solveri.h.

Public Member Functions

 SearchLog (Solver *const s, OptimizeVar *const obj, IntVar *const var, double scaling_factor, double offset, std::function< std::string()> display_callback, bool display_on_new_solutions_only, int period)
 
 ~SearchLog () override
 
void EnterSearch () override
 Beginning of the search. More...
 
void ExitSearch () override
 End of the search. More...
 
bool AtSolution () override
 This method is called when a valid solution is found. More...
 
void BeginFail () override
 Just when the failure occurs. More...
 
void NoMoreSolutions () override
 When the search tree is finished. More...
 
void AcceptUncheckedNeighbor () override
 After accepting an unchecked neighbor during local search. More...
 
void ApplyDecision (Decision *const decision) override
 Before applying the decision. More...
 
void RefuteDecision (Decision *const decision) override
 Before refuting the decision. More...
 
void OutputDecision ()
 
void Maintain ()
 
void BeginInitialPropagation () override
 Before the initial propagation. More...
 
void EndInitialPropagation () override
 After the initial propagation. More...
 
std::string DebugString () const override
 
virtual void RestartSearch ()
 Restart 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 AfterDecision (Decision *const d, bool apply)
 Just after refuting or applying the decision, apply is true after Apply. More...
 
virtual void EndFail ()
 After completing the backtrack. More...
 
virtual bool AcceptSolution ()
 This method is called when a solution is found. 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 bool IsUncheckedSolutionLimitReached ()
 Returns true if the limit of solutions has been reached including unchecked solutions. More...
 
Solversolver () 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...
 
virtual void Install ()
 Registers itself on the solver such that it gets notified of the search and propagation events. More...
 

Static Public Attributes

static constexpr int kNoProgress = -1
 

Protected Member Functions

virtual void OutputLine (const std::string &line)
 

Constructor & Destructor Documentation

◆ SearchLog()

SearchLog ( Solver *const  s,
OptimizeVar *const  obj,
IntVar *const  var,
double  scaling_factor,
double  offset,
std::function< std::string()>  display_callback,
bool  display_on_new_solutions_only,
int  period 
)

Definition at line 56 of file search.cc.

◆ ~SearchLog()

~SearchLog ( )
override

Definition at line 81 of file search.cc.

Member Function Documentation

◆ Accept()

void Accept ( ModelVisitor *const  visitor) const
virtualinherited

Accepts the given model visitor.

Reimplemented in OptimizeVar, and RegularLimit.

Definition at line 2890 of file constraint_solver.cc.

◆ AcceptDelta()

bool AcceptDelta ( Assignment delta,
Assignment deltadelta 
)
virtualinherited

Reimplemented in OptimizeVar.

Definition at line 2884 of file constraint_solver.cc.

◆ AcceptNeighbor()

void AcceptNeighbor ( )
virtualinherited

After accepting a neighbor during local search.

Definition at line 2887 of file constraint_solver.cc.

◆ AcceptSolution()

bool 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.

Definition at line 2880 of file constraint_solver.cc.

◆ AcceptUncheckedNeighbor()

void AcceptUncheckedNeighbor ( )
overridevirtual

After accepting an unchecked neighbor during local search.

Reimplemented from SearchMonitor.

Definition at line 176 of file search.cc.

◆ AfterDecision()

void AfterDecision ( Decision *const  d,
bool  apply 
)
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.

Definition at line 2875 of file constraint_solver.cc.

◆ ApplyDecision()

void ApplyDecision ( Decision *const  d)
overridevirtual

Before applying the decision.

Reimplemented from SearchMonitor.

Definition at line 200 of file search.cc.

◆ AtSolution()

bool AtSolution ( )
overridevirtual

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 from SearchMonitor.

Definition at line 106 of file search.cc.

◆ BeginFail()

void BeginFail ( )
overridevirtual

Just when the failure occurs.

Reimplemented from SearchMonitor.

Definition at line 178 of file search.cc.

◆ BeginInitialPropagation()

void BeginInitialPropagation ( )
overridevirtual

Before the initial propagation.

Reimplemented from SearchMonitor.

Definition at line 246 of file search.cc.

◆ BeginNextDecision()

void BeginNextDecision ( DecisionBuilder *const  b)
virtualinherited

Before calling DecisionBuilder::Next.

Reimplemented in SearchLimit, and OptimizeVar.

Definition at line 2870 of file constraint_solver.cc.

◆ DebugString()

std::string DebugString ( ) const
overridevirtual

Reimplemented from BaseObject.

Definition at line 83 of file search.cc.

◆ EndFail()

void EndFail ( )
virtualinherited

After completing the backtrack.

Definition at line 2877 of file constraint_solver.cc.

◆ EndInitialPropagation()

void EndInitialPropagation ( )
overridevirtual

After the initial propagation.

Reimplemented from SearchMonitor.

Definition at line 248 of file search.cc.

◆ EndNextDecision()

void EndNextDecision ( DecisionBuilder *const  b,
Decision *const  d 
)
virtualinherited

After calling DecisionBuilder::Next, along with the returned decision.

Reimplemented in SymmetryManager.

Definition at line 2871 of file constraint_solver.cc.

◆ EnterSearch()

void EnterSearch ( )
overridevirtual

Beginning of the search.

Reimplemented from SearchMonitor.

Definition at line 85 of file search.cc.

◆ ExitSearch()

void ExitSearch ( )
overridevirtual

End of the search.

Reimplemented from SearchMonitor.

Definition at line 93 of file search.cc.

◆ Install()

void Install ( )
virtualinherited

Registers itself on the solver such that it gets notified of the search and propagation events.

Reimplemented in Trace, LocalSearchMonitorMaster, PropagationMonitor, LocalSearchMonitor, DemonProfiler, and LocalSearchProfiler.

Definition at line 2892 of file constraint_solver.cc.

◆ IsUncheckedSolutionLimitReached()

virtual bool 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()

bool 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.

Definition at line 2883 of file constraint_solver.cc.

◆ Maintain()

void Maintain ( )

Definition at line 239 of file search.cc.

◆ NoMoreSolutions()

void NoMoreSolutions ( )
overridevirtual

When the search tree is finished.

Reimplemented from SearchMonitor.

Definition at line 180 of file search.cc.

◆ OutputDecision()

void OutputDecision ( )

Definition at line 213 of file search.cc.

◆ OutputLine()

void OutputLine ( const std::string &  line)
protectedvirtual

Definition at line 256 of file search.cc.

◆ PeriodicCheck()

void PeriodicCheck ( )
virtualinherited

Periodic call to check limits in long running methods.

Reimplemented in SearchLimit.

Definition at line 2889 of file constraint_solver.cc.

◆ ProgressPercent()

virtual int 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()

void RefuteDecision ( Decision *const  d)
overridevirtual

Before refuting the decision.

Reimplemented from SearchMonitor.

Definition at line 208 of file search.cc.

◆ RestartSearch()

void RestartSearch ( )
virtualinherited

Restart the search.

Reimplemented in DemonProfiler, and LocalSearchProfiler.

Definition at line 2868 of file constraint_solver.cc.

◆ solver()

Solver * solver ( ) const
inlineinherited

Definition at line 3708 of file constraint_solver.h.

Member Data Documentation

◆ kNoProgress

constexpr int kNoProgress = -1
staticconstexprinherited

Definition at line 3637 of file constraint_solver.h.


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