Google OR-Tools: operations_research::SearchLog Class Reference

The base class of all search logs that periodically outputs information when the search is running.

Definition at line 3398 of file constraint_solveri.h.

#include <constraint_solveri.h>

operations_research::SearchMonitor operations_research::BaseObject

Public Member Functions

 SearchLog (Solver *solver, std::vector< IntVar * > vars, std::string vars_name, std::vector< double > scaling_factors, std::vector< double > offsets, std::function< std::string()> display_callback, bool display_on_new_solutions_only, int period)
 ~SearchLog () override
void EnterSearch () override
 Beginning of the search.
void ExitSearch () override
 End of the search.
bool AtSolution () override
void BeginFail () override
 Just when the failure occurs.
void NoMoreSolutions () override
 When the search tree is finished.
void AcceptUncheckedNeighbor () override
 After accepting an unchecked neighbor during local search.
void ApplyDecision (Decision *decision) override
 Before applying the decision.
void RefuteDecision (Decision *decision) override
 Before refuting the decision.
void OutputDecision ()
void Maintain ()
void BeginInitialPropagation () override
 Before the initial propagation.
void EndInitialPropagation () override
 After the initial propagation.
std::string DebugString () const override
Public Member Functions inherited from operations_research::SearchMonitor
 SearchMonitor (Solver *const s)
 SearchMonitor (const SearchMonitor &)=delete
SearchMonitoroperator= (const SearchMonitor &)=delete
 ~SearchMonitor () override
virtual void RestartSearch ()
 Restart 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 AfterDecision (Decision *d, bool apply)
virtual void EndFail ()
 After completing the backtrack.
virtual bool AcceptSolution ()
virtual bool AtLocalOptimum ()
virtual bool AcceptDelta (Assignment *delta, Assignment *deltadelta)
virtual void AcceptNeighbor ()
 After accepting a 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 ()
Solversolver () const
Public Member Functions inherited from operations_research::BaseObject
 BaseObject ()
 BaseObject (const BaseObject &)=delete
BaseObjectoperator= (const BaseObject &)=delete
virtual ~BaseObject ()=default
operations_research::SearchLog::SearchLog ( Solver * solver,
std::vector< IntVar * > vars,
std::string vars_name,
std::vector< double > scaling_factors,
std::vector< double > offsets,
std::function< std::string()> display_callback,
bool display_on_new_solutions_only,
int period )

◆ ~SearchLog()

operations_research::SearchLog::~SearchLog ( )
override

◆ AcceptUncheckedNeighbor()

void operations_research::SearchLog::AcceptUncheckedNeighbor ( )
overridevirtual

◆ ApplyDecision()

void operations_research::SearchLog::ApplyDecision ( Decision * d)
overridevirtual

◆ AtSolution()

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

Definition at line 116 of file search.cc.

◆ BeginFail()

void operations_research::SearchLog::BeginFail ( )
overridevirtual

◆ BeginInitialPropagation()

void operations_research::SearchLog::BeginInitialPropagation ( )
overridevirtual

◆ DebugString()

std::string operations_research::SearchLog::DebugString ( ) const
overridevirtual

◆ EndInitialPropagation()

void operations_research::SearchLog::EndInitialPropagation ( )
overridevirtual

◆ EnterSearch()

void operations_research::SearchLog::EnterSearch ( )
overridevirtual

◆ ExitSearch()

void operations_research::SearchLog::ExitSearch ( )
overridevirtual

◆ Maintain()

void operations_research::SearchLog::Maintain ( )

◆ NoMoreSolutions()

void operations_research::SearchLog::NoMoreSolutions ( )
overridevirtual

◆ OutputDecision()

void operations_research::SearchLog::OutputDecision ( )

◆ OutputLine()

void operations_research::SearchLog::OutputLine ( const std::string & line)
protectedvirtual

◆ RefuteDecision()

void operations_research::SearchLog::RefuteDecision ( Decision * d)
overridevirtual

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