operations_research::LocalSearchMonitor Class Reference

Detailed Description

Definition at line 3291 of file constraint_solveri.h.

#include <constraint_solveri.h>

Inheritance diagram for operations_research::LocalSearchMonitor:

Public Member Functions
	LocalSearchMonitor (Solver *solver)
	-------— Local Search Monitor --------—
	~LocalSearchMonitor () override
std::string	DebugString () const override
virtual void	BeginOperatorStart ()=0
	Local search operator events.
virtual void	EndOperatorStart ()=0
virtual void	BeginMakeNextNeighbor (const LocalSearchOperator *op)=0
virtual void	EndMakeNextNeighbor (const LocalSearchOperator *op, bool neighbor_found, const Assignment *delta, const Assignment *deltadelta)=0
virtual void	BeginFilterNeighbor (const LocalSearchOperator *op)=0
virtual void	EndFilterNeighbor (const LocalSearchOperator *op, bool neighbor_found)=0
virtual void	BeginAcceptNeighbor (const LocalSearchOperator *op)=0
virtual void	EndAcceptNeighbor (const LocalSearchOperator *op, bool neighbor_found)=0
virtual void	BeginFiltering (const LocalSearchFilter *filter)=0
virtual void	EndFiltering (const LocalSearchFilter *filter, bool reject)=0
virtual bool	IsActive () const =0
void	Install () override
	Install itself on the solver.
Public Member Functions inherited from operations_research::SearchMonitor
	SearchMonitor (Solver *const s)
	SearchMonitor (const SearchMonitor &)=delete
	This type is neither copyable nor movable.
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	LocalOptimum ()
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.
Solver *	solver () const
Public Member Functions inherited from operations_research::BaseObject
	BaseObject ()
	BaseObject (const BaseObject &)=delete
	This type is neither copyable nor movable.
BaseObject &	operator= (const BaseObject &)=delete
virtual	~BaseObject ()=default

Additional Inherited Members
Static Public Attributes inherited from operations_research::SearchMonitor
static constexpr int	kNoProgress = -1
Protected Member Functions inherited from operations_research::SearchMonitor
void	ListenToEvent (Solver::MonitorEvent event)

Constructor & Destructor Documentation

LocalSearchMonitor()

operations_research::LocalSearchMonitor::LocalSearchMonitor ( Solver * solver )

explicit

-------— Local Search Monitor --------—

Todo

(user): Add monitoring of local search filters.

Definition at line 2932 of file constraint_solver.cc.

~LocalSearchMonitor()

operations_research::LocalSearchMonitor::~LocalSearchMonitor ( )

override

Definition at line 2935 of file constraint_solver.cc.

Member Function Documentation

BeginAcceptNeighbor()

virtual void operations_research::LocalSearchMonitor::BeginAcceptNeighbor ( const LocalSearchOperator * op )

pure virtual

Implemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

BeginFiltering()

virtual void operations_research::LocalSearchMonitor::BeginFiltering ( const LocalSearchFilter * filter )

pure virtual

Implemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

BeginFilterNeighbor()

virtual void operations_research::LocalSearchMonitor::BeginFilterNeighbor ( const LocalSearchOperator * op )

pure virtual

Implemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

BeginMakeNextNeighbor()

virtual void operations_research::LocalSearchMonitor::BeginMakeNextNeighbor ( const LocalSearchOperator * op )

pure virtual

Implemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

BeginOperatorStart()

virtual void operations_research::LocalSearchMonitor::BeginOperatorStart ( )

pure virtual

Local search operator events.

Implemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

DebugString()

std::string operations_research::LocalSearchMonitor::DebugString ( ) const

inlineoverridevirtual

Reimplemented from operations_research::BaseObject.

Reimplemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

Definition at line 3296 of file constraint_solveri.h.

EndAcceptNeighbor()

virtual void operations_research::LocalSearchMonitor::EndAcceptNeighbor ( const LocalSearchOperator * op, bool neighbor_found )

pure virtual

Implemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

EndFiltering()

virtual void operations_research::LocalSearchMonitor::EndFiltering ( const LocalSearchFilter * filter, bool reject )

pure virtual

Implemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

EndFilterNeighbor()

virtual void operations_research::LocalSearchMonitor::EndFilterNeighbor ( const LocalSearchOperator * op, bool neighbor_found )

pure virtual

Implemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

EndMakeNextNeighbor()

virtual void operations_research::LocalSearchMonitor::EndMakeNextNeighbor ( const LocalSearchOperator * op, bool neighbor_found, const Assignment * delta, const Assignment * deltadelta )

pure virtual

Implemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

EndOperatorStart()

virtual void operations_research::LocalSearchMonitor::EndOperatorStart ( )

pure virtual

Implemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

Install()

void operations_research::LocalSearchMonitor::Install ( )

overridevirtual

Install itself on the solver.

A local search monitor listens to search events as well as local search events.

Reimplemented from operations_research::SearchMonitor.

Reimplemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

Definition at line 2939 of file constraint_solver.cc.

IsActive()

virtual bool operations_research::LocalSearchMonitor::IsActive ( ) const

pure virtual

Implemented in operations_research::LocalSearchMonitorPrimary, and operations_research::LocalSearchProfiler.

---

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

• ortools/constraint_solver/constraint_solveri.h
• ortools/constraint_solver/constraint_solver.cc