OR-Tools  8.2
OptimizeVar

Detailed Description

This class encapsulates an objective.

It requires the direction (minimize or maximize), the variable to optimize, and the improvement step.

Definition at line 4204 of file constraint_solver.h.

Public Member Functions

 OptimizeVar (Solver *const s, bool maximize, IntVar *const a, int64 step)
 
 ~OptimizeVar () override
 
int64 best () const
 Returns the best value found during search. More...
 
IntVarVar () const
 Returns the variable that is optimized. More...
 
bool AcceptDelta (Assignment *delta, Assignment *deltadelta) override
 Internal methods. More...
 
void EnterSearch () override
 Beginning of the search. More...
 
void BeginNextDecision (DecisionBuilder *const db) override
 Before calling DecisionBuilder::Next. More...
 
void RefuteDecision (Decision *const d) override
 Before refuting the decision. More...
 
bool AtSolution () override
 This method is called when a valid solution is found. More...
 
bool AcceptSolution () override
 This method is called when a solution is found. More...
 
virtual std::string Print () const
 
std::string DebugString () const override
 
void Accept (ModelVisitor *const visitor) const override
 Accepts the given model visitor. More...
 
void ApplyBound ()
 
virtual void RestartSearch ()
 Restart the search. More...
 
virtual void ExitSearch ()
 End of the search. More...
 
virtual void EndNextDecision (DecisionBuilder *const b, Decision *const d)
 After calling DecisionBuilder::Next, along with the returned decision. More...
 
virtual void ApplyDecision (Decision *const d)
 Before applying the decision. More...
 
virtual void AfterDecision (Decision *const d, bool apply)
 Just after refuting or applying the decision, apply is true after Apply. More...
 
virtual void BeginFail ()
 Just when the failure occurs. More...
 
virtual void EndFail ()
 After completing the backtrack. More...
 
virtual void BeginInitialPropagation ()
 Before the initial propagation. More...
 
virtual void EndInitialPropagation ()
 After the initial propagation. More...
 
virtual void NoMoreSolutions ()
 When the search tree is finished. More...
 
virtual bool LocalOptimum ()
 When a local optimum is reached. More...
 
virtual void AcceptNeighbor ()
 After accepting a neighbor during local search. More...
 
virtual void AcceptUncheckedNeighbor ()
 After accepting an unchecked neighbor during local search. More...
 
virtual bool IsUncheckedSolutionLimitReached ()
 Returns true if the limit of solutions has been reached including unchecked solutions. More...
 
Solversolver () const
 
virtual void PeriodicCheck ()
 Periodic call to check limits in long running methods. More...
 
virtual int ProgressPercent ()
 Returns a percentage representing the propress of the search before reaching limits. More...
 
virtual void Install ()
 Registers itself on the solver such that it gets notified of the search and propagation events. More...
 

Static Public Attributes

static constexpr int kNoProgress = -1
 

Protected Attributes

IntVar *const var_
 
int64 step_
 
int64 best_
 
bool maximize_
 
bool found_initial_solution_
 

Constructor & Destructor Documentation

◆ OptimizeVar()

OptimizeVar ( Solver *const  s,
bool  maximize,
IntVar *const  a,
int64  step 
)

Definition at line 2717 of file search.cc.

◆ ~OptimizeVar()

~OptimizeVar ( )
override

Definition at line 2736 of file search.cc.

Member Function Documentation

◆ Accept()

void Accept ( ModelVisitor *const  visitor) const
overridevirtual

Accepts the given model visitor.

Reimplemented from SearchMonitor.

Definition at line 2840 of file search.cc.

◆ AcceptDelta()

bool AcceptDelta ( Assignment delta,
Assignment deltadelta 
)
overridevirtual

Internal methods.

Reimplemented from SearchMonitor.

Definition at line 2790 of file search.cc.

◆ AcceptNeighbor()

void AcceptNeighbor ( )
virtualinherited

After accepting a neighbor during local search.

Definition at line 2887 of file constraint_solver.cc.

◆ AcceptSolution()

bool AcceptSolution ( )
overridevirtual

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

Definition at line 2765 of file search.cc.

◆ AcceptUncheckedNeighbor()

void AcceptUncheckedNeighbor ( )
virtualinherited

After accepting an unchecked neighbor during local search.

Reimplemented in SearchLog.

Definition at line 2888 of file constraint_solver.cc.

◆ AfterDecision()

void AfterDecision ( Decision *const  d,
bool  apply 
)
virtualinherited

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 2875 of file constraint_solver.cc.

◆ ApplyBound()

void ApplyBound ( )

Definition at line 2753 of file search.cc.

◆ ApplyDecision()

void ApplyDecision ( Decision *const  d)
virtualinherited

Before applying the decision.

Reimplemented in SearchLog.

Definition at line 2873 of file constraint_solver.cc.

◆ AtSolution()

bool AtSolution ( )
overridevirtual

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 2777 of file search.cc.

◆ BeginFail()

void BeginFail ( )
virtualinherited

Just when the failure occurs.

Reimplemented in SearchLog, and DemonProfiler.

Definition at line 2876 of file constraint_solver.cc.

◆ BeginInitialPropagation()

void BeginInitialPropagation ( )
virtualinherited

Before the initial propagation.

Reimplemented in SearchLog.

Definition at line 2878 of file constraint_solver.cc.

◆ BeginNextDecision()

void BeginNextDecision ( DecisionBuilder *const  b)
overridevirtual

Before calling DecisionBuilder::Next.

Reimplemented from SearchMonitor.

Definition at line 2747 of file search.cc.

◆ best()

int64 best ( ) const
inline

Returns the best value found during search.

Definition at line 4210 of file constraint_solver.h.

◆ DebugString()

std::string DebugString ( ) const
overridevirtual

Reimplemented from BaseObject.

Definition at line 2828 of file search.cc.

◆ EndFail()

void EndFail ( )
virtualinherited

After completing the backtrack.

Definition at line 2877 of file constraint_solver.cc.

◆ EndInitialPropagation()

void EndInitialPropagation ( )
virtualinherited

After the initial propagation.

Reimplemented in SearchLog.

Definition at line 2879 of file constraint_solver.cc.

◆ EndNextDecision()

void EndNextDecision ( DecisionBuilder *const  b,
Decision *const  d 
)
virtualinherited

After calling DecisionBuilder::Next, along with the returned decision.

Reimplemented in SymmetryManager.

Definition at line 2871 of file constraint_solver.cc.

◆ EnterSearch()

void EnterSearch ( )
overridevirtual

Beginning of the search.

Reimplemented from SearchMonitor.

Definition at line 2738 of file search.cc.

◆ ExitSearch()

void ExitSearch ( )
virtualinherited

End of the search.

Reimplemented in RegularLimit, SearchLog, and LocalSearchProfiler.

Definition at line 2869 of file constraint_solver.cc.

◆ Install()

void Install ( )
virtualinherited

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

Reimplemented in Trace, LocalSearchMonitorMaster, PropagationMonitor, LocalSearchMonitor, DemonProfiler, and LocalSearchProfiler.

Definition at line 2892 of file constraint_solver.cc.

◆ IsUncheckedSolutionLimitReached()

virtual bool IsUncheckedSolutionLimitReached ( )
inlinevirtualinherited

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

Reimplemented in RegularLimit.

Definition at line 3706 of file constraint_solver.h.

◆ LocalOptimum()

bool LocalOptimum ( )
virtualinherited

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 2883 of file constraint_solver.cc.

◆ NoMoreSolutions()

void NoMoreSolutions ( )
virtualinherited

When the search tree is finished.

Reimplemented in SearchLog.

Definition at line 2882 of file constraint_solver.cc.

◆ PeriodicCheck()

void PeriodicCheck ( )
virtualinherited

Periodic call to check limits in long running methods.

Reimplemented in SearchLimit.

Definition at line 2889 of file constraint_solver.cc.

◆ Print()

std::string Print ( ) const
virtual

Definition at line 2824 of file search.cc.

◆ ProgressPercent()

virtual int ProgressPercent ( )
inlinevirtualinherited

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

Reimplemented in RegularLimit.

Definition at line 3715 of file constraint_solver.h.

◆ RefuteDecision()

void RefuteDecision ( Decision *const  d)
overridevirtual

Before refuting the decision.

Reimplemented from SearchMonitor.

Definition at line 2763 of file search.cc.

◆ RestartSearch()

void RestartSearch ( )
virtualinherited

Restart the search.

Reimplemented in DemonProfiler, and LocalSearchProfiler.

Definition at line 2868 of file constraint_solver.cc.

◆ solver()

Solver * solver ( ) const
inlineinherited

Definition at line 3708 of file constraint_solver.h.

◆ Var()

IntVar * Var ( ) const
inline

Returns the variable that is optimized.

Definition at line 4213 of file constraint_solver.h.

Member Data Documentation

◆ best_

int64 best_
protected

Definition at line 4230 of file constraint_solver.h.

◆ found_initial_solution_

bool found_initial_solution_
protected

Definition at line 4232 of file constraint_solver.h.

◆ kNoProgress

constexpr int kNoProgress = -1
staticconstexprinherited

Definition at line 3637 of file constraint_solver.h.

◆ maximize_

bool maximize_
protected

Definition at line 4231 of file constraint_solver.h.

◆ step_

int64 step_
protected

Definition at line 4229 of file constraint_solver.h.

◆ var_

IntVar* const var_
protected

Definition at line 4228 of file constraint_solver.h.


The documentation for this class was generated from the following files: