Java Reference

Java Reference

LocalSearchMonitor

Detailed Description

Definition at line 11 of file LocalSearchMonitor.java.

Public Member Functions

synchronized void delete ()
 
String toString ()
 
void beginOperatorStart ()
 Local search operator events. More...
 
void endOperatorStart ()
 
void beginMakeNextNeighbor (LocalSearchOperator op)
 
void endMakeNextNeighbor (LocalSearchOperator op, boolean neighbor_found, Assignment delta, Assignment deltadelta)
 
void beginFilterNeighbor (LocalSearchOperator op)
 
void endFilterNeighbor (LocalSearchOperator op, boolean neighbor_found)
 
void beginAcceptNeighbor (LocalSearchOperator op)
 
void endAcceptNeighbor (LocalSearchOperator op, boolean neighbor_found)
 
void beginFiltering (LocalSearchFilter filter)
 
void endFiltering (LocalSearchFilter filter, boolean reject)
 
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

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

Constructor & Destructor Documentation

◆ LocalSearchMonitor()

LocalSearchMonitor ( long  cPtr,
boolean  cMemoryOwn 
)
inlineprotected

Definition at line 14 of file LocalSearchMonitor.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.

◆ beginAcceptNeighbor()

void beginAcceptNeighbor ( LocalSearchOperator  op)
inline

Definition at line 70 of file LocalSearchMonitor.java.

◆ beginFail()

void beginFail ( )
inlineinherited

Just when the failure occurs.

Reimplemented in SearchLog.

Definition at line 121 of file SearchMonitor.java.

◆ beginFiltering()

void beginFiltering ( LocalSearchFilter  filter)
inline

Definition at line 78 of file LocalSearchMonitor.java.

◆ beginFilterNeighbor()

void beginFilterNeighbor ( LocalSearchOperator  op)
inline

Definition at line 62 of file LocalSearchMonitor.java.

◆ beginInitialPropagation()

void beginInitialPropagation ( )
inlineinherited

Before the initial propagation.

Reimplemented in SearchLog.

Definition at line 135 of file SearchMonitor.java.

◆ beginMakeNextNeighbor()

void beginMakeNextNeighbor ( LocalSearchOperator  op)
inline

Definition at line 54 of file LocalSearchMonitor.java.

◆ beginNextDecision()

void beginNextDecision ( DecisionBuilder  b)
inlineinherited

Before calling DecisionBuilder::Next.

Reimplemented in OptimizeVar, and SearchLimit.

Definition at line 86 of file SearchMonitor.java.

◆ beginOperatorStart()

void beginOperatorStart ( )
inline

Local search operator events.

Definition at line 46 of file LocalSearchMonitor.java.

◆ delete()

synchronized void delete ( )
inline

Reimplemented from SearchMonitor.

Definition at line 28 of file LocalSearchMonitor.java.

◆ endAcceptNeighbor()

void endAcceptNeighbor ( LocalSearchOperator  op,
boolean  neighbor_found 
)
inline

Definition at line 74 of file LocalSearchMonitor.java.

◆ endFail()

void endFail ( )
inlineinherited

After completing the backtrack.

Definition at line 128 of file SearchMonitor.java.

◆ endFiltering()

void endFiltering ( LocalSearchFilter  filter,
boolean  reject 
)
inline

Definition at line 82 of file LocalSearchMonitor.java.

◆ endFilterNeighbor()

void endFilterNeighbor ( LocalSearchOperator  op,
boolean  neighbor_found 
)
inline

Definition at line 66 of file LocalSearchMonitor.java.

◆ endInitialPropagation()

void endInitialPropagation ( )
inlineinherited

After the initial propagation.

Reimplemented in SearchLog.

Definition at line 142 of file SearchMonitor.java.

◆ endMakeNextNeighbor()

void endMakeNextNeighbor ( LocalSearchOperator  op,
boolean  neighbor_found,
Assignment  delta,
Assignment  deltadelta 
)
inline

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

◆ endOperatorStart()

void endOperatorStart ( )
inline

Definition at line 50 of file LocalSearchMonitor.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 89 of file LocalSearchMonitor.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.

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

◆ refuteDecision()

void refuteDecision ( Decision  d)
inlineinherited

Before refuting the decision.

Reimplemented in SearchLog, SearchLimit, and OptimizeVar.

Definition at line 107 of file SearchMonitor.java.

◆ restartSearch()

void restartSearch ( )
inlineinherited

Restart the search.

Definition at line 72 of file SearchMonitor.java.

◆ solver()

Solver solver ( )
inlineinherited

Definition at line 199 of file SearchMonitor.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 LocalSearchMonitor.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: