Detailed Description

Definition at line 1859 of file constraint_solveri.h.

Public Member Functions
	PropagationMonitor (Solver *const solver)

	~PropagationMonitor () override

std::string	DebugString () const override

virtual void	BeginConstraintInitialPropagation (Constraint *const constraint)=0
	Propagation events. More...

virtual void	EndConstraintInitialPropagation (Constraint *const constraint)=0

virtual void	BeginNestedConstraintInitialPropagation (Constraint const parent, Constraint const nested)=0

virtual void	EndNestedConstraintInitialPropagation (Constraint const parent, Constraint const nested)=0

virtual void	RegisterDemon (Demon *const demon)=0

virtual void	BeginDemonRun (Demon *const demon)=0

virtual void	EndDemonRun (Demon *const demon)=0

virtual void	StartProcessingIntegerVariable (IntVar *const var)=0

virtual void	EndProcessingIntegerVariable (IntVar *const var)=0

virtual void	PushContext (const std::string &context)=0

virtual void	PopContext ()=0

virtual void	SetMin (IntExpr *const expr, int64_t new_min)=0
	IntExpr modifiers. More...

virtual void	SetMax (IntExpr *const expr, int64_t new_max)=0

virtual void	SetRange (IntExpr *const expr, int64_t new_min, int64_t new_max)=0

virtual void	SetMin (IntVar *const var, int64_t new_min)=0
	IntVar modifiers. More...

virtual void	SetMax (IntVar *const var, int64_t new_max)=0

virtual void	SetRange (IntVar *const var, int64_t new_min, int64_t new_max)=0

virtual void	RemoveValue (IntVar *const var, int64_t value)=0

virtual void	SetValue (IntVar *const var, int64_t value)=0

virtual void	RemoveInterval (IntVar *const var, int64_t imin, int64_t imax)=0

virtual void	SetValues (IntVar *const var, const std::vector< int64_t > &values)=0

virtual void	RemoveValues (IntVar *const var, const std::vector< int64_t > &values)=0

virtual void	SetStartMin (IntervalVar *const var, int64_t new_min)=0
	IntervalVar modifiers. More...

virtual void	SetStartMax (IntervalVar *const var, int64_t new_max)=0

virtual void	SetStartRange (IntervalVar *const var, int64_t new_min, int64_t new_max)=0

virtual void	SetEndMin (IntervalVar *const var, int64_t new_min)=0

virtual void	SetEndMax (IntervalVar *const var, int64_t new_max)=0

virtual void	SetEndRange (IntervalVar *const var, int64_t new_min, int64_t new_max)=0

virtual void	SetDurationMin (IntervalVar *const var, int64_t new_min)=0

virtual void	SetDurationMax (IntervalVar *const var, int64_t new_max)=0

virtual void	SetDurationRange (IntervalVar *const var, int64_t new_min, int64_t new_max)=0

virtual void	SetPerformed (IntervalVar *const var, bool value)=0

virtual void	RankFirst (SequenceVar *const var, int index)=0
	SequenceVar modifiers. More...

virtual void	RankNotFirst (SequenceVar *const var, int index)=0

virtual void	RankLast (SequenceVar *const var, int index)=0

virtual void	RankNotLast (SequenceVar *const var, int index)=0

virtual void	RankSequence (SequenceVar *const var, const std::vector< int > &rank_first, const std::vector< int > &rank_last, const std::vector< int > &unperformed)=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...

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

◆ PropagationMonitor()

PropagationMonitor ( Solver *const solver )

explicit

Definition at line 2943 of file constraint_solver.cc.

◆ ~PropagationMonitor()

~PropagationMonitor ( )

override

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

◆ BeginConstraintInitialPropagation()

virtual void BeginConstraintInitialPropagation ( Constraint *const constraint )

pure virtual

Propagation events.

Implemented in DemonProfiler, and Trace.

◆ BeginDemonRun()

virtual void BeginDemonRun ( Demon *const demon )

pure virtual

Implemented in DemonProfiler, and Trace.

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

◆ BeginNestedConstraintInitialPropagation()

virtual void BeginNestedConstraintInitialPropagation	(	Constraint *const	parent,
		Constraint *const	nested
	)

pure virtual

Implemented in Trace, and DemonProfiler.

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

◆ DebugString()

std::string DebugString ( ) const

inlineoverridevirtual

Reimplemented from BaseObject.

Reimplemented in DemonProfiler.

Definition at line 1863 of file constraint_solveri.h.

◆ EndConstraintInitialPropagation()

virtual void EndConstraintInitialPropagation ( Constraint *const constraint )

pure virtual

Implemented in DemonProfiler, and Trace.

◆ EndDemonRun()

virtual void EndDemonRun ( Demon *const demon )

pure virtual

Implemented in DemonProfiler, and Trace.

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

◆ EndNestedConstraintInitialPropagation()

virtual void EndNestedConstraintInitialPropagation	(	Constraint *const	parent,
		Constraint *const	nested
	)

pure virtual

Implemented in Trace, and DemonProfiler.

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

◆ EndProcessingIntegerVariable()

virtual void EndProcessingIntegerVariable ( IntVar *const var )

pure virtual

Implemented in DemonProfiler, and Trace.

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

virtualinherited

End of the search.

Reimplemented in LocalSearchProfiler, SearchLog, and RegularLimit.

Definition at line 2908 of file constraint_solver.cc.

◆ Install()

void Install ( )

overridevirtual

Install itself on the solver.

Reimplemented from SearchMonitor.

Reimplemented in DemonProfiler.

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

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

◆ PopContext()

virtual void PopContext ( )

pure virtual

Implemented in DemonProfiler, and Trace.

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

◆ PushContext()

virtual void PushContext ( const std::string & context )

pure virtual

Implemented in DemonProfiler, and Trace.

◆ RankFirst()

virtual void RankFirst	(	SequenceVar *const	var,
		int	index
	)

pure virtual

SequenceVar modifiers.

Implemented in DemonProfiler, and Trace.

◆ RankLast()

virtual void RankLast	(	SequenceVar *const	var,
		int	index
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ RankNotFirst()

virtual void RankNotFirst	(	SequenceVar *const	var,
		int	index
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ RankNotLast()

virtual void RankNotLast	(	SequenceVar *const	var,
		int	index
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ RankSequence()

virtual void RankSequence	(	SequenceVar *const	var,
		const std::vector< int > &	rank_first,
		const std::vector< int > &	rank_last,
		const std::vector< int > &	unperformed
	)

pure virtual

Implemented in DemonProfiler, and Trace.

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

◆ RegisterDemon()

virtual void RegisterDemon ( Demon *const demon )

pure virtual

Implemented in DemonProfiler, and Trace.

◆ RemoveInterval()

virtual void RemoveInterval	(	IntVar *const	var,
		int64_t	imin,
		int64_t	imax
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ RemoveValue()

virtual void RemoveValue	(	IntVar *const	var,
		int64_t	value
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ RemoveValues()

virtual void RemoveValues	(	IntVar *const	var,
		const std::vector< int64_t > &	values
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ RestartSearch()

void RestartSearch ( )

virtualinherited

Restart the search.

Reimplemented in LocalSearchProfiler, and DemonProfiler.

Definition at line 2907 of file constraint_solver.cc.

◆ SetDurationMax()

virtual void SetDurationMax	(	IntervalVar *const	var,
		int64_t	new_max
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetDurationMin()

virtual void SetDurationMin	(	IntervalVar *const	var,
		int64_t	new_min
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetDurationRange()

virtual void SetDurationRange	(	IntervalVar *const	var,
		int64_t	new_min,
		int64_t	new_max
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetEndMax()

virtual void SetEndMax	(	IntervalVar *const	var,
		int64_t	new_max
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetEndMin()

virtual void SetEndMin	(	IntervalVar *const	var,
		int64_t	new_min
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetEndRange()

virtual void SetEndRange	(	IntervalVar *const	var,
		int64_t	new_min,
		int64_t	new_max
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetMax() [1/2]

virtual void SetMax	(	IntExpr *const	expr,
		int64_t	new_max
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetMax() [2/2]

virtual void SetMax	(	IntVar *const	var,
		int64_t	new_max
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetMin() [1/2]

virtual void SetMin	(	IntExpr *const	expr,
		int64_t	new_min
	)

pure virtual

IntExpr modifiers.

Implemented in DemonProfiler, and Trace.

◆ SetMin() [2/2]

virtual void SetMin	(	IntVar *const	var,
		int64_t	new_min
	)

pure virtual

IntVar modifiers.

Implemented in DemonProfiler, and Trace.

◆ SetPerformed()

virtual void SetPerformed	(	IntervalVar *const	var,
		bool	value
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetRange() [1/2]

virtual void SetRange	(	IntExpr *const	expr,
		int64_t	new_min,
		int64_t	new_max
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetRange() [2/2]

virtual void SetRange	(	IntVar *const	var,
		int64_t	new_min,
		int64_t	new_max
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetStartMax()

virtual void SetStartMax	(	IntervalVar *const	var,
		int64_t	new_max
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetStartMin()

virtual void SetStartMin	(	IntervalVar *const	var,
		int64_t	new_min
	)

pure virtual

IntervalVar modifiers.

Implemented in DemonProfiler, and Trace.

◆ SetStartRange()

virtual void SetStartRange	(	IntervalVar *const	var,
		int64_t	new_min,
		int64_t	new_max
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetValue()

virtual void SetValue	(	IntVar *const	var,
		int64_t	value
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ SetValues()

virtual void SetValues	(	IntVar *const	var,
		const std::vector< int64_t > &	values
	)

pure virtual

Implemented in DemonProfiler, and Trace.

◆ solver()

Solver* solver ( ) const

inlineinherited

Definition at line 3844 of file constraint_solver.h.

◆ StartProcessingIntegerVariable()

virtual void StartProcessingIntegerVariable ( IntVar *const var )

pure virtual

Implemented in DemonProfiler, and Trace.

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

◆ PropagationMonitor()

◆ ~PropagationMonitor()

Member Function Documentation

◆ Accept()

◆ AcceptDelta()

◆ AcceptNeighbor()

◆ AcceptSolution()

◆ AcceptUncheckedNeighbor()

◆ AfterDecision()

◆ ApplyDecision()

◆ AtSolution()

◆ BeginConstraintInitialPropagation()

◆ BeginDemonRun()

◆ BeginFail()

◆ BeginInitialPropagation()

◆ BeginNestedConstraintInitialPropagation()

◆ BeginNextDecision()

◆ DebugString()

◆ EndConstraintInitialPropagation()

◆ EndDemonRun()

◆ EndFail()

◆ EndInitialPropagation()

◆ EndNestedConstraintInitialPropagation()

◆ EndNextDecision()

◆ EndProcessingIntegerVariable()

◆ EnterSearch()

◆ ExitSearch()

◆ Install()

◆ IsUncheckedSolutionLimitReached()

◆ ListenToEvent()

◆ LocalOptimum()

◆ NoMoreSolutions()

◆ PeriodicCheck()

◆ PopContext()

◆ ProgressPercent()

◆ PushContext()

◆ RankFirst()

◆ RankLast()

◆ RankNotFirst()

◆ RankNotLast()

◆ RankSequence()

◆ RefuteDecision()

◆ RegisterDemon()

◆ RemoveInterval()

◆ RemoveValue()

◆ RemoveValues()

◆ RestartSearch()

◆ SetDurationMax()

◆ SetDurationMin()

◆ SetDurationRange()

◆ SetEndMax()

◆ SetEndMin()

◆ SetEndRange()

◆ SetMax() [1/2]

◆ SetMax() [2/2]

◆ SetMin() [1/2]

◆ SetMin() [2/2]

◆ SetPerformed()

◆ SetRange() [1/2]

◆ SetRange() [2/2]

◆ SetStartMax()

◆ SetStartMin()

◆ SetStartRange()

◆ SetValue()

◆ SetValues()

◆ solver()

◆ StartProcessingIntegerVariable()

Member Data Documentation

◆ kNoProgress