com.google.ortools.constraintsolver

Class RegularLimit

java.lang.Object

com.google.ortools.constraintsolver.BaseObject

com.google.ortools.constraintsolver.SearchMonitor

com.google.ortools.constraintsolver.SearchLimit

com.google.ortools.constraintsolver.RegularLimit

public class RegularLimit
extends SearchLimit

Usual limit based on wall_time, number of explored branches and
number of failures in the search tree

Field Summary

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

kNoProgress

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

swigCMemOwn

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegularLimit(long cPtr, boolean cMemoryOwn)
	RegularLimit(Solver s, SWIGTYPE_p_absl__Duration time, long branches, long failures, long solutions, boolean smart_time_check, boolean cumulative)

Method Summary

Modifier and Type	Method and Description
void	accept(ModelVisitor visitor) Accepts the given model visitor.
long	branches()
boolean	CheckWithOffset(SWIGTYPE_p_absl__Duration offset) Same as Check() but adds the 'offset' value to the current time when time is considered in the limit.
void	copy(SearchLimit limit) Copy a limit.
void	delete()
void	exitSearch() End of the search.
long	failures()
protected void	finalize()
protected static long	getCPtr(RegularLimit obj)
void	init() This method is called when the search limit is initialized.
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.
SearchLimit	makeClone() Allocates a clone of the limit.
RegularLimit	MakeIdenticalClone()
int	progressPercent() Returns a percentage representing the propress of the search before reaching limits.
long	solutions()
protected static long	swigRelease(RegularLimit obj)
java.lang.String	toString()
void	UpdateLimits(SWIGTYPE_p_absl__Duration time, long branches, long failures, long solutions)
long	wall_time()

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

beginNextDecision, check, crossed, enterSearch, getCPtr, keepAliveDecisionBuilder, periodicCheck, refuteDecision, swigRelease

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

acceptDelta, acceptNeighbor, acceptSolution, AcceptUncheckedNeighbor, afterDecision, applyDecision, atSolution, beginFail, beginInitialPropagation, endFail, endInitialPropagation, endNextDecision, getCPtr, localOptimum, noMoreSolutions, restartSearch, solver, swigDirectorDisconnect, swigRelease, swigReleaseOwnership, swigTakeOwnership

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

getCPtr, swigRelease

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RegularLimit

protected RegularLimit(long cPtr,
                       boolean cMemoryOwn)

RegularLimit

public RegularLimit(Solver s,
                    SWIGTYPE_p_absl__Duration time,
                    long branches,
                    long failures,
                    long solutions,
                    boolean smart_time_check,
                    boolean cumulative)

Method Detail

getCPtr

protected static long getCPtr(RegularLimit obj)

swigRelease

protected static long swigRelease(RegularLimit obj)

finalize

protected void finalize()

Overrides:

finalize in class SearchLimit

delete

public void delete()

Overrides:

delete in class SearchLimit

copy

public void copy(SearchLimit limit)

Description copied from class: SearchLimit

Copy a limit. Warning: leads to a direct (no check) downcasting of 'limit'
so one needs to be sure both SearchLimits are of the same type.

Overrides:

copy in class SearchLimit

makeClone

public SearchLimit makeClone()

Description copied from class: SearchLimit

Allocates a clone of the limit.

Overrides:

makeClone in class SearchLimit

MakeIdenticalClone

public RegularLimit MakeIdenticalClone()

CheckWithOffset

public boolean CheckWithOffset(SWIGTYPE_p_absl__Duration offset)

Description copied from class: SearchLimit

Same as Check() but adds the 'offset' value to the current time when time
is considered in the limit.

Overrides:

CheckWithOffset in class SearchLimit

init

public void init()

Description copied from class: SearchLimit

This method is called when the search limit is initialized.

Overrides:

init in class SearchLimit

exitSearch

public void exitSearch()

Description copied from class: SearchMonitor

End of the search.

Overrides:

exitSearch in class SearchMonitor

UpdateLimits

public void UpdateLimits(SWIGTYPE_p_absl__Duration time,
                         long branches,
                         long failures,
                         long solutions)

wall_time

public long wall_time()

branches

public long branches()

failures

public long failures()

solutions

public long solutions()

IsUncheckedSolutionLimitReached

public boolean IsUncheckedSolutionLimitReached()

Description copied from class: SearchMonitor

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

Overrides:

IsUncheckedSolutionLimitReached in class SearchMonitor

progressPercent

public int progressPercent()

Description copied from class: SearchMonitor

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

Overrides:

progressPercent in class SearchMonitor

toString

public java.lang.String toString()

Overrides:

toString in class SearchLimit

install

public void install()

Description copied from class: SearchMonitor

Registers itself on the solver such that it gets notified of the search
and propagation events. Override to incrementally install listeners for
specific events.

Overrides:

install in class SearchLimit

accept

public void accept(ModelVisitor visitor)

Description copied from class: SearchMonitor

Accepts the given model visitor.

Overrides:

accept in class SearchMonitor