Detailed Description

Usual limit based on wall_time, number of explored branches and number of failures in the search tree.

Definition at line 4412 of file constraint_solver.h.

Public Member Functions
	RegularLimit (Solver *const s, absl::Duration time, int64_t branches, int64_t failures, int64_t solutions, bool smart_time_check, bool cumulative)

	~RegularLimit () override

void	Copy (const SearchLimit *const limit) override
	Copy a limit. More...

SearchLimit *	MakeClone () const override
	Allocates a clone of the limit. More...

RegularLimit *	MakeIdenticalClone () const

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

void	Init () override
	This method is called when the search limit is initialized. More...

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

void	UpdateLimits (absl::Duration time, int64_t branches, int64_t failures, int64_t solutions)

absl::Duration	duration_limit () const

int64_t	wall_time () const

int64_t	branches () const

int64_t	failures () const

int64_t	solutions () const

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

int	ProgressPercent () override
	Returns a percentage representing the propress of the search before reaching limits. 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...

absl::Time	AbsoluteSolverDeadline () const

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

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

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

virtual void	RestartSearch ()
	Restart 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...

Solver *	solver () const

Static Public Attributes
static constexpr int	kNoProgress = -1

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

Constructor & Destructor Documentation

◆ RegularLimit()

RegularLimit	(	Solver *const	s,
		absl::Duration	time,
		int64_t	branches,
		int64_t	failures,
		int64_t	solutions,
		bool	smart_time_check,
		bool	cumulative
	)

◆ ~RegularLimit()

~RegularLimit ( )

override

Member Function Documentation

◆ AbsoluteSolverDeadline()

absl::Time AbsoluteSolverDeadline ( ) const

inline

Definition at line 4440 of file constraint_solver.h.

◆ Accept()

void Accept ( ModelVisitor *const visitor ) const

overridevirtual

Accepts the given model visitor.

Reimplemented from SearchMonitor.

◆ AcceptDelta()

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

virtualinherited

Reimplemented in OptimizeVar.

◆ AcceptNeighbor()

virtual void AcceptNeighbor ( )

virtualinherited

After accepting a neighbor during local search.

◆ AcceptSolution()

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

◆ AcceptUncheckedNeighbor()

virtual void AcceptUncheckedNeighbor ( )

virtualinherited

After accepting an unchecked neighbor during local search.

Reimplemented in SearchLog.

◆ AfterDecision()

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

◆ ApplyDecision()

virtual void ApplyDecision ( Decision *const d )

virtualinherited

Before applying the decision.

Reimplemented in SearchLog.

◆ AtSolution()

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

◆ BeginFail()

virtual void BeginFail ( )

virtualinherited

Just when the failure occurs.

Reimplemented in SearchLog.

◆ BeginInitialPropagation()

virtual void BeginInitialPropagation ( )

virtualinherited

Before the initial propagation.

Reimplemented in SearchLog.

◆ BeginNextDecision()

void BeginNextDecision ( DecisionBuilder *const b )

overridevirtualinherited

Before calling DecisionBuilder::Next.

Reimplemented from SearchMonitor.

◆ branches()

int64_t branches ( ) const

inline

Definition at line 4432 of file constraint_solver.h.

◆ Check()

bool Check ( )

inlineinherited

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()

bool CheckWithOffset ( absl::Duration offset )

overridevirtual

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

Implements SearchLimit.

◆ Copy()

void Copy ( const SearchLimit *const limit )

overridevirtual

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.

Implements SearchLimit.

◆ crossed()

bool crossed ( ) const

inlineinherited

Returns true if the limit has been crossed.

Definition at line 4372 of file constraint_solver.h.

◆ DebugString()

std::string DebugString ( ) const

overridevirtual

Reimplemented from SearchLimit.

◆ duration_limit()

absl::Duration duration_limit ( ) const

inline

Definition at line 4426 of file constraint_solver.h.

◆ EndFail()

virtual void EndFail ( )

virtualinherited

After completing the backtrack.

◆ EndInitialPropagation()

virtual void EndInitialPropagation ( )

virtualinherited

After the initial propagation.

Reimplemented in SearchLog.

◆ EndNextDecision()

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

virtualinherited

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

◆ EnterSearch()

void EnterSearch ( )

overridevirtualinherited

Internal methods.

Reimplemented from SearchMonitor.

◆ ExitSearch()

void ExitSearch ( )

overridevirtual

End of the search.

Reimplemented from SearchMonitor.

◆ failures()

int64_t failures ( ) const

inline

Definition at line 4433 of file constraint_solver.h.

◆ Init()

void Init ( )

overridevirtual

This method is called when the search limit is initialized.

Implements SearchLimit.

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

◆ IsUncheckedSolutionLimitReached()

bool IsUncheckedSolutionLimitReached ( )

overridevirtual

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

Reimplemented from SearchMonitor.

◆ ListenToEvent()

void ListenToEvent ( Solver::MonitorEvent event )

protectedinherited

◆ LocalOptimum()

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

◆ MakeClone()

SearchLimit* MakeClone ( ) const

overridevirtual

Allocates a clone of the limit.

Implements SearchLimit.

◆ MakeIdenticalClone()

RegularLimit* MakeIdenticalClone ( ) const

◆ NoMoreSolutions()

virtual void NoMoreSolutions ( )

virtualinherited

When the search tree is finished.

Reimplemented in SearchLog.

◆ PeriodicCheck()

void PeriodicCheck ( )

overridevirtualinherited

Periodic call to check limits in long running methods.

Reimplemented from SearchMonitor.

◆ ProgressPercent()

int ProgressPercent ( )

overridevirtual

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

Reimplemented from SearchMonitor.

◆ RefuteDecision()

void RefuteDecision ( Decision *const d )

overridevirtualinherited

Before refuting the decision.

Reimplemented from SearchMonitor.

◆ RestartSearch()

virtual void RestartSearch ( )

virtualinherited

Restart the search.

◆ solutions()

int64_t solutions ( ) const

inline

Definition at line 4434 of file constraint_solver.h.

◆ solver()

Solver* solver ( ) const

inlineinherited

Definition at line 3844 of file constraint_solver.h.

◆ UpdateLimits()

void UpdateLimits	(	absl::Duration	time,
		int64_t	branches,
		int64_t	failures,
		int64_t	solutions
	)

◆ wall_time()

int64_t wall_time ( ) const

inline

Definition at line 4427 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:

constraint_solver.h

C++ Reference

C++ Reference: Routing

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Constructor & Destructor Documentation

◆ RegularLimit()

◆ ~RegularLimit()

Member Function Documentation

◆ AbsoluteSolverDeadline()

◆ Accept()

◆ AcceptDelta()

◆ AcceptNeighbor()

◆ AcceptSolution()

◆ AcceptUncheckedNeighbor()

◆ AfterDecision()

◆ ApplyDecision()

◆ AtSolution()

◆ BeginFail()

◆ BeginInitialPropagation()

◆ BeginNextDecision()

◆ branches()

◆ Check()

◆ CheckWithOffset()

◆ Copy()

◆ crossed()

◆ DebugString()

◆ duration_limit()

◆ EndFail()

◆ EndInitialPropagation()

◆ EndNextDecision()

◆ EnterSearch()

◆ ExitSearch()

◆ failures()

◆ Init()

◆ Install()

◆ IsUncheckedSolutionLimitReached()

◆ ListenToEvent()

◆ LocalOptimum()

◆ MakeClone()

◆ MakeIdenticalClone()

◆ NoMoreSolutions()

◆ PeriodicCheck()

◆ ProgressPercent()

◆ RefuteDecision()

◆ RestartSearch()

◆ solutions()

◆ solver()

◆ UpdateLimits()

◆ wall_time()

Member Data Documentation

◆ kNoProgress