-------— Objective Management -------— More...

#include <constraint_solver.h>

Inheritance diagram for operations_research::OptimizeVar:

Collaboration diagram for operations_research::OptimizeVar:

[legend]

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

IntVar *	Var () 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...

Solver *	solver () 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 const int	kNoProgress = -1

Protected Attributes
IntVar *const	var_

int64	step_

int64	best_

bool	maximize_

bool	found_initial_solution_

Detailed Description

-------— Objective Management -------—

Todo:

(user): Refactor this into an Objective class:

print methods for AtNode and AtSolution.

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

Definition at line 4186 of file constraint_solver.h.

Constructor & Destructor Documentation

◆ OptimizeVar()

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

◆ ~OptimizeVar()

operations_research::OptimizeVar::~OptimizeVar ( )

override

Member Function Documentation

◆ Accept()

void operations_research::OptimizeVar::Accept ( ModelVisitor *const visitor ) const

overridevirtual

Accepts the given model visitor.

Reimplemented from operations_research::SearchMonitor.

◆ AcceptDelta()

bool operations_research::OptimizeVar::AcceptDelta	(	Assignment *	delta,
		Assignment *	deltadelta
	)

overridevirtual

Internal methods.

Reimplemented from operations_research::SearchMonitor.

◆ AcceptNeighbor()

virtual void operations_research::SearchMonitor::AcceptNeighbor ( )

virtualinherited

After accepting a neighbor during local search.

◆ AcceptSolution()

bool operations_research::OptimizeVar::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 operations_research::SearchMonitor.

◆ AcceptUncheckedNeighbor()

virtual void operations_research::SearchMonitor::AcceptUncheckedNeighbor ( )

virtualinherited

After accepting an unchecked neighbor during local search.

Reimplemented in operations_research::SearchLog.

◆ AfterDecision()

virtual void operations_research::SearchMonitor::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.

◆ ApplyBound()

void operations_research::OptimizeVar::ApplyBound ( )

◆ ApplyDecision()

virtual void operations_research::SearchMonitor::ApplyDecision ( Decision *const d )

virtualinherited

Before applying the decision.

Reimplemented in operations_research::SearchLog.

◆ AtSolution()

bool operations_research::OptimizeVar::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 operations_research::SearchMonitor.

◆ BeginFail()

virtual void operations_research::SearchMonitor::BeginFail ( )

virtualinherited

Just when the failure occurs.

Reimplemented in operations_research::SearchLog.

◆ BeginInitialPropagation()

virtual void operations_research::SearchMonitor::BeginInitialPropagation ( )

virtualinherited

Before the initial propagation.

Reimplemented in operations_research::SearchLog.

◆ BeginNextDecision()

void operations_research::OptimizeVar::BeginNextDecision ( DecisionBuilder *const b )

overridevirtual

Before calling DecisionBuilder::Next.

Reimplemented from operations_research::SearchMonitor.

◆ best()

int64 operations_research::OptimizeVar::best ( ) const

inline

Returns the best value found during search.

Definition at line 4192 of file constraint_solver.h.

◆ DebugString()

std::string operations_research::OptimizeVar::DebugString ( ) const

overridevirtual

Reimplemented from operations_research::BaseObject.

◆ EndFail()

virtual void operations_research::SearchMonitor::EndFail ( )

virtualinherited

After completing the backtrack.

◆ EndInitialPropagation()

virtual void operations_research::SearchMonitor::EndInitialPropagation ( )

virtualinherited

After the initial propagation.

Reimplemented in operations_research::SearchLog.

◆ EndNextDecision()

virtual void operations_research::SearchMonitor::EndNextDecision	(	DecisionBuilder *const	b,
		Decision *const	d
	)

virtualinherited

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

◆ EnterSearch()

void operations_research::OptimizeVar::EnterSearch ( )

overridevirtual

Beginning of the search.

Reimplemented from operations_research::SearchMonitor.

◆ ExitSearch()

virtual void operations_research::SearchMonitor::ExitSearch ( )

virtualinherited

End of the search.

Reimplemented in operations_research::RegularLimit, and operations_research::SearchLog.

◆ Install()

virtual void operations_research::SearchMonitor::Install ( )

virtualinherited

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

Reimplemented in operations_research::LocalSearchMonitor, and operations_research::PropagationMonitor.

◆ IsUncheckedSolutionLimitReached()

virtual bool operations_research::SearchMonitor::IsUncheckedSolutionLimitReached ( )

inlinevirtualinherited

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

Reimplemented in operations_research::RegularLimit.

Definition at line 3687 of file constraint_solver.h.

◆ LocalOptimum()

virtual bool operations_research::SearchMonitor::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.

◆ NoMoreSolutions()

virtual void operations_research::SearchMonitor::NoMoreSolutions ( )

virtualinherited

When the search tree is finished.

Reimplemented in operations_research::SearchLog.

◆ PeriodicCheck()

virtual void operations_research::SearchMonitor::PeriodicCheck ( )

virtualinherited

Periodic call to check limits in long running methods.

Reimplemented in operations_research::SearchLimit.

◆ Print()

virtual std::string operations_research::OptimizeVar::Print ( ) const

virtual

◆ ProgressPercent()

virtual int operations_research::SearchMonitor::ProgressPercent ( )

inlinevirtualinherited

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

Reimplemented in operations_research::RegularLimit.

Definition at line 3696 of file constraint_solver.h.

◆ RefuteDecision()

void operations_research::OptimizeVar::RefuteDecision ( Decision *const d )

overridevirtual

Before refuting the decision.

Reimplemented from operations_research::SearchMonitor.

◆ RestartSearch()

virtual void operations_research::SearchMonitor::RestartSearch ( )

virtualinherited

Restart the search.

◆ solver()

Solver* operations_research::SearchMonitor::solver ( ) const

inlineinherited

Definition at line 3689 of file constraint_solver.h.

◆ Var()

IntVar* operations_research::OptimizeVar::Var ( ) const

inline

Returns the variable that is optimized.

Definition at line 4195 of file constraint_solver.h.

Member Data Documentation

◆ best_

int64 operations_research::OptimizeVar::best_

protected

Definition at line 4212 of file constraint_solver.h.

◆ found_initial_solution_

bool operations_research::OptimizeVar::found_initial_solution_

protected

Definition at line 4214 of file constraint_solver.h.

◆ kNoProgress

const int operations_research::SearchMonitor::kNoProgress = -1

staticinherited

Definition at line 3618 of file constraint_solver.h.

◆ maximize_

bool operations_research::OptimizeVar::maximize_

protected

Definition at line 4213 of file constraint_solver.h.

◆ step_

int64 operations_research::OptimizeVar::step_

protected

Definition at line 4211 of file constraint_solver.h.

◆ var_

IntVar* const operations_research::OptimizeVar::var_

protected

Definition at line 4210 of file constraint_solver.h.

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

constraint_solver.h

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OptimizeVar()

◆ ~OptimizeVar()

Member Function Documentation

◆ Accept()

◆ AcceptDelta()

◆ AcceptNeighbor()

◆ AcceptSolution()

◆ AcceptUncheckedNeighbor()

◆ AfterDecision()

◆ ApplyBound()

◆ ApplyDecision()

◆ AtSolution()

◆ BeginFail()

◆ BeginInitialPropagation()

◆ BeginNextDecision()

◆ best()

◆ DebugString()

◆ EndFail()

◆ EndInitialPropagation()

◆ EndNextDecision()

◆ EnterSearch()

◆ ExitSearch()

◆ Install()

◆ IsUncheckedSolutionLimitReached()

◆ LocalOptimum()

◆ NoMoreSolutions()

◆ PeriodicCheck()

◆ Print()

◆ ProgressPercent()

◆ RefuteDecision()

◆ RestartSearch()

◆ solver()

◆ Var()

Member Data Documentation

◆ best_

◆ found_initial_solution_

◆ kNoProgress

◆ maximize_

◆ step_

◆ var_