OR-Tools  8.2
CPFeasibilityFilter

Detailed Description

This filter accepts deltas for which the assignment satisfies the constraints of the Solver.

This is verified by keeping an internal copy of the assignment with all Next vars and their updated values, and calling RestoreAssignment() on the assignment+delta. exception of Next Vars (woud fail on large instances). WARNING: In the case of mandatory nodes, when all vehicles are currently being used in the solution but uninserted nodes still remain, this filter will reject the solution, even if the node could be inserted on one of these routes, because all Next vars of vehicle starts are already instantiated.

Definition at line 3908 of file routing.h.

Public Member Functions

 CPFeasibilityFilter (RoutingModel *routing_model)
 
 ~CPFeasibilityFilter () override
 
std::string DebugString () const override
 
bool Accept (const Assignment *delta, const Assignment *deltadelta, int64 objective_min, int64 objective_max) override
 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...
 
void OnSynchronize (const Assignment *delta) 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
 
IntVarVar (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 void Commit (const Assignment *delta, const Assignment *deltadelta)
 Dual of Relax(), lets the filter know that the delta was accepted. More...
 
virtual bool IsIncremental () const
 
virtual void Revert ()
 Cancels the changes made by the last Relax()/Accept() calls. More...
 
virtual void Reset ()
 Sets the filter to empty solution. 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

void SynchronizeOnAssignment (const Assignment *assignment)
 

Constructor & Destructor Documentation

◆ CPFeasibilityFilter()

CPFeasibilityFilter ( RoutingModel routing_model)
explicit

Definition at line 2691 of file routing_search.cc.

◆ ~CPFeasibilityFilter()

~CPFeasibilityFilter ( )
inlineoverride

Definition at line 3911 of file routing.h.

Member Function Documentation

◆ Accept()

bool Accept ( const Assignment delta,
const Assignment deltadelta,
int64  objective_min,
int64  objective_max 
)
overridevirtual

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.

Implements LocalSearchFilter.

Definition at line 2703 of file routing_search.cc.

◆ AddVars()

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

Add variables to "track" to the filter.

Definition at line 3246 of file local_search.cc.

◆ Commit()

virtual void Commit ( const Assignment delta,
const Assignment deltadelta 
)
inlinevirtualinherited

Dual of Relax(), lets the filter know that the delta was accepted.

Definition at line 1725 of file constraint_solveri.h.

◆ DebugString()

std::string DebugString ( ) const
inlineoverridevirtual

Reimplemented from BaseObject.

Definition at line 3912 of file routing.h.

◆ FindIndex()

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

Definition at line 1820 of file constraint_solveri.h.

◆ GetAcceptedObjectiveValue()

virtual int64 GetAcceptedObjectiveValue ( ) const
inlinevirtualinherited

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

Definition at line 1757 of file constraint_solveri.h.

◆ GetSynchronizedObjectiveValue()

virtual int64 GetSynchronizedObjectiveValue ( ) const
inlinevirtualinherited

Objective value from last time Synchronize() was called.

Definition at line 1754 of file constraint_solveri.h.

◆ IsIncremental()

virtual bool IsIncremental ( ) const
inlinevirtualinherited

Definition at line 1738 of file constraint_solveri.h.

◆ IsVarSynced()

bool IsVarSynced ( int  index) const
inlineinherited

Definition at line 1837 of file constraint_solveri.h.

◆ OnSynchronize()

void OnSynchronize ( const Assignment delta)
overridevirtual

Reimplemented from IntVarLocalSearchFilter.

Definition at line 2712 of file routing_search.cc.

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

Definition at line 1723 of file constraint_solveri.h.

◆ Reset()

virtual void Reset ( )
inlinevirtualinherited

Sets the filter to empty solution.

Definition at line 1751 of file constraint_solveri.h.

◆ Revert()

virtual void Revert ( )
inlinevirtualinherited

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

Definition at line 1748 of file constraint_solveri.h.

◆ Size()

int Size ( ) const
inlineinherited

Definition at line 1831 of file constraint_solveri.h.

◆ Synchronize()

void Synchronize ( const Assignment assignment,
const Assignment delta 
)
overridevirtualinherited

This method should not be overridden.

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

Implements LocalSearchFilter.

Definition at line 3263 of file local_search.cc.

◆ SynchronizeOnAssignment()

void SynchronizeOnAssignment ( const Assignment assignment)
protectedinherited

Definition at line 3274 of file local_search.cc.

◆ Value()

int64 Value ( int  index) const
inlineinherited

Definition at line 1833 of file constraint_solveri.h.

◆ Var()

IntVar* Var ( int  index) const
inlineinherited

Definition at line 1832 of file constraint_solveri.h.


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