OR-Tools  8.2
DemonProfiler

Detailed Description

Definition at line 50 of file demon_profiler.cc.

Public Member Functions

 DemonProfiler (Solver *const solver)
 
 ~DemonProfiler () override
 
int64 CurrentTime () const
 
void BeginConstraintInitialPropagation (Constraint *const constraint) override
 Propagation events. More...
 
void EndConstraintInitialPropagation (Constraint *const constraint) override
 
void BeginNestedConstraintInitialPropagation (Constraint *const constraint, Constraint *const delayed) override
 
void EndNestedConstraintInitialPropagation (Constraint *const constraint, Constraint *const delayed) 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 BeginFail () override
 Just when the failure occurs. More...
 
void RestartSearch () override
 Restart the search. More...
 
void SetMin (IntExpr *const expr, int64 new_min) override
 IntExpr modifiers. More...
 
void SetMax (IntExpr *const expr, int64 new_max) override
 
void SetRange (IntExpr *const expr, int64 new_min, int64 new_max) override
 
void SetMin (IntVar *const var, int64 new_min) override
 IntVar modifiers. More...
 
void SetMax (IntVar *const var, int64 new_max) override
 
void SetRange (IntVar *const var, int64 new_min, int64 new_max) override
 
void RemoveValue (IntVar *const var, int64 value) override
 
void SetValue (IntVar *const var, int64 value) override
 
void RemoveInterval (IntVar *const var, int64 imin, int64 imax) override
 
void SetValues (IntVar *const var, const std::vector< int64 > &values) override
 
void RemoveValues (IntVar *const var, const std::vector< int64 > &values) override
 
void SetStartMin (IntervalVar *const var, int64 new_min) override
 IntervalVar modifiers. More...
 
void SetStartMax (IntervalVar *const var, int64 new_max) override
 
void SetStartRange (IntervalVar *const var, int64 new_min, int64 new_max) override
 
void SetEndMin (IntervalVar *const var, int64 new_min) override
 
void SetEndMax (IntervalVar *const var, int64 new_max) override
 
void SetEndRange (IntervalVar *const var, int64 new_min, int64 new_max) override
 
void SetDurationMin (IntervalVar *const var, int64 new_min) override
 
void SetDurationMax (IntervalVar *const var, int64 new_max) override
 
void SetDurationRange (IntervalVar *const var, int64 new_min, int64 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 AddFakeRun (Demon *const demon, int64 start_time, int64 end_time, bool is_fail)
 
void PrintOverview (Solver *const solver, const std::string &filename)
 
void ExportInformation (const Constraint *const constraint, int64 *const fails, int64 *const initial_propagation_runtime, int64 *const demon_invocations, int64 *const total_demon_runtime, int *demons)
 
void ExportInformation (const DemonRuns *const demon_runs, int64 *const demon_invocations, int64 *const fails, int64 *const total_demon_runtime, double *const mean_demon_runtime, double *const median_demon_runtime, double *const stddev_demon_runtime)
 
void Install () override
 Install itself on the solver. More...
 
std::string DebugString () const override
 
virtual void EnterSearch ()
 Beginning of 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 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

◆ DemonProfiler()

DemonProfiler ( Solver *const  solver)
inlineexplicit

Definition at line 52 of file demon_profiler.cc.

◆ ~DemonProfiler()

~DemonProfiler ( )
inlineoverride

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

◆ AddFakeRun()

void AddFakeRun ( Demon *const  demon,
int64  start_time,
int64  end_time,
bool  is_fail 
)
inline

Definition at line 244 of file demon_profiler.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 SearchLog, ImprovementSearchLimit, and OptimizeVar.

Definition at line 2881 of file constraint_solver.cc.

◆ BeginConstraintInitialPropagation()

void BeginConstraintInitialPropagation ( Constraint *const  constraint)
inlineoverridevirtual

Propagation events.

Implements PropagationMonitor.

Definition at line 69 of file demon_profiler.cc.

◆ BeginDemonRun()

void BeginDemonRun ( Demon *const  demon)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 146 of file demon_profiler.cc.

◆ BeginFail()

void BeginFail ( )
inlineoverridevirtual

Just when the failure occurs.

Reimplemented from SearchMonitor.

Definition at line 177 of file demon_profiler.cc.

◆ BeginInitialPropagation()

void BeginInitialPropagation ( )
virtualinherited

Before the initial propagation.

Reimplemented in SearchLog.

Definition at line 2878 of file constraint_solver.cc.

◆ BeginNestedConstraintInitialPropagation()

void BeginNestedConstraintInitialPropagation ( Constraint *const  constraint,
Constraint *const  delayed 
)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 98 of file demon_profiler.cc.

◆ BeginNextDecision()

void BeginNextDecision ( DecisionBuilder *const  b)
virtualinherited

Before calling DecisionBuilder::Next.

Reimplemented in OptimizeVar, and SearchLimit.

Definition at line 2870 of file constraint_solver.cc.

◆ CurrentTime()

int64 CurrentTime ( ) const
inline

Definition at line 65 of file demon_profiler.cc.

◆ DebugString()

std::string DebugString ( ) const
inlineoverridevirtual

Reimplemented from PropagationMonitor.

Definition at line 418 of file demon_profiler.cc.

◆ EndConstraintInitialPropagation()

void EndConstraintInitialPropagation ( Constraint *const  constraint)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 85 of file demon_profiler.cc.

◆ EndDemonRun()

void EndDemonRun ( Demon *const  demon)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 159 of file demon_profiler.cc.

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

void EndNestedConstraintInitialPropagation ( Constraint *const  constraint,
Constraint *const  delayed 
)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 113 of file demon_profiler.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 2871 of file constraint_solver.cc.

◆ EndProcessingIntegerVariable()

void EndProcessingIntegerVariable ( IntVar *const  var)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 173 of file demon_profiler.cc.

◆ EnterSearch()

void EnterSearch ( )
virtualinherited

Beginning of the search.

Reimplemented in SearchLog, SearchLimit, OptimizeVar, and SolutionCollector.

Definition at line 2867 of file constraint_solver.cc.

◆ ExitSearch()

void ExitSearch ( )
virtualinherited

End of the search.

Reimplemented in LocalSearchProfiler, SearchLog, and RegularLimit.

Definition at line 2869 of file constraint_solver.cc.

◆ ExportInformation() [1/2]

void ExportInformation ( const Constraint *const  constraint,
int64 *const  fails,
int64 *const  initial_propagation_runtime,
int64 *const  demon_invocations,
int64 *const  total_demon_runtime,
int *  demons 
)
inline

Definition at line 329 of file demon_profiler.cc.

◆ ExportInformation() [2/2]

void ExportInformation ( const DemonRuns *const  demon_runs,
int64 *const  demon_invocations,
int64 *const  fails,
int64 *const  total_demon_runtime,
double *const  mean_demon_runtime,
double *const  median_demon_runtime,
double *const  stddev_demon_runtime 
)
inline

Definition at line 362 of file demon_profiler.cc.

◆ Install()

void Install ( )
inlineoverridevirtual

Install itself on the solver.

Reimplemented from PropagationMonitor.

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

void PopContext ( )
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 175 of file demon_profiler.cc.

◆ PrintOverview()

void PrintOverview ( Solver *const  solver,
const std::string &  filename 
)
inline

Definition at line 257 of file demon_profiler.cc.

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

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

Implements PropagationMonitor.

Definition at line 174 of file demon_profiler.cc.

◆ RankFirst()

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

SequenceVar modifiers.

Implements PropagationMonitor.

Definition at line 235 of file demon_profiler.cc.

◆ RankLast()

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

Implements PropagationMonitor.

Definition at line 237 of file demon_profiler.cc.

◆ RankNotFirst()

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

Implements PropagationMonitor.

Definition at line 236 of file demon_profiler.cc.

◆ RankNotLast()

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

Implements PropagationMonitor.

Definition at line 238 of file demon_profiler.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 239 of file demon_profiler.cc.

◆ RefuteDecision()

void RefuteDecision ( Decision *const  d)
virtualinherited

Before refuting the decision.

Reimplemented in SymmetryManager, SearchLog, SearchLimit, and OptimizeVar.

Definition at line 2874 of file constraint_solver.cc.

◆ RegisterDemon()

void RegisterDemon ( Demon *const  demon)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 128 of file demon_profiler.cc.

◆ RemoveInterval()

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

Implements PropagationMonitor.

Definition at line 216 of file demon_profiler.cc.

◆ RemoveValue()

void RemoveValue ( IntVar *const  var,
int64  value 
)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 214 of file demon_profiler.cc.

◆ RemoveValues()

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

Implements PropagationMonitor.

Definition at line 219 of file demon_profiler.cc.

◆ RestartSearch()

void RestartSearch ( )
inlineoverridevirtual

Restart the search.

Reimplemented from SearchMonitor.

Definition at line 198 of file demon_profiler.cc.

◆ SetDurationMax()

void SetDurationMax ( IntervalVar *const  var,
int64  new_max 
)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 231 of file demon_profiler.cc.

◆ SetDurationMin()

void SetDurationMin ( IntervalVar *const  var,
int64  new_min 
)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 230 of file demon_profiler.cc.

◆ SetDurationRange()

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

Implements PropagationMonitor.

Definition at line 232 of file demon_profiler.cc.

◆ SetEndMax()

void SetEndMax ( IntervalVar *const  var,
int64  new_max 
)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 227 of file demon_profiler.cc.

◆ SetEndMin()

void SetEndMin ( IntervalVar *const  var,
int64  new_min 
)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 226 of file demon_profiler.cc.

◆ SetEndRange()

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

Implements PropagationMonitor.

Definition at line 228 of file demon_profiler.cc.

◆ SetMax() [1/2]

void SetMax ( IntExpr *const  expr,
int64  new_max 
)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 208 of file demon_profiler.cc.

◆ SetMax() [2/2]

void SetMax ( IntVar *const  var,
int64  new_max 
)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 212 of file demon_profiler.cc.

◆ SetMin() [1/2]

void SetMin ( IntExpr *const  expr,
int64  new_min 
)
inlineoverridevirtual

IntExpr modifiers.

Implements PropagationMonitor.

Definition at line 207 of file demon_profiler.cc.

◆ SetMin() [2/2]

void SetMin ( IntVar *const  var,
int64  new_min 
)
inlineoverridevirtual

IntVar modifiers.

Implements PropagationMonitor.

Definition at line 211 of file demon_profiler.cc.

◆ SetPerformed()

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

Implements PropagationMonitor.

Definition at line 234 of file demon_profiler.cc.

◆ SetRange() [1/2]

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

Implements PropagationMonitor.

Definition at line 209 of file demon_profiler.cc.

◆ SetRange() [2/2]

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

Implements PropagationMonitor.

Definition at line 213 of file demon_profiler.cc.

◆ SetStartMax()

void SetStartMax ( IntervalVar *const  var,
int64  new_max 
)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 223 of file demon_profiler.cc.

◆ SetStartMin()

void SetStartMin ( IntervalVar *const  var,
int64  new_min 
)
inlineoverridevirtual

IntervalVar modifiers.

Implements PropagationMonitor.

Definition at line 222 of file demon_profiler.cc.

◆ SetStartRange()

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

Implements PropagationMonitor.

Definition at line 224 of file demon_profiler.cc.

◆ SetValue()

void SetValue ( IntVar *const  var,
int64  value 
)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 215 of file demon_profiler.cc.

◆ SetValues()

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

Implements PropagationMonitor.

Definition at line 217 of file demon_profiler.cc.

◆ solver()

Solver* solver ( ) const
inlineinherited

Definition at line 3708 of file constraint_solver.h.

◆ StartProcessingIntegerVariable()

void StartProcessingIntegerVariable ( IntVar *const  var)
inlineoverridevirtual

Implements PropagationMonitor.

Definition at line 172 of file demon_profiler.cc.

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 file: