Home Original page

Google OR-Tools: operations_research::SearchMonitor Class Reference

A search monitor is a simple set of callbacks to monitor all search events. More...

A search monitor is a simple set of callbacks to monitor all search events.

Definition at line 3983 of file constraint_solver.h.

#include <constraint_solver.h>

operations_research::BaseObject operations_research::BaseObjectiveMonitor operations_research::LocalSearchMonitor operations_research::PropagationMonitor operations_research::SearchLimit operations_research::SearchLog operations_research::SolutionCollector operations_research::SymmetryManager operations_research::ObjectiveMonitor operations_research::RoundRobinCompoundObjectiveMonitor operations_research::LocalSearchMonitorPrimary operations_research::LocalSearchProfiler operations_research::DemonProfiler operations_research::Trace operations_research::ImprovementSearchLimit operations_research::RegularLimit

Public Member Functions

 SearchMonitor (Solver *const s)
 SearchMonitor (const SearchMonitor &)=delete
SearchMonitor & operator= (const SearchMonitor &)=delete
 ~SearchMonitor () override
virtual void EnterSearch ()
 Beginning of the search.
virtual void RestartSearch ()
 Restart the search.
virtual void ExitSearch ()
 End of the search.
virtual void BeginNextDecision (DecisionBuilder *b)
 Before calling DecisionBuilder::Next.
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 RefuteDecision (Decision *d)
 Before refuting 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 void PeriodicCheck ()
 Periodic call to check limits in long running methods.
virtual int ProgressPercent ()
virtual void Accept (ModelVisitor *visitor) const
 Accepts the given model visitor.
virtual void Install ()
Solver * solver () const
Public Member Functions inherited from operations_research::BaseObject
 BaseObject ()
 BaseObject (const BaseObject &)=delete
BaseObject & operator= (const BaseObject &)=delete
virtual ~BaseObject ()=default
virtual std::string DebugString () const

Static Public Attributes

static constexpr int kNoProgress = -1
operations_research::SearchMonitor::SearchMonitor ( Solver *const s)
inlineexplicit

◆ SearchMonitor() [2/2]

operations_research::SearchMonitor::SearchMonitor ( const SearchMonitor & )
delete

◆ ~SearchMonitor()

operations_research::SearchMonitor::~SearchMonitor ( )
inlineoverride

◆ Accept()

void operations_research::SearchMonitor::Accept ( ModelVisitor * visitor) const
virtual

◆ AcceptDelta()

bool operations_research::SearchMonitor::AcceptDelta ( Assignment * delta,
Assignment * deltadelta )
virtual

◆ AcceptNeighbor()

void operations_research::SearchMonitor::AcceptNeighbor ( )
virtual

◆ AcceptSolution()

bool operations_research::SearchMonitor::AcceptSolution ( )
virtual

◆ AcceptUncheckedNeighbor()

void operations_research::SearchMonitor::AcceptUncheckedNeighbor ( )
virtual

◆ AfterDecision()

void operations_research::SearchMonitor::AfterDecision ( Decision * d,
bool apply )
virtual

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 2888 of file constraint_solver.cc.

◆ ApplyDecision()

void operations_research::SearchMonitor::ApplyDecision ( Decision * d)
virtual

◆ AtLocalOptimum()

bool operations_research::SearchMonitor::AtLocalOptimum ( )
virtual

◆ AtSolution()

bool operations_research::SearchMonitor::AtSolution ( )
virtual

◆ BeginFail()

void operations_research::SearchMonitor::BeginFail ( )
virtual

◆ BeginInitialPropagation()

void operations_research::SearchMonitor::BeginInitialPropagation ( )
virtual

◆ BeginNextDecision()

void operations_research::SearchMonitor::BeginNextDecision ( DecisionBuilder * b)
virtual

◆ EndFail()

void operations_research::SearchMonitor::EndFail ( )
virtual

◆ EndInitialPropagation()

void operations_research::SearchMonitor::EndInitialPropagation ( )
virtual

◆ EndNextDecision()

◆ EnterSearch()

void operations_research::SearchMonitor::EnterSearch ( )
virtual

◆ ExitSearch()

void operations_research::SearchMonitor::ExitSearch ( )
virtual

◆ Install()

void operations_research::SearchMonitor::Install ( )
virtual

◆ IsUncheckedSolutionLimitReached()

virtual bool operations_research::SearchMonitor::IsUncheckedSolutionLimitReached ( )
inlinevirtual

◆ ListenToEvent()

◆ NoMoreSolutions()

void operations_research::SearchMonitor::NoMoreSolutions ( )
virtual

◆ operator=()

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

◆ PeriodicCheck()

void operations_research::SearchMonitor::PeriodicCheck ( )
virtual

◆ ProgressPercent()

virtual int operations_research::SearchMonitor::ProgressPercent ( )
inlinevirtual

◆ RefuteDecision()

void operations_research::SearchMonitor::RefuteDecision ( Decision * d)
virtual

◆ RestartSearch()

void operations_research::SearchMonitor::RestartSearch ( )
virtual

◆ solver()

Solver * operations_research::SearchMonitor::solver ( ) const
inline

◆ kNoProgress

int operations_research::SearchMonitor::kNoProgress = -1

 staticconstexpr

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