C++ Reference

C++ Reference: Routing

Detailed Description

Usual limit based on wall_time, number of explored branches and number of failures in the search tree.

Definition at line 4281 of file constraint_solver.h.

Public Member Functions

 RegularLimit (Solver *const s, absl::Duration time, int64 branches, int64 failures, int64 solutions, bool smart_time_check, bool cumulative)
 
 ~RegularLimit () override
 
void Copy (const SearchLimit *const limit) override
 Copy a limit. More...
 
SearchLimitMakeClone () const override
 Allocates a clone of the limit. More...
 
RegularLimitMakeIdenticalClone () const
 
bool Check () override
 This method is called to check the status of the limit. More...
 
void Init () override
 This method is called when the search limit is initialized. More...
 
void ExitSearch () override
 End of the search. More...
 
void UpdateLimits (absl::Duration time, int64 branches, int64 failures, int64 solutions)
 
absl::Duration duration_limit () const
 
int64 wall_time () const
 
int64 branches () const
 
int64 failures () const
 
int64 solutions () const
 
bool IsUncheckedSolutionLimitReached () override
 Returns true if the limit of solutions has been reached including unchecked solutions. More...
 
int ProgressPercent () override
 Returns a percentage representing the propress of the search before reaching limits. More...
 
std::string DebugString () const override
 
absl::Time AbsoluteSolverDeadline () const
 
void Accept (ModelVisitor *const visitor) const override
 Accepts the given model visitor. More...
 
bool crossed () const
 Returns true if the limit has been crossed. 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...
 
virtual void RestartSearch ()
 Restart 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...
 
Solversolver () const
 
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

◆ RegularLimit()

RegularLimit ( Solver *const  s,
absl::Duration  time,
int64  branches,
int64  failures,
int64  solutions,
bool  smart_time_check,
bool  cumulative 
)

◆ ~RegularLimit()

~RegularLimit ( )
override

Member Function Documentation

◆ AbsoluteSolverDeadline()

absl::Time AbsoluteSolverDeadline ( ) const
inline

Definition at line 4308 of file constraint_solver.h.

◆ Accept()

void Accept ( ModelVisitor *const  visitor) const
overridevirtual

Accepts the given model visitor.

Reimplemented from SearchMonitor.

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

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

Before calling DecisionBuilder::Next.

Reimplemented from SearchMonitor.

◆ branches()

int64 branches ( ) const
inline

Definition at line 4301 of file constraint_solver.h.

◆ Check()

bool Check ( )
overridevirtual

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.

Implements SearchLimit.

◆ Copy()

void Copy ( const SearchLimit *const  limit)
overridevirtual

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.

Implements SearchLimit.

◆ crossed()

bool crossed ( ) const
inlineinherited

Returns true if the limit has been crossed.

Definition at line 4245 of file constraint_solver.h.

◆ DebugString()

std::string DebugString ( ) const
overridevirtual

Reimplemented from SearchLimit.

◆ duration_limit()

absl::Duration duration_limit ( ) const
inline

Definition at line 4295 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 ( )
overridevirtualinherited

Internal methods.

Reimplemented from SearchMonitor.

◆ ExitSearch()

void ExitSearch ( )
overridevirtual

End of the search.

Reimplemented from SearchMonitor.

◆ failures()

int64 failures ( ) const
inline

Definition at line 4302 of file constraint_solver.h.

◆ Init()

void Init ( )
overridevirtual

This method is called when the search limit is initialized.

Implements SearchLimit.

◆ Install()

virtual void Install ( )
virtualinherited

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

Reimplemented in LocalSearchMonitor, and PropagationMonitor.

◆ IsUncheckedSolutionLimitReached()

bool IsUncheckedSolutionLimitReached ( )
overridevirtual

Returns true if the limit of solutions has been reached including unchecked solutions.

Reimplemented from SearchMonitor.

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

SearchLimit* MakeClone ( ) const
overridevirtual

Allocates a clone of the limit.

Implements SearchLimit.

◆ MakeIdenticalClone()

RegularLimit* MakeIdenticalClone ( ) const

◆ NoMoreSolutions()

virtual void NoMoreSolutions ( )
virtualinherited

When the search tree is finished.

Reimplemented in SearchLog.

◆ PeriodicCheck()

void PeriodicCheck ( )
overridevirtualinherited

Periodic call to check limits in long running methods.

Reimplemented from SearchMonitor.

◆ ProgressPercent()

int ProgressPercent ( )
overridevirtual

Returns a percentage representing the propress of the search before reaching limits.

Reimplemented from SearchMonitor.

◆ RefuteDecision()

void RefuteDecision ( Decision *const  d)
overridevirtualinherited

Before refuting the decision.

Reimplemented from SearchMonitor.

◆ RestartSearch()

virtual void RestartSearch ( )
virtualinherited

Restart the search.

◆ solutions()

int64 solutions ( ) const
inline

Definition at line 4303 of file constraint_solver.h.

◆ solver()

Solver* solver ( ) const
inlineinherited

Definition at line 3708 of file constraint_solver.h.

◆ UpdateLimits()

void UpdateLimits ( absl::Duration  time,
int64  branches,
int64  failures,
int64  solutions 
)

◆ wall_time()

int64 wall_time ( ) const
inline

Definition at line 4296 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: