SearchMonitor (com.google.ortools:ortools-java 9.10.4067 API)

java.lang.Object
- com.google.ortools.constraintsolver.BaseObject
- - com.google.ortools.constraintsolver.SearchMonitor

Direct Known Subclasses:

LocalSearchMonitor, ObjectiveMonitor, PropagationMonitor, SearchLimit, SearchLog, SolutionCollector
```
public class SearchMonitor
extends BaseObject
```
A search monitor is a simple set of callbacks to monitor all search events

Field Summary

Fields
Modifier and Type Field and Description

static int kNoProgress
- Fields inherited from class com.google.ortools.constraintsolver.BaseObject
  swigCMemOwn

Fields
Modifier and Type	Field and Description
`static int`	`kNoProgress`

Constructor Summary

Constructors
Modifier Constructor and Description

protected SearchMonitor(long cPtr, boolean cMemoryOwn)

SearchMonitor(Solver s)

Constructors
Modifier	Constructor and Description
`protected`	`SearchMonitor(long cPtr, boolean cMemoryOwn)`
	`SearchMonitor(Solver s)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(ModelVisitor visitor)` Accepts the given model visitor.
`boolean`	`acceptDelta(Assignment delta, Assignment deltadelta)`
`void`	`acceptNeighbor()` After accepting a neighbor during local search.
`boolean`	`acceptSolution()` This method is called when a solution is found.
`void`	`AcceptUncheckedNeighbor()` After accepting an unchecked neighbor during local search.
`void`	`afterDecision(Decision d, boolean apply)` 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.
`void`	`applyDecision(Decision d)` Before applying the decision.
`boolean`	`atSolution()` This method is called when a valid solution is found.
`void`	`beginFail()` Just when the failure occurs.
`void`	`beginInitialPropagation()` Before the initial propagation.
`void`	`beginNextDecision(DecisionBuilder b)` Before calling DecisionBuilder::Next.
`void`	`delete()`
`void`	`endFail()` After completing the backtrack.
`void`	`endInitialPropagation()` After the initial propagation.
`void`	`endNextDecision(DecisionBuilder b, Decision d)` After calling DecisionBuilder::Next, along with the returned decision.
`void`	`enterSearch()` Beginning of the search.
`void`	`exitSearch()` End of the search.
`protected void`	`finalize()`
`protected static long`	`getCPtr(SearchMonitor obj)`
`void`	`install()` Registers itself on the solver such that it gets notified of the search and propagation events.
`boolean`	`IsUncheckedSolutionLimitReached()` Returns true if the limit of solutions has been reached including unchecked solutions.
`void`	`keepAliveDecisionBuilder(DecisionBuilder db)`
`boolean`	`localOptimum()` When a local optimum is reached.
`void`	`noMoreSolutions()` When the search tree is finished.
`void`	`periodicCheck()` Periodic call to check limits in long running methods.
`int`	`progressPercent()` Returns a percentage representing the propress of the search before reaching limits.
`void`	`refuteDecision(Decision d)` Before refuting the decision.
`void`	`restartSearch()` Restart the search.
`Solver`	`solver()`
`protected void`	`swigDirectorDisconnect()`
`protected static long`	`swigRelease(SearchMonitor obj)`
`void`	`swigReleaseOwnership()`
`void`	`swigTakeOwnership()`

Methods inherited from class com.google.ortools.constraintsolver.BaseObject
getCPtr, swigRelease, toString

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - kNoProgress
```
public static final int kNoProgress
```
- Constructor Detail
  - SearchMonitor
```
protected SearchMonitor(long cPtr,
                        boolean cMemoryOwn)
```
  - SearchMonitor
```
public SearchMonitor(Solver s)
```
- Method Detail
  - getCPtr
```
protected static long getCPtr(SearchMonitor obj)
```
  - swigRelease
```
protected static long swigRelease(SearchMonitor obj)
```
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class BaseObject
  - delete
```
public void delete()
```
    Overrides:
    
    delete in class BaseObject
  - swigDirectorDisconnect
```
protected void swigDirectorDisconnect()
```
  - swigReleaseOwnership
```
public void swigReleaseOwnership()
```
  - swigTakeOwnership
```
public void swigTakeOwnership()
```
  - keepAliveDecisionBuilder
```
public void keepAliveDecisionBuilder(DecisionBuilder db)
```
  - enterSearch
```
public void enterSearch()
```
    Beginning of the search.
  - restartSearch
```
public void restartSearch()
```
    Restart the search.
  - exitSearch
```
public void exitSearch()
```
    End of the search.
  - beginNextDecision
```
public void beginNextDecision(DecisionBuilder b)
```
    Before calling DecisionBuilder::Next.
  - endNextDecision
```
public void endNextDecision(DecisionBuilder b,
                            Decision d)
```
    After calling DecisionBuilder::Next, along with the returned decision.
  - applyDecision
```
public void applyDecision(Decision d)
```
    Before applying the decision.
  - refuteDecision
```
public void refuteDecision(Decision d)
```
    Before refuting the decision.
  - afterDecision
```
public void afterDecision(Decision d,
                          boolean apply)
```
    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.
  - beginFail
```
public void beginFail()
```
    Just when the failure occurs.
  - endFail
```
public void endFail()
```
    After completing the backtrack.
  - beginInitialPropagation
```
public void beginInitialPropagation()
```
    Before the initial propagation.
  - endInitialPropagation
```
public void endInitialPropagation()
```
    After the initial propagation.
  - acceptSolution
```
public boolean acceptSolution()
```
    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.
  - atSolution
```
public boolean atSolution()
```
    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.
  - noMoreSolutions
```
public void noMoreSolutions()
```
    When the search tree is finished.
  - localOptimum
```
public boolean localOptimum()
```
    When a local optimum is reached. If 'true' is returned, the last solution
    is discarded and the search proceeds with the next one.
  - acceptDelta
```
public boolean acceptDelta(Assignment delta,
                           Assignment deltadelta)
```
  - acceptNeighbor
```
public void acceptNeighbor()
```
    After accepting a neighbor during local search.
  - AcceptUncheckedNeighbor
```
public void AcceptUncheckedNeighbor()
```
    After accepting an unchecked neighbor during local search.
  - IsUncheckedSolutionLimitReached
```
public boolean IsUncheckedSolutionLimitReached()
```
    Returns true if the limit of solutions has been reached including
    unchecked solutions.
  - periodicCheck
```
public void periodicCheck()
```
    Periodic call to check limits in long running methods.
  - progressPercent
```
public int progressPercent()
```
    Returns a percentage representing the propress of the search before
    reaching limits.
  - accept
```
public void accept(ModelVisitor visitor)
```
    Accepts the given model visitor.
  - install
```
public void install()
```
    Registers itself on the solver such that it gets notified of the search
    and propagation events. Override to incrementally install listeners for
    specific events.
  - solver
```
public Solver solver()
```

Class SearchMonitor

Field Summary

Fields inherited from class com.google.ortools.constraintsolver.BaseObject

Constructor Summary

Method Summary

Methods inherited from class com.google.ortools.constraintsolver.BaseObject

Methods inherited from class java.lang.Object

Field Detail

kNoProgress

Constructor Detail

SearchMonitor

SearchMonitor

Method Detail

getCPtr

swigRelease

finalize

delete

swigDirectorDisconnect

swigReleaseOwnership

swigTakeOwnership

keepAliveDecisionBuilder

enterSearch

restartSearch

exitSearch

beginNextDecision

endNextDecision

applyDecision

refuteDecision

afterDecision

beginFail

endFail

beginInitialPropagation

endInitialPropagation

acceptSolution

atSolution

noMoreSolutions

localOptimum

acceptDelta

acceptNeighbor

AcceptUncheckedNeighbor

IsUncheckedSolutionLimitReached

periodicCheck

progressPercent

accept

install

solver