Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
operations_research::VarLocalSearchOperator< V, Val, Handler > Class Template Referenceabstract

--— Base operator class for operators manipulating variables --— More...

#include <constraint_solveri.h>

Inheritance diagram for operations_research::VarLocalSearchOperator< V, Val, Handler >:
Inheritance graph
[legend]
Collaboration diagram for operations_research::VarLocalSearchOperator< V, Val, Handler >:
Collaboration graph
[legend]

Public Member Functions

 VarLocalSearchOperator ()
 
 VarLocalSearchOperator (std::vector< V * > vars, Handler var_handler)
 
 ~VarLocalSearchOperator () 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
 
const Val & Value (int64 index) const
 Returns the value in the current assignment of the variable of given index. More...
 
V * Var (int64 index) const
 Returns the variable of given index. More...
 
virtual bool SkipUnchanged (int index) const
 
const Val & OldValue (int64 index) const
 
void SetValue (int64 index, const Val &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< V * > &vars)
 
virtual void OnStart ()
 Called by Start() after synchronizing the operator with the current assignment. More...
 
virtual bool MakeNextNeighbor (Assignment *delta, Assignment *deltadelta)=0
 
virtual void Reset ()
 
virtual const LocalSearchOperator * Self () const
 
virtual bool HasFragments () const
 
virtual std::string DebugString () const
 

Protected Member Functions

void MarkChange (int64 index)
 OnStart() should really be protected, but then SWIG doesn't see it. More...
 

Protected Attributes

std::vector< V * > vars_
 
std::vector< Val > values_
 
std::vector< Val > old_values_
 
std::vector< Val > prev_values_
 
std::vector< int > assignment_indices_
 
Bitset64 activated_
 
Bitset64 was_activated_
 
SparseBitset changes_
 
SparseBitset delta_changes_
 
bool cleared_
 
Handler var_handler_
 

Detailed Description

template<class V, class Val, class Handler>
class operations_research::VarLocalSearchOperator< V, Val, Handler >

--— Base operator class for operators manipulating variables --—

Definition at line 830 of file constraint_solveri.h.

Constructor & Destructor Documentation

◆ VarLocalSearchOperator() [1/2]

template<class V, class Val, class Handler>
operations_research::VarLocalSearchOperator< V, Val, Handler >::VarLocalSearchOperator ( )
inline

Definition at line 832 of file constraint_solveri.h.

◆ VarLocalSearchOperator() [2/2]

template<class V, class Val, class Handler>
operations_research::VarLocalSearchOperator< V, Val, Handler >::VarLocalSearchOperator ( std::vector< V * >  vars,
Handler  var_handler 
)
inline

Definition at line 833 of file constraint_solveri.h.

◆ ~VarLocalSearchOperator()

template<class V, class Val, class Handler>
operations_research::VarLocalSearchOperator< V, Val, Handler >::~VarLocalSearchOperator ( )
inlineoverride

Definition at line 838 of file constraint_solveri.h.

Member Function Documentation

◆ Activate()

template<class V, class Val, class Handler>
void operations_research::VarLocalSearchOperator< V, Val, Handler >::Activate ( int64  index)
inline

Definition at line 871 of file constraint_solveri.h.

◆ Activated()

template<class V, class Val, class Handler>
bool operations_research::VarLocalSearchOperator< V, Val, Handler >::Activated ( int64  index) const
inline

Definition at line 870 of file constraint_solveri.h.

◆ AddVars()

template<class V, class Val, class Handler>
void operations_research::VarLocalSearchOperator< V, Val, Handler >::AddVars ( const std::vector< V * > &  vars)
inline

Definition at line 916 of file constraint_solveri.h.

◆ ApplyChanges()

template<class V, class Val, class Handler>
bool operations_research::VarLocalSearchOperator< V, Val, Handler >::ApplyChanges ( Assignment *  delta,
Assignment *  deltadelta 
) const
inline

Definition at line 879 of file constraint_solveri.h.

◆ Deactivate()

template<class V, class Val, class Handler>
void operations_research::VarLocalSearchOperator< V, Val, Handler >::Deactivate ( int64  index)
inline

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

template<class V, class Val, class Handler>
bool operations_research::VarLocalSearchOperator< V, Val, Handler >::HoldsDelta ( ) const
inlineoverridevirtual

Reimplemented from operations_research::LocalSearchOperator.

Definition at line 839 of file constraint_solveri.h.

◆ IsIncremental()

template<class V, class Val, class Handler>
virtual bool operations_research::VarLocalSearchOperator< V, Val, Handler >::IsIncremental ( ) const
inlinevirtual

Definition at line 855 of file constraint_solveri.h.

◆ MakeNextNeighbor()

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

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

◆ MarkChange()

template<class V, class Val, class Handler>
void operations_research::VarLocalSearchOperator< V, Val, Handler >::MarkChange ( int64  index)
inlineprotected

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

template<class V, class Val, class Handler>
const Val& operations_research::VarLocalSearchOperator< V, Val, Handler >::OldValue ( int64  index) const
inline

Definition at line 865 of file constraint_solveri.h.

◆ OnStart()

template<class V, class Val, class Handler>
virtual void operations_research::VarLocalSearchOperator< V, Val, Handler >::OnStart ( )
inlinevirtual

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

template<class V, class Val, class Handler>
void operations_research::VarLocalSearchOperator< V, Val, Handler >::RevertChanges ( bool  incremental)
inline

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

template<class V, class Val, class Handler>
void operations_research::VarLocalSearchOperator< V, Val, Handler >::SetValue ( int64  index,
const Val &  value 
)
inline

Definition at line 866 of file constraint_solveri.h.

◆ Size()

template<class V, class Val, class Handler>
int operations_research::VarLocalSearchOperator< V, Val, Handler >::Size ( ) const
inline

Definition at line 856 of file constraint_solveri.h.

◆ SkipUnchanged()

template<class V, class Val, class Handler>
virtual bool operations_research::VarLocalSearchOperator< V, Val, Handler >::SkipUnchanged ( int  index) const
inlinevirtual

Reimplemented in operations_research::PathOperator.

Definition at line 864 of file constraint_solveri.h.

◆ Start()

template<class V, class Val, class Handler>
void operations_research::VarLocalSearchOperator< V, Val, Handler >::Start ( const Assignment *  assignment)
inlineoverridevirtual

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

template<class V, class Val, class Handler>
const Val& operations_research::VarLocalSearchOperator< V, Val, Handler >::Value ( int64  index) const
inline

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

Definition at line 858 of file constraint_solveri.h.

◆ Var()

template<class V, class Val, class Handler>
V* operations_research::VarLocalSearchOperator< V, Val, Handler >::Var ( int64  index) const
inline

Returns the variable of given index.

Definition at line 863 of file constraint_solveri.h.

Member Data Documentation

◆ activated_

template<class V, class Val, class Handler>
Bitset64 operations_research::VarLocalSearchOperator< V, Val, Handler >::activated_
protected

Definition at line 950 of file constraint_solveri.h.

◆ assignment_indices_

template<class V, class Val, class Handler>
std::vector<int> operations_research::VarLocalSearchOperator< V, Val, Handler >::assignment_indices_
mutableprotected

Definition at line 949 of file constraint_solveri.h.

◆ changes_

template<class V, class Val, class Handler>
SparseBitset operations_research::VarLocalSearchOperator< V, Val, Handler >::changes_
protected

Definition at line 952 of file constraint_solveri.h.

◆ cleared_

template<class V, class Val, class Handler>
bool operations_research::VarLocalSearchOperator< V, Val, Handler >::cleared_
protected

Definition at line 954 of file constraint_solveri.h.

◆ delta_changes_

template<class V, class Val, class Handler>
SparseBitset operations_research::VarLocalSearchOperator< V, Val, Handler >::delta_changes_
protected

Definition at line 953 of file constraint_solveri.h.

◆ old_values_

template<class V, class Val, class Handler>
std::vector<Val> operations_research::VarLocalSearchOperator< V, Val, Handler >::old_values_
protected

Definition at line 947 of file constraint_solveri.h.

◆ prev_values_

template<class V, class Val, class Handler>
std::vector<Val> operations_research::VarLocalSearchOperator< V, Val, Handler >::prev_values_
protected

Definition at line 948 of file constraint_solveri.h.

◆ values_

template<class V, class Val, class Handler>
std::vector<Val> operations_research::VarLocalSearchOperator< V, Val, Handler >::values_
protected

Definition at line 946 of file constraint_solveri.h.

◆ var_handler_

template<class V, class Val, class Handler>
Handler operations_research::VarLocalSearchOperator< V, Val, Handler >::var_handler_
protected

Definition at line 955 of file constraint_solveri.h.

◆ vars_

template<class V, class Val, class Handler>
std::vector<V*> operations_research::VarLocalSearchOperator< V, Val, Handler >::vars_
protected

Definition at line 945 of file constraint_solveri.h.

◆ was_activated_

template<class V, class Val, class Handler>
Bitset64 operations_research::VarLocalSearchOperator< V, Val, Handler >::was_activated_
protected

Definition at line 951 of file constraint_solveri.h.

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