Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
operations_research::IntVarLocalSearchOperator Class Reference

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

#include <constraint_solveri.h>

Inheritance diagram for operations_research::IntVarLocalSearchOperator:
Inheritance graph
[legend]
Collaboration diagram for operations_research::IntVarLocalSearchOperator:
Collaboration graph
[legend]

Public Member Functions

 IntVarLocalSearchOperator ()
 
 IntVarLocalSearchOperator (const std::vector< IntVar * > &vars)
 
 ~IntVarLocalSearchOperator () override
 
bool MakeNextNeighbor (Assignment *delta, Assignment *deltadelta) override
 Redefines MakeNextNeighbor to export a simpler interface. More...
 
bool HoldsDelta () const override
 
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
 
virtual std::string DebugString () const
 

Protected Member Functions

virtual bool MakeOneNeighbor ()
 Creates a new neighbor. More...
 
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_
 

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

Constructor & Destructor Documentation

◆ IntVarLocalSearchOperator() [1/2]

operations_research::IntVarLocalSearchOperator::IntVarLocalSearchOperator ( )
inline

Definition at line 1045 of file constraint_solveri.h.

◆ IntVarLocalSearchOperator() [2/2]

operations_research::IntVarLocalSearchOperator::IntVarLocalSearchOperator ( const std::vector< IntVar * > &  vars)
inlineexplicit

Definition at line 1046 of file constraint_solveri.h.

◆ ~IntVarLocalSearchOperator()

operations_research::IntVarLocalSearchOperator::~IntVarLocalSearchOperator ( )
inlineoverride

Definition at line 1051 of file constraint_solveri.h.

Member Function Documentation

◆ Activate()

void operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::Activate ( int64  index)
inlineinherited

Definition at line 871 of file constraint_solveri.h.

◆ Activated()

bool operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::Activated ( int64  index) const
inlineinherited

Definition at line 870 of file constraint_solveri.h.

◆ AddVars()

void operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::AddVars ( const std::vector< IntVar * > &  vars)
inlineinherited

Definition at line 916 of file constraint_solveri.h.

◆ ApplyChanges()

bool operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::ApplyChanges ( Assignment *  delta,
Assignment *  deltadelta 
) const
inlineinherited

Definition at line 879 of file constraint_solveri.h.

◆ Deactivate()

void operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::Deactivate ( int64  index)
inlineinherited

Definition at line 875 of file constraint_solveri.h.

◆ DebugString()

virtual std::string operations_research::BaseObject::DebugString ( ) const
inlinevirtualinherited

Reimplemented in operations_research::Pack, operations_research::Assignment, operations_research::SequenceVar, operations_research::RegularLimit, operations_research::SearchLimit, operations_research::OptimizeVar, operations_research::SolutionCollector, operations_research::IntVarIterator, operations_research::Constraint, operations_research::Demon, operations_research::DecisionBuilder, operations_research::Decision, operations_research::PropagationBaseObject, operations_research::ArrayWithOffset< T >, operations_research::SearchLog, operations_research::BooleanVar, operations_research::LocalSearchMonitor, operations_research::PropagationMonitor, operations_research::LocalSearchFilterManager, operations_research::PathWithPreviousNodesOperator, operations_research::DelayedCallMethod2< T, P, Q >, operations_research::DelayedCallMethod1< T, P >, operations_research::DelayedCallMethod0< T >, operations_research::CallMethod3< T, P, Q, R >, operations_research::CallMethod2< T, P, Q >, operations_research::CallMethod1< T, P >, operations_research::ExchangeSubtrip, operations_research::CallMethod0< T >, operations_research::RelocateSubtrip, operations_research::PairNodeSwapActiveOperator< swap_first >, operations_research::RelocateExpensiveChain, operations_research::IndexPairSwapActiveOperator, operations_research::SwapIndexPairOperator, operations_research::PairExchangeRelocateOperator, operations_research::PairExchangeOperator, operations_research::LightPairRelocateOperator, operations_research::PairRelocateOperator, operations_research::MakePairInactiveOperator, operations_research::MakePairActiveOperator, and operations_research::MakeRelocateNeighborsOperator.

Definition at line 3138 of file constraint_solver.h.

◆ HasFragments()

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

Reimplemented in operations_research::BaseLns.

Definition at line 823 of file constraint_solveri.h.

◆ HoldsDelta()

bool operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::HoldsDelta ( ) const
inlineoverridevirtualinherited

Reimplemented from operations_research::LocalSearchOperator.

Definition at line 839 of file constraint_solveri.h.

◆ IsIncremental()

virtual bool operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::IsIncremental ( ) const
inlinevirtualinherited

Definition at line 855 of file constraint_solveri.h.

◆ MakeNextNeighbor()

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

Reimplemented in operations_research::PairNodeSwapActiveOperator< swap_first >, operations_research::IndexPairSwapActiveOperator, operations_research::SwapIndexPairOperator, and operations_research::MakePairActiveOperator.

◆ MakeOneNeighbor()

virtual bool operations_research::IntVarLocalSearchOperator::MakeOneNeighbor ( )
protectedvirtual

Creates a new neighbor.

It returns false when the neighborhood is completely explored.

Todo:
(user): make it pure virtual, implies porting all apps overriding MakeNextNeighbor() in a subclass of IntVarLocalSearchOperator.

Reimplemented in operations_research::PathOperator, operations_research::ChangeValue, operations_research::BaseLns, and operations_research::RelocateExpensiveChain.

◆ MarkChange()

void operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::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 940 of file constraint_solveri.h.

◆ OldValue()

const int64 & operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::OldValue ( int64  index) const
inlineinherited

Definition at line 865 of file constraint_solveri.h.

◆ OnStart()

virtual void operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::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 operations_research::SwapIndexPairOperator.

Definition at line 935 of file constraint_solveri.h.

◆ Reset()

virtual void operations_research::LocalSearchOperator::Reset ( )
inlinevirtualinherited

Reimplemented in operations_research::PathOperator.

Definition at line 819 of file constraint_solveri.h.

◆ RevertChanges()

void operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::RevertChanges ( bool  incremental)
inlineinherited

Definition at line 903 of file constraint_solveri.h.

◆ Self()

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

Definition at line 821 of file constraint_solveri.h.

◆ SetValue()

void operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::SetValue ( int64  index,
const int64 &  value 
)
inlineinherited

Definition at line 866 of file constraint_solveri.h.

◆ Size()

int operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::Size ( ) const
inlineinherited

Definition at line 856 of file constraint_solveri.h.

◆ SkipUnchanged()

virtual bool operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::SkipUnchanged ( int  index) const
inlinevirtualinherited

Reimplemented in operations_research::PathOperator.

Definition at line 864 of file constraint_solveri.h.

◆ Start()

void operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::Start ( const Assignment *  assignment)
inlineoverridevirtualinherited

This method should not be overridden.

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

Implements operations_research::LocalSearchOperator.

Definition at line 842 of file constraint_solveri.h.

◆ Value()

const int64 & operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::Value ( int64  index) const
inlineinherited

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

Definition at line 858 of file constraint_solveri.h.

◆ Var()

IntVar * operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::Var ( int64  index) const
inlineinherited

Returns the variable of given index.

Definition at line 863 of file constraint_solveri.h.

Member Data Documentation

◆ activated_

Bitset64 operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::activated_
protectedinherited

Definition at line 950 of file constraint_solveri.h.

◆ assignment_indices_

std::vector<int> operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::assignment_indices_
mutableprotectedinherited

Definition at line 949 of file constraint_solveri.h.

◆ changes_

SparseBitset operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::changes_
protectedinherited

Definition at line 952 of file constraint_solveri.h.

◆ cleared_

bool operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::cleared_
protectedinherited

Definition at line 954 of file constraint_solveri.h.

◆ delta_changes_

SparseBitset operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::delta_changes_
protectedinherited

Definition at line 953 of file constraint_solveri.h.

◆ old_values_

std::vector<int64 > operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::old_values_
protectedinherited

Definition at line 947 of file constraint_solveri.h.

◆ prev_values_

std::vector<int64 > operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::prev_values_
protectedinherited

Definition at line 948 of file constraint_solveri.h.

◆ values_

std::vector<int64 > operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::values_
protectedinherited

Definition at line 946 of file constraint_solveri.h.

◆ var_handler_

IntVarLocalSearchHandler operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::var_handler_
protectedinherited

Definition at line 955 of file constraint_solveri.h.

◆ vars_

std::vector<IntVar *> operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::vars_
protectedinherited

Definition at line 945 of file constraint_solveri.h.

◆ was_activated_

Bitset64 operations_research::VarLocalSearchOperator< IntVar , int64 , IntVarLocalSearchHandler >::was_activated_
protectedinherited

Definition at line 951 of file constraint_solveri.h.

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