com.google.ortools.constraintsolver

Class OptimizeVar

java.lang.Object

com.google.ortools.constraintsolver.BaseObject

com.google.ortools.constraintsolver.SearchMonitor

com.google.ortools.constraintsolver.BaseObjectiveMonitor

com.google.ortools.constraintsolver.ObjectiveMonitor

com.google.ortools.constraintsolver.OptimizeVar

public class OptimizeVar
extends ObjectiveMonitor

This class encapsulates an objective. It requires the direction
(minimize or maximize), the variable to optimize, and the
improvement step.

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

Constructor and Description
OptimizeVar(long cPtr, boolean cMemoryOwn)
OptimizeVar(Solver solver, boolean maximize, IntVar var, long step)
OptimizeVar(Solver solver, SWIGTYPE_p_std__vectorT_bool_t maximize, IntVar[] vars, long[] steps)

Method Summary

Modifier and Type	Method and Description
boolean	acceptSolution() This method is called when a solution is found.
void	applyBound()
boolean	atSolution() This method is called when a valid solution is found.
void	beginNextDecision(DecisionBuilder db) Internal methods.
long	best() Returns the best value found during search.
void	delete()
protected void	finalize()
static long	getCPtr(OptimizeVar obj)
void	keepAliveDecisionBuilder(DecisionBuilder db)
java.lang.String	Name()
void	refuteDecision(Decision d) Before refuting the decision.
static long	swigRelease(OptimizeVar obj)
java.lang.String	toString()
IntVar	var() Returns the variable that is optimized.

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

accept, acceptDelta, BestValue, enterSearch, getCPtr, Maximize, MinimizationVar, ObjectiveVar, Size, Step, swigRelease

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

getCPtr, is_active, set_active, swigRelease

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

acceptNeighbor, AcceptUncheckedNeighbor, afterDecision, applyDecision, beginFail, beginInitialPropagation, endFail, endInitialPropagation, endNextDecision, exitSearch, getCPtr, install, IsUncheckedSolutionLimitReached, localOptimum, noMoreSolutions, periodicCheck, progressPercent, 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

OptimizeVar

public OptimizeVar(long cPtr,
                   boolean cMemoryOwn)

OptimizeVar

public OptimizeVar(Solver solver,
                   boolean maximize,
                   IntVar var,
                   long step)

OptimizeVar

public OptimizeVar(Solver solver,
                   SWIGTYPE_p_std__vectorT_bool_t maximize,
                   IntVar[] vars,
                   long[] steps)

Method Detail

getCPtr

public static long getCPtr(OptimizeVar obj)

swigRelease

public static long swigRelease(OptimizeVar obj)

finalize

protected void finalize()

Overrides:

finalize in class ObjectiveMonitor

delete

public void delete()

Overrides:

delete in class ObjectiveMonitor

keepAliveDecisionBuilder

public void keepAliveDecisionBuilder(DecisionBuilder db)

Overrides:

keepAliveDecisionBuilder in class SearchMonitor

best

public long best()

Returns the best value found during search.

var

public IntVar var()

Returns the variable that is optimized.

beginNextDecision

public void beginNextDecision(DecisionBuilder db)

Internal methods.

Overrides:

beginNextDecision in class SearchMonitor

refuteDecision

public void refuteDecision(Decision d)

Description copied from class: SearchMonitor

Before refuting the decision.

Overrides:

refuteDecision in class SearchMonitor

atSolution

public boolean atSolution()

Description copied from class: SearchMonitor

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.

Overrides:

atSolution in class ObjectiveMonitor

acceptSolution

public boolean acceptSolution()

Description copied from class: SearchMonitor

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.

Overrides:

acceptSolution in class SearchMonitor

Name

public java.lang.String Name()

toString

public java.lang.String toString()

Overrides:

toString in class BaseObject

applyBound

public void applyBound()