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

--— LocalSearchProfiler --— More...

Inheritance diagram for operations_research::LocalSearchProfiler:
operations_research::LocalSearchMonitor operations_research::SearchMonitor operations_research::BaseObject

Public Member Functions

 LocalSearchProfiler (Solver *solver)
 
std::string DebugString () const override
 
void RestartSearch () override
 Restart the search.
 
void ExitSearch () override
 End of the search.
 
template<typename Callback >
void ParseFirstSolutionStatistics (const Callback &callback) const
 
template<typename Callback >
void ParseLocalSearchOperatorStatistics (const Callback &callback) const
 
template<typename Callback >
void ParseLocalSearchFilterStatistics (const Callback &callback) const
 
LocalSearchStatistics ExportToLocalSearchStatistics () const
 
std::string PrintOverview () const
 
void BeginOperatorStart () override
 Local search operator events.
 
void EndOperatorStart () override
 
void BeginMakeNextNeighbor (const LocalSearchOperator *op) override
 
void EndMakeNextNeighbor (const LocalSearchOperator *op, bool neighbor_found, const Assignment *, const Assignment *) override
 
void BeginFilterNeighbor (const LocalSearchOperator *) override
 
void EndFilterNeighbor (const LocalSearchOperator *op, bool neighbor_found) override
 
void BeginAcceptNeighbor (const LocalSearchOperator *) override
 
void EndAcceptNeighbor (const LocalSearchOperator *op, bool neighbor_found) override
 
void BeginFiltering (const LocalSearchFilter *filter) override
 
void EndFiltering (const LocalSearchFilter *filter, bool reject) override
 
void AddFirstSolutionProfiledDecisionBuilder (ProfiledDecisionBuilder *profiled_db)
 
bool IsActive () const override
 
void Install () override
 Install itself on the solver.
 
- Public Member Functions inherited from operations_research::LocalSearchMonitor
 LocalSearchMonitor (Solver *solver)
 -------— Local Search Monitor --------—
 
 ~LocalSearchMonitor () override
 
- 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 EnterSearch ()
 Beginning 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.
 
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 ()
 

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)
 

Detailed Description

--— LocalSearchProfiler --—

Definition at line 4276 of file local_search.cc.

Constructor & Destructor Documentation

◆ LocalSearchProfiler()

operations_research::LocalSearchProfiler::LocalSearchProfiler ( Solver * solver)
inlineexplicit

Definition at line 4278 of file local_search.cc.

Member Function Documentation

◆ AddFirstSolutionProfiledDecisionBuilder()

void operations_research::LocalSearchProfiler::AddFirstSolutionProfiledDecisionBuilder ( ProfiledDecisionBuilder * profiled_db)
inline

Definition at line 4527 of file local_search.cc.

◆ BeginAcceptNeighbor()

void operations_research::LocalSearchProfiler::BeginAcceptNeighbor ( const LocalSearchOperator * )
inlineoverridevirtual

Implements operations_research::LocalSearchMonitor.

Definition at line 4506 of file local_search.cc.

◆ BeginFiltering()

void operations_research::LocalSearchProfiler::BeginFiltering ( const LocalSearchFilter * filter)
inlineoverridevirtual

Implements operations_research::LocalSearchMonitor.

Definition at line 4513 of file local_search.cc.

◆ BeginFilterNeighbor()

void operations_research::LocalSearchProfiler::BeginFilterNeighbor ( const LocalSearchOperator * )
inlineoverridevirtual

Implements operations_research::LocalSearchMonitor.

Definition at line 4499 of file local_search.cc.

◆ BeginMakeNextNeighbor()

void operations_research::LocalSearchProfiler::BeginMakeNextNeighbor ( const LocalSearchOperator * op)
inlineoverridevirtual

Implements operations_research::LocalSearchMonitor.

Definition at line 4487 of file local_search.cc.

◆ BeginOperatorStart()

void operations_research::LocalSearchProfiler::BeginOperatorStart ( )
inlineoverridevirtual

Local search operator events.

Implements operations_research::LocalSearchMonitor.

Definition at line 4485 of file local_search.cc.

◆ DebugString()

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

Reimplemented from operations_research::LocalSearchMonitor.

Definition at line 4279 of file local_search.cc.

◆ EndAcceptNeighbor()

void operations_research::LocalSearchProfiler::EndAcceptNeighbor ( const LocalSearchOperator * op,
bool neighbor_found )
inlineoverridevirtual

Implements operations_research::LocalSearchMonitor.

Definition at line 4507 of file local_search.cc.

◆ EndFiltering()

void operations_research::LocalSearchProfiler::EndFiltering ( const LocalSearchFilter * filter,
bool reject )
inlineoverridevirtual

Implements operations_research::LocalSearchMonitor.

Definition at line 4519 of file local_search.cc.

◆ EndFilterNeighbor()

void operations_research::LocalSearchProfiler::EndFilterNeighbor ( const LocalSearchOperator * op,
bool neighbor_found )
inlineoverridevirtual

Implements operations_research::LocalSearchMonitor.

Definition at line 4500 of file local_search.cc.

◆ EndMakeNextNeighbor()

void operations_research::LocalSearchProfiler::EndMakeNextNeighbor ( const LocalSearchOperator * op,
bool neighbor_found,
const Assignment * ,
const Assignment *  )
inlineoverridevirtual

Implements operations_research::LocalSearchMonitor.

Definition at line 4493 of file local_search.cc.

◆ EndOperatorStart()

void operations_research::LocalSearchProfiler::EndOperatorStart ( )
inlineoverridevirtual

Implements operations_research::LocalSearchMonitor.

Definition at line 4486 of file local_search.cc.

◆ ExitSearch()

void operations_research::LocalSearchProfiler::ExitSearch ( )
inlineoverridevirtual

End of the search.

Update times for current operator when the search ends.

Reimplemented from operations_research::SearchMonitor.

Definition at line 4284 of file local_search.cc.

◆ ExportToLocalSearchStatistics()

LocalSearchStatistics operations_research::LocalSearchProfiler::ExportToLocalSearchStatistics ( ) const
inline

Definition at line 4338 of file local_search.cc.

◆ Install()

void operations_research::LocalSearchProfiler::Install ( )
inlineoverridevirtual

Install itself on the solver.

A local search monitor listens to search events as well as local search events.

Reimplemented from operations_research::LocalSearchMonitor.

Definition at line 4532 of file local_search.cc.

◆ IsActive()

bool operations_research::LocalSearchProfiler::IsActive ( ) const
inlineoverridevirtual

Implements operations_research::LocalSearchMonitor.

Definition at line 4531 of file local_search.cc.

◆ ParseFirstSolutionStatistics()

template<typename Callback >
void operations_research::LocalSearchProfiler::ParseFirstSolutionStatistics ( const Callback & callback) const
inline

Definition at line 4291 of file local_search.cc.

◆ ParseLocalSearchFilterStatistics()

template<typename Callback >
void operations_research::LocalSearchProfiler::ParseLocalSearchFilterStatistics ( const Callback & callback) const
inline

Definition at line 4318 of file local_search.cc.

◆ ParseLocalSearchOperatorStatistics()

template<typename Callback >
void operations_research::LocalSearchProfiler::ParseLocalSearchOperatorStatistics ( const Callback & callback) const
inline

Definition at line 4299 of file local_search.cc.

◆ PrintOverview()

std::string operations_research::LocalSearchProfiler::PrintOverview ( ) const
inline

Definition at line 4388 of file local_search.cc.

◆ RestartSearch()

void operations_research::LocalSearchProfiler::RestartSearch ( )
inlineoverridevirtual

Restart the search.

Reimplemented from operations_research::SearchMonitor.

Definition at line 4280 of file local_search.cc.


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