Detailed Description

Definition at line 2969 of file constraint_solver.cc.

Public Member Functions
	Trace (Solver *const s)

	~Trace () override

void	BeginConstraintInitialPropagation (Constraint *const constraint) override
	Propagation events. More...

void	EndConstraintInitialPropagation (Constraint *const constraint) override

void	BeginNestedConstraintInitialPropagation (Constraint const parent, Constraint const nested) override

void	EndNestedConstraintInitialPropagation (Constraint const parent, Constraint const nested) override

void	RegisterDemon (Demon *const demon) override

void	BeginDemonRun (Demon *const demon) override

void	EndDemonRun (Demon *const demon) override

void	StartProcessingIntegerVariable (IntVar *const var) override

void	EndProcessingIntegerVariable (IntVar *const var) override

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

void	PopContext () override

void	SetMin (IntExpr *const expr, int64_t new_min) override
	IntExpr modifiers. More...

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

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

void	SetMin (IntVar *const var, int64_t new_min) override
	IntVar modifiers. More...

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

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

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

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

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

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

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

void	SetStartMin (IntervalVar *const var, int64_t new_min) override
	IntervalVar modifiers. More...

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

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

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

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

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

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

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

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

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

void	RankFirst (SequenceVar *const var, int index) override
	SequenceVar modifiers. More...

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

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

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

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

void	Add (PropagationMonitor *const monitor)

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

std::string	DebugString () const override

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

◆ Trace()

Trace ( Solver *const s )

inlineexplicit

Definition at line 2971 of file constraint_solver.cc.

◆ ~Trace()

~Trace ( )

inlineoverride

Definition at line 2973 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.

◆ Add()

void Add ( PropagationMonitor *const monitor )

inline

Definition at line 3159 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()

void BeginConstraintInitialPropagation ( Constraint *const constraint )

inlineoverridevirtual

Propagation events.

Implements PropagationMonitor.

Definition at line 2975 of file constraint_solver.cc.

◆ BeginDemonRun()

void BeginDemonRun ( Demon *const demon )

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3004 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.

◆ BeginNestedConstraintInitialPropagation()

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

inlineoverridevirtual

Implements PropagationMonitor.

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

◆ DebugString()

std::string DebugString ( ) const

inlineoverridevirtual

Reimplemented from BaseObject.

Definition at line 3169 of file constraint_solver.cc.

◆ EndConstraintInitialPropagation()

void EndConstraintInitialPropagation ( Constraint *const constraint )

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 2981 of file constraint_solver.cc.

◆ EndDemonRun()

void EndDemonRun ( Demon *const demon )

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3008 of file constraint_solver.cc.

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

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

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 2993 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.

◆ EndProcessingIntegerVariable()

void EndProcessingIntegerVariable ( IntVar *const var )

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3016 of file constraint_solver.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 ( )

virtualinherited

End of the search.

Reimplemented in LocalSearchProfiler, SearchLog, and RegularLimit.

Definition at line 2908 of file constraint_solver.cc.

◆ Install()

void Install ( )

inlineoverridevirtual

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.

Definition at line 3167 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()

void PopContext ( )

inlineoverridevirtual

Implements PropagationMonitor.

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

◆ PushContext()

void PushContext ( const std::string & context )

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3020 of file constraint_solver.cc.

◆ RankFirst()

void RankFirst	(	SequenceVar *const	var,
		int	index
	)

inlineoverridevirtual

SequenceVar modifiers.

Implements PropagationMonitor.

Definition at line 3135 of file constraint_solver.cc.

◆ RankLast()

void RankLast	(	SequenceVar *const	var,
		int	index
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3143 of file constraint_solver.cc.

◆ RankNotFirst()

void RankNotFirst	(	SequenceVar *const	var,
		int	index
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3139 of file constraint_solver.cc.

◆ RankNotLast()

void RankNotLast	(	SequenceVar *const	var,
		int	index
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3147 of file constraint_solver.cc.

◆ RankSequence()

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

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3151 of file constraint_solver.cc.

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

void RegisterDemon ( Demon *const demon )

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3000 of file constraint_solver.cc.

◆ RemoveInterval()

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

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3075 of file constraint_solver.cc.

◆ RemoveValue()

void RemoveValue	(	IntVar *const	var,
		int64_t	value
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3067 of file constraint_solver.cc.

◆ RemoveValues()

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

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3084 of file constraint_solver.cc.

◆ RestartSearch()

void RestartSearch ( )

virtualinherited

Restart the search.

Reimplemented in LocalSearchProfiler, and DemonProfiler.

Definition at line 2907 of file constraint_solver.cc.

◆ SetDurationMax()

void SetDurationMax	(	IntervalVar *const	var,
		int64_t	new_max
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3121 of file constraint_solver.cc.

◆ SetDurationMin()

void SetDurationMin	(	IntervalVar *const	var,
		int64_t	new_min
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3117 of file constraint_solver.cc.

◆ SetDurationRange()

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

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3125 of file constraint_solver.cc.

◆ SetEndMax()

void SetEndMax	(	IntervalVar *const	var,
		int64_t	new_max
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3108 of file constraint_solver.cc.

◆ SetEndMin()

void SetEndMin	(	IntervalVar *const	var,
		int64_t	new_min
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3104 of file constraint_solver.cc.

◆ SetEndRange()

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

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3112 of file constraint_solver.cc.

◆ SetMax() [1/2]

void SetMax	(	IntExpr *const	expr,
		int64_t	new_max
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3035 of file constraint_solver.cc.

◆ SetMax() [2/2]

void SetMax	(	IntVar *const	var,
		int64_t	new_max
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3055 of file constraint_solver.cc.

◆ SetMin() [1/2]

void SetMin	(	IntExpr *const	expr,
		int64_t	new_min
	)

inlineoverridevirtual

IntExpr modifiers.

Implements PropagationMonitor.

Definition at line 3029 of file constraint_solver.cc.

◆ SetMin() [2/2]

void SetMin	(	IntVar *const	var,
		int64_t	new_min
	)

inlineoverridevirtual

IntVar modifiers.

Implements PropagationMonitor.

Definition at line 3049 of file constraint_solver.cc.

◆ SetPerformed()

void SetPerformed	(	IntervalVar *const	var,
		bool	value
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3131 of file constraint_solver.cc.

◆ SetRange() [1/2]

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

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3041 of file constraint_solver.cc.

◆ SetRange() [2/2]

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

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3061 of file constraint_solver.cc.

◆ SetStartMax()

void SetStartMax	(	IntervalVar *const	var,
		int64_t	new_max
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3094 of file constraint_solver.cc.

◆ SetStartMin()

void SetStartMin	(	IntervalVar *const	var,
		int64_t	new_min
	)

inlineoverridevirtual

IntervalVar modifiers.

Implements PropagationMonitor.

Definition at line 3090 of file constraint_solver.cc.

◆ SetStartRange()

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

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3098 of file constraint_solver.cc.

◆ SetValue()

void SetValue	(	IntVar *const	var,
		int64_t	value
	)

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3071 of file constraint_solver.cc.

◆ SetValues()

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

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3079 of file constraint_solver.cc.

◆ solver()

Solver* solver ( ) const

inlineinherited

Definition at line 3844 of file constraint_solver.h.

◆ StartProcessingIntegerVariable()

void StartProcessingIntegerVariable ( IntVar *const var )

inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 3012 of file constraint_solver.cc.

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

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Constructor & Destructor Documentation

◆ Trace()

◆ ~Trace()

Member Function Documentation

◆ Accept()

◆ AcceptDelta()

◆ AcceptNeighbor()

◆ AcceptSolution()

◆ AcceptUncheckedNeighbor()

◆ Add()

◆ 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