OR-Tools  8.2
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
NeighborhoodGeneratorabstract

Detailed Description

Definition at line 189 of file cp_model_lns.h.

Classes

struct  SolveData
 

Public Member Functions

 NeighborhoodGenerator (const std::string &name, NeighborhoodGeneratorHelper const *helper)
 
virtual ~NeighborhoodGenerator ()
 
virtual Neighborhood Generate (const CpSolverResponse &initial_solution, double difficulty, absl::BitGenRef random)=0
 
virtual bool ReadyToGenerate () const
 
virtual bool IsRelaxationGenerator () const
 
double GetUCBScore (int64 total_num_calls) const
 
void AddSolveData (SolveData data)
 
void Synchronize ()
 
std::string name () const
 
int64 num_calls () const
 
int64 num_fully_solved_calls () const
 
double difficulty () const
 
double deterministic_limit () const
 
double deterministic_time () const
 

Protected Member Functions

virtual void AdditionalProcessingOnSynchronize (const SolveData &solve_data)
 

Protected Attributes

const std::string name_
 
const NeighborhoodGeneratorHelper & helper_
 
absl::Mutex mutex_
 

Constructor & Destructor Documentation

◆ NeighborhoodGenerator()

NeighborhoodGenerator ( const std::string &  name,
NeighborhoodGeneratorHelper const *  helper 
)
inline

Definition at line 191 of file cp_model_lns.h.

◆ ~NeighborhoodGenerator()

virtual ~NeighborhoodGenerator ( )
inlinevirtual

Definition at line 194 of file cp_model_lns.h.

Member Function Documentation

◆ AdditionalProcessingOnSynchronize()

virtual void AdditionalProcessingOnSynchronize ( const SolveData &  solve_data)
inlineprotectedvirtual

Definition at line 325 of file cp_model_lns.h.

◆ AddSolveData()

void AddSolveData ( SolveData  data)
inline

Definition at line 279 of file cp_model_lns.h.

◆ deterministic_limit()

double deterministic_limit ( ) const
inline

Definition at line 310 of file cp_model_lns.h.

◆ deterministic_time()

double deterministic_time ( ) const
inline

Definition at line 316 of file cp_model_lns.h.

◆ difficulty()

double difficulty ( ) const
inline

Definition at line 304 of file cp_model_lns.h.

◆ Generate()

virtual Neighborhood Generate ( const CpSolverResponse &  initial_solution,
double  difficulty,
absl::BitGenRef  random 
)
pure virtual

Implemented in SimpleNeighborhoodGenerator, SimpleConstraintNeighborhoodGenerator, VariableGraphNeighborhoodGenerator, ConstraintGraphNeighborhoodGenerator, SchedulingNeighborhoodGenerator, SchedulingTimeWindowNeighborhoodGenerator, RelaxationInducedNeighborhoodGenerator, ConsecutiveConstraintsRelaxationNeighborhoodGenerator, and WeightedRandomRelaxationNeighborhoodGenerator.

◆ GetUCBScore()

double GetUCBScore ( int64  total_num_calls) const

Definition at line 305 of file cp_model_lns.cc.

◆ IsRelaxationGenerator()

virtual bool IsRelaxationGenerator ( ) const
inlinevirtual

Reimplemented in ConsecutiveConstraintsRelaxationNeighborhoodGenerator, and WeightedRandomRelaxationNeighborhoodGenerator.

Definition at line 218 of file cp_model_lns.h.

◆ name()

std::string name ( ) const
inline

Definition at line 289 of file cp_model_lns.h.

◆ num_calls()

int64 num_calls ( ) const
inline

Definition at line 292 of file cp_model_lns.h.

◆ num_fully_solved_calls()

int64 num_fully_solved_calls ( ) const
inline

Definition at line 298 of file cp_model_lns.h.

◆ ReadyToGenerate()

bool ReadyToGenerate ( ) const
virtual

Reimplemented in RelaxationInducedNeighborhoodGenerator, ConsecutiveConstraintsRelaxationNeighborhoodGenerator, and WeightedRandomRelaxationNeighborhoodGenerator.

Definition at line 301 of file cp_model_lns.cc.

◆ Synchronize()

void Synchronize ( )

Definition at line 312 of file cp_model_lns.cc.

Member Data Documentation

◆ helper_

const NeighborhoodGeneratorHelper& helper_
protected

Definition at line 328 of file cp_model_lns.h.

◆ mutex_

absl::Mutex mutex_
mutableprotected

Definition at line 329 of file cp_model_lns.h.

◆ name_

const std::string name_
protected

Definition at line 327 of file cp_model_lns.h.

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