Detailed Description

Definition at line 3799 of file local_search.cc.

Public Member Functions
	LocalSearchProfiler (Solver *solver)

std::string	DebugString () const override

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

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

template<typename Callback >
void	ParseFirstSolutionStatistics (const Callback &callback) const

template<typename Callback >
void	ParseLocalSearchOperatorStatistics (const Callback &callback) const

template<typename Callback >
void	ParseLocalSearchFilterStatistics (const Callback &callback) const

LocalSearchStatistics	ExportToLocalSearchStatistics () const

std::string	PrintOverview () const

void	BeginOperatorStart () override
	Local search operator events. More...

void	EndOperatorStart () override

void	BeginMakeNextNeighbor (const LocalSearchOperator *op) override

void	EndMakeNextNeighbor (const LocalSearchOperator op, bool neighbor_found, const Assignment delta, const Assignment *deltadelta) override

void	BeginFilterNeighbor (const LocalSearchOperator *op) override

void	EndFilterNeighbor (const LocalSearchOperator *op, bool neighbor_found) override

void	BeginAcceptNeighbor (const LocalSearchOperator *op) override

void	EndAcceptNeighbor (const LocalSearchOperator *op, bool neighbor_found) override

void	BeginFiltering (const LocalSearchFilter *filter) override

void	EndFiltering (const LocalSearchFilter *filter, bool reject) override

void	AddFirstSolutionProfiledDecisionBuilder (ProfiledDecisionBuilder *profiled_db)

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

virtual void	EnterSearch ()
	Beginning 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...

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...

Solver *	solver () const

Static Public Attributes
static constexpr int	kNoProgress = -1

Protected Member Functions
void	ListenToEvent (Solver::MonitorEvent event)

Constructor & Destructor Documentation

◆ LocalSearchProfiler()

LocalSearchProfiler ( Solver * solver )

inlineexplicit

Definition at line 3801 of file local_search.cc.

Member Function Documentation

◆ Accept()

void Accept ( ModelVisitor *const visitor ) const

virtualinherited

Accepts the given model visitor.

Reimplemented in RegularLimit, and OptimizeVar.

Definition at line 2929 of file constraint_solver.cc.

◆ AcceptDelta()

bool AcceptDelta	(	Assignment *	delta,
		Assignment *	deltadelta
	)

virtualinherited

Reimplemented in OptimizeVar.

Definition at line 2923 of file constraint_solver.cc.

◆ AcceptNeighbor()

void AcceptNeighbor ( )

virtualinherited

After accepting a neighbor during local search.

Definition at line 2926 of file constraint_solver.cc.

◆ AcceptSolution()

bool 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 OptimizeVar.

Definition at line 2919 of file constraint_solver.cc.

◆ AcceptUncheckedNeighbor()

void AcceptUncheckedNeighbor ( )

virtualinherited

After accepting an unchecked neighbor during local search.

Reimplemented in SearchLog.

Definition at line 2927 of file constraint_solver.cc.

◆ AddFirstSolutionProfiledDecisionBuilder()

void AddFirstSolutionProfiledDecisionBuilder ( ProfiledDecisionBuilder * profiled_db )

inline

Definition at line 4054 of file local_search.cc.

◆ AfterDecision()

void 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.

Definition at line 2914 of file constraint_solver.cc.

◆ ApplyDecision()

void ApplyDecision ( Decision *const d )

virtualinherited

Before applying the decision.

Reimplemented in SearchLog.

Definition at line 2912 of file constraint_solver.cc.

◆ AtSolution()

bool 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 SearchLog, ImprovementSearchLimit, and OptimizeVar.

Definition at line 2920 of file constraint_solver.cc.

◆ BeginAcceptNeighbor()

void BeginAcceptNeighbor ( const LocalSearchOperator * op )

inlineoverridevirtual

Implements LocalSearchMonitor.

Definition at line 4033 of file local_search.cc.

◆ BeginFail()

void BeginFail ( )

virtualinherited

Just when the failure occurs.

Reimplemented in DemonProfiler, and SearchLog.

Definition at line 2915 of file constraint_solver.cc.

◆ BeginFiltering()

void BeginFiltering ( const LocalSearchFilter * filter )

inlineoverridevirtual

Implements LocalSearchMonitor.

Definition at line 4040 of file local_search.cc.

◆ BeginFilterNeighbor()

void BeginFilterNeighbor ( const LocalSearchOperator * op )

inlineoverridevirtual

Implements LocalSearchMonitor.

Definition at line 4026 of file local_search.cc.

◆ BeginInitialPropagation()

void BeginInitialPropagation ( )

virtualinherited

Before the initial propagation.

Reimplemented in SearchLog.

Definition at line 2917 of file constraint_solver.cc.

◆ BeginMakeNextNeighbor()

void BeginMakeNextNeighbor ( const LocalSearchOperator * op )

inlineoverridevirtual

Implements LocalSearchMonitor.

Definition at line 4013 of file local_search.cc.

◆ BeginNextDecision()

void BeginNextDecision ( DecisionBuilder *const b )

virtualinherited

Before calling DecisionBuilder::Next.

Reimplemented in OptimizeVar, and SearchLimit.

Definition at line 2909 of file constraint_solver.cc.

◆ BeginOperatorStart()

void BeginOperatorStart ( )

inlineoverridevirtual

Local search operator events.

Implements LocalSearchMonitor.

Definition at line 4011 of file local_search.cc.

◆ DebugString()

std::string DebugString ( ) const

inlineoverridevirtual

Reimplemented from LocalSearchMonitor.

Definition at line 3802 of file local_search.cc.

◆ EndAcceptNeighbor()

void EndAcceptNeighbor	(	const LocalSearchOperator *	op,
		bool	neighbor_found
	)

inlineoverridevirtual

Implements LocalSearchMonitor.

Definition at line 4034 of file local_search.cc.

◆ EndFail()

void EndFail ( )

virtualinherited

After completing the backtrack.

Definition at line 2916 of file constraint_solver.cc.

◆ EndFiltering()

void EndFiltering	(	const LocalSearchFilter *	filter,
		bool	reject
	)

inlineoverridevirtual

Implements LocalSearchMonitor.

Definition at line 4046 of file local_search.cc.

◆ EndFilterNeighbor()

void EndFilterNeighbor	(	const LocalSearchOperator *	op,
		bool	neighbor_found
	)

inlineoverridevirtual

Implements LocalSearchMonitor.

Definition at line 4027 of file local_search.cc.

◆ EndInitialPropagation()

void EndInitialPropagation ( )

virtualinherited

After the initial propagation.

Reimplemented in SearchLog.

Definition at line 2918 of file constraint_solver.cc.

◆ EndMakeNextNeighbor()

void EndMakeNextNeighbor	(	const LocalSearchOperator *	op,
		bool	neighbor_found,
		const Assignment *	delta,
		const Assignment *	deltadelta
	)

inlineoverridevirtual

Implements LocalSearchMonitor.

Definition at line 4019 of file local_search.cc.

◆ EndNextDecision()

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

virtualinherited

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

Reimplemented in SymmetryManager.

Definition at line 2910 of file constraint_solver.cc.

◆ EndOperatorStart()

void EndOperatorStart ( )

inlineoverridevirtual

Implements LocalSearchMonitor.

Definition at line 4012 of file local_search.cc.

◆ EnterSearch()

void EnterSearch ( )

virtualinherited

Beginning of the search.

Reimplemented in SearchLog, SearchLimit, OptimizeVar, and SolutionCollector.

Definition at line 2906 of file constraint_solver.cc.

◆ ExitSearch()

void ExitSearch ( )

inlineoverridevirtual

End of the search.

Reimplemented from SearchMonitor.

Definition at line 3807 of file local_search.cc.

◆ ExportToLocalSearchStatistics()

LocalSearchStatistics ExportToLocalSearchStatistics ( ) const

inline

Definition at line 3861 of file local_search.cc.

◆ Install()

void Install ( )

inlineoverridevirtual

Install itself on the solver.

Reimplemented from LocalSearchMonitor.

Definition at line 4058 of file local_search.cc.

◆ IsUncheckedSolutionLimitReached()

virtual bool IsUncheckedSolutionLimitReached ( )

inlinevirtualinherited

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

Reimplemented in RegularLimit.

Definition at line 3827 of file constraint_solver.h.

◆ ListenToEvent()

void ListenToEvent ( Solver::MonitorEvent event )

protectedinherited

Definition at line 2938 of file constraint_solver.cc.

◆ LocalOptimum()

bool 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.

Definition at line 2922 of file constraint_solver.cc.

◆ NoMoreSolutions()

void NoMoreSolutions ( )

virtualinherited

When the search tree is finished.

Reimplemented in SearchLog.

Definition at line 2921 of file constraint_solver.cc.

◆ ParseFirstSolutionStatistics()

void ParseFirstSolutionStatistics ( const Callback & callback ) const

inline

Definition at line 3814 of file local_search.cc.

◆ ParseLocalSearchFilterStatistics()

void ParseLocalSearchFilterStatistics ( const Callback & callback ) const

inline

Definition at line 3841 of file local_search.cc.

◆ ParseLocalSearchOperatorStatistics()

void ParseLocalSearchOperatorStatistics ( const Callback & callback ) const

inline

Definition at line 3822 of file local_search.cc.

◆ PeriodicCheck()

void PeriodicCheck ( )

virtualinherited

Periodic call to check limits in long running methods.

Reimplemented in SearchLimit.

Definition at line 2928 of file constraint_solver.cc.

◆ PrintOverview()

std::string PrintOverview ( ) const

inline

Definition at line 3911 of file local_search.cc.

◆ ProgressPercent()

virtual int ProgressPercent ( )

inlinevirtualinherited

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

Reimplemented in RegularLimit.

Definition at line 3834 of file constraint_solver.h.

◆ RefuteDecision()

void RefuteDecision ( Decision *const d )

virtualinherited

Before refuting the decision.

Reimplemented in SymmetryManager, SearchLog, SearchLimit, and OptimizeVar.

Definition at line 2913 of file constraint_solver.cc.

◆ RestartSearch()

void RestartSearch ( )

inlineoverridevirtual

Restart the search.

Reimplemented from SearchMonitor.

Definition at line 3803 of file local_search.cc.

◆ solver()

Solver* solver ( ) const

inlineinherited

Definition at line 3844 of file constraint_solver.h.

Member Data Documentation

◆ kNoProgress

constexpr int kNoProgress = -1

staticconstexprinherited

Definition at line 3758 of file constraint_solver.h.

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

local_search.cc

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Constructor & Destructor Documentation

◆ LocalSearchProfiler()

Member Function Documentation

◆ Accept()

◆ AcceptDelta()

◆ AcceptNeighbor()

◆ AcceptSolution()

◆ AcceptUncheckedNeighbor()

◆ AddFirstSolutionProfiledDecisionBuilder()

◆ AfterDecision()

◆ ApplyDecision()

◆ AtSolution()

◆ BeginAcceptNeighbor()

◆ BeginFail()

◆ BeginFiltering()

◆ BeginFilterNeighbor()

◆ BeginInitialPropagation()

◆ BeginMakeNextNeighbor()

◆ BeginNextDecision()

◆ BeginOperatorStart()

◆ DebugString()

◆ EndAcceptNeighbor()

◆ EndFail()

◆ EndFiltering()

◆ EndFilterNeighbor()

◆ EndInitialPropagation()

◆ EndMakeNextNeighbor()

◆ EndNextDecision()

◆ EndOperatorStart()

◆ EnterSearch()

◆ ExitSearch()

◆ ExportToLocalSearchStatistics()

◆ Install()

◆ IsUncheckedSolutionLimitReached()

◆ ListenToEvent()

◆ LocalOptimum()

◆ NoMoreSolutions()

◆ ParseFirstSolutionStatistics()

◆ ParseLocalSearchFilterStatistics()

◆ ParseLocalSearchOperatorStatistics()

◆ PeriodicCheck()

◆ PrintOverview()

◆ ProgressPercent()

◆ RefuteDecision()

◆ RestartSearch()

◆ solver()

Member Data Documentation

◆ kNoProgress