Detailed Description

Base class of all search limits.

Definition at line 4366 of file constraint_solver.h.

Public Member Functions
	SearchLimit (Solver *const s)

	~SearchLimit () override

bool	crossed () const
	Returns true if the limit has been crossed. More...

bool	Check ()
	This method is called to check the status of the limit. More...

virtual bool	CheckWithOffset (absl::Duration offset)=0
	Same as Check() but adds the 'offset' value to the current time when time is considered in the limit. More...

virtual void	Init ()=0
	This method is called when the search limit is initialized. More...

virtual void	Copy (const SearchLimit *const limit)=0
	Copy a limit. More...

virtual SearchLimit *	MakeClone () const =0
	Allocates a clone of the limit. More...

void	EnterSearch () override
	Internal methods. More...

void	BeginNextDecision (DecisionBuilder *const b) override
	Before calling DecisionBuilder::Next. More...

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

void	RefuteDecision (Decision *const d) override
	Before refuting the decision. More...

std::string	DebugString () const override

void	Install () override
	Registers itself on the solver such that it gets notified of the search and propagation events. More...

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

virtual void	ExitSearch ()
	End of the search. 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	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 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

◆ SearchLimit()

SearchLimit ( Solver *const s )

inlineexplicit

Definition at line 4368 of file constraint_solver.h.

◆ ~SearchLimit()

~SearchLimit ( )

override

Definition at line 4153 of file 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.

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

◆ BeginFail()

void BeginFail ( )

virtualinherited

Just when the failure occurs.

Reimplemented in DemonProfiler, and SearchLog.

Definition at line 2915 of file constraint_solver.cc.

◆ BeginInitialPropagation()

void BeginInitialPropagation ( )

virtualinherited

Before the initial propagation.

Reimplemented in SearchLog.

Definition at line 2917 of file constraint_solver.cc.

◆ BeginNextDecision()

void BeginNextDecision ( DecisionBuilder *const b )

overridevirtual

Before calling DecisionBuilder::Next.

Reimplemented from SearchMonitor.

Definition at line 4167 of file search.cc.

◆ Check()

bool Check ( )

inline

This method is called to check the status of the limit.

A return value of true indicates that we have indeed crossed the limit. In that case, this method will not be called again and the remaining search will be discarded.

Definition at line 4378 of file constraint_solver.h.

◆ CheckWithOffset()

virtual bool CheckWithOffset ( absl::Duration offset )

pure virtual

Same as Check() but adds the 'offset' value to the current time when time is considered in the limit.

Implemented in ImprovementSearchLimit, and RegularLimit.

◆ Copy()

virtual void Copy ( const SearchLimit *const limit )

pure virtual

Copy a limit.

Warning: leads to a direct (no check) downcasting of 'limit' so one needs to be sure both SearchLimits are of the same type.

Implemented in ImprovementSearchLimit, and RegularLimit.

◆ crossed()

bool crossed ( ) const

inline

Returns true if the limit has been crossed.

Definition at line 4372 of file constraint_solver.h.

◆ DebugString()

std::string DebugString ( ) const

inlineoverridevirtual

Reimplemented from BaseObject.

Reimplemented in RegularLimit.

Definition at line 4398 of file constraint_solver.h.

◆ EndFail()

void EndFail ( )

virtualinherited

After completing the backtrack.

Definition at line 2916 of file constraint_solver.cc.

◆ EndInitialPropagation()

void EndInitialPropagation ( )

virtualinherited

After the initial propagation.

Reimplemented in SearchLog.

Definition at line 2918 of file constraint_solver.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.

◆ EnterSearch()

void EnterSearch ( )

overridevirtual

Internal methods.

Reimplemented from SearchMonitor.

Definition at line 4162 of file search.cc.

◆ ExitSearch()

void ExitSearch ( )

virtualinherited

End of the search.

Reimplemented in LocalSearchProfiler, SearchLog, and RegularLimit.

Definition at line 2908 of file constraint_solver.cc.

◆ Init()

virtual void Init ( )

pure virtual

This method is called when the search limit is initialized.

Implemented in ImprovementSearchLimit, and RegularLimit.

◆ Install()

void Install ( )

overridevirtual

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

Override to incrementally install listeners for specific events.

Reimplemented from SearchMonitor.

Reimplemented in ImprovementSearchLimit, and RegularLimit.

Definition at line 4155 of file 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.

◆ MakeClone()

virtual SearchLimit* MakeClone ( ) const

pure virtual

Allocates a clone of the limit.

Implemented in ImprovementSearchLimit, and RegularLimit.

◆ NoMoreSolutions()

void NoMoreSolutions ( )

virtualinherited

When the search tree is finished.

Reimplemented in SearchLog.

Definition at line 2921 of file constraint_solver.cc.

◆ PeriodicCheck()

void PeriodicCheck ( )

overridevirtual

Periodic call to check limits in long running methods.

Reimplemented from SearchMonitor.

Definition at line 4177 of file 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 )

overridevirtual

Before refuting the decision.

Reimplemented from SearchMonitor.

Definition at line 4172 of file search.cc.

◆ RestartSearch()

void RestartSearch ( )

virtualinherited

Restart the search.

Reimplemented in LocalSearchProfiler, and DemonProfiler.

Definition at line 2907 of file constraint_solver.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 files:

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Constructor & Destructor Documentation

◆ SearchLimit()

◆ ~SearchLimit()

Member Function Documentation

◆ Accept()

◆ AcceptDelta()

◆ AcceptNeighbor()

◆ AcceptSolution()

◆ AcceptUncheckedNeighbor()

◆ AfterDecision()

◆ ApplyDecision()

◆ AtSolution()

◆ BeginFail()

◆ BeginInitialPropagation()

◆ BeginNextDecision()

◆ Check()

◆ CheckWithOffset()

◆ Copy()

◆ crossed()

◆ DebugString()

◆ EndFail()

◆ EndInitialPropagation()

◆ EndNextDecision()

◆ EnterSearch()

◆ ExitSearch()

◆ Init()

◆ Install()

◆ IsUncheckedSolutionLimitReached()

◆ ListenToEvent()

◆ LocalOptimum()

◆ MakeClone()

◆ NoMoreSolutions()

◆ PeriodicCheck()

◆ ProgressPercent()

◆ RefuteDecision()

◆ RestartSearch()

◆ solver()

Member Data Documentation

◆ kNoProgress