Java Reference

Java Reference

PropagationMonitor

Detailed Description

Definition at line 11 of file PropagationMonitor.java.

Public Member Functions

synchronized void delete ()
 
String toString ()
 
void beginConstraintInitialPropagation (Constraint constraint)
 Propagation events. More...
 
void endConstraintInitialPropagation (Constraint constraint)
 
void beginNestedConstraintInitialPropagation (Constraint parent, Constraint nested)
 
void endNestedConstraintInitialPropagation (Constraint parent, Constraint nested)
 
void registerDemon (Demon demon)
 
void beginDemonRun (Demon demon)
 
void endDemonRun (Demon demon)
 
void startProcessingIntegerVariable (IntVar var)
 
void endProcessingIntegerVariable (IntVar var)
 
void pushContext (String context)
 
void popContext ()
 
void setMin (IntExpr expr, long new_min)
 IntExpr modifiers. More...
 
void setMax (IntExpr expr, long new_max)
 
void setRange (IntExpr expr, long new_min, long new_max)
 
void setMin (IntVar var, long new_min)
 IntVar modifiers. More...
 
void setMax (IntVar var, long new_max)
 
void setRange (IntVar var, long new_min, long new_max)
 
void removeValue (IntVar var, long value)
 
void setValue (IntVar var, long value)
 
void removeInterval (IntVar var, long imin, long imax)
 
void setValue (IntVar var, long[] values)
 
void removeValues (IntVar var, long[] values)
 
void setStartMin (IntervalVar var, long new_min)
 IntervalVar modifiers. More...
 
void setStartMax (IntervalVar var, long new_max)
 
void setStartRange (IntervalVar var, long new_min, long new_max)
 
void setEndMin (IntervalVar var, long new_min)
 
void setEndMax (IntervalVar var, long new_max)
 
void setEndRange (IntervalVar var, long new_min, long new_max)
 
void setDurationMin (IntervalVar var, long new_min)
 
void setDurationMax (IntervalVar var, long new_max)
 
void setDurationRange (IntervalVar var, long new_min, long new_max)
 
void setPerformed (IntervalVar var, boolean value)
 
void rankFirst (SequenceVar var, int index)
 SequenceVar modifiers. More...
 
void rankNotFirst (SequenceVar var, int index)
 
void rankLast (SequenceVar var, int index)
 
void rankNotLast (SequenceVar var, int index)
 
void rankSequence (SequenceVar var, int[] rank_first, int[] rank_last, int[] unperformed)
 
void install ()
 Install itself on the solver. More...
 
void swigReleaseOwnership ()
 
void swigTakeOwnership ()
 
void enterSearch ()
 Beginning of the search. More...
 
void restartSearch ()
 Restart the search. More...
 
void exitSearch ()
 End of the search. More...
 
void beginNextDecision (DecisionBuilder b)
 Before calling DecisionBuilder::Next. More...
 
void endNextDecision (DecisionBuilder b, Decision d)
 After calling DecisionBuilder::Next, along with the returned decision. More...
 
void applyDecision (Decision d)
 Before applying the decision. More...
 
void refuteDecision (Decision d)
 Before refuting the decision. More...
 
void afterDecision (Decision d, boolean apply)
 Just after refuting or applying the decision, apply is true after Apply. More...
 
void beginFail ()
 Just when the failure occurs. More...
 
void endFail ()
 After completing the backtrack. More...
 
void beginInitialPropagation ()
 Before the initial propagation. More...
 
void endInitialPropagation ()
 After the initial propagation. More...
 
boolean acceptSolution ()
 This method is called when a solution is found. More...
 
boolean atSolution ()
 This method is called when a valid solution is found. More...
 
void noMoreSolutions ()
 When the search tree is finished. More...
 
boolean localOptimum ()
 When a local optimum is reached. More...
 
boolean acceptDelta (Assignment delta, Assignment deltadelta)
 
void acceptNeighbor ()
 After accepting a neighbor during local search. More...
 
void AcceptUncheckedNeighbor ()
 After accepting an unchecked neighbor during local search. More...
 
boolean IsUncheckedSolutionLimitReached ()
 Returns true if the limit of solutions has been reached including unchecked solutions. More...
 
Solver solver ()
 
void periodicCheck ()
 Periodic call to check limits in long running methods. More...
 
int progressPercent ()
 Returns a percentage representing the propress of the search before reaching limits. More...
 
void accept (ModelVisitor visitor)
 Accepts the given model visitor. More...
 

Static Public Attributes

static final int kNoProgress = mainJNI.SearchMonitor_kNoProgress_get()
 

Protected Member Functions

 PropagationMonitor (long cPtr, boolean cMemoryOwn)
 
void swigDirectorDisconnect ()
 

Constructor & Destructor Documentation

◆ PropagationMonitor()

PropagationMonitor ( long  cPtr,
boolean  cMemoryOwn 
)
inlineprotected

Definition at line 14 of file PropagationMonitor.java.

Member Function Documentation

◆ accept()

void accept ( ModelVisitor  visitor)
inlineinherited

Accepts the given model visitor.

Reimplemented in RegularLimit, and OptimizeVar.

Definition at line 221 of file SearchMonitor.java.

◆ acceptDelta()

boolean acceptDelta ( Assignment  delta,
Assignment  deltadelta 
)
inlineinherited

Reimplemented in OptimizeVar.

Definition at line 174 of file SearchMonitor.java.

◆ acceptNeighbor()

void acceptNeighbor ( )
inlineinherited

After accepting a neighbor during local search.

Definition at line 181 of file SearchMonitor.java.

◆ acceptSolution()

boolean acceptSolution ( )
inlineinherited

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 149 of file SearchMonitor.java.

◆ AcceptUncheckedNeighbor()

void AcceptUncheckedNeighbor ( )
inlineinherited

After accepting an unchecked neighbor during local search.

Reimplemented in SearchLog.

Definition at line 188 of file SearchMonitor.java.

◆ afterDecision()

void afterDecision ( Decision  d,
boolean  apply 
)
inlineinherited

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 114 of file SearchMonitor.java.

◆ applyDecision()

void applyDecision ( Decision  d)
inlineinherited

Before applying the decision.

Reimplemented in SearchLog.

Definition at line 100 of file SearchMonitor.java.

◆ atSolution()

boolean atSolution ( )
inlineinherited

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, and SearchLog.

Definition at line 156 of file SearchMonitor.java.

◆ beginConstraintInitialPropagation()

void beginConstraintInitialPropagation ( Constraint  constraint)
inline

Propagation events.

Definition at line 46 of file PropagationMonitor.java.

◆ beginDemonRun()

void beginDemonRun ( Demon  demon)
inline

Definition at line 66 of file PropagationMonitor.java.

◆ beginFail()

void beginFail ( )
inlineinherited

Just when the failure occurs.

Reimplemented in SearchLog.

Definition at line 121 of file SearchMonitor.java.

◆ beginInitialPropagation()

void beginInitialPropagation ( )
inlineinherited

Before the initial propagation.

Reimplemented in SearchLog.

Definition at line 135 of file SearchMonitor.java.

◆ beginNestedConstraintInitialPropagation()

void beginNestedConstraintInitialPropagation ( Constraint  parent,
Constraint  nested 
)
inline

Definition at line 54 of file PropagationMonitor.java.

◆ beginNextDecision()

void beginNextDecision ( DecisionBuilder  b)
inlineinherited

Before calling DecisionBuilder::Next.

Reimplemented in OptimizeVar, and SearchLimit.

Definition at line 86 of file SearchMonitor.java.

◆ delete()

synchronized void delete ( )
inline

Reimplemented from SearchMonitor.

Definition at line 28 of file PropagationMonitor.java.

◆ endConstraintInitialPropagation()

void endConstraintInitialPropagation ( Constraint  constraint)
inline

Definition at line 50 of file PropagationMonitor.java.

◆ endDemonRun()

void endDemonRun ( Demon  demon)
inline

Definition at line 70 of file PropagationMonitor.java.

◆ endFail()

void endFail ( )
inlineinherited

After completing the backtrack.

Definition at line 128 of file SearchMonitor.java.

◆ endInitialPropagation()

void endInitialPropagation ( )
inlineinherited

After the initial propagation.

Reimplemented in SearchLog.

Definition at line 142 of file SearchMonitor.java.

◆ endNestedConstraintInitialPropagation()

void endNestedConstraintInitialPropagation ( Constraint  parent,
Constraint  nested 
)
inline

Definition at line 58 of file PropagationMonitor.java.

◆ endNextDecision()

void endNextDecision ( DecisionBuilder  b,
Decision  d 
)
inlineinherited

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

Definition at line 93 of file SearchMonitor.java.

◆ endProcessingIntegerVariable()

void endProcessingIntegerVariable ( IntVar  var)
inline

Definition at line 78 of file PropagationMonitor.java.

◆ enterSearch()

void enterSearch ( )
inlineinherited

Beginning of the search.

Reimplemented in SolutionCollector, SearchLimit, OptimizeVar, and SearchLog.

Definition at line 65 of file SearchMonitor.java.

◆ exitSearch()

void exitSearch ( )
inlineinherited

End of the search.

Reimplemented in RegularLimit, and SearchLog.

Definition at line 79 of file SearchMonitor.java.

◆ install()

void install ( )
inline

Install itself on the solver.

Reimplemented from SearchMonitor.

Definition at line 209 of file PropagationMonitor.java.

◆ IsUncheckedSolutionLimitReached()

boolean IsUncheckedSolutionLimitReached ( )
inlineinherited

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

Reimplemented in RegularLimit.

Definition at line 195 of file SearchMonitor.java.

◆ localOptimum()

boolean localOptimum ( )
inlineinherited

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 170 of file SearchMonitor.java.

◆ noMoreSolutions()

void noMoreSolutions ( )
inlineinherited

When the search tree is finished.

Reimplemented in SearchLog.

Definition at line 163 of file SearchMonitor.java.

◆ periodicCheck()

void periodicCheck ( )
inlineinherited

Periodic call to check limits in long running methods.

Reimplemented in SearchLimit.

Definition at line 207 of file SearchMonitor.java.

◆ popContext()

void popContext ( )
inline

Definition at line 86 of file PropagationMonitor.java.

◆ progressPercent()

int progressPercent ( )
inlineinherited

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

Reimplemented in RegularLimit.

Definition at line 214 of file SearchMonitor.java.

◆ pushContext()

void pushContext ( String  context)
inline

Definition at line 82 of file PropagationMonitor.java.

◆ rankFirst()

void rankFirst ( SequenceVar  var,
int  index 
)
inline

SequenceVar modifiers.

Definition at line 186 of file PropagationMonitor.java.

◆ rankLast()

void rankLast ( SequenceVar  var,
int  index 
)
inline

Definition at line 194 of file PropagationMonitor.java.

◆ rankNotFirst()

void rankNotFirst ( SequenceVar  var,
int  index 
)
inline

Definition at line 190 of file PropagationMonitor.java.

◆ rankNotLast()

void rankNotLast ( SequenceVar  var,
int  index 
)
inline

Definition at line 198 of file PropagationMonitor.java.

◆ rankSequence()

void rankSequence ( SequenceVar  var,
int[]  rank_first,
int[]  rank_last,
int[]  unperformed 
)
inline

Definition at line 202 of file PropagationMonitor.java.

◆ refuteDecision()

void refuteDecision ( Decision  d)
inlineinherited

Before refuting the decision.

Reimplemented in SearchLog, SearchLimit, and OptimizeVar.

Definition at line 107 of file SearchMonitor.java.

◆ registerDemon()

void registerDemon ( Demon  demon)
inline

Definition at line 62 of file PropagationMonitor.java.

◆ removeInterval()

void removeInterval ( IntVar  var,
long  imin,
long  imax 
)
inline

Definition at line 128 of file PropagationMonitor.java.

◆ removeValue()

void removeValue ( IntVar  var,
long  value 
)
inline

Definition at line 120 of file PropagationMonitor.java.

◆ removeValues()

void removeValues ( IntVar  var,
long[]  values 
)
inline

Definition at line 136 of file PropagationMonitor.java.

◆ restartSearch()

void restartSearch ( )
inlineinherited

Restart the search.

Definition at line 72 of file SearchMonitor.java.

◆ setDurationMax()

void setDurationMax ( IntervalVar  var,
long  new_max 
)
inline

Definition at line 171 of file PropagationMonitor.java.

◆ setDurationMin()

void setDurationMin ( IntervalVar  var,
long  new_min 
)
inline

Definition at line 167 of file PropagationMonitor.java.

◆ setDurationRange()

void setDurationRange ( IntervalVar  var,
long  new_min,
long  new_max 
)
inline

Definition at line 175 of file PropagationMonitor.java.

◆ setEndMax()

void setEndMax ( IntervalVar  var,
long  new_max 
)
inline

Definition at line 159 of file PropagationMonitor.java.

◆ setEndMin()

void setEndMin ( IntervalVar  var,
long  new_min 
)
inline

Definition at line 155 of file PropagationMonitor.java.

◆ setEndRange()

void setEndRange ( IntervalVar  var,
long  new_min,
long  new_max 
)
inline

Definition at line 163 of file PropagationMonitor.java.

◆ setMax() [1/2]

void setMax ( IntExpr  expr,
long  new_max 
)
inline

Definition at line 97 of file PropagationMonitor.java.

◆ setMax() [2/2]

void setMax ( IntVar  var,
long  new_max 
)
inline

Definition at line 112 of file PropagationMonitor.java.

◆ setMin() [1/2]

void setMin ( IntExpr  expr,
long  new_min 
)
inline

IntExpr modifiers.

Definition at line 93 of file PropagationMonitor.java.

◆ setMin() [2/2]

void setMin ( IntVar  var,
long  new_min 
)
inline

IntVar modifiers.

Definition at line 108 of file PropagationMonitor.java.

◆ setPerformed()

void setPerformed ( IntervalVar  var,
boolean  value 
)
inline

Definition at line 179 of file PropagationMonitor.java.

◆ setRange() [1/2]

void setRange ( IntExpr  expr,
long  new_min,
long  new_max 
)
inline

Definition at line 101 of file PropagationMonitor.java.

◆ setRange() [2/2]

void setRange ( IntVar  var,
long  new_min,
long  new_max 
)
inline

Definition at line 116 of file PropagationMonitor.java.

◆ setStartMax()

void setStartMax ( IntervalVar  var,
long  new_max 
)
inline

Definition at line 147 of file PropagationMonitor.java.

◆ setStartMin()

void setStartMin ( IntervalVar  var,
long  new_min 
)
inline

IntervalVar modifiers.

Definition at line 143 of file PropagationMonitor.java.

◆ setStartRange()

void setStartRange ( IntervalVar  var,
long  new_min,
long  new_max 
)
inline

Definition at line 151 of file PropagationMonitor.java.

◆ setValue() [1/2]

void setValue ( IntVar  var,
long  value 
)
inline

Definition at line 124 of file PropagationMonitor.java.

◆ setValue() [2/2]

void setValue ( IntVar  var,
long[]  values 
)
inline

Definition at line 132 of file PropagationMonitor.java.

◆ solver()

Solver solver ( )
inlineinherited

Definition at line 199 of file SearchMonitor.java.

◆ startProcessingIntegerVariable()

void startProcessingIntegerVariable ( IntVar  var)
inline

Definition at line 74 of file PropagationMonitor.java.

◆ swigDirectorDisconnect()

void swigDirectorDisconnect ( )
inlineprotectedinherited

Definition at line 42 of file SearchMonitor.java.

◆ swigReleaseOwnership()

void swigReleaseOwnership ( )
inlineinherited

Definition at line 47 of file SearchMonitor.java.

◆ swigTakeOwnership()

void swigTakeOwnership ( )
inlineinherited

Definition at line 52 of file SearchMonitor.java.

◆ toString()

String toString ( )
inline

Reimplemented from BaseObject.

Definition at line 39 of file PropagationMonitor.java.

Member Data Documentation

◆ kNoProgress

final int kNoProgress = mainJNI.SearchMonitor_kNoProgress_get()
staticinherited

Definition at line 232 of file SearchMonitor.java.


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