Detailed Description

This is the base class for building an Lns operator.

An Lns fragment is a collection of variables which will be relaxed. Fragments are built with NextFragment(), which returns false if there are no more fragments to build. Optionally one can override InitFragments, which is called from LocalSearchOperator::Start to initialize fragment data.

Here's a sample relaxing one variable at a time:

class OneVarLns : public BaseLns { public: OneVarLns(const std::vector<IntVar*>& vars) : BaseLns(vars), index_(0) {} virtual ~OneVarLns() {} virtual void InitFragments() { index_ = 0; } virtual bool NextFragment() { const int size = Size(); if (index_ < size) { AppendToFragment(index_); ++index_; return true; } else { return false; } }

private: int index_; };

Definition at line 1271 of file constraint_solveri.h.

Public Member Functions
	BaseLns (const std::vector< IntVar * > &vars)

	~BaseLns () override

virtual void	InitFragments ()

virtual bool	NextFragment ()=0

void	AppendToFragment (int index)

int	FragmentSize () const

bool	HasFragments () const 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	Reset ()

virtual const LocalSearchOperator *	Self () const

Protected Member Functions
bool	MakeOneNeighbor () override
	This method should not be overridden. Override NextFragment() instead. 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

◆ BaseLns()

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

explicit

◆ ~BaseLns()

~BaseLns ( )

override

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< IntVar * > & vars )

inlineinherited

Definition at line 908 of file constraint_solveri.h.

◆ AppendToFragment()

void AppendToFragment ( int index )

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

◆ FragmentSize()

int FragmentSize ( ) const

◆ HasFragments()

bool HasFragments ( ) const

inlineoverridevirtual

Reimplemented from LocalSearchOperator.

Definition at line 1279 of file constraint_solveri.h.

◆ HoldsDelta() [1/2]

virtual bool HoldsDelta ( ) const

inlinevirtualinherited

Reimplemented in VarLocalSearchOperator< V, Val, Handler >.

Definition at line 816 of file constraint_solveri.h.

◆ HoldsDelta() [2/2]

bool HoldsDelta

inlineoverrideinherited

Definition at line 830 of file constraint_solveri.h.

◆ InitFragments()

virtual void InitFragments ( )

virtual

◆ InverseValue()

int64 InverseValue ( int64 index ) const

inlineprotectedinherited

Definition at line 1077 of file constraint_solveri.h.

◆ IsIncremental()

virtual bool IsIncremental

inlinevirtualinherited

Definition at line 846 of file constraint_solveri.h.

◆ IsInverseValue()

bool IsInverseValue ( int64 index ) const

inlineprotectedinherited

Definition at line 1072 of file constraint_solveri.h.

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

overrideprotectedvirtual

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

Reimplemented from IntVarLocalSearchOperator.

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

◆ NextFragment()

virtual bool NextFragment ( )

pure virtual

◆ OldInverseValue()

int64 OldInverseValue ( int64 index ) const

inlineprotectedinherited

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.

◆ Reset()

virtual void Reset ( )

inlinevirtualinherited

Reimplemented in PathOperator.

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
	)

inlineprotectedinherited

Definition at line 1083 of file constraint_solveri.h.

◆ SetOldInverseValue()

void SetOldInverseValue	(	int64	index,
		int64	value
	)

inlineprotectedinherited

Definition at line 1087 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

inlineinherited

Definition at line 847 of file constraint_solveri.h.

◆ SkipUnchanged()

virtual bool SkipUnchanged ( int index ) const

inlinevirtualinherited

Reimplemented in PathOperator.

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 file:

constraint_solveri.h

C++ Reference

C++ Reference: Routing

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ BaseLns()

◆ ~BaseLns()

Member Function Documentation

◆ Activate()

◆ Activated()

◆ AddVars()

◆ AppendToFragment()

◆ ApplyChanges()

◆ Deactivate()

◆ FragmentSize()

◆ HasFragments()

◆ HoldsDelta() [1/2]

◆ HoldsDelta() [2/2]

◆ InitFragments()

◆ InverseValue()

◆ IsIncremental()

◆ IsInverseValue()

◆ MakeNextNeighbor()

◆ MakeOneNeighbor()

◆ MarkChange()

◆ NextFragment()

◆ OldInverseValue()

◆ OldValue()

◆ Reset()

◆ RevertChanges()

◆ Self()

◆ SetInverseValue()

◆ SetOldInverseValue()

◆ SetValue()

◆ Size()

◆ SkipUnchanged()

◆ Start()

◆ Value()

◆ Var()

Member Data Documentation

◆ activated_

◆ assignment_indices_

◆ changes_

◆ cleared_

◆ delta_changes_

◆ old_values_

◆ prev_values_

◆ values_

◆ var_handler_

◆ vars_

◆ was_activated_