Java Reference

Java Reference

SearchLog

Detailed Description

The base class of all search logs that periodically outputs information when the search is running.

Definition at line 18 of file SearchLog.java.

Public Member Functions

synchronized void delete ()
 
 SearchLog (Solver s, OptimizeVar obj, IntVar var, double scaling_factor, double offset, Supplier< String > display_callback, int period)
 
void enterSearch ()
 Beginning of the search. More...
 
void exitSearch ()
 End of the search. More...
 
boolean atSolution ()
 This method is called when a valid solution is found. More...
 
void beginFail ()
 Just when the failure occurs. More...
 
void noMoreSolutions ()
 When the search tree is finished. More...
 
void AcceptUncheckedNeighbor ()
 After accepting an unchecked neighbor during local search. More...
 
void applyDecision (Decision decision)
 Before applying the decision. More...
 
void refuteDecision (Decision decision)
 Before refuting the decision. More...
 
void outputDecision ()
 
void maintain ()
 
void beginInitialPropagation ()
 Before the initial propagation. More...
 
void endInitialPropagation ()
 After the initial propagation. More...
 
String toString ()
 
void swigReleaseOwnership ()
 
void swigTakeOwnership ()
 
void restartSearch ()
 Restart 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 afterDecision (Decision d, boolean apply)
 Just after refuting or applying the decision, apply is true after Apply. More...
 
void endFail ()
 After completing the backtrack. More...
 
boolean acceptSolution ()
 This method is called when a solution is found. 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...
 
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...
 
void install ()
 Registers itself on the solver such that it gets notified of the search and propagation events. More...
 

Static Public Attributes

static final int kNoProgress = mainJNI.SearchMonitor_kNoProgress_get()
 

Protected Member Functions

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

Constructor & Destructor Documentation

◆ SearchLog() [1/2]

SearchLog ( long  cPtr,
boolean  cMemoryOwn 
)
inlineprotected

Definition at line 21 of file SearchLog.java.

◆ SearchLog() [2/2]

SearchLog ( Solver  s,
OptimizeVar  obj,
IntVar  var,
double  scaling_factor,
double  offset,
Supplier< String >  display_callback,
int  period 
)
inline

Definition at line 46 of file SearchLog.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 ( )
inline

After accepting an unchecked neighbor during local search.

Reimplemented from SearchMonitor.

Definition at line 70 of file SearchLog.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)
inline

Before applying the decision.

Reimplemented from SearchMonitor.

Definition at line 74 of file SearchLog.java.

◆ atSolution()

boolean atSolution ( )
inline

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 from SearchMonitor.

Definition at line 58 of file SearchLog.java.

◆ beginFail()

void beginFail ( )
inline

Just when the failure occurs.

Reimplemented from SearchMonitor.

Definition at line 62 of file SearchLog.java.

◆ beginInitialPropagation()

void beginInitialPropagation ( )
inline

Before the initial propagation.

Reimplemented from SearchMonitor.

Definition at line 90 of file SearchLog.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 35 of file SearchLog.java.

◆ endFail()

void endFail ( )
inlineinherited

After completing the backtrack.

Definition at line 128 of file SearchMonitor.java.

◆ endInitialPropagation()

void endInitialPropagation ( )
inline

After the initial propagation.

Reimplemented from SearchMonitor.

Definition at line 94 of file SearchLog.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.

◆ enterSearch()

void enterSearch ( )
inline

Beginning of the search.

Reimplemented from SearchMonitor.

Definition at line 50 of file SearchLog.java.

◆ exitSearch()

void exitSearch ( )
inline

End of the search.

Reimplemented from SearchMonitor.

Definition at line 54 of file SearchLog.java.

◆ install()

void install ( )
inlineinherited

Registers itself on the solver such that it gets notified of the search and propagation events.

Reimplemented in PropagationMonitor, and LocalSearchMonitor.

Definition at line 228 of file SearchMonitor.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.

◆ maintain()

void maintain ( )
inline

Definition at line 86 of file SearchLog.java.

◆ noMoreSolutions()

void noMoreSolutions ( )
inline

When the search tree is finished.

Reimplemented from SearchMonitor.

Definition at line 66 of file SearchLog.java.

◆ outputDecision()

void outputDecision ( )
inline

Definition at line 82 of file SearchLog.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)
inline

Before refuting the decision.

Reimplemented from SearchMonitor.

Definition at line 78 of file SearchLog.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 98 of file SearchLog.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: