Java Reference

Java Reference

BasePathFilter

Detailed Description

Generic path-based filter class.

Definition at line 14 of file BasePathFilter.java.

Public Member Functions

synchronized void delete ()
 
boolean accept (Assignment delta, Assignment deltadelta, long objective_min, long objective_max)
 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 (Assignment delta)
 
void swigReleaseOwnership ()
 
void swigTakeOwnership ()
 
void synchronize (Assignment assignment, Assignment delta)
 This method should not be overridden. More...
 
void addVars (IntVar[] vars)
 Add variables to "track" to the filter. More...
 
int size ()
 
IntVar var (int index)
 
long value (int index)
 
int index (IntVar var)
 
void Relax (Assignment delta, Assignment deltadelta)
 Lets the filter know what delta and deltadelta will be passed in the next Accept(). More...
 
boolean isIncremental ()
 
void Revert ()
 Cancels the changes made by the last Relax()/Accept() calls. More...
 
long getSynchronizedObjectiveValue ()
 Objective value from last time Synchronize() was called. More...
 
long getAcceptedObjectiveValue ()
 Objective value from the last time Accept() was called and returned true. More...
 
String toString ()
 

Protected Member Functions

 BasePathFilter (long cPtr, boolean cMemoryOwn)
 
void swigDirectorDisconnect ()
 

Constructor & Destructor Documentation

◆ BasePathFilter()

BasePathFilter ( long  cPtr,
boolean  cMemoryOwn 
)
inlineprotected

Definition at line 17 of file BasePathFilter.java.

Member Function Documentation

◆ accept()

boolean accept ( Assignment  delta,
Assignment  deltadelta,
long  objective_min,
long  objective_max 
)
inline

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.

Reimplemented from LocalSearchFilter.

Definition at line 42 of file BasePathFilter.java.

◆ addVars()

void addVars ( IntVar[]  vars)
inlineinherited

Add variables to "track" to the filter.

Definition at line 73 of file IntVarLocalSearchFilter.java.

◆ delete()

synchronized void delete ( )
inline

Reimplemented from IntVarLocalSearchFilter.

Definition at line 31 of file BasePathFilter.java.

◆ getAcceptedObjectiveValue()

long getAcceptedObjectiveValue ( )
inlineinherited

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

Definition at line 99 of file LocalSearchFilter.java.

◆ getSynchronizedObjectiveValue()

long getSynchronizedObjectiveValue ( )
inlineinherited

Objective value from last time Synchronize() was called.

Definition at line 92 of file LocalSearchFilter.java.

◆ index()

int index ( IntVar  var)
inlineinherited

Definition at line 94 of file IntVarLocalSearchFilter.java.

◆ isIncremental()

boolean isIncremental ( )
inlineinherited

Definition at line 71 of file LocalSearchFilter.java.

◆ onSynchronize()

void onSynchronize ( Assignment  delta)
inline

Reimplemented from IntVarLocalSearchFilter.

Definition at line 46 of file BasePathFilter.java.

◆ Relax()

void Relax ( Assignment  delta,
Assignment  deltadelta 
)
inlineinherited

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

Definition at line 60 of file LocalSearchFilter.java.

◆ Revert()

void Revert ( )
inlineinherited

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

Definition at line 85 of file LocalSearchFilter.java.

◆ size()

int size ( )
inlineinherited

Definition at line 77 of file IntVarLocalSearchFilter.java.

◆ swigDirectorDisconnect()

void swigDirectorDisconnect ( )
inlineprotectedinherited

Reimplemented from LocalSearchFilter.

Definition at line 43 of file IntVarLocalSearchFilter.java.

◆ swigReleaseOwnership()

void swigReleaseOwnership ( )
inlineinherited

Reimplemented from LocalSearchFilter.

Definition at line 48 of file IntVarLocalSearchFilter.java.

◆ swigTakeOwnership()

void swigTakeOwnership ( )
inlineinherited

Reimplemented from LocalSearchFilter.

Definition at line 53 of file IntVarLocalSearchFilter.java.

◆ synchronize()

void synchronize ( Assignment  assignment,
Assignment  delta 
)
inlineinherited

This method should not be overridden.

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

Reimplemented from LocalSearchFilter.

Definition at line 66 of file IntVarLocalSearchFilter.java.

◆ toString()

◆ value()

long value ( int  index)
inlineinherited

Definition at line 86 of file IntVarLocalSearchFilter.java.

◆ var()

IntVar var ( int  index)
inlineinherited

Definition at line 81 of file IntVarLocalSearchFilter.java.


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