OR-Tools  8.2
PropagationMonitorabstract

Detailed Description

Definition at line 1851 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 new_min)=0
 IntExpr modifiers. More...
 
virtual void SetMax (IntExpr *const expr, int64 new_max)=0
 
virtual void SetRange (IntExpr *const expr, int64 new_min, int64 new_max)=0
 
virtual void SetMin (IntVar *const var, int64 new_min)=0
 IntVar modifiers. More...
 
virtual void SetMax (IntVar *const var, int64 new_max)=0
 
virtual void SetRange (IntVar *const var, int64 new_min, int64 new_max)=0
 
virtual void RemoveValue (IntVar *const var, int64 value)=0
 
virtual void SetValue (IntVar *const var, int64 value)=0
 
virtual void RemoveInterval (IntVar *const var, int64 imin, int64 imax)=0
 
virtual void SetValues (IntVar *const var, const std::vector< int64 > &values)=0
 
virtual void RemoveValues (IntVar *const var, const std::vector< int64 > &values)=0
 
virtual void SetStartMin (IntervalVar *const var, int64 new_min)=0
 IntervalVar modifiers. More...
 
virtual void SetStartMax (IntervalVar *const var, int64 new_max)=0
 
virtual void SetStartRange (IntervalVar *const var, int64 new_min, int64 new_max)=0
 
virtual void SetEndMin (IntervalVar *const var, int64 new_min)=0
 
virtual void SetEndMax (IntervalVar *const var, int64 new_max)=0
 
virtual void SetEndRange (IntervalVar *const var, int64 new_min, int64 new_max)=0
 
virtual void SetDurationMin (IntervalVar *const var, int64 new_min)=0
 
virtual void SetDurationMax (IntervalVar *const var, int64 new_max)=0
 
virtual void SetDurationRange (IntervalVar *const var, int64 new_min, int64 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...
 
Solversolver () const
 
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...
 

Static Public Attributes

static constexpr int kNoProgress = -1
 

Constructor & Destructor Documentation

◆ PropagationMonitor()

PropagationMonitor ( Solver *const  solver)
explicit

Definition at line 2897 of file constraint_solver.cc.

◆ ~PropagationMonitor()

~PropagationMonitor ( )
override

Definition at line 2900 of file constraint_solver.cc.

Member Function Documentation

◆ Accept()

void Accept ( ModelVisitor *const  visitor) const
virtualinherited

Accepts the given model visitor.

Reimplemented in OptimizeVar, and RegularLimit.

Definition at line 2890 of file constraint_solver.cc.

◆ AcceptDelta()

bool AcceptDelta ( Assignment delta,
Assignment deltadelta 
)
virtualinherited

Reimplemented in OptimizeVar.

Definition at line 2884 of file constraint_solver.cc.

◆ AcceptNeighbor()

void AcceptNeighbor ( )
virtualinherited

After accepting a neighbor during local search.

Definition at line 2887 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 2880 of file constraint_solver.cc.

◆ AcceptUncheckedNeighbor()

void AcceptUncheckedNeighbor ( )
virtualinherited

After accepting an unchecked neighbor during local search.

Reimplemented in SearchLog.

Definition at line 2888 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 2875 of file constraint_solver.cc.

◆ ApplyDecision()

void ApplyDecision ( Decision *const  d)
virtualinherited

Before applying the decision.

Reimplemented in SearchLog.

Definition at line 2873 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 OptimizeVar, ImprovementSearchLimit, and SearchLog.

Definition at line 2881 of file constraint_solver.cc.

◆ BeginConstraintInitialPropagation()

virtual void BeginConstraintInitialPropagation ( Constraint *const  constraint)
pure virtual

Propagation events.

Implemented in Trace, and DemonProfiler.

◆ BeginDemonRun()

virtual void BeginDemonRun ( Demon *const  demon)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ BeginFail()

void BeginFail ( )
virtualinherited

Just when the failure occurs.

Reimplemented in SearchLog, and DemonProfiler.

Definition at line 2876 of file constraint_solver.cc.

◆ BeginInitialPropagation()

void BeginInitialPropagation ( )
virtualinherited

Before the initial propagation.

Reimplemented in SearchLog.

Definition at line 2878 of file constraint_solver.cc.

◆ BeginNestedConstraintInitialPropagation()

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

Implemented in DemonProfiler, and Trace.

◆ BeginNextDecision()

void BeginNextDecision ( DecisionBuilder *const  b)
virtualinherited

Before calling DecisionBuilder::Next.

Reimplemented in SearchLimit, and OptimizeVar.

Definition at line 2870 of file constraint_solver.cc.

◆ DebugString()

std::string DebugString ( ) const
inlineoverridevirtual

Reimplemented from BaseObject.

Reimplemented in DemonProfiler.

Definition at line 1855 of file constraint_solveri.h.

◆ EndConstraintInitialPropagation()

virtual void EndConstraintInitialPropagation ( Constraint *const  constraint)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ EndDemonRun()

virtual void EndDemonRun ( Demon *const  demon)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ EndFail()

void EndFail ( )
virtualinherited

After completing the backtrack.

Definition at line 2877 of file constraint_solver.cc.

◆ EndInitialPropagation()

void EndInitialPropagation ( )
virtualinherited

After the initial propagation.

Reimplemented in SearchLog.

Definition at line 2879 of file constraint_solver.cc.

◆ EndNestedConstraintInitialPropagation()

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

Implemented in DemonProfiler, and Trace.

◆ 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 2871 of file constraint_solver.cc.

◆ EndProcessingIntegerVariable()

virtual void EndProcessingIntegerVariable ( IntVar *const  var)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ EnterSearch()

void EnterSearch ( )
virtualinherited

Beginning of the search.

Reimplemented in SolutionCollector, OptimizeVar, SearchLimit, and SearchLog.

Definition at line 2867 of file constraint_solver.cc.

◆ ExitSearch()

void ExitSearch ( )
virtualinherited

End of the search.

Reimplemented in RegularLimit, SearchLog, and LocalSearchProfiler.

Definition at line 2869 of file constraint_solver.cc.

◆ Install()

void Install ( )
overridevirtual

Install itself on the solver.

Reimplemented from SearchMonitor.

Reimplemented in DemonProfiler.

Definition at line 2903 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 3706 of file constraint_solver.h.

◆ 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 2883 of file constraint_solver.cc.

◆ NoMoreSolutions()

void NoMoreSolutions ( )
virtualinherited

When the search tree is finished.

Reimplemented in SearchLog.

Definition at line 2882 of file constraint_solver.cc.

◆ PeriodicCheck()

void PeriodicCheck ( )
virtualinherited

Periodic call to check limits in long running methods.

Reimplemented in SearchLimit.

Definition at line 2889 of file constraint_solver.cc.

◆ PopContext()

virtual void PopContext ( )
pure virtual

Implemented in Trace, and DemonProfiler.

◆ ProgressPercent()

virtual int ProgressPercent ( )
inlinevirtualinherited

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

Reimplemented in RegularLimit.

Definition at line 3715 of file constraint_solver.h.

◆ PushContext()

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

Implemented in Trace, and DemonProfiler.

◆ RankFirst()

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

SequenceVar modifiers.

Implemented in Trace, and DemonProfiler.

◆ RankLast()

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

Implemented in Trace, and DemonProfiler.

◆ RankNotFirst()

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

Implemented in Trace, and DemonProfiler.

◆ RankNotLast()

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

Implemented in Trace, and DemonProfiler.

◆ 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 Trace, and DemonProfiler.

◆ RefuteDecision()

void RefuteDecision ( Decision *const  d)
virtualinherited

Before refuting the decision.

Reimplemented in OptimizeVar, SearchLimit, SearchLog, and SymmetryManager.

Definition at line 2874 of file constraint_solver.cc.

◆ RegisterDemon()

virtual void RegisterDemon ( Demon *const  demon)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ RemoveInterval()

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

Implemented in Trace, and DemonProfiler.

◆ RemoveValue()

virtual void RemoveValue ( IntVar *const  var,
int64  value 
)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ RemoveValues()

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

Implemented in Trace, and DemonProfiler.

◆ RestartSearch()

void RestartSearch ( )
virtualinherited

Restart the search.

Reimplemented in DemonProfiler, and LocalSearchProfiler.

Definition at line 2868 of file constraint_solver.cc.

◆ SetDurationMax()

virtual void SetDurationMax ( IntervalVar *const  var,
int64  new_max 
)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ SetDurationMin()

virtual void SetDurationMin ( IntervalVar *const  var,
int64  new_min 
)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ SetDurationRange()

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

Implemented in Trace, and DemonProfiler.

◆ SetEndMax()

virtual void SetEndMax ( IntervalVar *const  var,
int64  new_max 
)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ SetEndMin()

virtual void SetEndMin ( IntervalVar *const  var,
int64  new_min 
)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ SetEndRange()

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

Implemented in Trace, and DemonProfiler.

◆ SetMax() [1/2]

virtual void SetMax ( IntExpr *const  expr,
int64  new_max 
)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ SetMax() [2/2]

virtual void SetMax ( IntVar *const  var,
int64  new_max 
)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ SetMin() [1/2]

virtual void SetMin ( IntExpr *const  expr,
int64  new_min 
)
pure virtual

IntExpr modifiers.

Implemented in Trace, and DemonProfiler.

◆ SetMin() [2/2]

virtual void SetMin ( IntVar *const  var,
int64  new_min 
)
pure virtual

IntVar modifiers.

Implemented in Trace, and DemonProfiler.

◆ SetPerformed()

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

Implemented in Trace, and DemonProfiler.

◆ SetRange() [1/2]

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

Implemented in Trace, and DemonProfiler.

◆ SetRange() [2/2]

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

Implemented in Trace, and DemonProfiler.

◆ SetStartMax()

virtual void SetStartMax ( IntervalVar *const  var,
int64  new_max 
)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ SetStartMin()

virtual void SetStartMin ( IntervalVar *const  var,
int64  new_min 
)
pure virtual

IntervalVar modifiers.

Implemented in Trace, and DemonProfiler.

◆ SetStartRange()

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

Implemented in Trace, and DemonProfiler.

◆ SetValue()

virtual void SetValue ( IntVar *const  var,
int64  value 
)
pure virtual

Implemented in Trace, and DemonProfiler.

◆ SetValues()

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

Implemented in Trace, and DemonProfiler.

◆ solver()

Solver * solver ( ) const
inlineinherited

Definition at line 3708 of file constraint_solver.h.

◆ StartProcessingIntegerVariable()

virtual void StartProcessingIntegerVariable ( IntVar *const  var)
pure virtual

Implemented in Trace, and DemonProfiler.

Member Data Documentation

◆ kNoProgress

constexpr int kNoProgress = -1
staticconstexprinherited

Definition at line 3637 of file constraint_solver.h.


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