operations_research::SearchMonitor Class Reference

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

#include <constraint_solver.h>

Inheritance diagram for operations_research::SearchMonitor:

List of all members.

Public Member Functions

SearchMonitor (Solver *const s)

virtual ~SearchMonitor ()

virtual void EnterSearch ()

Beginning of the search.

virtual void RestartSearch ()

Restart the search.

virtual void ExitSearch ()

End of the search.

virtual void BeginNextDecision (DecisionBuilder *const b)

Before calling DecisionBuilder::Next.

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

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

virtual void ApplyDecision (Decision *const d)

Before applying the decision.

virtual void RefuteDecision (Decision *const d)

Before refuting the Decision.

virtual void AfterDecision (Decision *const d, bool apply)

Just after refuting or applying the decision, apply is true after 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 ()

This method is called when a solution is found.

virtual bool AtSolution ()

This method is called when a valid solution is found.

virtual void NoMoreSolutions ()

When the search tree is finished.

virtual bool LocalOptimum ()

When a local optimum is reached.

virtual bool AcceptDelta (Assignment *delta, Assignment *deltadelta)

virtual void AcceptNeighbor ()

After accepting a neighbor during local search.

Solver * solver () const

void FinishCurrentSearch ()

Tells the solver to kill the current search.

void RestartCurrentSearch ()

Tells the solver to restart the current search.

virtual void PeriodicCheck ()

Periodic call to check limits in long running methods.

virtual int ProgressPercent ()

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

virtual void Accept (ModelVisitor *const visitor) const

Accepts the given model visitor.

virtual void Install ()

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

Static Public Attributes

static const int kNoProgress = -1

Detailed Description

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

Definition at line 3486 of file constraint_solver.h.

Constructor & Destructor Documentation

operations_research::SearchMonitor::SearchMonitor ( Solver *const s ) [inline, explicit]

Definition at line 3490 of file constraint_solver.h.

virtual operations_research::SearchMonitor::~SearchMonitor ( ) [inline, virtual]

Definition at line 3491 of file constraint_solver.h.

Member Function Documentation

void operations_research::SearchMonitor::EnterSearch ( ) [virtual]

Beginning of the search.

Search Monitor.

Reimplemented in operations_research::SolutionCollector, operations_research::OptimizeVar, operations_research::SearchLimit, operations_research::NoGoodManager, and operations_research::SearchLog.

Definition at line 2916 of file constraint_solver.cc.

void operations_research::SearchMonitor::RestartSearch ( ) [virtual]

Restart the search.

Reimplemented in operations_research::OptimizeVar, and operations_research::DemonProfiler.

Definition at line 2917 of file constraint_solver.cc.

void operations_research::SearchMonitor::ExitSearch ( ) [virtual]

End of the search.

Reimplemented in operations_research::SearchLog.

Definition at line 2918 of file constraint_solver.cc.

void operations_research::SearchMonitor::BeginNextDecision ( DecisionBuilder *const b ) [virtual]

Before calling DecisionBuilder::Next.

Reimplemented in operations_research::SearchLimit, and operations_research::NoGoodManager.

Definition at line 2919 of file constraint_solver.cc.

void operations_research::SearchMonitor::EndNextDecision	(	DecisionBuilder *const	b,
		Decision *const	d
	)			`[virtual]`

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

Reimplemented in operations_research::SymmetryManager.

Definition at line 2920 of file constraint_solver.cc.

void operations_research::SearchMonitor::ApplyDecision ( Decision *const d ) [virtual]

Before applying the decision.

Reimplemented in operations_research::SearchLog.

Definition at line 2922 of file constraint_solver.cc.

void operations_research::SearchMonitor::RefuteDecision ( Decision *const d ) [virtual]

Before refuting the Decision.

Reimplemented in operations_research::OptimizeVar, operations_research::SearchLimit, operations_research::SearchLog, and operations_research::SymmetryManager.

Definition at line 2923 of file constraint_solver.cc.

void operations_research::SearchMonitor::AfterDecision	(	Decision *const	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 2924 of file constraint_solver.cc.

void operations_research::SearchMonitor::BeginFail ( ) [virtual]

Just when the failure occurs.

Reimplemented in operations_research::SearchLog, and operations_research::DemonProfiler.

Definition at line 2925 of file constraint_solver.cc.

void operations_research::SearchMonitor::EndFail ( ) [virtual]

After completing the backtrack.

Definition at line 2926 of file constraint_solver.cc.

void operations_research::SearchMonitor::BeginInitialPropagation ( ) [virtual]

Before the initial propagation.

Reimplemented in operations_research::SearchLog.

Definition at line 2927 of file constraint_solver.cc.

void operations_research::SearchMonitor::EndInitialPropagation ( ) [virtual]

After the initial propagation.

Reimplemented in operations_research::SearchLog.

Definition at line 2928 of file constraint_solver.cc.

bool operations_research::SearchMonitor::AcceptSolution ( ) [virtual]

This method is called when a solution is found.

It asserts of the solution is valid. A value of false indicate that the solution should be discarded.

Reimplemented in operations_research::OptimizeVar, and operations_research::NoGoodManager.

Definition at line 2929 of file constraint_solver.cc.

bool operations_research::SearchMonitor::AtSolution ( ) [virtual]

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 operations_research::OptimizeVar, and operations_research::SearchLog.

Definition at line 2930 of file constraint_solver.cc.

void operations_research::SearchMonitor::NoMoreSolutions ( ) [virtual]

When the search tree is finished.

Reimplemented in operations_research::SearchLog.

Definition at line 2931 of file constraint_solver.cc.

bool operations_research::SearchMonitor::LocalOptimum ( ) [virtual]

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

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

Definition at line 2933 of file constraint_solver.cc.

void operations_research::SearchMonitor::AcceptNeighbor ( ) [virtual]

After accepting a neighbor during local search.

Definition at line 2935 of file constraint_solver.cc.

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

Definition at line 3552 of file constraint_solver.h.

void operations_research::SearchMonitor::FinishCurrentSearch ( )

Tells the solver to kill the current search.

Definition at line 2936 of file constraint_solver.cc.

void operations_research::SearchMonitor::RestartCurrentSearch ( )

Tells the solver to restart the current search.

Definition at line 2939 of file constraint_solver.cc.

void operations_research::SearchMonitor::PeriodicCheck ( ) [virtual]

Periodic call to check limits in long running methods.

Reimplemented in operations_research::SearchLimit.

Definition at line 2942 of file constraint_solver.cc.

virtual int operations_research::SearchMonitor::ProgressPercent ( ) [inline, virtual]

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

Definition at line 3565 of file constraint_solver.h.

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

Accepts the given model visitor.

Reimplemented in operations_research::OptimizeVar.

Definition at line 2943 of file constraint_solver.cc.

void operations_research::SearchMonitor::Install ( ) [virtual]

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

A search monitors adds itself on the active search.

Reimplemented in operations_research::Trace, operations_research::PropagationMonitor, and operations_research::DemonProfiler.

Definition at line 2945 of file constraint_solver.cc.

Member Data Documentation

const int operations_research::SearchMonitor::kNoProgress = -1 [static]

Definition at line 3488 of file constraint_solver.h.

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

or-tools/src/constraint_solver/constraint_solver.h
or-tools/src/constraint_solver/constraint_solver.cc


Public Member Functions
	SearchMonitor (Solver *const s)
virtual	~SearchMonitor ()
virtual void	EnterSearch ()
	Beginning of the search.
virtual void	RestartSearch ()
	Restart the search.
virtual void	ExitSearch ()
	End of the search.
virtual void	BeginNextDecision (DecisionBuilder *const b)
	Before calling DecisionBuilder::Next.
virtual void	EndNextDecision (DecisionBuilder const b, Decision const d)
	After calling DecisionBuilder::Next, along with the returned decision.
virtual void	ApplyDecision (Decision *const d)
	Before applying the decision.
virtual void	RefuteDecision (Decision *const d)
	Before refuting the Decision.
virtual void	AfterDecision (Decision *const d, bool apply)
	Just after refuting or applying the decision, apply is true after 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 ()
	This method is called when a solution is found.
virtual bool	AtSolution ()
	This method is called when a valid solution is found.
virtual void	NoMoreSolutions ()
	When the search tree is finished.
virtual bool	LocalOptimum ()
	When a local optimum is reached.
virtual bool	AcceptDelta (Assignment delta, Assignment deltadelta)
virtual void	AcceptNeighbor ()
	After accepting a neighbor during local search.
Solver *	solver () const
void	FinishCurrentSearch ()
	Tells the solver to kill the current search.
void	RestartCurrentSearch ()
	Tells the solver to restart the current search.
virtual void	PeriodicCheck ()
	Periodic call to check limits in long running methods.
virtual int	ProgressPercent ()
	Returns a percentage representing the propress of the search before reaching limits.
virtual void	Accept (ModelVisitor *const visitor) const
	Accepts the given model visitor.
virtual void	Install ()
	Registers itself on the solver such that it gets notified of the search and propagation events.
Static Public Attributes
static const int	kNoProgress = -1