operations_research::BaseObjectiveMonitor Class Reference

Detailed Description

Base objective monitor class. All metaheuristics and metaheuristic combiners derive from this.

Definition at line 4572 of file constraint_solver.h.

#include <constraint_solver.h>

Inheritance diagram for operations_research::BaseObjectiveMonitor:

Public Member Functions
	BaseObjectiveMonitor (Solver *solver)
	~BaseObjectiveMonitor () override
	BaseObjectiveMonitor (const BaseObjectiveMonitor &)=delete
BaseObjectiveMonitor &	operator= (const BaseObjectiveMonitor &)=delete
virtual IntVar *	ObjectiveVar (int index) const =0
virtual IntVar *	MinimizationVar (int index) const =0
virtual int64_t	Step (int index) const =0
virtual bool	Maximize (int index) const =0
virtual int64_t	BestValue (int index) const =0
virtual int	Size () const =0
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
	This type is neither copyable nor movable.
SearchMonitor &	operator= (const SearchMonitor &)=delete
	~SearchMonitor () override
virtual void	EnterSearch ()
	Beginning of the search.
virtual void	RestartSearch ()
	Restart the search.
virtual void	ExitSearch ()
	End of the search.
virtual void	BeginNextDecision (DecisionBuilder *b)
	Before calling DecisionBuilder::Next.
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	RefuteDecision (Decision *d)
	Before refuting 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 bool	AcceptSolution ()
virtual bool	AtSolution ()
virtual void	NoMoreSolutions ()
	When the search tree is finished.
virtual bool	LocalOptimum ()
virtual bool	AcceptDelta (Assignment *delta, Assignment *deltadelta)
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	Accept (ModelVisitor *visitor) const
	Accepts the given model visitor.
virtual void	Install ()
	A search monitors adds itself on the active search.
Solver *	solver () const
Public Member Functions inherited from operations_research::BaseObject
	BaseObject ()
	BaseObject (const BaseObject &)=delete
	This type is neither copyable nor movable.
BaseObject &	operator= (const BaseObject &)=delete
virtual	~BaseObject ()=default
virtual std::string	DebugString () const

Additional Inherited Members
Static Public Attributes inherited from operations_research::SearchMonitor
static constexpr int	kNoProgress = -1
Protected Member Functions inherited from operations_research::SearchMonitor
void	ListenToEvent (Solver::MonitorEvent event)

Constructor & Destructor Documentation

BaseObjectiveMonitor() [1/2]

operations_research::BaseObjectiveMonitor::BaseObjectiveMonitor ( Solver * solver )

inlineexplicit

Definition at line 4574 of file constraint_solver.h.

~BaseObjectiveMonitor()

operations_research::BaseObjectiveMonitor::~BaseObjectiveMonitor ( )

inlineoverride

Definition at line 4575 of file constraint_solver.h.

BaseObjectiveMonitor() [2/2]

operations_research::BaseObjectiveMonitor::BaseObjectiveMonitor ( const BaseObjectiveMonitor & )

delete

Member Function Documentation

BestValue()

virtual int64_t operations_research::BaseObjectiveMonitor::BestValue ( int index ) const

pure virtual

Implemented in operations_research::ObjectiveMonitor, and operations_research::RoundRobinCompoundObjectiveMonitor.

is_active()

bool operations_research::BaseObjectiveMonitor::is_active ( ) const

inline

Definition at line 4586 of file constraint_solver.h.

Maximize()

virtual bool operations_research::BaseObjectiveMonitor::Maximize ( int index ) const

pure virtual

Implemented in operations_research::ObjectiveMonitor, and operations_research::RoundRobinCompoundObjectiveMonitor.

MinimizationVar()

virtual IntVar * operations_research::BaseObjectiveMonitor::MinimizationVar ( int index ) const

pure virtual

Implemented in operations_research::ObjectiveMonitor, and operations_research::RoundRobinCompoundObjectiveMonitor.

ObjectiveVar()

virtual IntVar * operations_research::BaseObjectiveMonitor::ObjectiveVar ( int index ) const

pure virtual

Implemented in operations_research::ObjectiveMonitor, and operations_research::RoundRobinCompoundObjectiveMonitor.

operator=()

BaseObjectiveMonitor & operations_research::BaseObjectiveMonitor::operator= ( const BaseObjectiveMonitor & )

delete

set_active()

void operations_research::BaseObjectiveMonitor::set_active ( bool is_active )

inline

Definition at line 4587 of file constraint_solver.h.

Size()

virtual int operations_research::BaseObjectiveMonitor::Size ( ) const

pure virtual

Implemented in operations_research::ObjectiveMonitor, and operations_research::RoundRobinCompoundObjectiveMonitor.

Step()

virtual int64_t operations_research::BaseObjectiveMonitor::Step ( int index ) const

pure virtual

Implemented in operations_research::ObjectiveMonitor, and operations_research::RoundRobinCompoundObjectiveMonitor.

---

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

• ortools/constraint_solver/constraint_solver.h