Detailed Description

Specialization of LocalSearchOperator built from an array of IntVars which specifies the scope of the operator.

This class also takes care of storing current variable values in Start(), keeps track of changes done by the operator and builds the delta. The Deactivate() method can be used to perform Large Neighborhood Search.

Definition at line 1048 of file constraint_solveri.h.

Public Member Functions
	IntVarLocalSearchOperator (const std::vector< IntVar * > &vars, bool keep_inverse_values=false)

	~IntVarLocalSearchOperator () override

bool	HoldsDelta () const override

void	Start (const Assignment *assignment) override
	This method should not be overridden. More...

virtual bool	IsIncremental () const

int	Size () const

int64_t	Value (int64_t index) const
	Returns the value in the current assignment of the variable of given index. More...

IntVar *	Var (int64_t index) const
	Returns the variable of given index. More...

virtual bool	SkipUnchanged (int index) const

int64_t	OldValue (int64_t index) const

int64_t	PrevValue (int64_t index) const

void	SetValue (int64_t index, int64_t value)

bool	Activated (int64_t index) const

void	Activate (int64_t index)

void	Deactivate (int64_t index)

bool	ApplyChanges (Assignment delta, Assignment deltadelta) const

void	RevertChanges (bool change_was_incremental)

void	AddVars (const std::vector< IntVar * > &vars)

virtual void	OnStart ()
	Called by Start() after synchronizing the operator with the current assignment. More...

bool	MakeNextNeighbor (Assignment delta, Assignment deltadelta) override
	OnStart() should really be protected, but then SWIG doesn't see it. More...

virtual void	Reset ()

virtual const LocalSearchOperator *	Self () const

virtual bool	HasFragments () const

virtual std::string	DebugString () const

Protected Member Functions
virtual bool	MakeOneNeighbor ()
	Creates a new neighbor. More...

int64_t	InverseValue (int64_t index) const

int64_t	OldInverseValue (int64_t index) const

void	AddToAssignment (IntVar var, int64_t value, bool active, std::vector< int > assignment_indices, int64_t index, Assignment *assignment) const

Constructor & Destructor Documentation

◆ IntVarLocalSearchOperator()

IntVarLocalSearchOperator	(	const std::vector< IntVar * > &	vars,
		bool	keep_inverse_values = `false`
	)

inlineexplicit

Definition at line 1053 of file constraint_solveri.h.

◆ ~IntVarLocalSearchOperator()

~IntVarLocalSearchOperator ( )

inlineoverride

Definition at line 1064 of file constraint_solveri.h.

Member Function Documentation

◆ Activate()

void Activate ( int64_t index )

inline

Definition at line 1111 of file constraint_solveri.h.

◆ Activated()

bool Activated ( int64_t index ) const

inline

Definition at line 1108 of file constraint_solveri.h.

◆ AddToAssignment()

void AddToAssignment	(	IntVar *	var,
		int64_t	value,
		bool	active,
		std::vector< int > *	assignment_indices,
		int64_t	index,
		Assignment *	assignment
	)		const

inlineprotected

Definition at line 1188 of file constraint_solveri.h.

◆ AddVars()

void AddVars ( const std::vector< IntVar * > & vars )

inline

Definition at line 1149 of file constraint_solveri.h.

◆ ApplyChanges()

bool ApplyChanges	(	Assignment *	delta,
		Assignment *	deltadelta
	)		const

inline

Definition at line 1114 of file constraint_solveri.h.

◆ Deactivate()

void Deactivate ( int64_t index )

inline

Definition at line 1112 of file constraint_solveri.h.

◆ DebugString()

virtual std::string DebugString ( ) const

inlinevirtualinherited

Reimplemented in SymmetryManager, IntVarFilteredDecisionBuilder, ExchangeSubtrip, RelocateSubtrip, PairNodeSwapActiveOperator< swap_first >, RelocateExpensiveChain, FilteredHeuristicCloseNodesLNSOperator, FilteredHeuristicExpensiveChainLNSOperator, RelocatePathAndHeuristicInsertUnperformedOperator, FilteredHeuristicPathLNSOperator, IndexPairSwapActiveOperator, SwapIndexPairOperator, PairExchangeRelocateOperator, PairExchangeOperator, LightPairRelocateOperator, GroupPairAndRelocateOperator, PairRelocateOperator, MakePairInactiveOperator, MakePairActiveOperator, SwapActiveToShortestPathOperator, MakeRelocateNeighborsOperator, GlobalVehicleBreaksConstraint, Dimension, LocalSearchPhaseParameters, FindOneNeighbor, LocalSearchProfiler, NeighborhoodLimit, PathLns, LinKernighan, TSPLns, TSPOpt, ExtendedSwapActiveOperator, SwapActiveOperator, MakeChainInactiveOperator, RelocateAndMakeInactiveOperator, MakeInactiveOperator, MakeActiveAndRelocate, RelocateAndMakeActiveOperator, MakeActiveOperator, Cross, Exchange, Relocate, TwoOpt, PiecewiseLinearExpr, IfThenElseCt, DemonProfiler, ArrayWithOffset< T >, SearchLog, BooleanVar, LocalSearchMonitor, PropagationMonitor, LocalSearchFilterManager, LightIntIntFunctionElementCt< F >, LightIntFunctionElementCt< F >, DelayedCallMethod2< T, P, Q >, DelayedCallMethod1< T, P >, DelayedCallMethod0< T >, CallMethod3< T, P, Q, R >, CallMethod2< T, P, Q >, CallMethod1< T, P >, CallMethod0< T >, Pack, Assignment, SequenceVar, RegularLimit, SearchLimit, OptimizeVar, SolutionCollector, IntVarIterator, Constraint, Demon, ProfiledDecisionBuilder, DecisionBuilder, Decision, PropagationBaseObject, LocalSearchMonitorPrimary, and Trace.

Definition at line 3251 of file constraint_solver.h.

◆ HasFragments()

virtual bool HasFragments ( ) const

inlinevirtualinherited

Reimplemented in PathLns, and BaseLns.

Definition at line 922 of file constraint_solveri.h.

◆ HoldsDelta()

bool HoldsDelta ( ) const

inlineoverridevirtual

Reimplemented from LocalSearchOperator.

Definition at line 1066 of file constraint_solveri.h.

◆ InverseValue()

int64_t InverseValue ( int64_t index ) const

inlineprotected

Definition at line 1181 of file constraint_solveri.h.

◆ IsIncremental()

virtual bool IsIncremental ( ) const

inlinevirtual

Reimplemented in TwoOpt.

Definition at line 1089 of file constraint_solveri.h.

◆ MakeNextNeighbor()

bool MakeNextNeighbor	(	Assignment *	delta,
		Assignment *	deltadelta
	)

overridevirtual

OnStart() should really be protected, but then SWIG doesn't see it.

So we make it public, but only subclasses should access to it (to override it). Redefines MakeNextNeighbor to export a simpler interface. The calls to ApplyChanges() and RevertChanges() are factored in this method, hiding both delta and deltadelta from subclasses which only need to override MakeOneNeighbor(). Therefore this method should not be overridden. Override MakeOneNeighbor() instead.

Implements LocalSearchOperator.

Reimplemented in PairNodeSwapActiveOperator< swap_first >, IndexPairSwapActiveOperator, and SwapIndexPairOperator.

Definition at line 79 of file local_search.cc.

◆ MakeOneNeighbor()

bool MakeOneNeighbor ( )

protectedvirtual

Creates a new neighbor.

It returns false when the neighborhood is completely explored. MakeNextNeighbor() in a subclass of IntVarLocalSearchOperator.

Reimplemented in RelocateExpensiveChain, MakePairActiveOperator, TSPLns, BaseInactiveNodeToPathOperator, PathOperator, ChangeValue, and BaseLns.

Definition at line 100 of file local_search.cc.

◆ OldInverseValue()

int64_t OldInverseValue ( int64_t index ) const

inlineprotected

Definition at line 1184 of file constraint_solveri.h.

◆ OldValue()

int64_t OldValue ( int64_t index ) const

inline

Definition at line 1101 of file constraint_solveri.h.

◆ OnStart()

virtual void OnStart ( )

inlinevirtual

Called by Start() after synchronizing the operator with the current assignment.

Should be overridden instead of Start() to avoid calling IntVarLocalSearchOperator::Start explicitly.

Reimplemented in SwapIndexPairOperator.

Definition at line 1161 of file constraint_solveri.h.

◆ PrevValue()

int64_t PrevValue ( int64_t index ) const

inline

Definition at line 1102 of file constraint_solveri.h.

◆ Reset()

virtual void Reset ( )

inlinevirtualinherited

Reimplemented in PathOperator.

Definition at line 918 of file constraint_solveri.h.

◆ RevertChanges()

void RevertChanges ( bool change_was_incremental )

inline

Definition at line 1138 of file constraint_solveri.h.

◆ Self()

virtual const LocalSearchOperator* Self ( ) const

inlinevirtualinherited

Definition at line 920 of file constraint_solveri.h.

◆ SetValue()

void SetValue	(	int64_t	index,
		int64_t	value
	)

inline

Definition at line 1105 of file constraint_solveri.h.

◆ Size()

int Size ( ) const

inline

Definition at line 1091 of file constraint_solveri.h.

◆ SkipUnchanged()

virtual bool SkipUnchanged ( int index ) const

inlinevirtual

Reimplemented in PathOperator.

Definition at line 1100 of file constraint_solveri.h.

◆ Start()

void Start ( const Assignment * assignment )

inlineoverridevirtual

This method should not be overridden.

Override OnStart() instead which is called before exiting this method.

Implements LocalSearchOperator.

Definition at line 1069 of file constraint_solveri.h.

◆ Value()

int64_t Value ( int64_t index ) const

inline

Returns the value in the current assignment of the variable of given index.

Definition at line 1094 of file constraint_solveri.h.

◆ Var()

IntVar* Var ( int64_t index ) const

inline

Returns the variable of given index.

Definition at line 1099 of file constraint_solveri.h.

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

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ IntVarLocalSearchOperator()

◆ ~IntVarLocalSearchOperator()

Member Function Documentation

◆ Activate()

◆ Activated()

◆ AddToAssignment()

◆ AddVars()

◆ ApplyChanges()

◆ Deactivate()

◆ DebugString()

◆ HasFragments()

◆ HoldsDelta()

◆ InverseValue()

◆ IsIncremental()

◆ MakeNextNeighbor()

◆ MakeOneNeighbor()

◆ OldInverseValue()

◆ OldValue()

◆ OnStart()

◆ PrevValue()

◆ Reset()

◆ RevertChanges()

◆ Self()

◆ SetValue()

◆ Size()

◆ SkipUnchanged()

◆ Start()

◆ Value()

◆ Var()