Google OR-Tools v9.14
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
operations_research::RoundRobinCompoundObjectiveMonitor Class Reference

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

Detailed Description

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

Definition at line 2972 of file search.cc.

Inheritance diagram for operations_research::RoundRobinCompoundObjectiveMonitor:
operations_research::BaseObjectiveMonitor operations_research::SearchMonitor operations_research::BaseObject

Public Member Functions

 RoundRobinCompoundObjectiveMonitor (std::vector< BaseObjectiveMonitor * > monitors, int num_max_local_optima_before_metaheuristic_switch)
void EnterSearch () override
 Beginning of the search.
void ApplyDecision (Decision *d) override
 Before applying the decision.
void AcceptNeighbor () override
 After accepting a neighbor during local search.
bool AtSolution () override
bool AcceptDelta (Assignment *delta, Assignment *deltadelta) override
void BeginNextDecision (DecisionBuilder *db) override
 Before calling DecisionBuilder::Next.
void RefuteDecision (Decision *d) override
 Before refuting the decision.
bool AcceptSolution () override
bool LocalOptimum () override
IntVarObjectiveVar (int index) const override
IntVarMinimizationVar (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
std::string DebugString () const 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
BaseObjectiveMonitoroperator= (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
 This type is neither copyable nor movable.
SearchMonitoroperator= (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 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 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 ()
 A search monitors adds itself on the active search.
Solversolver () const
Public Member Functions inherited from operations_research::BaseObject
 BaseObject ()
 BaseObject (const BaseObject &)=delete
 This type is neither copyable nor movable.
BaseObjectoperator= (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::SearchMonitor
void ListenToEvent (Solver::MonitorEvent event)

Constructor & Destructor Documentation

◆ RoundRobinCompoundObjectiveMonitor()

operations_research::RoundRobinCompoundObjectiveMonitor::RoundRobinCompoundObjectiveMonitor ( std::vector< BaseObjectiveMonitor * > monitors,
int num_max_local_optima_before_metaheuristic_switch )
inline

Definition at line 2974 of file search.cc.

Member Function Documentation

◆ Accept()

void operations_research::RoundRobinCompoundObjectiveMonitor::Accept ( ModelVisitor * visitor) const
inlineoverridevirtual

Accepts the given model visitor.

Todo
(user): properly implement this.

Reimplemented from operations_research::SearchMonitor.

Definition at line 3055 of file search.cc.

◆ AcceptDelta()

bool operations_research::RoundRobinCompoundObjectiveMonitor::AcceptDelta ( Assignment * delta,
Assignment * deltadelta )
inlineoverridevirtual

Reimplemented from operations_research::SearchMonitor.

Definition at line 3004 of file search.cc.

◆ AcceptNeighbor()

void operations_research::RoundRobinCompoundObjectiveMonitor::AcceptNeighbor ( )
inlineoverridevirtual

After accepting a neighbor during local search.

Reimplemented from operations_research::SearchMonitor.

Definition at line 2994 of file search.cc.

◆ AcceptSolution()

bool operations_research::RoundRobinCompoundObjectiveMonitor::AcceptSolution ( )
inlineoverridevirtual

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

◆ ApplyDecision()

void operations_research::RoundRobinCompoundObjectiveMonitor::ApplyDecision ( Decision * d)
inlineoverridevirtual

Before applying the decision.

Reimplemented from operations_research::SearchMonitor.

Definition at line 2991 of file search.cc.

◆ AtSolution()

bool operations_research::RoundRobinCompoundObjectiveMonitor::AtSolution ( )
inlineoverridevirtual

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.

Definition at line 2997 of file search.cc.

◆ BeginNextDecision()

void operations_research::RoundRobinCompoundObjectiveMonitor::BeginNextDecision ( DecisionBuilder * b)
inlineoverridevirtual

Before calling DecisionBuilder::Next.

Reimplemented from operations_research::SearchMonitor.

Definition at line 3007 of file search.cc.

◆ BestValue()

int64_t operations_research::RoundRobinCompoundObjectiveMonitor::BestValue ( int index) const
inlineoverridevirtual

Implements operations_research::BaseObjectiveMonitor.

Definition at line 3048 of file search.cc.

◆ DebugString()

std::string operations_research::RoundRobinCompoundObjectiveMonitor::DebugString ( ) const
inlineoverridevirtual

Reimplemented from operations_research::BaseObject.

Definition at line 3052 of file search.cc.

◆ EnterSearch()

void operations_research::RoundRobinCompoundObjectiveMonitor::EnterSearch ( )
inlineoverridevirtual

Beginning of the search.

-------— Search Monitor -------—

Reimplemented from operations_research::SearchMonitor.

Definition at line 2982 of file search.cc.

◆ LocalOptimum()

bool operations_research::RoundRobinCompoundObjectiveMonitor::LocalOptimum ( )
inlineoverridevirtual

When a local optimum is reached. If 'true' is returned, the last solution is discarded and the search proceeds with the next one.

Reimplemented from operations_research::SearchMonitor.

Definition at line 3016 of file search.cc.

◆ Maximize()

bool operations_research::RoundRobinCompoundObjectiveMonitor::Maximize ( int index) const
inlineoverridevirtual

Implements operations_research::BaseObjectiveMonitor.

Definition at line 3045 of file search.cc.

◆ MinimizationVar()

IntVar * operations_research::RoundRobinCompoundObjectiveMonitor::MinimizationVar ( int index) const
inlineoverridevirtual

Implements operations_research::BaseObjectiveMonitor.

Definition at line 3039 of file search.cc.

◆ ObjectiveVar()

IntVar * operations_research::RoundRobinCompoundObjectiveMonitor::ObjectiveVar ( int index) const
inlineoverridevirtual

Implements operations_research::BaseObjectiveMonitor.

Definition at line 3036 of file search.cc.

◆ RefuteDecision()

void operations_research::RoundRobinCompoundObjectiveMonitor::RefuteDecision ( Decision * d)
inlineoverridevirtual

Before refuting the decision.

Reimplemented from operations_research::SearchMonitor.

Definition at line 3010 of file search.cc.

◆ Size()

int operations_research::RoundRobinCompoundObjectiveMonitor::Size ( ) const
inlineoverridevirtual

Implements operations_research::BaseObjectiveMonitor.

Definition at line 3051 of file search.cc.

◆ Step()

int64_t operations_research::RoundRobinCompoundObjectiveMonitor::Step ( int index) const
inlineoverridevirtual

Implements operations_research::BaseObjectiveMonitor.

Definition at line 3042 of file search.cc.


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