C++ Reference

C++ Reference: Routing

IntVarLocalSearchFilterabstract

Detailed Description

Definition at line 1795 of file constraint_solveri.h.

Public Member Functions

 IntVarLocalSearchFilter (const std::vector< IntVar * > &vars)
 
 ~IntVarLocalSearchFilter () override
 
void Synchronize (const Assignment *assignment, const Assignment *delta) override
 This method should not be overridden. More...
 
bool FindIndex (IntVar *const var, int64 *index) const
 
void AddVars (const std::vector< IntVar * > &vars)
 Add variables to "track" to the filter. More...
 
int Size () const
 
IntVar * Var (int index) const
 
int64 Value (int index) const
 
bool IsVarSynced (int index) const
 
virtual void Relax (const Assignment *delta, const Assignment *deltadelta)
 Lets the filter know what delta and deltadelta will be passed in the next Accept(). More...
 
virtual bool Accept (const Assignment *delta, const Assignment *deltadelta, int64 objective_min, int64 objective_max)=0
 Accepts a "delta" given the assignment with which the filter has been synchronized; the delta holds the variables which have been modified and their new value. More...
 
virtual bool IsIncremental () const
 
virtual void Revert ()
 Cancels the changes made by the last Relax()/Accept() calls. More...
 
virtual int64 GetSynchronizedObjectiveValue () const
 Objective value from last time Synchronize() was called. More...
 
virtual int64 GetAcceptedObjectiveValue () const
 Objective value from the last time Accept() was called and returned true. More...
 

Protected Member Functions

virtual void OnSynchronize (const Assignment *delta)
 
void SynchronizeOnAssignment (const Assignment *assignment)
 

Constructor & Destructor Documentation

◆ IntVarLocalSearchFilter()

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

◆ ~IntVarLocalSearchFilter()

~IntVarLocalSearchFilter ( )
override

Member Function Documentation

◆ Accept()

virtual bool Accept ( const Assignment *  delta,
const Assignment *  deltadelta,
int64  objective_min,
int64  objective_max 
)
pure virtualinherited

Accepts a "delta" given the assignment with which the filter has been synchronized; the delta holds the variables which have been modified and their new value.

If the filter represents a part of the global objective, its contribution must be between objective_min and objective_max. Sample: supposing one wants to maintain a[0,1] + b[0,1] <= 1, for the assignment (a,1), (b,0), the delta (b,1) will be rejected but the delta (a,0) will be accepted. TODO(user): Remove arguments when there are no more need for those.

Implemented in CPFeasibilityFilter, BasePathFilter, and LocalSearchFilterManager.

◆ AddVars()

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

Add variables to "track" to the filter.

◆ FindIndex()

bool FindIndex ( IntVar *const  var,
int64 *  index 
) const
inline

Definition at line 1804 of file constraint_solveri.h.

◆ GetAcceptedObjectiveValue()

virtual int64 GetAcceptedObjectiveValue ( ) const
inlinevirtualinherited

Objective value from the last time Accept() was called and returned true.

Reimplemented in LocalSearchFilterManager.

Definition at line 1757 of file constraint_solveri.h.

◆ GetSynchronizedObjectiveValue()

virtual int64 GetSynchronizedObjectiveValue ( ) const
inlinevirtualinherited

Objective value from last time Synchronize() was called.

Reimplemented in LocalSearchFilterManager.

Definition at line 1754 of file constraint_solveri.h.

◆ IsIncremental()

virtual bool IsIncremental ( ) const
inlinevirtualinherited

Reimplemented in LocalSearchFilterManager.

Definition at line 1741 of file constraint_solveri.h.

◆ IsVarSynced()

bool IsVarSynced ( int  index) const
inline

Definition at line 1821 of file constraint_solveri.h.

◆ OnSynchronize()

virtual void OnSynchronize ( const Assignment *  delta)
inlineprotectedvirtual

Reimplemented in CPFeasibilityFilter, and BasePathFilter.

Definition at line 1824 of file constraint_solveri.h.

◆ Relax()

virtual void Relax ( const Assignment *  delta,
const Assignment *  deltadelta 
)
inlinevirtualinherited

Lets the filter know what delta and deltadelta will be passed in the next Accept().

Reimplemented in LocalSearchFilterManager.

Definition at line 1728 of file constraint_solveri.h.

◆ Revert()

virtual void Revert ( )
inlinevirtualinherited

Cancels the changes made by the last Relax()/Accept() calls.

Reimplemented in LocalSearchFilterManager.

Definition at line 1751 of file constraint_solveri.h.

◆ Size()

int Size ( ) const
inline

Definition at line 1815 of file constraint_solveri.h.

◆ Synchronize()

void Synchronize ( const Assignment *  assignment,
const Assignment *  delta 
)
overridevirtual

This method should not be overridden.

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

Implements LocalSearchFilter.

◆ SynchronizeOnAssignment()

void SynchronizeOnAssignment ( const Assignment *  assignment)
protected

◆ Value()

int64 Value ( int  index) const
inline

Definition at line 1817 of file constraint_solveri.h.

◆ Var()

IntVar* Var ( int  index) const
inline

Definition at line 1816 of file constraint_solveri.h.


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