C++ Reference

C++ Reference: Routing

Detailed Description

Base class of all search limits.

Definition at line 4239 of file constraint_solver.h.

Public Member Functions

 SearchLimit (Solver *const s)
 
 ~SearchLimit () override
 
bool crossed () const
 Returns true if the limit has been crossed. More...
 
virtual bool Check ()=0
 This method is called to check the status of the limit. More...
 
virtual void Init ()=0
 This method is called when the search limit is initialized. More...
 
virtual void Copy (const SearchLimit *const limit)=0
 Copy a limit. More...
 
virtual SearchLimitMakeClone () const =0
 Allocates a clone of the limit. More...
 
void EnterSearch () override
 Internal methods. More...
 
void BeginNextDecision (DecisionBuilder *const b) override
 Before calling DecisionBuilder::Next. More...
 
void PeriodicCheck () override
 Periodic call to check limits in long running methods. More...
 
void RefuteDecision (Decision *const d) override
 Before refuting the decision. More...
 
std::string DebugString () const override
 
virtual void RestartSearch ()
 Restart the search. More...
 
virtual void ExitSearch ()
 End of the search. 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 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...
 
Solversolver () const
 
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
 

Constructor & Destructor Documentation

◆ SearchLimit()

SearchLimit ( Solver *const  s)
inlineexplicit

Definition at line 4241 of file constraint_solver.h.

◆ ~SearchLimit()

~SearchLimit ( )
override

Member Function Documentation

◆ Accept()

virtual void Accept ( ModelVisitor *const  visitor) const
virtualinherited

Accepts the given model visitor.

Reimplemented in OptimizeVar, and RegularLimit.

◆ AcceptDelta()

virtual bool AcceptDelta ( Assignment delta,
Assignment deltadelta 
)
virtualinherited

Reimplemented in OptimizeVar.

◆ AcceptNeighbor()

virtual void AcceptNeighbor ( )
virtualinherited

After accepting a neighbor during local search.

◆ AcceptSolution()

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

◆ AcceptUncheckedNeighbor()

virtual void AcceptUncheckedNeighbor ( )
virtualinherited

After accepting an unchecked neighbor during local search.

Reimplemented in SearchLog.

◆ AfterDecision()

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

◆ ApplyDecision()

virtual void ApplyDecision ( Decision *const  d)
virtualinherited

Before applying the decision.

Reimplemented in SearchLog.

◆ AtSolution()

virtual bool 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 OptimizeVar, ImprovementSearchLimit, and SearchLog.

◆ BeginFail()

virtual void BeginFail ( )
virtualinherited

Just when the failure occurs.

Reimplemented in SearchLog.

◆ BeginInitialPropagation()

virtual void BeginInitialPropagation ( )
virtualinherited

Before the initial propagation.

Reimplemented in SearchLog.

◆ BeginNextDecision()

void BeginNextDecision ( DecisionBuilder *const  b)
overridevirtual

Before calling DecisionBuilder::Next.

Reimplemented from SearchMonitor.

◆ Check()

virtual bool Check ( )
pure virtual

This method is called to check the status of the limit.

A return value of true indicates that we have indeed crossed the limit. In that case, this method will not be called again and the remaining search will be discarded.

Implemented in RegularLimit, and ImprovementSearchLimit.

◆ Copy()

virtual void Copy ( const SearchLimit *const  limit)
pure virtual

Copy a limit.

Warning: leads to a direct (no check) downcasting of 'limit' so one needs to be sure both SearchLimits are of the same type.

Implemented in RegularLimit, and ImprovementSearchLimit.

◆ crossed()

bool crossed ( ) const
inline

Returns true if the limit has been crossed.

Definition at line 4245 of file constraint_solver.h.

◆ DebugString()

std::string DebugString ( ) const
inlineoverridevirtual

Reimplemented from BaseObject.

Reimplemented in RegularLimit.

Definition at line 4268 of file constraint_solver.h.

◆ EndFail()

virtual void EndFail ( )
virtualinherited

After completing the backtrack.

◆ EndInitialPropagation()

virtual void EndInitialPropagation ( )
virtualinherited

After the initial propagation.

Reimplemented in SearchLog.

◆ EndNextDecision()

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

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

◆ EnterSearch()

void EnterSearch ( )
overridevirtual

Internal methods.

Reimplemented from SearchMonitor.

◆ ExitSearch()

virtual void ExitSearch ( )
virtualinherited

End of the search.

Reimplemented in RegularLimit, and SearchLog.

◆ Init()

virtual void Init ( )
pure virtual

This method is called when the search limit is initialized.

Implemented in RegularLimit, and ImprovementSearchLimit.

◆ Install()

virtual void Install ( )
virtualinherited

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

Reimplemented in PropagationMonitor, and LocalSearchMonitor.

◆ 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()

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

◆ MakeClone()

virtual SearchLimit * MakeClone ( ) const
pure virtual

Allocates a clone of the limit.

Implemented in RegularLimit, and ImprovementSearchLimit.

◆ NoMoreSolutions()

virtual void NoMoreSolutions ( )
virtualinherited

When the search tree is finished.

Reimplemented in SearchLog.

◆ PeriodicCheck()

void PeriodicCheck ( )
overridevirtual

Periodic call to check limits in long running methods.

Reimplemented from SearchMonitor.

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

◆ RestartSearch()

virtual void RestartSearch ( )
virtualinherited

Restart the search.

◆ 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 file: