Detailed Description

Definition at line 1679 of file constraint_solveri.h.

Public Member Functions
	LocalSearchMonitor (Solver *const solver)

	~LocalSearchMonitor () override

std::string	DebugString () const override

virtual void	BeginOperatorStart ()=0
	Local search operator events. More...

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

void	Install () override
	Install itself on the solver. More...

virtual void	EnterSearch ()
	Beginning of the search. More...

virtual void	RestartSearch ()
	Restart the search. More...

virtual void	ExitSearch ()
	End of the search. More...

virtual void	BeginNextDecision (DecisionBuilder *const b)
	Before calling DecisionBuilder::Next. 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	RefuteDecision (Decision *const d)
	Before refuting 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...

virtual bool	IsUncheckedSolutionLimitReached ()
	Returns true if the limit of solutions has been reached including unchecked solutions. More...

Solver *	solver () const

virtual void	PeriodicCheck ()
	Periodic call to check limits in long running methods. More...

virtual int	ProgressPercent ()
	Returns a percentage representing the propress of the search before reaching limits. More...

virtual void	Accept (ModelVisitor *const visitor) const
	Accepts the given model visitor. More...

Static Public Attributes
static const int	kNoProgress = -1

Constructor & Destructor Documentation

◆ LocalSearchMonitor()

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

explicit

◆ ~LocalSearchMonitor()

operations_research::LocalSearchMonitor::~LocalSearchMonitor ( )

override

Member Function Documentation

◆ Accept()

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

virtualinherited

Accepts the given model visitor.

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

◆ AcceptDelta()

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

virtualinherited

Reimplemented in operations_research::OptimizeVar.

◆ AcceptNeighbor()

virtual void operations_research::SearchMonitor::AcceptNeighbor ( )

virtualinherited

After accepting a neighbor during local search.

◆ AcceptSolution()

virtual bool operations_research::SearchMonitor::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 operations_research::OptimizeVar.

◆ AcceptUncheckedNeighbor()

virtual void operations_research::SearchMonitor::AcceptUncheckedNeighbor ( )

virtualinherited

After accepting an unchecked neighbor during local search.

Reimplemented in operations_research::SearchLog.

◆ AfterDecision()

virtual void operations_research::SearchMonitor::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 operations_research::SearchMonitor::ApplyDecision ( Decision *const d )

virtualinherited

Before applying the decision.

Reimplemented in operations_research::SearchLog.

◆ AtSolution()

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

◆ BeginAcceptNeighbor()

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

pure virtual

◆ BeginFail()

virtual void operations_research::SearchMonitor::BeginFail ( )

virtualinherited

Just when the failure occurs.

Reimplemented in operations_research::SearchLog.

◆ BeginFiltering()

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

pure virtual

◆ BeginFilterNeighbor()

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

pure virtual

◆ BeginInitialPropagation()

virtual void operations_research::SearchMonitor::BeginInitialPropagation ( )

virtualinherited

Before the initial propagation.

Reimplemented in operations_research::SearchLog.

◆ BeginMakeNextNeighbor()

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

pure virtual

◆ BeginNextDecision()

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

virtualinherited

Before calling DecisionBuilder::Next.

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

◆ BeginOperatorStart()

virtual void operations_research::LocalSearchMonitor::BeginOperatorStart ( )

pure virtual

Local search operator events.

◆ DebugString()

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

inlineoverridevirtual

Reimplemented from operations_research::BaseObject.

Definition at line 1684 of file constraint_solveri.h.

◆ EndAcceptNeighbor()

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

pure virtual

◆ EndFail()

virtual void operations_research::SearchMonitor::EndFail ( )

virtualinherited

After completing the backtrack.

◆ EndFiltering()

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

pure virtual

◆ EndFilterNeighbor()

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

pure virtual

◆ EndInitialPropagation()

virtual void operations_research::SearchMonitor::EndInitialPropagation ( )

virtualinherited

After the initial propagation.

Reimplemented in operations_research::SearchLog.

◆ EndMakeNextNeighbor()

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

pure virtual

◆ EndNextDecision()

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

virtualinherited

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

◆ EndOperatorStart()

virtual void operations_research::LocalSearchMonitor::EndOperatorStart ( )

pure virtual

◆ EnterSearch()

virtual void operations_research::SearchMonitor::EnterSearch ( )

virtualinherited

Beginning of the search.

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

◆ ExitSearch()

virtual void operations_research::SearchMonitor::ExitSearch ( )

virtualinherited

End of the search.

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

◆ Install()

void operations_research::LocalSearchMonitor::Install ( )

overridevirtual

Install itself on the solver.

Reimplemented from operations_research::SearchMonitor.

◆ IsUncheckedSolutionLimitReached()

virtual bool operations_research::SearchMonitor::IsUncheckedSolutionLimitReached ( )

inlinevirtualinherited

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

Reimplemented in operations_research::RegularLimit.

Definition at line 3643 of file constraint_solver.h.

◆ LocalOptimum()

virtual bool operations_research::SearchMonitor::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.

◆ NoMoreSolutions()

virtual void operations_research::SearchMonitor::NoMoreSolutions ( )

virtualinherited

When the search tree is finished.

Reimplemented in operations_research::SearchLog.

◆ PeriodicCheck()

virtual void operations_research::SearchMonitor::PeriodicCheck ( )

virtualinherited

Periodic call to check limits in long running methods.

Reimplemented in operations_research::SearchLimit.

◆ ProgressPercent()

virtual int operations_research::SearchMonitor::ProgressPercent ( )

inlinevirtualinherited

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

Reimplemented in operations_research::RegularLimit.

Definition at line 3652 of file constraint_solver.h.

◆ RefuteDecision()

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

virtualinherited

Before refuting the decision.

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

◆ RestartSearch()

virtual void operations_research::SearchMonitor::RestartSearch ( )

virtualinherited

Restart the search.

◆ solver()

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

inlineinherited

Definition at line 3645 of file constraint_solver.h.

Member Data Documentation

◆ kNoProgress

const int operations_research::SearchMonitor::kNoProgress = -1

staticinherited

Definition at line 3574 of file constraint_solver.h.

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

constraint_solveri.h

Detailed Description

Public Member Functions

Static Public Attributes

Constructor & Destructor Documentation

◆ LocalSearchMonitor()

◆ ~LocalSearchMonitor()

Member Function Documentation

◆ Accept()

◆ AcceptDelta()

◆ AcceptNeighbor()

◆ AcceptSolution()

◆ AcceptUncheckedNeighbor()

◆ AfterDecision()

◆ ApplyDecision()

◆ AtSolution()

◆ BeginAcceptNeighbor()

◆ BeginFail()

◆ BeginFiltering()

◆ BeginFilterNeighbor()

◆ BeginInitialPropagation()

◆ BeginMakeNextNeighbor()

◆ BeginNextDecision()

◆ BeginOperatorStart()

◆ DebugString()

◆ EndAcceptNeighbor()

◆ EndFail()

◆ EndFiltering()

◆ EndFilterNeighbor()

◆ EndInitialPropagation()

◆ EndMakeNextNeighbor()

◆ EndNextDecision()

◆ EndOperatorStart()

◆ EnterSearch()

◆ ExitSearch()

◆ Install()

◆ IsUncheckedSolutionLimitReached()

◆ LocalOptimum()

◆ NoMoreSolutions()

◆ PeriodicCheck()

◆ ProgressPercent()

◆ RefuteDecision()

◆ RestartSearch()

◆ solver()

Member Data Documentation

◆ kNoProgress