operations_research::LocalSearchOperator Class Reference

Detailed Description

The base class for all local search operators. A local search operator is an object that defines the neighborhood of a solution. In other words, a neighborhood is the set of solutions which can be reached from a given solution using an operator. The behavior of the LocalSearchOperator class is similar to iterators. The operator is synchronized with an assignment (gives the current values of the variables); this is done in the Start() method. Then one can iterate over the neighbors using the MakeNextNeighbor method. This method returns an assignment which represents the incremental changes to the current solution. It also returns a second assignment representing the changes to the last solution defined by the neighborhood operator; this assignment is empty if the neighborhood operator cannot track this information.

Todo

(user): rename Start to Synchronize ?

(user): decouple the iterating from the defining of a neighbor.

Definition at line 987 of file constraint_solveri.h.

#include <constraint_solveri.h>

Inheritance diagram for operations_research::LocalSearchOperator:

Public Member Functions
	LocalSearchOperator ()
	~LocalSearchOperator () override
virtual bool	MakeNextNeighbor (Assignment *delta, Assignment *deltadelta)=0
virtual void	EnterSearch ()
virtual void	Start (const Assignment *assignment)=0
virtual void	Reset ()
virtual const LocalSearchOperator *	Self () const
virtual bool	HasFragments () const
virtual bool	HoldsDelta () 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

Constructor & Destructor Documentation

LocalSearchOperator()

operations_research::LocalSearchOperator::LocalSearchOperator ( )

inline

Definition at line 989 of file constraint_solveri.h.

~LocalSearchOperator()

operations_research::LocalSearchOperator::~LocalSearchOperator ( )

inlineoverride

Definition at line 990 of file constraint_solveri.h.

Member Function Documentation

EnterSearch()

virtual void operations_research::LocalSearchOperator::EnterSearch ( )

inlinevirtual

Reimplemented in operations_research::PathOperator< ignore_path_vars >.

Definition at line 992 of file constraint_solveri.h.

HasFragments()

virtual bool operations_research::LocalSearchOperator::HasFragments ( ) const

inlinevirtual

Reimplemented in operations_research::BaseLns, and operations_research::PathLns< ignore_path_vars >.

Definition at line 998 of file constraint_solveri.h.

HoldsDelta()

virtual bool operations_research::LocalSearchOperator::HoldsDelta ( ) const

inlinevirtual

Reimplemented in operations_research::IntVarLocalSearchOperator, and operations_research::NeighborhoodLimit.

Definition at line 999 of file constraint_solveri.h.

MakeNextNeighbor()

virtual bool operations_research::LocalSearchOperator::MakeNextNeighbor ( Assignment * delta, Assignment * deltadelta )

pure virtual

Implemented in operations_research::IndexPairSwapActiveOperator< ignore_path_vars >, operations_research::IntVarLocalSearchOperator, operations_research::NeighborhoodLimit, operations_research::PairNodeSwapActiveOperator< swap_first, ignore_path_vars >, and operations_research::SwapIndexPairOperator.

Reset()

virtual void operations_research::LocalSearchOperator::Reset ( )

inlinevirtual

Reimplemented in operations_research::PathOperator< ignore_path_vars >.

Definition at line 994 of file constraint_solveri.h.

Self()

virtual const LocalSearchOperator * operations_research::LocalSearchOperator::Self ( ) const

inlinevirtual

Definition at line 996 of file constraint_solveri.h.

Start()

virtual void operations_research::LocalSearchOperator::Start ( const Assignment * assignment )

pure virtual

Implemented in operations_research::IntVarLocalSearchOperator, and operations_research::NeighborhoodLimit.

---

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

• ortools/constraint_solver/constraint_solveri.h