C++ Reference

C++ Reference: Routing

PathWithPreviousNodesOperatorabstract

Detailed Description

Simple PathOperator wrapper that also stores the current previous nodes, and is thus able to provide the "Prev" and "IsPathStart" functions.

Definition at line 1499 of file constraint_solveri.h.

Public Member Functions

 PathWithPreviousNodesOperator (const std::vector< IntVar * > &vars, const std::vector< IntVar * > &secondary_vars, int number_of_base_nodes, std::function< int(int64)> start_empty_path_class)
 
 ~PathWithPreviousNodesOperator () override
 
bool IsPathStart (int64 node) const
 
int64 Prev (int64 node) const
 
std::string DebugString () const override
 
virtual bool MakeNeighbor ()=0
 
void Reset () override
 
bool SkipUnchanged (int index) const override
 
int64 Next (int64 node) const
 Returns the node after node in the current delta. More...
 
int64 Path (int64 node) const
 Returns the index of the path to which node belongs in the current delta. More...
 
int number_of_nexts () const
 Number of next variables. More...
 
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...
 
IntVarVar (int64 index) const
 Returns the variable of given index. More...
 
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 const LocalSearchOperatorSelf () const
 
virtual bool HasFragments () const
 

Protected Member Functions

void OnNodeInitialization () override
 Called by OnStart() after initializing node information. More...
 
bool MakeOneNeighbor () override
 This method should not be overridden. Override MakeNeighbor() instead. More...
 
int64 BaseNode (int i) const
 Returns the ith base node of the operator. More...
 
int64 StartNode (int i) const
 Returns the start node of the ith base node. More...
 
const std::vector< int64 > & path_starts () const
 Returns the vector of path start nodes. More...
 
int PathClass (int i) const
 Returns the class of the path of the ith base node. More...
 
virtual bool RestartAtPathStartOnSynchronize ()
 When the operator is being synchronized with a new solution (when Start() is called), returns true to restart the exploration of the neighborhood from the start of the last paths explored; returns false to restart the exploration at the last nodes visited. More...
 
virtual bool OnSamePathAsPreviousBase (int64 base_index)
 Returns true if a base node has to be on the same path as the "previous" base node (base node of index base_index - 1). More...
 
virtual int64 GetBaseNodeRestartPosition (int base_index)
 Returns the index of the node to which the base node of index base_index must be set to when it reaches the end of a path. More...
 
virtual void SetNextBaseToIncrement (int64 base_index)
 Set the next base to increment on next iteration. More...
 
int64 OldNext (int64 node) const
 
int64 OldPath (int64 node) const
 
bool MoveChain (int64 before_chain, int64 chain_end, int64 destination)
 Moves the chain starting after the node before_chain and ending at the node chain_end after the node destination. More...
 
bool ReverseChain (int64 before_chain, int64 after_chain, int64 *chain_last)
 Reverses the chain starting after before_chain and ending before after_chain. More...
 
bool MakeActive (int64 node, int64 destination)
 Insert the inactive node after destination. More...
 
bool MakeChainInactive (int64 before_chain, int64 chain_end)
 Makes the nodes on the chain starting after before_chain and ending at chain_end inactive. More...
 
void SetNext (int64 from, int64 to, int64 path)
 Sets 'to' to be the node after 'from' on the given path. More...
 
bool IsPathEnd (int64 node) const
 Returns true if node is the last node on the path; defined by the fact that node is outside the range of the variable array. More...
 
bool IsInactive (int64 node) const
 Returns true if node is inactive. More...
 
virtual bool InitPosition () const
 Returns true if the operator needs to restart its initial position at each call to Start() More...
 
void ResetPosition ()
 Reset the position of the operator to its position when Start() was last called; this can be used to let an operator iterate more than once over the paths. More...
 
int AddAlternativeSet (const std::vector< int64 > &alternative_set)
 Handling node alternatives. More...
 
void AddPairAlternativeSets (const std::vector< std::pair< std::vector< int64 >, std::vector< int64 >>> &pair_alternative_sets)
 Adds all sets of node alternatives of a vector of alternative pairs. More...
 
int64 GetActiveInAlternativeSet (int alternative_index) const
 Returns the active node in the given alternative set. More...
 
int64 GetActiveAlternativeNode (int node) const
 Returns the active node in the alternative set of the given node. More...
 
int64 GetActiveAlternativeSibling (int node) const
 Returns the active node in the alternative set of the sibling of the given node. More...
 
void MarkChange (int64 index)
 OnStart() should really be protected, but then SWIG doesn't see it. More...
 

Protected Attributes

const int number_of_nexts_
 
const bool ignore_path_vars_
 
int next_base_to_increment_
 
int num_paths_ = 0
 
std::vector< int64 > start_to_path_
 
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

◆ PathWithPreviousNodesOperator()

PathWithPreviousNodesOperator ( const std::vector< IntVar * > &  vars,
const std::vector< IntVar * > &  secondary_vars,
int  number_of_base_nodes,
std::function< int(int64)>  start_empty_path_class 
)

◆ ~PathWithPreviousNodesOperator()

~PathWithPreviousNodesOperator ( )
inlineoverride

Definition at line 1505 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.

◆ AddAlternativeSet()

int AddAlternativeSet ( const std::vector< int64 > &  alternative_set)
inlineprotectedinherited

Handling node alternatives.

Adds a set of node alternatives to the neighborhood. No node can be in two altrnatives.

Definition at line 1400 of file constraint_solveri.h.

◆ AddPairAlternativeSets()

void AddPairAlternativeSets ( const std::vector< std::pair< std::vector< int64 >, std::vector< int64 >>> &  pair_alternative_sets)
inlineprotectedinherited

Adds all sets of node alternatives of a vector of alternative pairs.

No node can be in two altrnatives.

Definition at line 1413 of file constraint_solveri.h.

◆ AddVars()

void AddVars ( const std::vector< IntVar * > &  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.

◆ BaseNode()

int64 BaseNode ( int  i) const
inlineprotectedinherited

Returns the ith base node of the operator.

Definition at line 1307 of file constraint_solveri.h.

◆ Deactivate()

void Deactivate ( int64  index)
inlineinherited

Definition at line 867 of file constraint_solveri.h.

◆ DebugString()

◆ GetActiveAlternativeNode()

int64 GetActiveAlternativeNode ( int  node) const
inlineprotectedinherited

Returns the active node in the alternative set of the given node.

Definition at line 1430 of file constraint_solveri.h.

◆ GetActiveAlternativeSibling()

int64 GetActiveAlternativeSibling ( int  node) const
inlineprotectedinherited

Returns the active node in the alternative set of the sibling of the given node.

Definition at line 1435 of file constraint_solveri.h.

◆ GetActiveInAlternativeSet()

int64 GetActiveInAlternativeSet ( int  alternative_index) const
inlineprotectedinherited

Returns the active node in the given alternative set.

Definition at line 1424 of file constraint_solveri.h.

◆ GetBaseNodeRestartPosition()

virtual int64 GetBaseNodeRestartPosition ( int  base_index)
inlineprotectedvirtualinherited

Returns the index of the node to which the base node of index base_index must be set to when it reaches the end of a path.

By default, it is set to the start of the current path. When this method is called, one can only assume that base nodes with indices < base_index have their final position.

Reimplemented in PairNodeSwapActiveOperator< swap_first >, PairExchangeRelocateOperator, PairRelocateOperator, and MakePairActiveOperator.

Definition at line 1338 of file constraint_solveri.h.

◆ HasFragments()

virtual bool HasFragments ( ) const
inlinevirtualinherited

Reimplemented in BaseLns.

Definition at line 815 of file constraint_solveri.h.

◆ HoldsDelta()

bool HoldsDelta ( ) const
inlineoverridevirtualinherited

Reimplemented from LocalSearchOperator.

Definition at line 830 of file constraint_solveri.h.

◆ InitPosition()

virtual bool InitPosition ( ) const
inlineprotectedvirtualinherited

Returns true if the operator needs to restart its initial position at each call to Start()

Definition at line 1391 of file constraint_solveri.h.

◆ IsInactive()

bool IsInactive ( int64  node) const
inlineprotectedinherited

Returns true if node is inactive.

Definition at line 1385 of file constraint_solveri.h.

◆ IsIncremental()

virtual bool IsIncremental ( ) const
inlinevirtualinherited

Definition at line 846 of file constraint_solveri.h.

◆ IsPathEnd()

bool IsPathEnd ( int64  node) const
inlineprotectedinherited

Returns true if node is the last node on the path; defined by the fact that node is outside the range of the variable array.

Definition at line 1382 of file constraint_solveri.h.

◆ IsPathStart()

bool IsPathStart ( int64  node) const
inline

Definition at line 1507 of file constraint_solveri.h.

◆ MakeActive()

bool MakeActive ( int64  node,
int64  destination 
)
protectedinherited

Insert the inactive node after destination.

◆ MakeChainInactive()

bool MakeChainInactive ( int64  before_chain,
int64  chain_end 
)
protectedinherited

Makes the nodes on the chain starting after before_chain and ending at chain_end inactive.

◆ MakeNeighbor()

◆ MakeNextNeighbor()

bool MakeNextNeighbor ( Assignment delta,
Assignment deltadelta 
)
overridevirtualinherited

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.

◆ MakeOneNeighbor()

bool MakeOneNeighbor ( )
overrideprotectedvirtualinherited

This method should not be overridden. Override MakeNeighbor() instead.

Reimplemented from IntVarLocalSearchOperator.

Reimplemented in RelocateExpensiveChain, and MakePairActiveOperator.

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

◆ MoveChain()

bool MoveChain ( int64  before_chain,
int64  chain_end,
int64  destination 
)
protectedinherited

Moves the chain starting after the node before_chain and ending at the node chain_end after the node destination.

◆ Next()

int64 Next ( int64  node) const
inlineinherited

Returns the node after node in the current delta.

Definition at line 1288 of file constraint_solveri.h.

◆ number_of_nexts()

int number_of_nexts ( ) const
inlineinherited

Number of next variables.

Definition at line 1300 of file constraint_solveri.h.

◆ OldNext()

int64 OldNext ( int64  node) const
inlineprotectedinherited

Definition at line 1347 of file constraint_solveri.h.

◆ OldPath()

int64 OldPath ( int64  node) const
inlineprotectedinherited

Definition at line 1352 of file constraint_solveri.h.

◆ OldValue()

const int64 & OldValue ( int64  index) const
inlineinherited

Definition at line 857 of file constraint_solveri.h.

◆ OnNodeInitialization()

void OnNodeInitialization ( )
overrideprotectedvirtual

Called by OnStart() after initializing node information.

Should be overridden instead of OnStart() to avoid calling PathOperator::OnStart explicitly.

Reimplemented from PathOperator.

◆ OnSamePathAsPreviousBase()

virtual bool OnSamePathAsPreviousBase ( int64  base_index)
inlineprotectedvirtualinherited

Returns true if a base node has to be on the same path as the "previous" base node (base node of index base_index - 1).

Useful to limit neighborhood exploration to nodes on the same path. it's currently way more complicated to implement.

Reimplemented in PairNodeSwapActiveOperator< swap_first >, PairExchangeRelocateOperator, PairRelocateOperator, and MakePairActiveOperator.

Definition at line 1332 of file constraint_solveri.h.

◆ Path()

int64 Path ( int64  node) const
inlineinherited

Returns the index of the path to which node belongs in the current delta.

Only returns a valid value if path variables are taken into account.

Definition at line 1295 of file constraint_solveri.h.

◆ path_starts()

const std::vector<int64>& path_starts ( ) const
inlineprotectedinherited

Returns the vector of path start nodes.

Definition at line 1311 of file constraint_solveri.h.

◆ PathClass()

int PathClass ( int  i) const
inlineprotectedinherited

Returns the class of the path of the ith base node.

Definition at line 1313 of file constraint_solveri.h.

◆ Prev()

int64 Prev ( int64  node) const
inline

Definition at line 1509 of file constraint_solveri.h.

◆ Reset()

void Reset ( )
overridevirtualinherited

Reimplemented from LocalSearchOperator.

◆ ResetPosition()

void ResetPosition ( )
inlineprotectedinherited

Reset the position of the operator to its position when Start() was last called; this can be used to let an operator iterate more than once over the paths.

Definition at line 1395 of file constraint_solveri.h.

◆ RestartAtPathStartOnSynchronize()

virtual bool RestartAtPathStartOnSynchronize ( )
inlineprotectedvirtualinherited

When the operator is being synchronized with a new solution (when Start() is called), returns true to restart the exploration of the neighborhood from the start of the last paths explored; returns false to restart the exploration at the last nodes visited.

This is used to avoid restarting on base nodes which have changed paths, leading to potentially skipping neighbors.

Reimplemented in PairNodeSwapActiveOperator< swap_first >, and MakePairActiveOperator.

Definition at line 1326 of file constraint_solveri.h.

◆ ReverseChain()

bool ReverseChain ( int64  before_chain,
int64  after_chain,
int64 *  chain_last 
)
protectedinherited

Reverses the chain starting after before_chain and ending before after_chain.

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

◆ SetNext()

void SetNext ( int64  from,
int64  to,
int64  path 
)
inlineprotectedinherited

Sets 'to' to be the node after 'from' on the given path.

Definition at line 1371 of file constraint_solveri.h.

◆ SetNextBaseToIncrement()

virtual void SetNextBaseToIncrement ( int64  base_index)
inlineprotectedvirtualinherited

Set the next base to increment on next iteration.

All base > base_index will be reset to their start value.

Definition at line 1343 of file constraint_solveri.h.

◆ SetValue()

void SetValue ( int64  index,
const int64 &  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()

bool SkipUnchanged ( int  index) const
overridevirtualinherited

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

◆ StartNode()

int64 StartNode ( int  i) const
inlineprotectedinherited

Returns the start node of the ith base node.

Definition at line 1309 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.

◆ ignore_path_vars_

const bool ignore_path_vars_
protectedinherited

Definition at line 1444 of file constraint_solveri.h.

◆ next_base_to_increment_

int next_base_to_increment_
protectedinherited

Definition at line 1445 of file constraint_solveri.h.

◆ num_paths_

int num_paths_ = 0
protectedinherited

Definition at line 1446 of file constraint_solveri.h.

◆ number_of_nexts_

const int number_of_nexts_
protectedinherited

Definition at line 1443 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.

◆ start_to_path_

std::vector<int64> start_to_path_
protectedinherited

Definition at line 1447 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 file: