OR-Tools  8.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
IntVarLocalSearchOperator

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 1032 of file constraint_solveri.h.

Public Member Functions

 IntVarLocalSearchOperator ()
 
 IntVarLocalSearchOperator (const std::vector< IntVar * > &vars, bool keep_inverse_values=false)
 
 ~IntVarLocalSearchOperator () override
 
bool MakeNextNeighbor (Assignment *delta, Assignment *deltadelta) override
 Redefines MakeNextNeighbor to export a simpler interface. More...
 
bool HoldsDelta () const override
 
virtual bool HoldsDelta () const
 
void Start (const Assignment *assignment) override
 This method should not be overridden. More...
 
virtual bool IsIncremental () const
 
int Size () const
 
const int64 & Value (int64 index) const
 Returns the value in the current assignment of the variable of given index. More...
 
IntVar * Var (int64 index) const
 Returns the variable of given index. More...
 
virtual bool SkipUnchanged (int index) const
 
const int64 & OldValue (int64 index) const
 
void SetValue (int64 index, const int64 &value)
 
bool Activated (int64 index) const
 
void Activate (int64 index)
 
void Deactivate (int64 index)
 
bool ApplyChanges (Assignment *delta, Assignment *deltadelta) const
 
void RevertChanges (bool incremental)
 
void AddVars (const std::vector< IntVar * > &vars)
 
virtual void OnStart ()
 Called by Start() after synchronizing the operator with the current assignment. More...
 
virtual void Reset ()
 
virtual const LocalSearchOperator * Self () const
 
virtual bool HasFragments () const
 

Protected Member Functions

virtual bool MakeOneNeighbor ()
 Creates a new neighbor. More...
 
bool IsInverseValue (int64 index) const
 
int64 InverseValue (int64 index) const
 
int64 OldInverseValue (int64 index) const
 
void SetInverseValue (int64 index, int64 value)
 
void SetOldInverseValue (int64 index, int64 value)
 
void MarkChange (int64 index)
 OnStart() should really be protected, but then SWIG doesn't see it. More...
 

Protected Attributes

std::vector< IntVar * > vars_
 
std::vector< int64 > values_
 
std::vector< int64 > old_values_
 
std::vector< int64 > prev_values_
 
std::vector< int > assignment_indices_
 
Bitset64 activated_
 
Bitset64 was_activated_
 
SparseBitset changes_
 
SparseBitset delta_changes_
 
bool cleared_
 
IntVarLocalSearchHandler var_handler_
 

Constructor & Destructor Documentation

◆ IntVarLocalSearchOperator() [1/2]

IntVarLocalSearchOperator ( )
inline

Definition at line 1035 of file constraint_solveri.h.

◆ IntVarLocalSearchOperator() [2/2]

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

Definition at line 1039 of file constraint_solveri.h.

◆ ~IntVarLocalSearchOperator()

~IntVarLocalSearchOperator ( )
inlineoverride

Definition at line 1054 of file constraint_solveri.h.

Member Function Documentation

◆ Activate()

void Activate ( int64  index)
inlineinherited

Definition at line 863 of file constraint_solveri.h.

◆ Activated()

bool Activated ( int64  index) const
inlineinherited

Definition at line 862 of file constraint_solveri.h.

◆ AddVars()

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

Definition at line 908 of file constraint_solveri.h.

◆ ApplyChanges()

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

Definition at line 871 of file constraint_solveri.h.

◆ Deactivate()

void Deactivate ( int64  index)
inlineinherited

Definition at line 867 of file constraint_solveri.h.

◆ HasFragments()

virtual bool HasFragments ( ) const
inlinevirtualinherited

Reimplemented in PathLns, BaseLns, SwigDirector_PathOperator, SwigDirector_ChangeValue, SwigDirector_BaseLns, SwigDirector_SequenceVarLocalSearchOperator, SwigDirector_IntVarLocalSearchOperator, SwigDirector_LocalSearchOperator, SwigDirector_ChangeValue, SwigDirector_BaseLns, SwigDirector_IntVarLocalSearchOperator, SwigDirector_LocalSearchOperator, SwigDirector_PathOperator, SwigDirector_ChangeValue, SwigDirector_BaseLns, SwigDirector_SequenceVarLocalSearchOperator, SwigDirector_IntVarLocalSearchOperator, and SwigDirector_LocalSearchOperator.

Definition at line 815 of file constraint_solveri.h.

◆ HoldsDelta() [1/2]

virtual bool HoldsDelta ( ) const
inlinevirtualinherited

Reimplemented in NeighborhoodLimit, VarLocalSearchOperator< V, Val, Handler >, SwigDirector_PathOperator, SwigDirector_ChangeValue, SwigDirector_BaseLns, SwigDirector_SequenceVarLocalSearchOperator, SwigDirector_IntVarLocalSearchOperator, SwigDirector_LocalSearchOperator, SwigDirector_ChangeValue, SwigDirector_BaseLns, SwigDirector_IntVarLocalSearchOperator, SwigDirector_LocalSearchOperator, SwigDirector_PathOperator, SwigDirector_ChangeValue, SwigDirector_BaseLns, SwigDirector_SequenceVarLocalSearchOperator, SwigDirector_IntVarLocalSearchOperator, and SwigDirector_LocalSearchOperator.

Definition at line 816 of file constraint_solveri.h.

◆ HoldsDelta() [2/2]

bool HoldsDelta ( ) const
inlineoverrideinherited

Definition at line 830 of file constraint_solveri.h.

◆ InverseValue()

int64 InverseValue ( int64  index) const
inlineprotected

Definition at line 1077 of file constraint_solveri.h.

◆ IsIncremental()

virtual bool IsIncremental ( ) const
inlinevirtualinherited

Definition at line 846 of file constraint_solveri.h.

◆ IsInverseValue()

bool IsInverseValue ( int64  index) const
inlineprotected

Definition at line 1072 of file constraint_solveri.h.

◆ MakeNextNeighbor()

bool MakeNextNeighbor ( Assignment *  delta,
Assignment *  deltadelta 
)
overridevirtual

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 74 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 TSPLns, PathOperator, ChangeValue, BaseLns, BaseInactiveNodeToPathOperator, RelocateExpensiveChain, MakePairActiveOperator, SwigDirector_PathOperator, SwigDirector_ChangeValue, SwigDirector_IntVarLocalSearchOperator, SwigDirector_ChangeValue, SwigDirector_IntVarLocalSearchOperator, SwigDirector_PathOperator, SwigDirector_ChangeValue, and SwigDirector_IntVarLocalSearchOperator.

Definition at line 95 of file local_search.cc.

◆ MarkChange()

void MarkChange ( int64  index)
inlineprotectedinherited

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).

Definition at line 932 of file constraint_solveri.h.

◆ OldInverseValue()

int64 OldInverseValue ( int64  index) const
inlineprotected

Definition at line 1079 of file constraint_solveri.h.

◆ OldValue()

const int64 & OldValue ( int64  index) const
inlineinherited

Definition at line 857 of file constraint_solveri.h.

◆ OnStart()

virtual void OnStart
inlinevirtualinherited

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

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

Reimplemented in SwapIndexPairOperator, SwigDirector_PathOperator, SwigDirector_ChangeValue, SwigDirector_IntVarLocalSearchOperator, SwigDirector_ChangeValue, SwigDirector_IntVarLocalSearchOperator, SwigDirector_PathOperator, SwigDirector_ChangeValue, and SwigDirector_IntVarLocalSearchOperator.

Definition at line 927 of file constraint_solveri.h.

◆ Reset()

virtual void Reset ( )
inlinevirtualinherited

Reimplemented in PathOperator, SwigDirector_PathOperator, SwigDirector_ChangeValue, SwigDirector_BaseLns, SwigDirector_SequenceVarLocalSearchOperator, SwigDirector_IntVarLocalSearchOperator, SwigDirector_LocalSearchOperator, SwigDirector_ChangeValue, SwigDirector_BaseLns, SwigDirector_IntVarLocalSearchOperator, SwigDirector_LocalSearchOperator, SwigDirector_PathOperator, SwigDirector_ChangeValue, SwigDirector_BaseLns, SwigDirector_SequenceVarLocalSearchOperator, SwigDirector_IntVarLocalSearchOperator, and SwigDirector_LocalSearchOperator.

Definition at line 811 of file constraint_solveri.h.

◆ RevertChanges()

void RevertChanges ( bool  incremental)
inlineinherited

Definition at line 895 of file constraint_solveri.h.

◆ Self()

virtual const LocalSearchOperator* Self ( ) const
inlinevirtualinherited

Definition at line 813 of file constraint_solveri.h.

◆ SetInverseValue()

void SetInverseValue ( int64  index,
int64  value 
)
inlineprotected

Definition at line 1083 of file constraint_solveri.h.

◆ SetOldInverseValue()

void SetOldInverseValue ( int64  index,
int64  value 
)
inlineprotected

Definition at line 1087 of file constraint_solveri.h.

◆ SetValue()

void SetValue ( int64  index,
const Val &  value 
)
inlineinherited

Definition at line 858 of file constraint_solveri.h.

◆ Size()

int Size ( ) const
inlineinherited

Definition at line 847 of file constraint_solveri.h.

◆ SkipUnchanged()

virtual bool SkipUnchanged ( int  index) const
inlinevirtualinherited

Reimplemented in PathOperator, SwigDirector_PathOperator, SwigDirector_ChangeValue, SwigDirector_IntVarLocalSearchOperator, SwigDirector_ChangeValue, SwigDirector_IntVarLocalSearchOperator, SwigDirector_PathOperator, SwigDirector_ChangeValue, and SwigDirector_IntVarLocalSearchOperator.

Definition at line 856 of file constraint_solveri.h.

◆ Start()

void Start ( const Assignment *  assignment)
inlineoverridevirtualinherited

This method should not be overridden.

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

Implements LocalSearchOperator.

Definition at line 833 of file constraint_solveri.h.

◆ Value()

const int64 & Value ( int64  index) const
inlineinherited

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

Definition at line 850 of file constraint_solveri.h.

◆ Var()

IntVar * Var ( int64  index) const
inlineinherited

Returns the variable of given index.

Definition at line 855 of file constraint_solveri.h.

Member Data Documentation

◆ activated_

Bitset64 activated_
protectedinherited

Definition at line 942 of file constraint_solveri.h.

◆ assignment_indices_

std::vector<int> assignment_indices_
mutableprotectedinherited

Definition at line 941 of file constraint_solveri.h.

◆ changes_

SparseBitset changes_
protectedinherited

Definition at line 944 of file constraint_solveri.h.

◆ cleared_

bool cleared_
protectedinherited

Definition at line 946 of file constraint_solveri.h.

◆ delta_changes_

SparseBitset delta_changes_
protectedinherited

Definition at line 945 of file constraint_solveri.h.

◆ old_values_

std::vector<int64 > old_values_
protectedinherited

Definition at line 939 of file constraint_solveri.h.

◆ prev_values_

std::vector<int64 > prev_values_
protectedinherited

Definition at line 940 of file constraint_solveri.h.

◆ values_

std::vector<int64 > values_
protectedinherited

Definition at line 938 of file constraint_solveri.h.

◆ var_handler_

IntVarLocalSearchHandler var_handler_
protectedinherited

Definition at line 947 of file constraint_solveri.h.

◆ vars_

std::vector<IntVar *> vars_
protectedinherited

Definition at line 937 of file constraint_solveri.h.

◆ was_activated_

Bitset64 was_activated_
protectedinherited

Definition at line 943 of file constraint_solveri.h.

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