Home Original page

Google OR-Tools: operations_research::SearchLimit Class Reference

Base class of all search limits. More...

Base class of all search limits.

Definition at line 4735 of file constraint_solver.h.

#include <constraint_solver.h>

operations_research::SearchMonitor operations_research::BaseObject operations_research::ImprovementSearchLimit operations_research::RegularLimit

Public Member Functions

 SearchLimit (Solver *const s)
 SearchLimit (const SearchLimit &)=delete
SearchLimit & operator= (const SearchLimit &)=delete
 ~SearchLimit () override
bool crossed () const
 Returns true if the limit has been crossed.
bool Check ()
virtual bool CheckWithOffset (absl::Duration offset)=0
virtual void Init ()=0
 This method is called when the search limit is initialized.
virtual void Copy (const SearchLimit *limit)=0
virtual SearchLimit * MakeClone () const =0
 Allocates a clone of the limit.
void EnterSearch () override
 Internal methods.
void BeginNextDecision (DecisionBuilder *b) override
 Before calling DecisionBuilder::Next.
void PeriodicCheck () override
 Periodic call to check limits in long running methods.
void RefuteDecision (Decision *d) override
 Before refuting the decision.
std::string DebugString () const override
void Install () override
Public Member Functions inherited from operations_research::SearchMonitor
 SearchMonitor (Solver *const s)
 SearchMonitor (const SearchMonitor &)=delete
SearchMonitor & operator= (const SearchMonitor &)=delete
 ~SearchMonitor () override
virtual void RestartSearch ()
 Restart the search.
virtual void ExitSearch ()
 End of the search.
virtual void EndNextDecision (DecisionBuilder *b, Decision *d)
 After calling DecisionBuilder::Next, along with the returned decision.
virtual void ApplyDecision (Decision *d)
 Before applying the decision.
virtual void AfterDecision (Decision *d, bool apply)
virtual void BeginFail ()
 Just when the failure occurs.
virtual void EndFail ()
 After completing the backtrack.
virtual void BeginInitialPropagation ()
 Before the initial propagation.
virtual void EndInitialPropagation ()
 After the initial propagation.
virtual bool AcceptSolution ()
virtual bool AtSolution ()
virtual void NoMoreSolutions ()
 When the search tree is finished.
virtual bool AtLocalOptimum ()
virtual bool AcceptDelta (Assignment *delta, Assignment *deltadelta)
virtual void AcceptNeighbor ()
 After accepting a neighbor during local search.
virtual void AcceptUncheckedNeighbor ()
 After accepting an unchecked neighbor during local search.
virtual bool IsUncheckedSolutionLimitReached ()
virtual int ProgressPercent ()
virtual void Accept (ModelVisitor *visitor) const
 Accepts the given model visitor.
Solver * solver () const
Public Member Functions inherited from operations_research::BaseObject
 BaseObject ()
 BaseObject (const BaseObject &)=delete
BaseObject & operator= (const BaseObject &)=delete
virtual ~BaseObject ()=default
operations_research::SearchLimit::SearchLimit ( Solver *const s)
inlineexplicit

◆ SearchLimit() [2/2]

operations_research::SearchLimit::SearchLimit ( const SearchLimit & )
delete

◆ ~SearchLimit()

operations_research::SearchLimit::~SearchLimit ( )
override

◆ BeginNextDecision()

void operations_research::SearchLimit::BeginNextDecision ( DecisionBuilder * b)
overridevirtual

◆ Check()

bool operations_research::SearchLimit::Check ( )
inline

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.

Definition at line 4753 of file constraint_solver.h.

◆ CheckWithOffset()

virtual bool operations_research::SearchLimit::CheckWithOffset ( absl::Duration offset)
pure virtual

◆ Copy()

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

◆ crossed()

bool operations_research::SearchLimit::crossed ( ) const
inline

◆ DebugString()

std::string operations_research::SearchLimit::DebugString ( ) const
inlineoverridevirtual

◆ EnterSearch()

void operations_research::SearchLimit::EnterSearch ( )
overridevirtual

◆ Init()

virtual void operations_research::SearchLimit::Init ( )
pure virtual

◆ Install()

void operations_research::SearchLimit::Install ( )
overridevirtual

Registers itself on the solver such that it gets notified of the search and propagation events. Override to incrementally install listeners for specific events.

Reimplemented from operations_research::SearchMonitor.

Definition at line 4547 of file search.cc.

◆ MakeClone()

virtual SearchLimit * operations_research::SearchLimit::MakeClone ( ) const
pure virtual

◆ operator=()

SearchLimit & operations_research::SearchLimit::operator= ( const SearchLimit & )
delete

◆ PeriodicCheck()

void operations_research::SearchLimit::PeriodicCheck ( )
overridevirtual

◆ RefuteDecision()

void operations_research::SearchLimit::RefuteDecision ( Decision * d)
overridevirtual

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