operations_research::OptimizeVar Class Reference

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 4694 of file constraint_solver.h.

#include <constraint_solver.h>

Inheritance diagram for operations_research::OptimizeVar:

Public Member Functions
	OptimizeVar (Solver *solver, bool maximize, IntVar *var, int64_t step)
	OptimizeVar (Solver *solver, const std::vector< bool > &maximize, std::vector< IntVar * > vars, std::vector< int64_t > steps)
	~OptimizeVar () override
int64_t	best () const
	Returns the best value found during search.
IntVar *	var () const
	Returns the variable that is optimized.
void	SetOnOptimalFoundcallback (std::function< void(int64_t)> on_optimal_found)
void	BeginNextDecision (DecisionBuilder *db) override
	Internal methods.
void	RefuteDecision (Decision *d) override
	Before refuting the decision.
bool	AtSolution () override
bool	AcceptSolution () override
virtual std::string	Name () const
std::string	DebugString () const override
void	ApplyBound ()
Public Member Functions inherited from operations_research::ObjectiveMonitor
	ObjectiveMonitor (Solver *solver, const std::vector< bool > &maximize, std::vector< IntVar * > vars, std::vector< int64_t > steps)
	~ObjectiveMonitor () override
	ObjectiveMonitor (const ObjectiveMonitor &)=delete
ObjectiveMonitor &	operator= (const ObjectiveMonitor &)=delete
IntVar *	ObjectiveVar (int index) const override
IntVar *	MinimizationVar (int index) const override
int64_t	Step (int index) const override
bool	Maximize (int index) const override
int64_t	BestValue (int index) const override
int	Size () const override
void	EnterSearch () override
	Beginning of the search.
bool	AcceptDelta (Assignment *delta, Assignment *deltadelta) override
void	Accept (ModelVisitor *visitor) const override
	Accepts the given model visitor.
Public Member Functions inherited from operations_research::BaseObjectiveMonitor
	BaseObjectiveMonitor (Solver *solver)
	~BaseObjectiveMonitor () override
	BaseObjectiveMonitor (const BaseObjectiveMonitor &)=delete
BaseObjectiveMonitor &	operator= (const BaseObjectiveMonitor &)=delete
bool	is_active () const
void	set_active (bool is_active)
Public Member Functions inherited from operations_research::SearchMonitor
	SearchMonitor (Solver *const s)
	SearchMonitor (const SearchMonitor &)=delete
SearchMonitor &	operator= (const SearchMonitor &)=delete
	~SearchMonitor () override
virtual void	RestartSearch ()
	Restart the search.
virtual void	ExitSearch ()
	End of the search.
virtual void	EndNextDecision (DecisionBuilder *b, Decision *d)
	After calling DecisionBuilder::Next, along with the returned decision.
virtual void	ApplyDecision (Decision *d)
	Before applying the decision.
virtual void	AfterDecision (Decision *d, bool apply)
virtual void	BeginFail ()
	Just when the failure occurs.
virtual void	EndFail ()
	After completing the backtrack.
virtual void	BeginInitialPropagation ()
	Before the initial propagation.
virtual void	EndInitialPropagation ()
	After the initial propagation.
virtual void	NoMoreSolutions ()
	When the search tree is finished.
virtual bool	AtLocalOptimum ()
virtual void	AcceptNeighbor ()
	After accepting a neighbor during local search.
virtual void	AcceptUncheckedNeighbor ()
	After accepting an unchecked neighbor during local search.
virtual bool	IsUncheckedSolutionLimitReached ()
virtual void	PeriodicCheck ()
	Periodic call to check limits in long running methods.
virtual int	ProgressPercent ()
virtual void	Install ()
Solver *	solver () const
Public Member Functions inherited from operations_research::BaseObject
	BaseObject ()
	BaseObject (const BaseObject &)=delete
BaseObject &	operator= (const BaseObject &)=delete
virtual	~BaseObject ()=default

Additional Inherited Members
Static Public Attributes inherited from operations_research::SearchMonitor
static constexpr int	kNoProgress = -1
Protected Member Functions inherited from operations_research::ObjectiveMonitor
const std::vector< IntVar * > &	objective_vars () const
const std::vector< IntVar * > &	minimization_vars () const
int64_t	BestInternalValue (int index) const
int64_t	CurrentInternalValue (int index) const
void	SetCurrentInternalValue (int index, int64_t value)
template<typename T>
void	MakeMinimizationVarsLessOrEqualWithSteps (const T &upper_bounds)
template<typename T>
IntVar *	MakeMinimizationVarsLessOrEqualWithStepsStatus (const T &upper_bounds)
bool	CurrentInternalValuesAreConstraining () const
Protected Member Functions inherited from operations_research::SearchMonitor
void	ListenToEvent (Solver::MonitorEvent event)
Protected Attributes inherited from operations_research::ObjectiveMonitor
bool	found_initial_solution_

Constructor & Destructor Documentation

OptimizeVar() [1/2]

operations_research::OptimizeVar::OptimizeVar	(	Solver *	solver,
		bool	maximize,
		IntVar *	var,
		int64_t	step )

Definition at line 3198 of file search.cc.

OptimizeVar() [2/2]

operations_research::OptimizeVar::OptimizeVar	(	Solver *	solver,
		const std::vector< bool > &	maximize,
		std::vector< IntVar * >	vars,
		std::vector< int64_t >	steps )

Definition at line 3203 of file search.cc.

~OptimizeVar()

operations_research::OptimizeVar::~OptimizeVar ( )

inlineoverride

Definition at line 4702 of file constraint_solver.h.

Member Function Documentation

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.

Definition at line 3250 of file search.cc.

ApplyBound()

void operations_research::OptimizeVar::ApplyBound

(

)

Definition at line 3213 of file search.cc.

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

Definition at line 3270 of file search.cc.

BeginNextDecision()

void operations_research::OptimizeVar::BeginNextDecision ( DecisionBuilder * db )

overridevirtual

Internal methods.

Reimplemented from operations_research::SearchMonitor.

Definition at line 3207 of file search.cc.

best()

int64_t operations_research::OptimizeVar::best ( ) const

inline

Returns the best value found during search.

Definition at line 4706 of file constraint_solver.h.

DebugString()

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

overridevirtual

Reimplemented from operations_research::BaseObject.

Definition at line 3277 of file search.cc.

Name()

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

virtual

Definition at line 3275 of file search.cc.

RefuteDecision()

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

overridevirtual

Before refuting the decision.

Reimplemented from operations_research::SearchMonitor.

Definition at line 3236 of file search.cc.

SetOnOptimalFoundcallback()

void operations_research::OptimizeVar::SetOnOptimalFoundcallback ( std::function< void(int64_t)> on_optimal_found )

inline

Sets a callback to be called when the objective value is found to be optimal.

Definition at line 4714 of file constraint_solver.h.

var()

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

inline

Returns the variable that is optimized.

Definition at line 4709 of file constraint_solver.h.

---

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

• ortools/constraint_solver/constraint_solver.h
• ortools/constraint_solver/search.cc